9.5 API for Finding Installation Directories
The setup/dirs library provides several procedures for locating
installation directories:
procedure
(find-collects-dir) → (or/c path? false/c)
Returns a path to the installation’s main "collects" directory, or
#f if none can be found. A #f result is likely only
in a stand-alone executable that is distributed without libraries.
procedure
Returns a path to the user-specific "collects" directory; the
directory indicated by the returned path may or may not exist.
procedure
Returns the same result as (current-library-collection-paths),
which means that this result is not sensitive to the value of the
use-user-specific-search-paths parameter.
procedure
(find-doc-dir) → (or/c path? false/c)
Returns a path to the installation’s "doc" directory.
The result is #f if no such directory is available.
procedure
Returns a path to a user-specific "doc" directory. The directory
indicated by the returned path may or may not exist.
procedure
(get-doc-search-dirs) → (listof path?)
Returns a list of paths to search for documentation, not including
documentation stored in individual collections. Unless it is
configured otherwise, the result includes any non-#f result of
(find-doc-dir) and (find-user-doc-dir)— but the latter is
included only if the value of the use-user-specific-search-paths
parameter is #t.
procedure
(find-lib-dir) → (or/c path? false/c)
Returns a path to the installation’s "lib" directory, which contains
libraries and other build information. The result is #f if no such
directory is available.
procedure
(find-dll-dir) → (or/c path? false/c)
Returns a path to the directory that contains DLLs for use with the
current executable (e.g., "libmzsch.dll" on Windows).
The result is #f if no such directory is available, or if no
specific directory is available (i.e., other than the platform’s normal
search path).
procedure
Returns a path to a user-specific "lib" directory; the directory
indicated by the returned path may or may not exist.
procedure
(get-lib-search-dirs) → (listof path?)
Returns a list of paths to search for libraries. Unless it is
configured otherwise, the result includes any non-#f result of
(find-lib-dir), (find-dll-dir),
and (find-user-lib-dir)— but the last is included only if the
value of the use-user-specific-search-paths parameter
is #t.
procedure
(find-include-dir) → (or/c path? false/c)
Returns a path to the installation’s "include" directory, which
contains ".h" files for building Racket extensions and embedding
programs. The result is #f if no such directory is available.
procedure
Returns a path to a user-specific "include" directory; the
directory indicated by the returned path may or may not exist.
procedure
Returns a list of paths to search for ".h" files. Unless it is
configured otherwise, the result includes any non-#f result of
(find-include-dir) and (find-user-include-dir)— but the
latter is included only if the value of the
use-user-specific-search-paths parameter is #t.
procedure
(find-console-bin-dir) → (or/c path? false/c)
Returns a path to the installation’s executable directory, where the
stand-alone Racket executable resides. The result is #f if no
such directory is available.
procedure
(find-gui-bin-dir) → (or/c path? false/c)
Returns a path to the installation’s executable directory, where the
stand-alone GRacket executable resides. The result is #f if no such
directory is available.
value
A binary boolean flag that is true if this installation is using
absolute path names.