/usr/share/doc/racket/raco/config-file.html is in racket-doc 6.1-4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html><head><meta http-equiv="content-type" content="text/html; charset=utf-8"/><title>18 Installation Configuration and Search Paths</title><link rel="stylesheet" type="text/css" href="../scribble.css" title="default"/><link rel="stylesheet" type="text/css" href="../racket.css" title="default"/><link rel="stylesheet" type="text/css" href="../manual-style.css" title="default"/><link rel="stylesheet" type="text/css" href="../manual-racket.css" title="default"/><link rel="stylesheet" type="text/css" href="../doc-site.css" title="default"/><script type="text/javascript" src="../scribble-common.js"></script><script type="text/javascript" src="../manual-racket.js"></script><script type="text/javascript" src="../doc-site.js"></script><script type="text/javascript" src="../local-redirect/local-redirect.js"></script><script type="text/javascript" src="../local-redirect/local-user-redirect.js"></script><!--[if IE 6]><style type="text/css">.SIEHidden { overflow: hidden; }</style><![endif]--></head><body id="doc-racket-lang-org"><div class="tocset"><div class="tocview"><div class="tocviewlist tocviewlisttopspace"><div class="tocviewtitle"><table cellspacing="0" cellpadding="0"><tr><td style="width: 1em;"><a href="javascript:void(0);" title="Expand/Collapse" class="tocviewtoggle" onclick="TocviewToggle(this,"tocview_0");">▼</a></td><td></td><td><a href="index.html" class="tocviewlink" data-pltdoc="x"><span class="stt">raco</span>:<span class="mywbr"> </span> Racket Command-<wbr></wbr>Line Tools</a></td></tr></table></div><div class="tocviewsublistonly" style="display: block;" id="tocview_0"><table cellspacing="0" cellpadding="0"><tr><td align="right">1 </td><td><a href="make.html" class="tocviewlink" data-pltdoc="x"><span class="stt">raco make</span>:<span class="mywbr"> </span> Compiling Source to Bytecode</a></td></tr><tr><td align="right">2 </td><td><a href="exe.html" class="tocviewlink" data-pltdoc="x"><span class="stt">raco exe</span>:<span class="mywbr"> </span> Creating Stand-<wbr></wbr>Alone Executables</a></td></tr><tr><td align="right">3 </td><td><a href="exe-dist.html" class="tocviewlink" data-pltdoc="x"><span class="stt">raco distribute</span>:<span class="mywbr"> </span> Sharing Stand-<wbr></wbr>Alone Executables</a></td></tr><tr><td align="right">4 </td><td><a href="planet.html" class="tocviewlink" data-pltdoc="x"><span class="stt">raco planet</span>:<span class="mywbr"> </span> Automatic Package Distribution</a></td></tr><tr><td align="right">5 </td><td><a href="pkg.html" class="tocviewlink" data-pltdoc="x"><span class="stt">raco pkg</span>:<span class="mywbr"> </span> Package Management</a></td></tr><tr><td align="right">6 </td><td><a href="setup.html" class="tocviewlink" data-pltdoc="x"><span class="stt">raco setup</span>:<span class="mywbr"> </span> Installation Management</a></td></tr><tr><td align="right">7 </td><td><a href="decompile.html" class="tocviewlink" data-pltdoc="x"><span class="stt">raco decompile</span>:<span class="mywbr"> </span> Decompiling Bytecode</a></td></tr><tr><td align="right">8 </td><td><a href="demod.html" class="tocviewlink" data-pltdoc="x"><span class="stt">raco demod</span>:<span class="mywbr"> </span> Demodularizing Programs</a></td></tr><tr><td align="right">9 </td><td><a href="link.html" class="tocviewlink" data-pltdoc="x"><span class="stt">raco link</span>:<span class="mywbr"> </span> Library Collection Links</a></td></tr><tr><td align="right">10 </td><td><a href="plt.html" class="tocviewlink" data-pltdoc="x"><span class="stt">raco pack</span>:<span class="mywbr"> </span> Packing Library Collections</a></td></tr><tr><td align="right">11 </td><td><a href="unpack.html" class="tocviewlink" data-pltdoc="x"><span class="stt">raco unpack</span>:<span class="mywbr"> </span> Unpacking Library Collections</a></td></tr><tr><td align="right">12 </td><td><a href="ctool.html" class="tocviewlink" data-pltdoc="x"><span class="stt">raco ctool</span>:<span class="mywbr"> </span> Working with C Code</a></td></tr><tr><td align="right">13 </td><td><a href="test.html" class="tocviewlink" data-pltdoc="x"><span class="stt">raco test</span>:<span class="mywbr"> </span> Run tests</a></td></tr><tr><td align="right">14 </td><td><a href="docs.html" class="tocviewlink" data-pltdoc="x"><span class="stt">raco docs</span>:<span class="mywbr"> </span> Documentation Search</a></td></tr><tr><td align="right">15 </td><td><a href="expand.html" class="tocviewlink" data-pltdoc="x"><span class="stt">raco expand</span>:<span class="mywbr"> </span> Macro Expansion</a></td></tr><tr><td align="right">16 </td><td><a href="scribble.html" class="tocviewlink" data-pltdoc="x"><span class="stt">raco scribble</span>:<span class="mywbr"> </span> Building Documentation</a></td></tr><tr><td align="right">17 </td><td><a href="command.html" class="tocviewlink" data-pltdoc="x">Adding a <span class="stt">raco</span> Command</a></td></tr><tr><td align="right">18 </td><td><a href="" class="tocviewselflink" data-pltdoc="x">Installation Configuration and Search Paths</a></td></tr></table></div></div></div></div><div class="maincolumn"><div class="main"><div class="navsettop"><span class="navleft"><form class="searchform"><input class="searchbox" style="color: #888;" type="text" value="...search manuals..." title="Enter a search string to search the manuals" onkeypress="return DoSearchKey(event, this, "6.1", "../");" onfocus="this.style.color="black"; this.style.textAlign="left"; if (this.value == "...search manuals...") this.value="";" onblur="if (this.value.match(/^ *$/)) { this.style.color="#888"; this.style.textAlign="center"; this.value="...search manuals..."; }"/></form> <a href="../index.html" title="up to the documentation top" data-pltdoc="x" onclick="return GotoPLTRoot("6.1");">top</a></span><span class="navright"> <a href="command.html" title="backward to "17 Adding a raco Command"" data-pltdoc="x">← prev</a> <a href="index.html" title="up to "raco: Racket Command-Line Tools"" data-pltdoc="x">up</a> <span class="nonavigation">next →</span></span> </div><h3 x-source-module="(lib "scribblings/raco/raco.scrbl")" x-part-tag=""config-file"">18<tt> </tt><a name="(part._config-file)"></a>Installation Configuration and Search Paths</h3><p>A <a name="(tech._configuration._directory)"></a><span style="font-style: italic">configuration directory</span> path is built into the Racket executable as
selected at install time, and its location can be changed via the
<span class="stt">PLTCONFIGDIR</span> directory or <span class="nobreak"><span class="stt">--config</span></span>/<span class="nobreak"><span class="stt">-G</span></span>
command-line flag. Use <span class="RktSym"><a href="dirs.html#%28def._%28%28lib._setup%2Fdirs..rkt%29._find-config-dir%29%29" class="RktValLink" data-pltdoc="x">find-config-dir</a></span> to locate the
configuration directory.</p><p>Modify the <a name="(idx._(gentag._57._(lib._scribblings/raco/raco..scrbl)))"></a><span class="stt">"config.rktd"</span> file in the <a href="#%28tech._configuration._directory%29" class="techoutside" data-pltdoc="x"><span class="techinside">configuration directory</span></a>
to configure other directories as described below. Use the
<a href="dirs.html" class="RktModLink" data-pltdoc="x"><span class="RktSym">setup/dirs</span></a> library (which combines information from
the configuration files and other sources) to locate configured
directories, instead of reading <span class="stt">"config.rktd"</span> directly.</p><p>The path of the <a name="(tech._main._collection._directory)"></a><span style="font-style: italic">main collection directory</span> is built into the
Racket executable, and it can be changed via the
<span class="nobreak"><span class="stt">--collects</span></span>/<span class="nobreak"><span class="stt">-X</span></span> flag, so it has no entry in
<span class="stt">"config.rktd"</span>. Most paths that are specified in
<span class="stt">"config.rktd"</span> have default values that are relative to the
main collection directory. The paths of the <a href="#%28tech._configuration._directory%29" class="techoutside" data-pltdoc="x"><span class="techinside">configuration directory</span></a> and
<a href="#%28tech._main._collection._directory%29" class="techoutside" data-pltdoc="x"><span class="techinside">main collection directory</span></a> thus work together to determine a
Racket configuration.</p><p>A <span class="stt">"config.rktd"</span> file in the configuration directory should
contain a <span class="RktSym"><a href="http://download.racket-lang.org/docs/6.1/html/local-redirect/index.html?doc=reference&rel=Reading.html%23%2528def._%2528%2528quote._%7E23%7E25kernel%2529._read%2529%2529&version=6.1" class="RktValLink Sq" data-pltdoc="x">read</a></span>able hash table with any of the following
symbolic keys, where a relative path is relative to the <a href="#%28tech._main._collection._directory%29" class="techoutside" data-pltdoc="x"><span class="techinside">main collection
directory</span></a>:</p><ul><li><p><a name="(idx._(gentag._58._(lib._scribblings/raco/raco..scrbl)))"></a><span class="RktVal">'</span><span class="RktVal">installation-name</span> —<wbr></wbr> a string for the installation
name, which is used to determine user- and version-specific paths,
such as the initial path produced by <span class="RktSym"><a href="http://download.racket-lang.org/docs/6.1/html/local-redirect/index.html?doc=reference&rel=collects.html%23%2528def._%2528%2528lib._racket%252Fprivate%252Fmisc..rkt%2529._find-library-collection-paths%2529%2529&version=6.1" class="RktValLink Sq" data-pltdoc="x">find-library-collection-paths</a></span>
and the location of packages that are installed in <span class="stt">user</span>
<a href="http://download.racket-lang.org/docs/6.1/html/local-redirect/index.html?doc=pkg&rel=Package_Concepts.html%23%2528tech._package._scope%2529&version=6.1" class="techoutside Sq" data-pltdoc="x"><span class="techinside">package
scope</span></a>. The default is <span class="RktPn">(</span><span class="RktSym"><a href="http://download.racket-lang.org/docs/6.1/html/local-redirect/index.html?doc=reference&rel=runtime.html%23%2528def._%2528%2528quote._%7E23%7E25kernel%2529._version%2529%2529&version=6.1" class="RktValLink Sq" data-pltdoc="x">version</a></span><span class="RktPn">)</span>.</p></li><li><p><a name="(idx._(gentag._59._(lib._scribblings/raco/raco..scrbl)))"></a><span class="RktVal">'</span><span class="RktVal">lib-dir</span> —<wbr></wbr> a path, string, or byte string for the
<a name="(tech._main._library._directory)"></a><span style="font-style: italic">main library directory</span>. It defaults to a <span class="stt">"lib"</span>
sibling directory of the <a href="#%28tech._main._collection._directory%29" class="techoutside" data-pltdoc="x"><span class="techinside">main collection directory</span></a>.</p></li><li><p><a name="(idx._(gentag._60._(lib._scribblings/raco/raco..scrbl)))"></a><span class="RktVal">'</span><span class="RktVal">lib-search-dirs</span> —<wbr></wbr> a list of paths, strings, byte
strings, or <span class="RktVal">#f</span> representing the search path for
directories containing foreign libraries. Each <span class="RktVal">#f</span> in
the list, if any, is replaced with the default search path,
which is the user- and version-specific <span class="stt">"lib"</span>
directory followed by the <a href="#%28tech._main._library._directory%29" class="techoutside" data-pltdoc="x"><span class="techinside">main library directory</span></a>.</p></li><li><p><a name="(idx._(gentag._61._(lib._scribblings/raco/raco..scrbl)))"></a><span class="RktVal">'</span><span class="RktVal">dll-dir</span> —<wbr></wbr> a path, string, or byte string for a
directory containing shared libraries for the main
executable. It defaults to the <a href="#%28tech._main._library._directory%29" class="techoutside" data-pltdoc="x"><span class="techinside">main library directory</span></a>.</p></li><li><p><a name="(idx._(gentag._62._(lib._scribblings/raco/raco..scrbl)))"></a><span class="RktVal">'</span><span class="RktVal">share-dir</span> —<wbr></wbr> a path, string, or byte string for the
<a name="(tech._main._shared._file._directory)"></a><span style="font-style: italic">main shared-file directory</span>, which normally includes installed packages.
It defaults to a <span class="stt">"share"</span> sibling directory of the main
collection directory.</p></li><li><p><a name="(idx._(gentag._63._(lib._scribblings/raco/raco..scrbl)))"></a><span class="RktVal">'</span><span class="RktVal">links-file</span> —<wbr></wbr> a path, string, or byte string for the
<a href="http://download.racket-lang.org/docs/6.1/html/local-redirect/index.html?doc=reference&rel=collects.html%23%2528tech._collection._links._file%2529&version=6.1" class="techoutside Sq" data-pltdoc="x"><span class="techinside">collection links file</span></a>. It defaults
to a <span class="stt">"links.rktd"</span> file in the <a href="#%28tech._main._shared._file._directory%29" class="techoutside" data-pltdoc="x"><span class="techinside">main shared-file directory</span></a>.</p></li><li><p><a name="(idx._(gentag._64._(lib._scribblings/raco/raco..scrbl)))"></a><span class="RktVal">'</span><span class="RktVal">links-search-files</span> —<wbr></wbr> like <span class="RktVal">'</span><span class="RktVal">lib-search-dirs</span>,
but for <a href="http://download.racket-lang.org/docs/6.1/html/local-redirect/index.html?doc=reference&rel=collects.html%23%2528tech._collection._links._file%2529&version=6.1" class="techoutside Sq" data-pltdoc="x"><span class="techinside">collection links file</span></a>.</p></li><li><p><a name="(idx._(gentag._65._(lib._scribblings/raco/raco..scrbl)))"></a><span class="RktVal">'</span><span class="RktVal">pkgs-dir</span> —<wbr></wbr> a path, string, or byte string
for packages that have <span class="stt">installation</span> <a href="http://download.racket-lang.org/docs/6.1/html/local-redirect/index.html?doc=pkg&rel=Package_Concepts.html%23%2528tech._package._scope%2529&version=6.1" class="techoutside Sq" data-pltdoc="x"><span class="techinside">package scope</span></a>. It defaults to
<span class="stt">"pkgs"</span> in the main shared-file directory.</p></li><li><p><a name="(idx._(gentag._66._(lib._scribblings/raco/raco..scrbl)))"></a><span class="RktVal">'</span><span class="RktVal">pkgs-search-dirs</span> —<wbr></wbr> like
<span class="RktVal">'</span><span class="RktVal">lib-search-dirs</span>, but for packages in <span class="stt">installation</span>
<a href="http://download.racket-lang.org/docs/6.1/html/local-redirect/index.html?doc=pkg&rel=Package_Concepts.html%23%2528tech._package._scope%2529&version=6.1" class="techoutside Sq" data-pltdoc="x"><span class="techinside">package
scope</span></a>.</p></li><li><p><a name="(idx._(gentag._67._(lib._scribblings/raco/raco..scrbl)))"></a><span class="RktVal">'</span><span class="RktVal">bin-dir</span> —<wbr></wbr> a path, string, or byte string for the
installation’s directory containing executables. It defaults to a
<span class="stt">"bin"</span> sibling directory of the <a href="#%28tech._main._collection._directory%29" class="techoutside" data-pltdoc="x"><span class="techinside">main collection
directory</span></a>.</p></li><li><p><a name="(idx._(gentag._68._(lib._scribblings/raco/raco..scrbl)))"></a><span class="RktVal">'</span><span class="RktVal">apps-dir</span> —<wbr></wbr> a path, string, or byte string
for the installation’s directory for <span class="stt">".desktop"</span> files.
It defaults to a <span class="stt">"applications"</span> subdirectory of the
<a href="#%28tech._main._shared._file._directory%29" class="techoutside" data-pltdoc="x"><span class="techinside">main shared-file directory</span></a>.</p></li><li><p><a name="(idx._(gentag._69._(lib._scribblings/raco/raco..scrbl)))"></a><span class="RktVal">'</span><span class="RktVal">man-dir</span> —<wbr></wbr> a path, string, or byte string for the
installation’s man-page directory. It defaults to a <span class="stt">"man"</span>
sibling directory of the <a href="#%28tech._main._collection._directory%29" class="techoutside" data-pltdoc="x"><span class="techinside">main collection directory</span></a>.</p></li><li><p><a name="(idx._(gentag._70._(lib._scribblings/raco/raco..scrbl)))"></a><span class="RktVal">'</span><span class="RktVal">doc-dir</span> —<wbr></wbr> a path, string, or byte string for the
main documentation directory. The value defaults to a
<span class="stt">"doc"</span> sibling directory of the
<a href="#%28tech._main._collection._directory%29" class="techoutside" data-pltdoc="x"><span class="techinside">main collection directory</span></a>.</p></li><li><p><a name="(idx._(gentag._71._(lib._scribblings/raco/raco..scrbl)))"></a><span class="RktVal">'</span><span class="RktVal">doc-search-dirs</span> —<wbr></wbr> like <span class="RktVal">'</span><span class="RktVal">lib-search-dirs</span>,
but for directories containing documentation.</p></li><li><p><a name="(idx._(gentag._72._(lib._scribblings/raco/raco..scrbl)))"></a><span class="RktVal">'</span><span class="RktVal">doc-search-url</span> —<wbr></wbr> a URL string that is augmented
with version and search-tag queries to form a remote
documentation reference.</p></li><li><p><a name="(idx._(gentag._73._(lib._scribblings/raco/raco..scrbl)))"></a><span class="RktVal">'</span><span class="RktVal">doc-open-url</span> —<wbr></wbr> a URL string or <span class="RktVal">#f</span>;
a string supplies a URL that is used instead of a local path to
search and maybe open documentation pages (which normally makes
sense only in an environment where opening a local HTML file
does not work).</p></li><li><p><a name="(idx._(gentag._74._(lib._scribblings/raco/raco..scrbl)))"></a><span class="RktVal">'</span><span class="RktVal">include-dir</span> —<wbr></wbr> a path, string, or byte string for
the main directory containing C header files. It defaults to an
<span class="stt">"include"</span> sibling directory of the <a href="#%28tech._main._collection._directory%29" class="techoutside" data-pltdoc="x"><span class="techinside">main collection
directory</span></a>.</p></li><li><p><a name="(idx._(gentag._75._(lib._scribblings/raco/raco..scrbl)))"></a><span class="RktVal">'</span><span class="RktVal">include-search-dirs</span> —<wbr></wbr> like
<span class="RktSym">doc-search-dirs</span>, but for directories containing C
header files.</p></li><li><p><a name="(idx._(gentag._76._(lib._scribblings/raco/raco..scrbl)))"></a><span class="RktVal">'</span><span class="RktVal">catalogs</span> —<wbr></wbr> a list of URL strings used as the search
path for resolving package names. An <span class="RktVal">#f</span> in the list
is replaced with the default search path.</p></li><li><p><a name="(idx._(gentag._77._(lib._scribblings/raco/raco..scrbl)))"></a><span class="RktVal">'</span><span class="RktVal">default-scope</span> —<wbr></wbr> either <span class="RktVal">"user"</span> or
<span class="RktVal">"installation"</span>, determining the default <a href="http://download.racket-lang.org/docs/6.1/html/local-redirect/index.html?doc=pkg&rel=Package_Concepts.html%23%2528tech._package._scope%2529&version=6.1" class="techoutside Sq" data-pltdoc="x"><span class="techinside">package scope</span></a> for
package-management operations.</p></li><li><p><a name="(idx._(gentag._78._(lib._scribblings/raco/raco..scrbl)))"></a><span class="RktVal">'</span><span class="RktVal">download-cache-dir</span> —<wbr></wbr> a path string used as
the location for storing downloaded package archives. When not
specified, packages are cached in a <span class="stt">"download-cache"</span>
directory in the user’s add-on directory as reported by
<span class="RktPn">(</span><span class="RktSym"><a href="http://download.racket-lang.org/docs/6.1/html/local-redirect/index.html?doc=reference&rel=Filesystem.html%23%2528def._%2528%2528quote._%7E23%7E25kernel%2529._find-system-path%2529%2529&version=6.1" class="RktValLink Sq" data-pltdoc="x">find-system-path</a></span><span class="stt"> </span><span class="RktVal">'</span><span class="RktVal">addon-dir</span><span class="RktPn">)</span>.</p></li><li><p><a name="(idx._(gentag._79._(lib._scribblings/raco/raco..scrbl)))"></a><span class="RktVal">'</span><span class="RktVal">download-cache-max-files</span> and
<a name="(idx._(gentag._80._(lib._scribblings/raco/raco..scrbl)))"></a><span class="RktVal">'</span><span class="RktVal">download-cache-max-bytes</span> —<wbr></wbr> real numbers that
determine limits on the download cache. When not specified, the
cache is allowed to hold up to 1024 files that total up to
64 MB.</p></li><li><p><a name="(idx._(gentag._81._(lib._scribblings/raco/raco..scrbl)))"></a><span class="RktVal">'</span><span class="RktVal">build-stamp</span> —<wbr></wbr> a string that identifies a build,
which can be used to augment the Racket version number to more
specifically identify the build. An empty string is normally
appropriate for a release build.</p></li><li><p><a name="(idx._(gentag._82._(lib._scribblings/raco/raco..scrbl)))"></a><span class="RktVal">'</span><span class="RktVal">absolute-installation?</span> —<wbr></wbr> a boolean that is
<span class="RktVal">#t</span> if the installation uses absolute path names,
<span class="RktVal">#f</span> otherwise.</p></li><li><p><a name="(idx._(gentag._83._(lib._scribblings/raco/raco..scrbl)))"></a><span class="RktVal">'</span><span class="RktVal">cgc-suffix</span> —<wbr></wbr> a string used as the suffix (before
the actual suffix, such as <span class="stt">".exe"</span>) for a
<span class="stt">"CGC"</span> executable. Use Windows-style casing, and the
string will be downcased as appropriate (e.g., for a Unix
binary name). A <span class="RktVal">#f</span> value means that if the
<span class="stt">racket</span> binary identifies itself as CGC, then the suffix
is <span class="RktVal">""</span>, otherwise it is <span class="RktVal">"CGC"</span>.</p></li><li><p><a name="(idx._(gentag._84._(lib._scribblings/raco/raco..scrbl)))"></a><span class="RktVal">'</span><span class="RktVal">3m-suffix</span> —<wbr></wbr> analogous to <span class="RktVal">'</span><span class="RktVal">cgc-suffix</span>, but
for 3m. A <span class="RktVal">#f</span> value means that if the <span class="stt">"racket"</span>
binary identifies itself as CGC, then the suffix is
<span class="RktVal">"3m"</span>, otherwise it is <span class="RktVal">""</span>.</p></li></ul><div class="navsetbottom"><span class="navleft"><form class="searchform"><input class="searchbox" style="color: #888;" type="text" value="...search manuals..." title="Enter a search string to search the manuals" onkeypress="return DoSearchKey(event, this, "6.1", "../");" onfocus="this.style.color="black"; this.style.textAlign="left"; if (this.value == "...search manuals...") this.value="";" onblur="if (this.value.match(/^ *$/)) { this.style.color="#888"; this.style.textAlign="center"; this.value="...search manuals..."; }"/></form> <a href="../index.html" title="up to the documentation top" data-pltdoc="x" onclick="return GotoPLTRoot("6.1");">top</a></span><span class="navright"> <a href="command.html" title="backward to "17 Adding a raco Command"" data-pltdoc="x">← prev</a> <a href="index.html" title="up to "raco: Racket Command-Line Tools"" data-pltdoc="x">up</a> <span class="nonavigation">next →</span></span> </div></div></div><div id="contextindicator"> </div></body></html>
|