On this page:
6.7.1 Non-GUI Installer
run-single-installer
install-planet-package
reindex-user-documentation
clean-planet-package

6.7 API for Installing ".plt" Archives

The setup/plt-single-installer module provides a function for installing a single ".plt" file.

6.7.1 Non-GUI Installer

 (require setup/plt-single-installer) package: base

procedure

(run-single-installer 
  file 
  get-dir-proc 
  [#:show-beginning-of-file? show-beginning-of-file?]) 
  void?
  file : path-string?
  get-dir-proc : (-> (or/c path-string? #f))
  show-beginning-of-file? : any/c = #f
Creates a separate thread and namespace, runs the installer in that thread with the new namespace, and returns when the thread completes or dies. It also creates a custodian (see Custodians) to manage the created thread, sets the exit handler for the thread to shut down the custodian, and explicitly shuts down the custodian when the created thread terminates or dies.

The get-dir-proc procedure is called if the installer needs a target directory for installation, and a #f result means that the user canceled the installation. Typically, get-dir-proc is current-directory.

If show-beginning-of-file? is a true value and the installation fails, then run-single-installer prints the first 1,000 characters of the file (in an attempt to help debug the cause of failures).

procedure

(install-planet-package file directory spec)  void?

  file : path-string?
  directory : path-string?
  spec : 
(list/c string? string?
        (listof string?)
        exact-nonnegative-integer?
        exact-nonnegative-integer?)
Similar to run-single-installer, but runs the setup process to install the archive file into directory as the PLaneT package described by spec. The user-specific documentation index is not rebuilt, so reindex-user-documentation should be run after a set of PLaneT packages are installed.

Similar to run-single-installer, but runs only the part of the setup process that rebuilds the user-specific documentation start page, search page, and master index.

procedure

(clean-planet-package directory spec)  void?

  directory : path-string?
  spec : 
(list/c string? string?
        (listof string?)
        exact-nonnegative-integer?
        exact-nonnegative-integer?)
Undoes the work of install-planet-package. The user-specific documentation index is not rebuilt, so reindex-user-documentation should be run after a set of PLaneT packages are removed.