/usr/share/doc/racket/raco/setup-info.html

<!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>6.3&nbsp;Controlling raco setup with "info.rkt" Files</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,&quot;tocview_0&quot;);">&#9658;</a></td><td></td><td><a href="index.html" class="tocviewlink" data-pltdoc="x"><span class="stt">raco</span>:<span class="mywbr"> &nbsp;</span> Racket Command-<wbr></wbr>Line Tools</a></td></tr></table></div><div class="tocviewsublisttop" style="display: none;" id="tocview_0"><table cellspacing="0" cellpadding="0"><tr><td align="right">1&nbsp;</td><td><a href="make.html" class="tocviewlink" data-pltdoc="x"><span class="stt">raco make</span>:<span class="mywbr"> &nbsp;</span> Compiling Source to Bytecode</a></td></tr><tr><td align="right">2&nbsp;</td><td><a href="exe.html" class="tocviewlink" data-pltdoc="x"><span class="stt">raco exe</span>:<span class="mywbr"> &nbsp;</span> Creating Stand-<wbr></wbr>Alone Executables</a></td></tr><tr><td align="right">3&nbsp;</td><td><a href="exe-dist.html" class="tocviewlink" data-pltdoc="x"><span class="stt">raco distribute</span>:<span class="mywbr"> &nbsp;</span> Sharing Stand-<wbr></wbr>Alone Executables</a></td></tr><tr><td align="right">4&nbsp;</td><td><a href="planet.html" class="tocviewlink" data-pltdoc="x"><span class="stt">raco planet</span>:<span class="mywbr"> &nbsp;</span> Automatic Package Distribution</a></td></tr><tr><td align="right">5&nbsp;</td><td><a href="pkg.html" class="tocviewlink" data-pltdoc="x"><span class="stt">raco pkg</span>:<span class="mywbr"> &nbsp;</span> Package Management</a></td></tr><tr><td align="right">6&nbsp;</td><td><a href="setup.html" class="tocviewselflink" data-pltdoc="x"><span class="stt">raco setup</span>:<span class="mywbr"> &nbsp;</span> Installation Management</a></td></tr><tr><td align="right">7&nbsp;</td><td><a href="decompile.html" class="tocviewlink" data-pltdoc="x"><span class="stt">raco decompile</span>:<span class="mywbr"> &nbsp;</span> Decompiling Bytecode</a></td></tr><tr><td align="right">8&nbsp;</td><td><a href="demod.html" class="tocviewlink" data-pltdoc="x"><span class="stt">raco demod</span>:<span class="mywbr"> &nbsp;</span> Demodularizing Programs</a></td></tr><tr><td align="right">9&nbsp;</td><td><a href="link.html" class="tocviewlink" data-pltdoc="x"><span class="stt">raco link</span>:<span class="mywbr"> &nbsp;</span> Library Collection Links</a></td></tr><tr><td align="right">10&nbsp;</td><td><a href="plt.html" class="tocviewlink" data-pltdoc="x"><span class="stt">raco pack</span>:<span class="mywbr"> &nbsp;</span> Packing Library Collections</a></td></tr><tr><td align="right">11&nbsp;</td><td><a href="unpack.html" class="tocviewlink" data-pltdoc="x"><span class="stt">raco unpack</span>:<span class="mywbr"> &nbsp;</span> Unpacking Library Collections</a></td></tr><tr><td align="right">12&nbsp;</td><td><a href="ctool.html" class="tocviewlink" data-pltdoc="x"><span class="stt">raco ctool</span>:<span class="mywbr"> &nbsp;</span> Working with C Code</a></td></tr><tr><td align="right">13&nbsp;</td><td><a href="test.html" class="tocviewlink" data-pltdoc="x"><span class="stt">raco test</span>:<span class="mywbr"> &nbsp;</span> Run tests</a></td></tr><tr><td align="right">14&nbsp;</td><td><a href="docs.html" class="tocviewlink" data-pltdoc="x"><span class="stt">raco docs</span>:<span class="mywbr"> &nbsp;</span> Documentation Search</a></td></tr><tr><td align="right">15&nbsp;</td><td><a href="expand.html" class="tocviewlink" data-pltdoc="x"><span class="stt">raco expand</span>:<span class="mywbr"> &nbsp;</span> Macro Expansion</a></td></tr><tr><td align="right">16&nbsp;</td><td><a href="read.html" class="tocviewlink" data-pltdoc="x"><span class="stt">raco read</span>:<span class="mywbr"> &nbsp;</span> Reading and Pretty-<wbr></wbr>Printing</a></td></tr><tr><td align="right">17&nbsp;</td><td><a href="scribble.html" class="tocviewlink" data-pltdoc="x"><span class="stt">raco scribble</span>:<span class="mywbr"> &nbsp;</span> Building Documentation</a></td></tr><tr><td align="right">18&nbsp;</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">19&nbsp;</td><td><a href="config-file.html" class="tocviewlink" data-pltdoc="x">Installation Configuration and Search Paths</a></td></tr></table></div></div><div class="tocviewlist"><table cellspacing="0" cellpadding="0"><tr><td style="width: 1em;"><a href="javascript:void(0);" title="Expand/Collapse" class="tocviewtoggle" onclick="TocviewToggle(this,&quot;tocview_1&quot;);">&#9660;</a></td><td>6&nbsp;</td><td><a href="setup.html" class="tocviewlink" data-pltdoc="x"><span class="stt">raco setup</span>:<span class="mywbr"> &nbsp;</span> Installation Management</a></td></tr></table><div class="tocviewsublistbottom" style="display: block;" id="tocview_1"><table cellspacing="0" cellpadding="0"><tr><td align="right">6.1&nbsp;</td><td><a href="running.html" class="tocviewlink" data-pltdoc="x">Running <span class="stt">raco setup</span></a></td></tr><tr><td align="right">6.2&nbsp;</td><td><a href="raco-setup-A.html" class="tocviewlink" data-pltdoc="x">Installing <span class="stt">".plt"</span> Archives</a></td></tr><tr><td align="right">6.3&nbsp;</td><td><a href="" class="tocviewselflink" data-pltdoc="x">Controlling <span class="stt">raco setup</span> with <span class="stt">"info.rkt"</span> Files</a></td></tr><tr><td align="right">6.4&nbsp;</td><td><a href="info_rkt.html" class="tocviewlink" data-pltdoc="x"><span class="stt">"info.rkt"</span> File Format</a></td></tr><tr><td align="right">6.5&nbsp;</td><td><a href="setup-check-deps.html" class="tocviewlink" data-pltdoc="x">Package Dependency Checking</a></td></tr><tr><td align="right">6.6&nbsp;</td><td><a href="setup-plt-plt.html" class="tocviewlink" data-pltdoc="x">API for Setup</a></td></tr><tr><td align="right">6.7&nbsp;</td><td><a href="_plt-archives.html" class="tocviewlink" data-pltdoc="x">API for Installing <span class="stt">".plt"</span> Archives</a></td></tr><tr><td align="right">6.8&nbsp;</td><td><a href="dirs.html" class="tocviewlink" data-pltdoc="x">API for Finding Installation Directories</a></td></tr><tr><td align="right">6.9&nbsp;</td><td><a href="getinfo.html" class="tocviewlink" data-pltdoc="x">API for Reading <span class="stt">"info.rkt"</span> Files</a></td></tr><tr><td align="right">6.10&nbsp;</td><td><a href="relative-paths.html" class="tocviewlink" data-pltdoc="x">API for Relative Paths</a></td></tr><tr><td align="right">6.11&nbsp;</td><td><a href="collection-names.html" class="tocviewlink" data-pltdoc="x">API for Collection Names</a></td></tr><tr><td align="right">6.12&nbsp;</td><td><a href="collection-search.html" class="tocviewlink" data-pltdoc="x">API for Collection Searches</a></td></tr><tr><td align="right">6.13&nbsp;</td><td><a href="matching-platform.html" class="tocviewlink" data-pltdoc="x">API for Platform Specifications</a></td></tr><tr><td align="right">6.14&nbsp;</td><td><a href="cross-system.html" class="tocviewlink" data-pltdoc="x">API for Cross-<wbr></wbr>Platform Configuration</a></td></tr><tr><td align="right">6.15&nbsp;</td><td><a href="xref.html" class="tocviewlink" data-pltdoc="x">API for Cross-<wbr></wbr>References for Installed Manuals</a></td></tr><tr><td align="right">6.16&nbsp;</td><td><a href="materialize-user-docs.html" class="tocviewlink" data-pltdoc="x">API for Materializing User-<wbr></wbr>Specific Documentation</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, &quot;6.7&quot;, &quot;../&quot;);" onfocus="this.style.color=&quot;black&quot;; this.style.textAlign=&quot;left&quot;; if (this.value == &quot;...search manuals...&quot;) this.value=&quot;&quot;;" onblur="if (this.value.match(/^ *$/)) { this.style.color=&quot;#888&quot;; this.style.textAlign=&quot;center&quot;; this.value=&quot;...search manuals...&quot;; }"/></form>&nbsp;&nbsp;<a href="../index.html" title="up to the documentation top" data-pltdoc="x" onclick="return GotoPLTRoot(&quot;6.7&quot;);">top</a></span><span class="navright">&nbsp;&nbsp;<a href="raco-setup-A.html" title="backward to &quot;6.2 Installing &quot;.plt&quot; Archives&quot;" data-pltdoc="x">&larr; prev</a>&nbsp;&nbsp;<a href="setup.html" title="up to &quot;6 raco setup: Installation Management&quot;" data-pltdoc="x">up</a>&nbsp;&nbsp;<a href="info_rkt.html" title="forward to &quot;6.4 &quot;info.rkt&quot; File Format&quot;" data-pltdoc="x">next &rarr;</a></span>&nbsp;</div><h4 x-source-module="(lib &quot;scribblings/raco/raco.scrbl&quot;)" x-source-pkg="racket-doc" x-part-tag="&quot;setup-info&quot;">6.3<tt>&nbsp;</tt><a name="(part._setup-info)"></a>Controlling <span class="stt">raco setup</span> with <span class="stt">"info.rkt"</span> Files</h4><p>To compile a collection&rsquo;s files to bytecode, <span class="stt">raco setup</span> uses the
<span class="RktSym"><a href="API_for_Raw_Compilation.html#%28def._%28%28lib._compiler%2Fcompiler..rkt%29._compile-collection-zos%29%29" class="RktValLink" data-pltdoc="x">compile-collection-zos</a></span> procedure. That procedure, in turn,
consults the collection&rsquo;s <span class="stt">"info.rkt"</span> file, if it exists, for
specific instructions on compiling the collection. See
<span class="RktSym"><a href="API_for_Raw_Compilation.html#%28def._%28%28lib._compiler%2Fcompiler..rkt%29._compile-collection-zos%29%29" class="RktValLink" data-pltdoc="x">compile-collection-zos</a></span> for more information on the fields of
<span class="stt">"info.rkt"</span> that it uses, and see <a href="info_rkt.html" data-pltdoc="x"><span class="stt">"info.rkt"</span> File Format</a> for
information on the format of an <span class="stt">"info.rkt"</span> file.</p><p>Additional fields are used by the
<a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=pkg&amp;rel=index.html&amp;version=6.7" class="Sq" data-pltdoc="x">Racket package manager</a>
and are documented in <a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=pkg&amp;rel=metadata.html&amp;version=6.7" class="Sq" data-pltdoc="x">Package Metadata</a>.
The <span class="stt">raco test</span> command also recognizes additional fields, which are
documented in <a href="test.html#%28part._test-config-info%29" data-pltdoc="x">Test Configuration by <span class="stt">"info.rkt"</span></a>.</p><p>Optional <span class="stt">"info.rkt"</span> fields trigger additional actions by
<span class="stt">raco setup</span>:</p><ul><li><p><a name="(idx._(gentag._11._(lib._scribblings/raco/raco..scrbl)))"></a><span class="RktSym">scribblings</span> : <span class="RktPn">(</span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&amp;rel=data-structure-contracts.html%23%2528def._%2528%2528lib._racket%252Fcontract%252Fbase..rkt%2529._listof%2529%2529&amp;version=6.7" class="RktValLink Sq" data-pltdoc="x">listof</a></span><span class="stt"> </span><span class="RktPn">(</span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&amp;rel=data-structure-contracts.html%23%2528def._%2528%2528lib._racket%252Fcontract%252Fbase..rkt%2529._cons%252Fc%2529%2529&amp;version=6.7" class="RktValLink Sq" data-pltdoc="x">cons/c</a></span><span class="stt"> </span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&amp;rel=strings.html%23%2528def._%2528%2528quote._%7E23%7E25kernel%2529._string%7E3f%2529%2529&amp;version=6.7" class="RktValLink Sq" data-pltdoc="x">string?</a></span><span class="stt"> </span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&amp;rel=pairs.html%23%2528def._%2528%2528quote._%7E23%7E25kernel%2529._list%7E3f%2529%2529&amp;version=6.7" class="RktValLink Sq" data-pltdoc="x">list?</a></span><span class="RktPn">)</span><span class="RktPn">)</span> &#8212;<wbr></wbr>
A list of documents to build. Each document in the list is itself
represented as a list, where each document&rsquo;s list starts with a
string that is a collection-relative path to the document&rsquo;s source
file. A document name (which is derived from the source module&rsquo;s
name by default) is intended to be globally unique in the same way
as a package or module name.</p><p>More precisely a <span class="RktSym">scribblings</span> entry must be a value
that can be generated from an expression matching the following
<span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=scribble&amp;rel=xref.html%23%2528def._%2528%2528lib._scribble%252Fxref..rkt%2529._entry%2529%2529&amp;version=6.7" class="RktValLink Sq" data-pltdoc="x">entry</a></span> grammar:</p><p><table cellspacing="0" cellpadding="0"><tr><td align="right" valign="baseline"><span class="hspace">&nbsp;&nbsp;</span><span class="RktVar">entry</span></td><td align="left" valign="baseline"><span class="stt">&nbsp;</span></td><td align="center" valign="baseline">=</td><td align="left" valign="baseline"><span class="stt">&nbsp;</span></td><td align="left" valign="baseline"><span class="RktPn">(</span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&amp;rel=pairs.html%23%2528def._%2528%2528quote._%7E23%7E25kernel%2529._list%2529%2529&amp;version=6.7" class="RktValLink Sq" data-pltdoc="x">list</a></span><span class="hspace">&nbsp;</span><span class="RktVar">doc</span><span class="hspace">&nbsp;</span><span class="RktSym">...</span><span class="RktPn">)</span></td></tr><tr><td align="right" valign="baseline"><span class="stt">&nbsp;</span></td><td align="left" valign="baseline"><span class="stt">&nbsp;</span></td><td align="center" valign="baseline"><span class="stt">&nbsp;</span></td><td align="left" valign="baseline"><span class="stt">&nbsp;</span></td><td align="left" valign="baseline"><span class="stt">&nbsp;</span></td></tr><tr><td align="right" valign="baseline"><span class="hspace">&nbsp;&nbsp;</span><span class="RktVar">doc</span></td><td align="left" valign="baseline"><span class="stt">&nbsp;</span></td><td align="center" valign="baseline">=</td><td align="left" valign="baseline"><span class="stt">&nbsp;</span></td><td align="left" valign="baseline"><span class="RktPn">(</span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&amp;rel=pairs.html%23%2528def._%2528%2528quote._%7E23%7E25kernel%2529._list%2529%2529&amp;version=6.7" class="RktValLink Sq" data-pltdoc="x">list</a></span><span class="hspace">&nbsp;</span><span class="RktVar">src-string</span><span class="RktPn">)</span></td></tr><tr><td align="right" valign="baseline"><span class="stt">&nbsp;</span></td><td align="left" valign="baseline"><span class="stt">&nbsp;</span></td><td align="center" valign="baseline">|</td><td align="left" valign="baseline"><span class="stt">&nbsp;</span></td><td align="left" valign="baseline"><span class="RktPn">(</span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&amp;rel=pairs.html%23%2528def._%2528%2528quote._%7E23%7E25kernel%2529._list%2529%2529&amp;version=6.7" class="RktValLink Sq" data-pltdoc="x">list</a></span><span class="hspace">&nbsp;</span><span class="RktVar">src-string</span><span class="hspace">&nbsp;</span><span class="RktVar">flags</span><span class="RktPn">)</span></td></tr><tr><td align="right" valign="baseline"><span class="stt">&nbsp;</span></td><td align="left" valign="baseline"><span class="stt">&nbsp;</span></td><td align="center" valign="baseline">|</td><td align="left" valign="baseline"><span class="stt">&nbsp;</span></td><td align="left" valign="baseline"><span class="RktPn">(</span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&amp;rel=pairs.html%23%2528def._%2528%2528quote._%7E23%7E25kernel%2529._list%2529%2529&amp;version=6.7" class="RktValLink Sq" data-pltdoc="x">list</a></span><span class="hspace">&nbsp;</span><span class="RktVar">src-string</span><span class="hspace">&nbsp;</span><span class="RktVar">flags</span><span class="hspace">&nbsp;</span><span class="RktVar">category</span><span class="RktPn">)</span></td></tr><tr><td align="right" valign="baseline"><span class="stt">&nbsp;</span></td><td align="left" valign="baseline"><span class="stt">&nbsp;</span></td><td align="center" valign="baseline">|</td><td align="left" valign="baseline"><span class="stt">&nbsp;</span></td><td align="left" valign="baseline"><span class="RktPn">(</span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&amp;rel=pairs.html%23%2528def._%2528%2528quote._%7E23%7E25kernel%2529._list%2529%2529&amp;version=6.7" class="RktValLink Sq" data-pltdoc="x">list</a></span><span class="hspace">&nbsp;</span><span class="RktVar">src-string</span><span class="hspace">&nbsp;</span><span class="RktVar">flags</span><span class="hspace">&nbsp;</span><span class="RktVar">category</span><span class="hspace">&nbsp;</span><span class="RktVar">name</span><span class="RktPn">)</span></td></tr><tr><td align="right" valign="baseline"><span class="stt">&nbsp;</span></td><td align="left" valign="baseline"><span class="stt">&nbsp;</span></td><td align="center" valign="baseline">|</td><td align="left" valign="baseline"><span class="stt">&nbsp;</span></td><td align="left" valign="baseline"><span class="RktPn">(</span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&amp;rel=pairs.html%23%2528def._%2528%2528quote._%7E23%7E25kernel%2529._list%2529%2529&amp;version=6.7" class="RktValLink Sq" data-pltdoc="x">list</a></span><span class="hspace">&nbsp;</span><span class="RktVar">src-string</span><span class="hspace">&nbsp;</span><span class="RktVar">flags</span><span class="hspace">&nbsp;</span><span class="RktVar">category</span><span class="hspace">&nbsp;</span><span class="RktVar">name</span><span class="hspace">&nbsp;</span><span class="RktVar">out-k</span><span class="RktPn">)</span></td></tr><tr><td align="right" valign="baseline"><span class="stt">&nbsp;</span></td><td align="left" valign="baseline"><span class="stt">&nbsp;</span></td><td align="center" valign="baseline">|</td><td align="left" valign="baseline"><span class="stt">&nbsp;</span></td><td align="left" valign="baseline"><span class="RktPn">(</span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&amp;rel=pairs.html%23%2528def._%2528%2528quote._%7E23%7E25kernel%2529._list%2529%2529&amp;version=6.7" class="RktValLink Sq" data-pltdoc="x">list</a></span><span class="hspace">&nbsp;</span><span class="RktVar">src-string</span><span class="hspace">&nbsp;</span><span class="RktVar">flags</span><span class="hspace">&nbsp;</span><span class="RktVar">category</span><span class="hspace">&nbsp;</span><span class="RktVar">name</span><span class="hspace">&nbsp;</span><span class="RktVar">out-k</span><span class="hspace">&nbsp;</span><span class="RktVar">order-n</span><span class="RktPn">)</span></td></tr><tr><td align="right" valign="baseline"><span class="stt">&nbsp;</span></td><td align="left" valign="baseline"><span class="stt">&nbsp;</span></td><td align="center" valign="baseline"><span class="stt">&nbsp;</span></td><td align="left" valign="baseline"><span class="stt">&nbsp;</span></td><td align="left" valign="baseline"><span class="stt">&nbsp;</span></td></tr><tr><td align="right" valign="baseline"><span class="hspace">&nbsp;&nbsp;</span><span class="RktVar">flags</span></td><td align="left" valign="baseline"><span class="stt">&nbsp;</span></td><td align="center" valign="baseline">=</td><td align="left" valign="baseline"><span class="stt">&nbsp;</span></td><td align="left" valign="baseline"><span class="RktPn">(</span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&amp;rel=pairs.html%23%2528def._%2528%2528quote._%7E23%7E25kernel%2529._list%2529%2529&amp;version=6.7" class="RktValLink Sq" data-pltdoc="x">list</a></span><span class="hspace">&nbsp;</span><span class="RktVar">mode-symbol</span><span class="hspace">&nbsp;</span><span class="RktSym">...</span><span class="RktPn">)</span></td></tr><tr><td align="right" valign="baseline"><span class="stt">&nbsp;</span></td><td align="left" valign="baseline"><span class="stt">&nbsp;</span></td><td align="center" valign="baseline"><span class="stt">&nbsp;</span></td><td align="left" valign="baseline"><span class="stt">&nbsp;</span></td><td align="left" valign="baseline"><span class="stt">&nbsp;</span></td></tr><tr><td align="right" valign="baseline"><span class="hspace">&nbsp;&nbsp;</span><span class="RktVar">category</span></td><td align="left" valign="baseline"><span class="stt">&nbsp;</span></td><td align="center" valign="baseline">=</td><td align="left" valign="baseline"><span class="stt">&nbsp;</span></td><td align="left" valign="baseline"><span class="RktPn">(</span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&amp;rel=pairs.html%23%2528def._%2528%2528quote._%7E23%7E25kernel%2529._list%2529%2529&amp;version=6.7" class="RktValLink Sq" data-pltdoc="x">list</a></span><span class="hspace">&nbsp;</span><span class="RktVar">category-string-or-symbol</span><span class="RktPn">)</span></td></tr><tr><td align="right" valign="baseline"><span class="stt">&nbsp;</span></td><td align="left" valign="baseline"><span class="stt">&nbsp;</span></td><td align="center" valign="baseline">|</td><td align="left" valign="baseline"><span class="stt">&nbsp;</span></td><td align="left" valign="baseline"><span class="RktPn">(</span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&amp;rel=pairs.html%23%2528def._%2528%2528quote._%7E23%7E25kernel%2529._list%2529%2529&amp;version=6.7" class="RktValLink Sq" data-pltdoc="x">list</a></span><span class="hspace">&nbsp;</span><span class="RktVar">category-string-or-symbol</span><span class="hspace">&nbsp;</span><span class="RktVar">sort-number</span><span class="RktPn">)</span></td></tr><tr><td align="right" valign="baseline"><span class="stt">&nbsp;</span></td><td align="left" valign="baseline"><span class="stt">&nbsp;</span></td><td align="center" valign="baseline"><span class="stt">&nbsp;</span></td><td align="left" valign="baseline"><span class="stt">&nbsp;</span></td><td align="left" valign="baseline"><span class="stt">&nbsp;</span></td></tr><tr><td align="right" valign="baseline"><span class="hspace">&nbsp;&nbsp;</span><span class="RktVar">name</span></td><td align="left" valign="baseline"><span class="stt">&nbsp;</span></td><td align="center" valign="baseline">=</td><td align="left" valign="baseline"><span class="stt">&nbsp;</span></td><td align="left" valign="baseline"><span class="RktVar">string</span></td></tr><tr><td align="right" valign="baseline"><span class="stt">&nbsp;</span></td><td align="left" valign="baseline"><span class="stt">&nbsp;</span></td><td align="center" valign="baseline">|</td><td align="left" valign="baseline"><span class="stt">&nbsp;</span></td><td align="left" valign="baseline"><span class="RktVal">#f</span></td></tr></table></p><p>A document&rsquo;s list optionally continues with information on how to
build the document. If a document&rsquo;s list contains a second item,
<span class="RktVar">flags</span>, it must be a list of mode symbols (described
below). If a document&rsquo;s list contains a third item,
<span class="RktVar">category</span>, it must be a list that categorizes the document
(described further below). If a document&rsquo;s list contains a fourth
item, <span class="RktVar">name</span>, it is a name to use for the generated
documentation, instead of defaulting to the source file&rsquo;s name
(sans extension), where <span class="RktVal">#f</span> means to use the default; a
non-<span class="RktVal">#f</span> value for <span class="RktVar">name</span> must fit the grammar
of a collection-name element as checked by
<span class="RktSym"><a href="collection-names.html#%28def._%28%28lib._setup%2Fcollection-name..rkt%29._collection-name-element~3f%29%29" class="RktValLink" data-pltdoc="x">collection-name-element?</a></span>. If a
document&rsquo;s list contains a fifth item, <span class="RktVar">out-k</span>, it is used
a hint for the number of files to use for the document&rsquo;s
cross-reference information; see below. If a document&rsquo;s list
contains a fourth item, <span class="RktVar">order-n</span>, it is used a hint for
the order of rendering; see below.</p><p>Each mode symbol in <span class="RktVar">flags</span> can be one of the following,
where only <span class="RktVal">'</span><span class="RktVal">multi-page</span> is commonly used:</p><ul><li><p><span class="RktVal">'</span><span class="RktVal">multi-page</span> : Generates multi-page HTML output,
instead of the default single-page format.</p></li><li><p><span class="RktVal">'</span><span class="RktVal">main-doc</span> : Indicates that the generated
documentation should be written into the main installation
directory, instead of to a user-specific directory. This
mode is the default for a collection that is itself located
in the main installation.</p></li><li><p><span class="RktVal">'</span><span class="RktVal">user-doc</span> : Indicates that the generated
documentation should be written a user-specific
directory. This mode is the default for a collection that
is not itself located in the main installation.</p></li><li><p><span class="RktVal">'</span><span class="RktVal">depends-all</span> : Indicates that the document should
be re-built if any other document is rebuilt&#8212;<wbr></wbr>except for
documents that have the <span class="RktVal">'</span><span class="RktVal">no-depend-on</span> flag.</p></li><li><p><span class="RktVal">'</span><span class="RktVal">depends-all-main</span> : Indicates that the document
should be re-built if any other document is rebuilt that is
installed into the main installation&#8212;<wbr></wbr>except for documents
that have the <span class="RktVal">'</span><span class="RktVal">no-depend-on</span> flag.</p></li><li><p><span class="RktVal">'</span><span class="RktVal">depends-all-user</span> : Indicates that the document
should be re-built if any other document is rebuilt that is
installed into the user&rsquo;s space&#8212;<wbr></wbr>except for documents
that have the <span class="RktVal">'</span><span class="RktVal">no-depend-on</span> flag.</p></li><li><p><span class="RktVal">'</span><span class="RktVal">always-run</span> : Build the document every time that
<span class="stt">raco setup</span> is run, even if none of its dependencies
change.</p></li><li><p><span class="RktVal">'</span><span class="RktVal">no-depend-on</span> : Removes the document for
consideration for other dependencies. Furthermore,
references from the document to other documents are always
direct, instead of potentially indirect (i.e., resolved at
document-viewing time and potentially redirected to a
remote site).</p></li><li><p><span class="RktVal">'</span><span class="RktVal">main-doc-root</span> : Designates the root document for
the main installation. The document that currently has this
mode should be the only one with the mode.</p></li><li><p><span class="RktVal">'</span><span class="RktVal">user-doc-root</span> : Designates the root document for
the user-specific documentation directory. The document
that currently has this mode should be the only one with
the mode.</p></li><li><p><span class="RktVal">'</span><span class="RktVal">keep-style</span> : Leave the document&rsquo;s style as-is,
instead of imposing the document style for manuals.</p></li><li><p><span class="RktVal">'</span><span class="RktVal">no-search</span> : Build the document without a search
box.</p></li></ul><p>The <span class="RktVar">category</span> list specifies how to show the document in
 the root table of contents. The list must start with a category,
 which determines where the manual appears in the root
 documentation page. A category is either a string or a symbol. If
 it is a string, then the string is the category label on the root
 page. If it is a symbol, then a default category label is
 used. The available symbols and the order of categories on the
 root documentation page is as below:</p><ul><li><p><span class="RktVal">'</span><span class="RktVal">getting-started</span> : High-level, introductory
documentation, typeset at the same level as other
category titles.</p></li><li><p><span class="RktVal">'</span><span class="RktVal">language</span> : Documentation for a prominent
programming language.</p></li><li><p><span class="RktVal">'</span><span class="RktVal">tool</span> : Documentation for an executable.</p></li><li><p><span class="RktVal">'</span><span class="RktVal">gui-library</span> : Documentation for GUI and graphics
libraries.</p></li><li><p><span class="RktVal">'</span><span class="RktVal">net-library</span> : Documentation for networking
libraries.</p></li><li><p><span class="RktVal">'</span><span class="RktVal">parsing-library</span> : Documentation for parsing
libraries.</p></li><li><p><span class="RktVal">'</span><span class="RktVal">tool-library</span> : Documentation for programming-tool
libraries (i.e., not important enough for the more
prominent <span class="RktVal">'</span><span class="RktVal">tool</span> category).</p></li><li><p><span class="RktVal">'</span><span class="RktVal">interop</span> : Documentation for interoperability
tools and libraries.</p></li><li><p>All string categories as ordered by <span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&amp;rel=strings.html%23%2528def._%2528%2528quote._%7E23%7E25kernel%2529._string%7E3c%7E3d%7E3f%2529%2529&amp;version=6.7" class="RktValLink Sq" data-pltdoc="x">string&lt;=?</a></span>.</p></li><li><p><span class="RktVal">'</span><span class="RktVal">library</span> : Documentation for libraries; this
category is the default and used for unrecognized category
symbols.</p></li><li><p><span class="RktVal">'</span><span class="RktVal">legacy</span> : Documentation for deprecated libraries,
languages, and tools.</p></li><li><p><span class="RktVal">'</span><span class="RktVal">experimental</span> : Documentation for an experimental
language or library.</p></li><li><p><span class="RktVal">'</span><span class="RktVal">other</span> : Other documentation.</p></li><li><p><span class="RktVal">'</span><span class="RktVal">omit</span> : Documentation that should not be listed on
the root page or indexed for searching.</p></li><li><p><span class="RktVal">'</span><span class="RktVal">omit-start</span> : Documentation that should not be
listed on the root page but should be indexed for
searching.</p></li></ul><p>If the category list has a second element, it must be a real number
that designates the manual&rsquo;s sorting position with the category;
manuals with the same sorting position are ordered
alphabetically. For a pair of manuals with sorting numbers
<span class="RktVar">n</span> and <span class="RktVar">m</span>, the groups for the manuals are
separated by space if <span class="RktPn">(</span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&amp;rel=generic-numbers.html%23%2528def._%2528%2528quote._%7E23%7E25kernel%2529._truncate%2529%2529&amp;version=6.7" class="RktValLink Sq" data-pltdoc="x">truncate</a></span><span class="stt"> </span><span class="RktPn">(</span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&amp;rel=generic-numbers.html%23%2528def._%2528%2528quote._%7E23%7E25kernel%2529._%252F%2529%2529&amp;version=6.7" class="RktValLink Sq" data-pltdoc="x">/</a></span><span class="stt"> </span><span class="RktVar">n</span><span class="stt"> </span><span class="RktVal">10</span><span class="RktPn">)</span><span class="RktPn">)</span>and
<span class="RktPn">(</span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&amp;rel=generic-numbers.html%23%2528def._%2528%2528quote._%7E23%7E25kernel%2529._truncate%2529%2529&amp;version=6.7" class="RktValLink Sq" data-pltdoc="x">truncate</a></span><span class="stt"> </span><span class="RktPn">(</span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&amp;rel=generic-numbers.html%23%2528def._%2528%2528quote._%7E23%7E25kernel%2529._%252F%2529%2529&amp;version=6.7" class="RktValLink Sq" data-pltdoc="x">/</a></span><span class="stt"> </span><span class="RktVar">m</span><span class="stt"> </span><span class="RktVal">10</span><span class="RktPn">)</span><span class="RktPn">)</span> are different.</p><p>The <span class="RktVar">out-k</span> specification is a hint on whether to break the
document&rsquo;s cross-reference information into multiple parts, which
can reduce the time and memory use for resolving a cross-reference
into the document. It must be a positive, exact integer, and the
default is <span class="RktVal">1</span>.</p><p>The <span class="RktVar">order-n</span> specification is a hint for ordering document
builds, since documentation references can be mutually recursive.
The order hint can be any real number. A value of <span class="RktVal"><span class="nobreak">-1</span>0</span> or
less disables running the document in parallel to other documents.
The main Racket reference is given a value of <span class="RktVal"><span class="nobreak">-1</span>1</span>, the
search page is given a value of <span class="RktVal">10</span>, and the default is
<span class="RktVal">0</span>.</p><p>A directory for pre-rendered documentation is computed from the
source file name by starting with the directory of the
<span class="stt">"info.rkt"</span> file, adding <span class="stt">"doc"</span>, and then using the
document name (which is usually the source file&rsquo;s name without a
suffix); if such a directory exists and does not have a
<span class="stt">"synced.rktd"</span> file, then it is treated as pre-rendered
documentation and moved into place, in which case the documentation
source file need not be present. Moving documentation into place
may require no movement at all, depending on the way that the
enclosing collection is installed, but movement includes adding a
<span class="stt">"synced.rktd"</span> file to represent the installation.</p><p class="SHistory">Changed in version 6.4: Allow a category to be a string
instead of a symbol.</p></li><li><p><a name="(idx._(gentag._12._(lib._scribblings/raco/raco..scrbl)))"></a><span class="RktSym">release-note-files</span> : <span class="RktPn">(</span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&amp;rel=data-structure-contracts.html%23%2528def._%2528%2528lib._racket%252Fcontract%252Fbase..rkt%2529._listof%2529%2529&amp;version=6.7" class="RktValLink Sq" data-pltdoc="x">listof</a></span><span class="stt"> </span><span class="RktPn">(</span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&amp;rel=data-structure-contracts.html%23%2528def._%2528%2528lib._racket%252Fcontract%252Fbase..rkt%2529._cons%252Fc%2529%2529&amp;version=6.7" class="RktValLink Sq" data-pltdoc="x">cons/c</a></span><span class="stt"> </span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&amp;rel=strings.html%23%2528def._%2528%2528quote._%7E23%7E25kernel%2529._string%7E3f%2529%2529&amp;version=6.7" class="RktValLink Sq" data-pltdoc="x">string?</a></span><span class="stt"> </span><span class="RktPn">(</span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&amp;rel=data-structure-contracts.html%23%2528def._%2528%2528lib._racket%252Fcontract%252Fbase..rkt%2529._cons%252Fc%2529%2529&amp;version=6.7" class="RktValLink Sq" data-pltdoc="x">cons/c</a></span><span class="stt"> </span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&amp;rel=strings.html%23%2528def._%2528%2528quote._%7E23%7E25kernel%2529._string%7E3f%2529%2529&amp;version=6.7" class="RktValLink Sq" data-pltdoc="x">string?</a></span><span class="stt"> </span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&amp;rel=pairs.html%23%2528def._%2528%2528quote._%7E23%7E25kernel%2529._list%7E3f%2529%2529&amp;version=6.7" class="RktValLink Sq" data-pltdoc="x">list?</a></span><span class="RktPn">)</span><span class="RktPn">)</span><span class="RktPn">)</span> &#8212;<wbr></wbr>
A list of release-notes text files to link from the main documentation pages.
Each note is itself represented as a list, and the list can specify auxiliary
notes that are grouped with the main note.</p><p>A <span class="RktSym">release-note-files</span> entry must be a value
that can be generated from an expression matching the following
<span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=scribble&amp;rel=xref.html%23%2528def._%2528%2528lib._scribble%252Fxref..rkt%2529._entry%2529%2529&amp;version=6.7" class="RktValLink Sq" data-pltdoc="x">entry</a></span> grammar:</p><p><table cellspacing="0" cellpadding="0"><tr><td align="right" valign="baseline"><span class="hspace">&nbsp;&nbsp;</span><span class="RktVar">entry</span></td><td align="left" valign="baseline"><span class="stt">&nbsp;</span></td><td align="center" valign="baseline">=</td><td align="left" valign="baseline"><span class="stt">&nbsp;</span></td><td align="left" valign="baseline"><span class="RktPn">(</span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&amp;rel=pairs.html%23%2528def._%2528%2528quote._%7E23%7E25kernel%2529._list%2529%2529&amp;version=6.7" class="RktValLink Sq" data-pltdoc="x">list</a></span><span class="hspace">&nbsp;</span><span class="RktVar">note</span><span class="hspace">&nbsp;</span><span class="RktSym">...</span><span class="RktPn">)</span></td></tr><tr><td align="right" valign="baseline"><span class="stt">&nbsp;</span></td><td align="left" valign="baseline"><span class="stt">&nbsp;</span></td><td align="center" valign="baseline"><span class="stt">&nbsp;</span></td><td align="left" valign="baseline"><span class="stt">&nbsp;</span></td><td align="left" valign="baseline"><span class="stt">&nbsp;</span></td></tr><tr><td align="right" valign="baseline"><span class="hspace">&nbsp;&nbsp;</span><span class="RktVar">doc</span></td><td align="left" valign="baseline"><span class="stt">&nbsp;</span></td><td align="center" valign="baseline">=</td><td align="left" valign="baseline"><span class="stt">&nbsp;</span></td><td align="left" valign="baseline"><span class="RktPn">(</span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&amp;rel=pairs.html%23%2528def._%2528%2528quote._%7E23%7E25kernel%2529._list%2529%2529&amp;version=6.7" class="RktValLink Sq" data-pltdoc="x">list</a></span><span class="hspace">&nbsp;</span><span class="RktVar">label-string</span><span class="hspace">&nbsp;</span><span class="RktVar">note-path</span><span class="RktPn">)</span></td></tr><tr><td align="right" valign="baseline"><span class="stt">&nbsp;</span></td><td align="left" valign="baseline"><span class="stt">&nbsp;</span></td><td align="center" valign="baseline">|</td><td align="left" valign="baseline"><span class="stt">&nbsp;</span></td><td align="left" valign="baseline"><span class="RktPn">(</span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&amp;rel=pairs.html%23%2528def._%2528%2528quote._%7E23%7E25kernel%2529._list%2529%2529&amp;version=6.7" class="RktValLink Sq" data-pltdoc="x">list</a></span><span class="hspace">&nbsp;</span><span class="RktVar">label-string</span><span class="hspace">&nbsp;</span><span class="RktVar">note-path</span><span class="hspace">&nbsp;</span><span class="RktVar">order-integer</span><span class="RktPn">)</span></td></tr><tr><td align="right" valign="baseline"><span class="stt">&nbsp;</span></td><td align="left" valign="baseline"><span class="stt">&nbsp;</span></td><td align="center" valign="baseline">|</td><td align="left" valign="baseline"><span class="stt">&nbsp;</span></td><td align="left" valign="baseline"><table cellspacing="0" cellpadding="0" class="RktBlk"><tr><td><span class="RktPn">(</span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&amp;rel=pairs.html%23%2528def._%2528%2528quote._%7E23%7E25kernel%2529._list%2529%2529&amp;version=6.7" class="RktValLink Sq" data-pltdoc="x">list</a></span><span class="hspace">&nbsp;</span><span class="RktVar">label-string</span><span class="hspace">&nbsp;</span><span class="RktVar">note-path</span><span class="hspace">&nbsp;</span><span class="RktVar">order-integer</span></td></tr><tr><td><span class="hspace">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span class="RktPn">(</span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&amp;rel=pairs.html%23%2528def._%2528%2528quote._%7E23%7E25kernel%2529._list%2529%2529&amp;version=6.7" class="RktValLink Sq" data-pltdoc="x">list</a></span><span class="hspace">&nbsp;</span><span class="RktVar">sub-note</span><span class="hspace">&nbsp;</span><span class="RktSym">...</span><span class="RktPn">)</span><span class="RktPn">)</span></td></tr></table></td></tr><tr><td align="right" valign="baseline"><span class="stt">&nbsp;</span></td><td align="left" valign="baseline"><span class="stt">&nbsp;</span></td><td align="center" valign="baseline"><span class="stt">&nbsp;</span></td><td align="left" valign="baseline"><span class="stt">&nbsp;</span></td><td align="left" valign="baseline"><span class="stt">&nbsp;</span></td></tr><tr><td align="right" valign="baseline"><span class="hspace">&nbsp;&nbsp;</span><span class="RktVar">sub-note</span></td><td align="left" valign="baseline"><span class="stt">&nbsp;</span></td><td align="center" valign="baseline">=</td><td align="left" valign="baseline"><span class="stt">&nbsp;</span></td><td align="left" valign="baseline"><span class="RktPn">(</span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&amp;rel=pairs.html%23%2528def._%2528%2528quote._%7E23%7E25kernel%2529._list%2529%2529&amp;version=6.7" class="RktValLink Sq" data-pltdoc="x">list</a></span><span class="hspace">&nbsp;</span><span class="RktVar">label-string</span><span class="hspace">&nbsp;</span><span class="RktVar">note-path</span><span class="RktPn">)</span></td></tr></table></p><p>The <span class="RktVar">order-integer</span> is used to order notes and defaults to <span class="RktVal">0</span>.</p></li><li><p><a name="(idx._(gentag._13._(lib._scribblings/raco/raco..scrbl)))"></a><span class="RktSym">racket-launcher-names</span> : <span class="RktPn">(</span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&amp;rel=data-structure-contracts.html%23%2528def._%2528%2528lib._racket%252Fcontract%252Fbase..rkt%2529._listof%2529%2529&amp;version=6.7" class="RktValLink Sq" data-pltdoc="x">listof</a></span><span class="stt"> </span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&amp;rel=strings.html%23%2528def._%2528%2528quote._%7E23%7E25kernel%2529._string%7E3f%2529%2529&amp;version=6.7" class="RktValLink Sq" data-pltdoc="x">string?</a></span><span class="RktPn">)</span>
&#8212;<wbr></wbr> <a name="(elem._racket-launcher-names)"></a> A list of executable names
to be generated in the installation&rsquo;s executable directory to run
Racket-based programs implemented by the collection. A parallel
list of library names must be provided by
<span class="RktSym">racket-launcher-libraries</span> or
<span class="RktSym">racket-launcher-flags</span>.</p><p>For each name, a launching executable is set up using
<span class="RktSym"><a href="exe.html#%28def._%28%28lib._launcher%2Flauncher..rkt%29._make-racket-launcher%29%29" class="RktValLink" data-pltdoc="x">make-racket-launcher</a></span>.  The arguments are <span class="nobreak"><span class="stt">-l-</span></span> and
<span class="sroman">&#8249;<span style="font-style: italic">colls</span>&#8250;</span><span class="stt">/.../</span><span class="sroman">&#8249;<span style="font-style: italic">file</span>&#8250;</span>, where <span class="sroman">&#8249;<span style="font-style: italic">file</span>&#8250;</span> is
the file named by <span class="RktSym">racket-launcher-libraries</span> and
<span class="sroman">&#8249;<span style="font-style: italic">colls</span>&#8250;</span><span class="stt">/...</span>  are the collections (and subcollections)
of the <span class="stt">"info.rkt"</span> file.</p><p>In addition,</p><blockquote class="SCodeFlow"><table cellspacing="0" cellpadding="0" class="RktBlk"><tr><td><span class="RktPn">(</span><span class="RktSym"><a href="exe.html#%28def._%28%28lib._launcher%2Flauncher..rkt%29._build-aux-from-path%29%29" class="RktValLink" data-pltdoc="x">build-aux-from-path</a></span></td></tr><tr><td><span class="hspace">&nbsp;</span><span class="RktPn">(</span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&amp;rel=Manipulating_Paths.html%23%2528def._%2528%2528quote._%7E23%7E25kernel%2529._build-path%2529%2529&amp;version=6.7" class="RktValLink Sq" data-pltdoc="x">build-path</a></span><span class="hspace">&nbsp;</span><span class="RktPn">(</span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&amp;rel=collects.html%23%2528def._%2528%2528lib._racket%252Fprivate%252Fbase..rkt%2529._collection-path%2529%2529&amp;version=6.7" class="RktValLink Sq" data-pltdoc="x">collection-path</a></span><span class="hspace">&nbsp;</span><span class="sroman">&#8249;<span style="font-style: italic">colls</span>&#8250;</span><span class="hspace">&nbsp;</span><span class="RktVar">...</span><span class="RktPn">)</span><span class="hspace">&nbsp;</span><span class="sroman">&#8249;<span style="font-style: italic">suffixless-file</span>&#8250;</span><span class="RktPn">)</span><span class="RktPn">)</span></td></tr></table></blockquote><p>is provided for the optional <span class="RktVar">aux</span> argument (for icons,
etc.) to <span class="RktSym"><a href="exe.html#%28def._%28%28lib._launcher%2Flauncher..rkt%29._make-racket-launcher%29%29" class="RktValLink" data-pltdoc="x">make-racket-launcher</a></span>, where
<span class="sroman">&#8249;<span style="font-style: italic">suffixless-file</span>&#8250;</span> is <span class="sroman">&#8249;<span style="font-style: italic">file</span>&#8250;</span> without its suffix.</p><p>If <span class="RktSym">racket-launcher-flags</span> is provided, it is used as a
list of command-line arguments passed to <span class="stt">racket</span> instead of
the above default, allowing arbitrary command-line arguments. If
<span class="RktSym">racket-launcher-flags</span> is specified together with
<span class="RktSym">racket-launcher-libraries</span>, then the flags will override
the libraries, but the libraries can still be used to specify a
name for <span class="RktSym"><a href="exe.html#%28def._%28%28lib._launcher%2Flauncher..rkt%29._build-aux-from-path%29%29" class="RktValLink" data-pltdoc="x">build-aux-from-path</a></span> (to find related information
like icon files etc).</p></li><li><p><a name="(idx._(gentag._14._(lib._scribblings/raco/raco..scrbl)))"></a><span class="RktSym">racket-launcher-libraries</span> : <span class="RktPn">(</span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&amp;rel=data-structure-contracts.html%23%2528def._%2528%2528lib._racket%252Fcontract%252Fbase..rkt%2529._listof%2529%2529&amp;version=6.7" class="RktValLink Sq" data-pltdoc="x">listof</a></span><span class="stt"> </span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&amp;rel=Manipulating_Paths.html%23%2528def._%2528%2528lib._racket%252Fprivate%252Fmisc..rkt%2529._path-string%7E3f%2529%2529&amp;version=6.7" class="RktValLink Sq" data-pltdoc="x">path-string?</a></span><span class="RktPn">)</span> &#8212;<wbr></wbr> A list of library names in parallel to
<a href="#%28elem._racket-launcher-names%29" data-pltdoc="x"><span class="RktSym">racket-launcher-names</span></a>.</p></li><li><p><a name="(idx._(gentag._15._(lib._scribblings/raco/raco..scrbl)))"></a><span class="RktSym">racket-launcher-flags</span> : <span class="RktPn">(</span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&amp;rel=data-structure-contracts.html%23%2528def._%2528%2528lib._racket%252Fcontract%252Fbase..rkt%2529._listof%2529%2529&amp;version=6.7" class="RktValLink Sq" data-pltdoc="x">listof</a></span><span class="stt"> </span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&amp;rel=strings.html%23%2528def._%2528%2528quote._%7E23%7E25kernel%2529._string%7E3f%2529%2529&amp;version=6.7" class="RktValLink Sq" data-pltdoc="x">string?</a></span><span class="RktPn">)</span>
&#8212;<wbr></wbr> A list of command-line flag lists, in parallel to
<a href="#%28elem._racket-launcher-names%29" data-pltdoc="x"><span class="RktSym">racket-launcher-names</span></a>.</p></li><li><p><a name="(idx._(gentag._16._(lib._scribblings/raco/raco..scrbl)))"></a><span class="RktSym">mzscheme-launcher-names</span>,
<span class="RktSym">mzscheme-launcher-libraries</span>, and
<span class="RktSym">mzscheme-launcher-flags</span> &#8212;<wbr></wbr> Backward-compatible variant of
<span class="RktSym">racket-launcher-names</span>, etc.</p></li><li><p><a name="(idx._(gentag._17._(lib._scribblings/raco/raco..scrbl)))"></a><span class="RktSym">gracket-launcher-names</span> : <span class="RktPn">(</span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&amp;rel=data-structure-contracts.html%23%2528def._%2528%2528lib._racket%252Fcontract%252Fbase..rkt%2529._listof%2529%2529&amp;version=6.7" class="RktValLink Sq" data-pltdoc="x">listof</a></span><span class="stt"> </span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&amp;rel=strings.html%23%2528def._%2528%2528quote._%7E23%7E25kernel%2529._string%7E3f%2529%2529&amp;version=6.7" class="RktValLink Sq" data-pltdoc="x">string?</a></span><span class="RktPn">)</span>  &#8212;<wbr></wbr>
<a name="(elem._gracket-launcher-names)"></a> Like
<a href="#%28elem._racket-launcher-names%29" data-pltdoc="x"><span class="RktSym">racket-launcher-names</span></a>,
but for GRacket-based executables. The launcher-name list is treated
in parallel to <span class="RktSym">gracket-launcher-libraries</span> and
<span class="RktSym">gracket-launcher-flags</span>.</p></li><li><p><a name="(idx._(gentag._18._(lib._scribblings/raco/raco..scrbl)))"></a><span class="RktSym">gracket-launcher-libraries</span> : <span class="RktPn">(</span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&amp;rel=data-structure-contracts.html%23%2528def._%2528%2528lib._racket%252Fcontract%252Fbase..rkt%2529._listof%2529%2529&amp;version=6.7" class="RktValLink Sq" data-pltdoc="x">listof</a></span><span class="stt"> </span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&amp;rel=Manipulating_Paths.html%23%2528def._%2528%2528lib._racket%252Fprivate%252Fmisc..rkt%2529._path-string%7E3f%2529%2529&amp;version=6.7" class="RktValLink Sq" data-pltdoc="x">path-string?</a></span><span class="RktPn">)</span>
&#8212;<wbr></wbr> A list of library names in parallel to
<a href="#%28elem._gracket-launcher-names%29" data-pltdoc="x"><span class="RktSym">gracket-launcher-names</span></a>.</p></li><li><p><a name="(idx._(gentag._19._(lib._scribblings/raco/raco..scrbl)))"></a><span class="RktSym">gracket-launcher-flags</span> : <span class="RktPn">(</span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&amp;rel=data-structure-contracts.html%23%2528def._%2528%2528lib._racket%252Fcontract%252Fbase..rkt%2529._listof%2529%2529&amp;version=6.7" class="RktValLink Sq" data-pltdoc="x">listof</a></span><span class="stt"> </span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&amp;rel=strings.html%23%2528def._%2528%2528quote._%7E23%7E25kernel%2529._string%7E3f%2529%2529&amp;version=6.7" class="RktValLink Sq" data-pltdoc="x">string?</a></span><span class="RktPn">)</span> &#8212;<wbr></wbr> A
list of command-line flag lists, in parallel to
<a href="#%28elem._gracket-launcher-names%29" data-pltdoc="x"><span class="RktSym">gracket-launcher-names</span></a>.</p></li><li><p><a name="(idx._(gentag._20._(lib._scribblings/raco/raco..scrbl)))"></a><span class="RktSym">mred-launcher-names</span>,
<span class="RktSym">mred-launcher-libraries</span>, and
<span class="RktSym">mred-launcher-flags</span> &#8212;<wbr></wbr> Backward-compatible variant of
<span class="RktSym">gracket-launcher-names</span>, etc.</p></li><li><p><a name="(idx._(gentag._21._(lib._scribblings/raco/raco..scrbl)))"></a><span class="RktSym">copy-foreign-libs</span> : <span class="RktPn">(</span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&amp;rel=data-structure-contracts.html%23%2528def._%2528%2528lib._racket%252Fcontract%252Fbase..rkt%2529._listof%2529%2529&amp;version=6.7" class="RktValLink Sq" data-pltdoc="x">listof</a></span><span class="stt"> </span><span class="RktPn">(</span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&amp;rel=data-structure-contracts.html%23%2528def._%2528%2528lib._racket%252Fcontract%252Fbase..rkt%2529._and%252Fc%2529%2529&amp;version=6.7" class="RktValLink Sq" data-pltdoc="x">and/c</a></span><span class="stt"> </span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&amp;rel=Manipulating_Paths.html%23%2528def._%2528%2528lib._racket%252Fprivate%252Fmisc..rkt%2529._path-string%7E3f%2529%2529&amp;version=6.7" class="RktValLink Sq" data-pltdoc="x">path-string?</a></span><span class="stt"> </span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&amp;rel=Manipulating_Paths.html%23%2528def._%2528%2528quote._%7E23%7E25kernel%2529._relative-path%7E3f%2529%2529&amp;version=6.7" class="RktValLink Sq" data-pltdoc="x">relative-path?</a></span><span class="RktPn">)</span><span class="RktPn">)</span> &#8212;<wbr></wbr> Files to copy into a
directory where foreign libraries are found by <span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=foreign&amp;rel=Loading_Foreign_Libraries.html%23%2528def._%2528%2528lib._ffi%252Funsafe..rkt%2529._ffi-lib%2529%2529&amp;version=6.7" class="RktValLink Sq" data-pltdoc="x">ffi-lib</a></span>.
If <span class="RktSym">install-platform</span> is defined, then the files are copied
only if the current platform matches the definition.</p><p>On Mac OS X, when a Mach-O file is copied, if the copied file
includes a library reference that starts <span class="RktInBG"><span class="hspace"></span><span class="RktIn">@loader_path/</span><span class="hspace"></span></span>,
and if the referenced library exists in a different location among
the paths listed by <span class="RktPn">(</span><span class="RktSym"><a href="dirs.html#%28def._%28%28lib._setup%2Fdirs..rkt%29._get-lib-search-dirs%29%29" class="RktValLink" data-pltdoc="x">get-lib-search-dirs</a></span><span class="RktPn">)</span>, then the
library reference is updated to an absolute path.</p><p>On Unix, when an ELF file is copied, if the copied file includes an
RPATH setting of <span class="RktInBG"><span class="hspace"></span><span class="RktIn">$ORIGIN</span><span class="hspace"></span></span> and the file is being installed
to a user-specific location, then the file&rsquo;s RPATH is adjusted to
<span class="RktInBG"><span class="hspace"></span><span class="RktIn">$ORIGIN:</span><span class="hspace"></span></span> followed by the path to the main installation&rsquo;s
library directory as reported by <span class="RktPn">(</span><span class="RktSym"><a href="dirs.html#%28def._%28%28lib._setup%2Fdirs..rkt%29._find-lib-dir%29%29" class="RktValLink" data-pltdoc="x">find-lib-dir</a></span><span class="RktPn">)</span>.</p><p>On Windows, deleting a previously installed foreign library may be
complicated by a lock on the file, if it is in use. To compensate,
<span class="stt">raco setup</span> deletes a foreign-library file by first renaming
the file to have the prefix <span class="stt">"raco-setup-delete-"</span>; it then
attempts to delete the renamed file and merely issues a warning on
a failure to delete the renamed file. Meanwhile, in modes where
<span class="stt">raco setup</span> removes uninstalled libraries, it attempts to
delete any file in the foreign-library directory whose name starts
with <span class="stt">"raco-setup-delete-"</span> (in an attempt to clean up after
previous failures).</p></li><li><p><a name="(idx._(gentag._22._(lib._scribblings/raco/raco..scrbl)))"></a><span class="RktSym">move-foreign-libs</span> : <span class="RktPn">(</span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&amp;rel=data-structure-contracts.html%23%2528def._%2528%2528lib._racket%252Fcontract%252Fbase..rkt%2529._listof%2529%2529&amp;version=6.7" class="RktValLink Sq" data-pltdoc="x">listof</a></span><span class="stt"> </span><span class="RktPn">(</span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&amp;rel=data-structure-contracts.html%23%2528def._%2528%2528lib._racket%252Fcontract%252Fbase..rkt%2529._and%252Fc%2529%2529&amp;version=6.7" class="RktValLink Sq" data-pltdoc="x">and/c</a></span><span class="stt"> </span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&amp;rel=Manipulating_Paths.html%23%2528def._%2528%2528lib._racket%252Fprivate%252Fmisc..rkt%2529._path-string%7E3f%2529%2529&amp;version=6.7" class="RktValLink Sq" data-pltdoc="x">path-string?</a></span><span class="stt"> </span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&amp;rel=Manipulating_Paths.html%23%2528def._%2528%2528quote._%7E23%7E25kernel%2529._relative-path%7E3f%2529%2529&amp;version=6.7" class="RktValLink Sq" data-pltdoc="x">relative-path?</a></span><span class="RktPn">)</span><span class="RktPn">)</span> &#8212;<wbr></wbr> Like <span class="RktSym">copy-foreign-libs</span>,
but the original file is removed after it is copied (which makes sense
for precompiled packages).</p></li><li><p><a name="(idx._(gentag._23._(lib._scribblings/raco/raco..scrbl)))"></a><span class="RktSym">copy-shared-files</span> : <span class="RktPn">(</span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&amp;rel=data-structure-contracts.html%23%2528def._%2528%2528lib._racket%252Fcontract%252Fbase..rkt%2529._listof%2529%2529&amp;version=6.7" class="RktValLink Sq" data-pltdoc="x">listof</a></span><span class="stt"> </span><span class="RktPn">(</span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&amp;rel=data-structure-contracts.html%23%2528def._%2528%2528lib._racket%252Fcontract%252Fbase..rkt%2529._and%252Fc%2529%2529&amp;version=6.7" class="RktValLink Sq" data-pltdoc="x">and/c</a></span><span class="stt"> </span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&amp;rel=Manipulating_Paths.html%23%2528def._%2528%2528lib._racket%252Fprivate%252Fmisc..rkt%2529._path-string%7E3f%2529%2529&amp;version=6.7" class="RktValLink Sq" data-pltdoc="x">path-string?</a></span><span class="stt"> </span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&amp;rel=Manipulating_Paths.html%23%2528def._%2528%2528quote._%7E23%7E25kernel%2529._relative-path%7E3f%2529%2529&amp;version=6.7" class="RktValLink Sq" data-pltdoc="x">relative-path?</a></span><span class="RktPn">)</span><span class="RktPn">)</span> &#8212;<wbr></wbr> Files to copy into a
directory where shared files are found.
If <span class="RktSym">install-platform</span> is defined, then the files are copied
only if the current platform matches the definition.</p><p>On Windows, uninstalled files are deleted in the same way as for
<span class="RktSym">copy-foreign-libs</span>, and the name prefix
<span class="stt">"raco-setup-delete-"</span> is similarly special.</p></li><li><p><a name="(idx._(gentag._24._(lib._scribblings/raco/raco..scrbl)))"></a><span class="RktSym">move-shared-files</span> : <span class="RktPn">(</span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&amp;rel=data-structure-contracts.html%23%2528def._%2528%2528lib._racket%252Fcontract%252Fbase..rkt%2529._listof%2529%2529&amp;version=6.7" class="RktValLink Sq" data-pltdoc="x">listof</a></span><span class="stt"> </span><span class="RktPn">(</span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&amp;rel=data-structure-contracts.html%23%2528def._%2528%2528lib._racket%252Fcontract%252Fbase..rkt%2529._and%252Fc%2529%2529&amp;version=6.7" class="RktValLink Sq" data-pltdoc="x">and/c</a></span><span class="stt"> </span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&amp;rel=Manipulating_Paths.html%23%2528def._%2528%2528lib._racket%252Fprivate%252Fmisc..rkt%2529._path-string%7E3f%2529%2529&amp;version=6.7" class="RktValLink Sq" data-pltdoc="x">path-string?</a></span><span class="stt"> </span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&amp;rel=Manipulating_Paths.html%23%2528def._%2528%2528quote._%7E23%7E25kernel%2529._relative-path%7E3f%2529%2529&amp;version=6.7" class="RktValLink Sq" data-pltdoc="x">relative-path?</a></span><span class="RktPn">)</span><span class="RktPn">)</span> &#8212;<wbr></wbr> Like <span class="RktSym">copy-shared-files</span>,
but the original file is removed after it is copied (which makes sense
for precompiled packages).</p></li><li><p><a name="(idx._(gentag._25._(lib._scribblings/raco/raco..scrbl)))"></a><span class="RktSym">copy-man-pages</span> : <span class="RktPn">(</span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&amp;rel=data-structure-contracts.html%23%2528def._%2528%2528lib._racket%252Fcontract%252Fbase..rkt%2529._listof%2529%2529&amp;version=6.7" class="RktValLink Sq" data-pltdoc="x">listof</a></span><span class="stt"> </span><span class="RktPn">(</span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&amp;rel=data-structure-contracts.html%23%2528def._%2528%2528lib._racket%252Fcontract%252Fbase..rkt%2529._and%252Fc%2529%2529&amp;version=6.7" class="RktValLink Sq" data-pltdoc="x">and/c</a></span><span class="stt"> </span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&amp;rel=Manipulating_Paths.html%23%2528def._%2528%2528lib._racket%252Fprivate%252Fmisc..rkt%2529._path-string%7E3f%2529%2529&amp;version=6.7" class="RktValLink Sq" data-pltdoc="x">path-string?</a></span><span class="stt"> </span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&amp;rel=Manipulating_Paths.html%23%2528def._%2528%2528quote._%7E23%7E25kernel%2529._relative-path%7E3f%2529%2529&amp;version=6.7" class="RktValLink Sq" data-pltdoc="x">relative-path?</a></span><span class="stt"> </span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&amp;rel=More_Path_Utilities.html%23%2528def._%2528%2528lib._racket%252Fpath..rkt%2529._filename-extension%2529%2529&amp;version=6.7" class="RktValLink Sq" data-pltdoc="x">filename-extension</a></span><span class="RktPn">)</span><span class="RktPn">)</span> &#8212;<wbr></wbr> Files to copy
into a <span class="stt">man</span> directory. The file suffix determines its category;
for example, <span class="RktInBG"><span class="hspace"></span><span class="RktIn">.1</span><span class="hspace"></span></span> should be used for a <span class="stt">man</span> page
describing an executable.</p><p>On Windows, uninstalled files are deleted in the same way as for
<span class="RktSym">copy-foreign-libs</span>, and the name prefix
<span class="stt">"raco-setup-delete-"</span> is similarly special.</p></li><li><p><a name="(idx._(gentag._26._(lib._scribblings/raco/raco..scrbl)))"></a><span class="RktSym">move-man-pages</span> : <span class="RktPn">(</span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&amp;rel=data-structure-contracts.html%23%2528def._%2528%2528lib._racket%252Fcontract%252Fbase..rkt%2529._listof%2529%2529&amp;version=6.7" class="RktValLink Sq" data-pltdoc="x">listof</a></span><span class="stt"> </span><span class="RktPn">(</span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&amp;rel=data-structure-contracts.html%23%2528def._%2528%2528lib._racket%252Fcontract%252Fbase..rkt%2529._and%252Fc%2529%2529&amp;version=6.7" class="RktValLink Sq" data-pltdoc="x">and/c</a></span><span class="stt"> </span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&amp;rel=Manipulating_Paths.html%23%2528def._%2528%2528lib._racket%252Fprivate%252Fmisc..rkt%2529._path-string%7E3f%2529%2529&amp;version=6.7" class="RktValLink Sq" data-pltdoc="x">path-string?</a></span><span class="stt"> </span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&amp;rel=Manipulating_Paths.html%23%2528def._%2528%2528quote._%7E23%7E25kernel%2529._relative-path%7E3f%2529%2529&amp;version=6.7" class="RktValLink Sq" data-pltdoc="x">relative-path?</a></span><span class="stt"> </span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&amp;rel=More_Path_Utilities.html%23%2528def._%2528%2528lib._racket%252Fpath..rkt%2529._filename-extension%2529%2529&amp;version=6.7" class="RktValLink Sq" data-pltdoc="x">filename-extension</a></span><span class="RktPn">)</span><span class="RktPn">)</span> &#8212;<wbr></wbr> Like
<span class="RktSym">copy-man-pages</span>, but the original file is removed after it
is copied (which makes sense for precompiled packages).</p></li><li><p><a name="(idx._(gentag._27._(lib._scribblings/raco/raco..scrbl)))"></a><span class="RktSym">install-platform</span> : <span class="RktSym"><a href="matching-platform.html#%28def._%28%28lib._setup%2Fmatching-platform..rkt%29._platform-spec~3f%29%29" class="RktValLink" data-pltdoc="x">platform-spec?</a></span>
&#8212;<wbr></wbr> Determines whether files are copied or moved
for <span class="RktSym">copy-foreign-libs</span>, <span class="RktSym">move-foreign-libs</span>,
<span class="RktSym">copy-shared-files</span>, or <span class="RktSym">move-shared-files</span>.
See <span class="RktSym"><a href="matching-platform.html#%28def._%28%28lib._setup%2Fmatching-platform..rkt%29._matching-platform~3f%29%29" class="RktValLink" data-pltdoc="x">matching-platform?</a></span> for information on the way that the
specification is compared to <span class="RktPn">(</span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&amp;rel=runtime.html%23%2528def._%2528%2528quote._%7E23%7E25kernel%2529._system-type%2529%2529&amp;version=6.7" class="RktValLink Sq" data-pltdoc="x">system-type</a></span><span class="RktPn">)</span>
and <span class="RktPn">(</span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&amp;rel=runtime.html%23%2528def._%2528%2528quote._%7E23%7E25kernel%2529._system-library-subpath%2529%2529&amp;version=6.7" class="RktValLink Sq" data-pltdoc="x">system-library-subpath</a></span><span class="stt"> </span><span class="RktVal">#f</span><span class="RktPn">)</span>.</p></li><li><p><a name="(idx._(gentag._28._(lib._scribblings/raco/raco..scrbl)))"></a><span class="RktSym">install-collection</span> : <span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&amp;rel=Manipulating_Paths.html%23%2528def._%2528%2528lib._racket%252Fprivate%252Fmisc..rkt%2529._path-string%7E3f%2529%2529&amp;version=6.7" class="RktValLink Sq" data-pltdoc="x">path-string?</a></span> &#8212;<wbr></wbr>
A library module relative to the collection that provides
<span class="RktSym">installer</span>. The <span class="RktSym">installer</span> procedure must accept
one, two, three, or four arguments:</p><ul><li><p>The first argument is a directory path to the parent of the
Racket installation&rsquo;s <span class="stt">"collects"</span> directory.</p></li><li><p>The second argument, if accepted, is a path to the
collection&rsquo;s own directory.</p></li><li><p>The third argument, if accepted, is a boolean indicating
whether the collection is installed as user-specific (<span class="RktVal">#t</span>)
or installation-wide (<span class="RktVal">#f</span>).</p></li><li><p>The fourth argument, if accepted, is a boolean indicating
whether the collection is installed as installation-wide and should
nevertheless avoid modifying the installation; an
<span class="RktSym">installer</span> procedure that does not accept this argument is
never called when the argument would be <span class="RktVal">#t</span>. An installer
that does accept this argument is called with <span class="RktVal">#t</span> to that
it can perform user-specific work, even though the collection is
installed installation-wide.</p></li></ul></li><li><p><a name="(idx._(gentag._29._(lib._scribblings/raco/raco..scrbl)))"></a><span class="RktSym">pre-install-collection</span> : <span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&amp;rel=Manipulating_Paths.html%23%2528def._%2528%2528lib._racket%252Fprivate%252Fmisc..rkt%2529._path-string%7E3f%2529%2529&amp;version=6.7" class="RktValLink Sq" data-pltdoc="x">path-string?</a></span> &#8212;<wbr></wbr>
Like <span class="RktSym">install-collection</span>, except that the corresponding
installer procedures are called <span style="font-style: italic">before</span> the normal <span class="stt">".zo"</span> build,
instead of after. The provided procedure is
<span class="RktSym">pre-installer</span>, so it can be provided by the
same file that provides an <span class="RktSym">installer</span> procedure.</p></li><li><p><a name="(idx._(gentag._30._(lib._scribblings/raco/raco..scrbl)))"></a><span class="RktSym">post-install-collection</span> : <span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&amp;rel=Manipulating_Paths.html%23%2528def._%2528%2528lib._racket%252Fprivate%252Fmisc..rkt%2529._path-string%7E3f%2529%2529&amp;version=6.7" class="RktValLink Sq" data-pltdoc="x">path-string?</a></span>  &#8212;<wbr></wbr>
Like <span class="RktSym">install-collection</span> for a procedure that is called right after the
<span class="RktSym">install-collection</span> procedure is executed. The
<span class="nobreak"><span class="stt">--no-install</span></span> flag can be provided to <span class="stt">raco setup</span>
to disable <span class="RktSym">install-collection</span> and <span class="RktSym">pre-install-collection</span>,
but not <span class="RktSym">post-install-collection</span>.  The <span class="RktSym">post-install-collection</span>
function is therefore expected to perform operations that are always needed,
even after an installation that contains pre-compiled files. The
provided procedure is <span class="RktSym">post-installer</span>, so it
can be provided by the same file that provides an
<span class="RktSym">installer</span> procedure.</p></li><li><p><a name="(idx._(gentag._31._(lib._scribblings/raco/raco..scrbl)))"></a><span class="RktSym">assume-virtual-sources</span> : <span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&amp;rel=data-structure-contracts.html%23%2528def._%2528%2528lib._racket%252Fcontract%252Fprivate%252Fmisc..rkt%2529._any%252Fc%2529%2529&amp;version=6.7" class="RktValLink Sq" data-pltdoc="x">any/c</a></span> &#8212;<wbr></wbr>
A true value indicates that bytecode files without a corresponding
source file should not be removed from <span class="stt">"compiled"</span> directories,
and no files should not be removed when the
<span class="nobreak"><span class="stt">--clean</span></span> or <span class="nobreak"><span class="stt">-c</span></span> flag is passed to <span class="stt">raco setup</span>.</p></li><li><p><a name="(idx._(gentag._32._(lib._scribblings/raco/raco..scrbl)))"></a><span class="RktSym">clean</span> : <span class="RktPn">(</span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&amp;rel=data-structure-contracts.html%23%2528def._%2528%2528lib._racket%252Fcontract%252Fbase..rkt%2529._listof%2529%2529&amp;version=6.7" class="RktValLink Sq" data-pltdoc="x">listof</a></span><span class="stt"> </span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&amp;rel=Manipulating_Paths.html%23%2528def._%2528%2528lib._racket%252Fprivate%252Fmisc..rkt%2529._path-string%7E3f%2529%2529&amp;version=6.7" class="RktValLink Sq" data-pltdoc="x">path-string?</a></span><span class="RktPn">)</span> &#8212;<wbr></wbr>
<a name="(elem._clean)"></a> A list of pathnames to be deleted when the
<span class="nobreak"><span class="stt">--clean</span></span> or <span class="nobreak"><span class="stt">-c</span></span> flag is passed to <span class="stt">raco setup</span>. The
pathnames must be relative to the collection. If any path names a
directory, each of the files in the directory are deleted, but none
of the subdirectories of the directory are checked. If the path
names a file, the file is deleted. The default, if this flag is not
specified, is to delete all files in the <span class="stt">"compiled"</span>
subdirectory, and all of the files in the platform-specific
subdirectory of the compiled directory for the current platform.</p><p>Just as compiling <span class="stt">".zo"</span> files will compile each module
used by a compiled module, deleting a module&rsquo;s compiled image will
delete the <span class="stt">".zo"</span> of each module that is used by the
module. More specifically, used modules are determined when
deleting a <span class="stt">".dep"</span> file, which would have been created to
accompany a <span class="stt">".zo"</span> file when the <span class="stt">".zo"</span> was built
by <span class="stt">raco setup</span> or <span class="stt">raco make</span> (see
<a href="Dependency_Files.html" data-pltdoc="x">Dependency Files</a>). If the <span class="stt">".dep"</span> file
indicates another module, that module&rsquo;s <span class="stt">".zo"</span> is deleted
only if it also has an accompanying <span class="stt">".dep"</span> file. In that
case, the <span class="stt">".dep"</span> file is deleted, and additional used
modules are deleted based on the used module&rsquo;s <span class="stt">".dep"</span>
file, etc. Supplying a specific list of collections to <span class="stt">raco
setup</span> disables this dependency-based deletion of compiled files.</p></li><li><p><span class="RktSym">compile-omit-paths</span>, <span class="RktSym">compile-omit-files</span>, and
<span class="RktSym">compile-include-files</span> &#8212;<wbr></wbr> Used indirectly via
<span class="RktSym"><a href="API_for_Raw_Compilation.html#%28def._%28%28lib._compiler%2Fcompiler..rkt%29._compile-collection-zos%29%29" class="RktValLink" data-pltdoc="x">compile-collection-zos</a></span>.</p></li><li><p><span class="RktSym">module-suffixes</span> and <span class="RktSym">doc-module-suffixes</span> &#8212;<wbr></wbr>
Used indirectly via <span class="RktSym"><a href="API_for_Raw_Compilation.html#%28def._%28%28lib._compiler%2Fmodule-suffix..rkt%29._get-module-suffixes%29%29" class="RktValLink" data-pltdoc="x">get-module-suffixes</a></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, &quot;6.7&quot;, &quot;../&quot;);" onfocus="this.style.color=&quot;black&quot;; this.style.textAlign=&quot;left&quot;; if (this.value == &quot;...search manuals...&quot;) this.value=&quot;&quot;;" onblur="if (this.value.match(/^ *$/)) { this.style.color=&quot;#888&quot;; this.style.textAlign=&quot;center&quot;; this.value=&quot;...search manuals...&quot;; }"/></form>&nbsp;&nbsp;<a href="../index.html" title="up to the documentation top" data-pltdoc="x" onclick="return GotoPLTRoot(&quot;6.7&quot;);">top</a></span><span class="navright">&nbsp;&nbsp;<a href="raco-setup-A.html" title="backward to &quot;6.2 Installing &quot;.plt&quot; Archives&quot;" data-pltdoc="x">&larr; prev</a>&nbsp;&nbsp;<a href="setup.html" title="up to &quot;6 raco setup: Installation Management&quot;" data-pltdoc="x">up</a>&nbsp;&nbsp;<a href="info_rkt.html" title="forward to &quot;6.4 &quot;info.rkt&quot; File Format&quot;" data-pltdoc="x">next &rarr;</a></span>&nbsp;</div></div></div><div id="contextindicator">&nbsp;</div></body></html>
racket-doc 6.7-3 / usr / share / doc / racket / raco / setup-info.html
