6.3 API for Installation
The setup/setup-unit library provides raco setup in unit
form. The associated setup/option-sig and
setup/option-unit libraries provides the interface for
setting options for the run of raco setup.
For example, to unpack a single ".plt" archive
"x.plt", set the archives parameter
to (list "x.plt") and leave specific-collections as null.
Link the options and setup units so that your option-setting code is
initialized between them, e.g.:
6.3.1 raco setup Unit
and exports nothing. Invoking setup@ starts the setup process.
6.3.2 Options Unit
6.3.3 Options Signature
Provides parameters used to control raco setup in unit
If on, prints message from make to stderr.
The default is #f.
If on, verbose make. The default is #f.
If on, verbose compiler. The default is #f.
If on, delete ".zo" and
".so"/".dll"/".dylib" files in the
specified collections. The default is #f.
If a path
is given, use a ".zo"
compiler other than plain
, and build to (build-path "compiled" (compile-mode))
The default is #f
If on, compile ".zo". The default is #t.
If on, compile ".so"/".dll" files. The default is #f.
If on, make collection "info.rkt"-specified launchers. The default is #t.
If on, update "info-domain/compiled/cache.rkt" for each
collection path. The default is #t.
If on, avoid building bytecode in the main installation tree when building
other bytecode (e.g., in a user-specific collection). The default is #f.
If on, call collection "info.rkt"-specified setup code.
The default is #t.
If on, ignore version and already-installed errors when unpacking a
".plt" archive. The default is #f.
If on, in the event of an error, prints a summary error and waits for
stdin input before terminating. The default is #f.
A list of collections to set up; the empty list means set-up all
collections if the archives list is also empty The default is null
A list of ".plt"
archives to unpack; any collections specified
by the archives are set-up in addition to the collections listed in
specific-collections. The default is null
If on, when archives has a non-empty list of packages, if any
documentation is built, then suitable documentation start pages, search pages,
and master index pages are re-built. The default is #t.
A thunk that returns the target directory for unpacking a relative
archive; when unpacking an archive, either this or
the procedure in current-target-plt-directory-getter
be called. The default is current-directory
A procedure that takes a preferred path, a path to the parent of the main
directory, and a list of path choices; it returns
a path for a "plt-relative" install; when unpacking an archive, either
this or the procedure in current-target-directory-getter
be called, and in the former case, this procedure may be called
multiple times. The default is (lambda (preferred main-parent-dir choices) preferred)