/usr/share/doc/racket/planet/cmdline.html is in racket-doc 6.7-3.
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 | <!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>3 The raco planet Command-Line Tool</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="../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="../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">PLane<span class="mywbr"> </span>T:<span class="mywbr"> </span> Automatic Package Distribution</a></td></tr></table></div><div class="tocviewsublisttop" style="display: block;" id="tocview_0"><table cellspacing="0" cellpadding="0"><tr><td align="right">1 </td><td><a href="Using_PLaneT.html" class="tocviewlink" data-pltdoc="x">Using PLane<span class="mywbr"> </span>T</a></td></tr><tr><td align="right">2 </td><td><a href="search-order.html" class="tocviewlink" data-pltdoc="x">The PLane<span class="mywbr"> </span>T Search Order</a></td></tr><tr><td align="right">3 </td><td><a href="" class="tocviewselflink" data-pltdoc="x">The <span class="stt">raco planet</span> Command-<wbr></wbr>Line Tool</a></td></tr><tr><td align="right">4 </td><td><a href="hash-lang-planet.html" class="tocviewlink" data-pltdoc="x">The <span class="RktModLink"><span class="RktSym">planet</span></span> Language</a></td></tr><tr><td align="right">5 </td><td><a href="Utility_Libraries.html" class="tocviewlink" data-pltdoc="x">Utility Libraries</a></td></tr><tr><td align="right">6 </td><td><a href="Developing_Packages_for_PLaneT.html" class="tocviewlink" data-pltdoc="x">Developing Packages for PLane<span class="mywbr"> </span>T</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,"tocview_1");">►</a></td><td>3 </td><td><a href="" class="tocviewselflink" data-pltdoc="x">The <span class="stt">raco planet</span> Command-<wbr></wbr>Line Tool</a></td></tr></table><div class="tocviewsublistbottom" style="display: none;" id="tocview_1"><table cellspacing="0" cellpadding="0"><tr><td align="right">3.1 </td><td><a href="#%28part._create%29" class="tocviewlink" data-pltdoc="x"><span class="stt">create</span></a></td></tr><tr><td align="right">3.2 </td><td><a href="#%28part._install%29" class="tocviewlink" data-pltdoc="x"><span class="stt">install</span></a></td></tr><tr><td align="right">3.3 </td><td><a href="#%28part._remove%29" class="tocviewlink" data-pltdoc="x"><span class="stt">remove</span></a></td></tr><tr><td align="right">3.4 </td><td><a href="#%28part._show%29" class="tocviewlink" data-pltdoc="x"><span class="stt">show</span></a></td></tr><tr><td align="right">3.5 </td><td><a href="#%28part._clearlinks%29" class="tocviewlink" data-pltdoc="x"><span class="stt">clearlinks</span></a></td></tr><tr><td align="right">3.6 </td><td><a href="#%28part._fileinject%29" class="tocviewlink" data-pltdoc="x"><span class="stt">fileinject</span></a></td></tr><tr><td align="right">3.7 </td><td><a href="#%28part._link%29" class="tocviewlink" data-pltdoc="x"><span class="stt">link</span></a></td></tr><tr><td align="right">3.8 </td><td><a href="#%28part._unlink%29" class="tocviewlink" data-pltdoc="x"><span class="stt">unlink</span></a></td></tr><tr><td align="right">3.9 </td><td><a href="#%28part._fetch%29" class="tocviewlink" data-pltdoc="x"><span class="stt">fetch</span></a></td></tr><tr><td align="right">3.10 </td><td><a href="#%28part._url%29" class="tocviewlink" data-pltdoc="x"><span class="stt">url</span></a></td></tr><tr><td align="right">3.11 </td><td><a href="#%28part._open%29" class="tocviewlink" data-pltdoc="x"><span class="stt">open</span></a></td></tr><tr><td align="right">3.12 </td><td><a href="#%28part._structure%29" class="tocviewlink" data-pltdoc="x"><span class="stt">structure</span></a></td></tr><tr><td align="right">3.13 </td><td><a href="#%28part._print%29" class="tocviewlink" data-pltdoc="x"><span class="stt">print</span></a></td></tr></table></div></div></div><div class="tocsub"><div class="tocsubtitle">On this page:</div><table class="tocsublist" cellspacing="0"><tr><td><span class="tocsublinknumber">3.1<tt> </tt></span><a href="#%28part._create%29" class="tocsubseclink" data-pltdoc="x"><span class="stt">create</span></a></td></tr><tr><td><span class="tocsublinknumber">3.2<tt> </tt></span><a href="#%28part._install%29" class="tocsubseclink" data-pltdoc="x"><span class="stt">install</span></a></td></tr><tr><td><span class="tocsublinknumber">3.3<tt> </tt></span><a href="#%28part._remove%29" class="tocsubseclink" data-pltdoc="x"><span class="stt">remove</span></a></td></tr><tr><td><span class="tocsublinknumber">3.4<tt> </tt></span><a href="#%28part._show%29" class="tocsubseclink" data-pltdoc="x"><span class="stt">show</span></a></td></tr><tr><td><span class="tocsublinknumber">3.5<tt> </tt></span><a href="#%28part._clearlinks%29" class="tocsubseclink" data-pltdoc="x"><span class="stt">clearlinks</span></a></td></tr><tr><td><span class="tocsublinknumber">3.6<tt> </tt></span><a href="#%28part._fileinject%29" class="tocsubseclink" data-pltdoc="x"><span class="stt">fileinject</span></a></td></tr><tr><td><span class="tocsublinknumber">3.7<tt> </tt></span><a href="#%28part._link%29" class="tocsubseclink" data-pltdoc="x"><span class="stt">link</span></a></td></tr><tr><td><span class="tocsublinknumber">3.8<tt> </tt></span><a href="#%28part._unlink%29" class="tocsubseclink" data-pltdoc="x"><span class="stt">unlink</span></a></td></tr><tr><td><span class="tocsublinknumber">3.9<tt> </tt></span><a href="#%28part._fetch%29" class="tocsubseclink" data-pltdoc="x"><span class="stt">fetch</span></a></td></tr><tr><td><span class="tocsublinknumber">3.10<tt> </tt></span><a href="#%28part._url%29" class="tocsubseclink" data-pltdoc="x"><span class="stt">url</span></a></td></tr><tr><td><span class="tocsublinknumber">3.11<tt> </tt></span><a href="#%28part._open%29" class="tocsubseclink" data-pltdoc="x"><span class="stt">open</span></a></td></tr><tr><td><span class="tocsublinknumber">3.12<tt> </tt></span><a href="#%28part._structure%29" class="tocsubseclink" data-pltdoc="x"><span class="stt">structure</span></a></td></tr><tr><td><span class="tocsublinknumber">3.13<tt> </tt></span><a href="#%28part._print%29" class="tocsubseclink" data-pltdoc="x"><span class="stt">print</span></a></td></tr></table></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.7", "../");" 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.7");">top</a></span><span class="navright"> <a href="search-order.html" title="backward to "2 The PLaneT Search Order"" data-pltdoc="x">← prev</a> <a href="index.html" title="up to "PLaneT: Automatic Package Distribution"" data-pltdoc="x">up</a> <a href="hash-lang-planet.html" title="forward to "4 The planet Language"" data-pltdoc="x">next →</a></span> </div><h3 x-source-module="(lib "planet/planet.scrbl")" x-source-pkg="planet-doc" x-part-tag=""cmdline"">3<tt> </tt><a name="(part._cmdline)"></a>The <span class="stt">raco planet</span> Command-Line Tool</h3><p>The <span class="stt">raco planet</span> command-line tool allows a command-line interface to
the most commonly-performed PLaneT tasks. It is invoked from the
command line as</p><p><span class="hspace"> </span><span class="stt">raco planet </span><span style="font-style: italic">subcommand</span><span class="stt"> </span><span style="font-style: italic">arg</span><span class="stt"> ...</span></p><p>where <span style="font-style: italic">subcommand</span> is a subcommand from the following list, and
<span style="font-style: italic">arg</span> is a sequence of arguments determined by that subcommand:</p><ul><li><p><a href="#%28part._create%29" data-pltdoc="x"><span class="stt">create</span></a>: create a PLaneT archive from a directory</p></li><li><p><a href="#%28part._install%29" data-pltdoc="x"><span class="stt">install</span></a>: download and install a given package</p></li><li><p><a href="#%28part._remove%29" data-pltdoc="x"><span class="stt">remove</span></a>: remove the specified package from the local cache</p></li><li><p><a href="#%28part._show%29" data-pltdoc="x"><span class="stt">show</span></a>: list the packages installed in the local cache</p></li><li><p><a href="#%28part._clearlinks%29" data-pltdoc="x"><span class="stt">clearlinks</span></a>: clear the linkage table, allowing upgrades</p></li><li><p><a href="#%28part._fileinject%29" data-pltdoc="x"><span class="stt">fileinject</span></a>: install a local file to the planet cache</p></li><li><p><a href="#%28part._link%29" data-pltdoc="x"><span class="stt">link</span></a>: create a development link</p></li><li><p><a href="#%28part._unlink%29" data-pltdoc="x"><span class="stt">unlink</span></a>: remove development link associated with the given package</p></li><li><p><a href="#%28part._fetch%29" data-pltdoc="x"><span class="stt">fetch</span></a>: download a package file without installing it</p></li><li><p><a href="#%28part._url%29" data-pltdoc="x"><span class="stt">url</span></a>: get a URL for the given package</p></li><li><p><a href="#%28part._open%29" data-pltdoc="x"><span class="stt">open</span></a>: unpack the contents of the given package</p></li><li><p><a href="#%28part._structure%29" data-pltdoc="x"><span class="stt">structure</span></a>: display the structure of a given .plt archive</p></li><li><p><a href="#%28part._print%29" data-pltdoc="x"><span class="stt">print</span></a>: display a file within of the given .plt archive</p></li></ul><p>Each of these commands is described in more detail below. All the
functionality of the command-line tool is also provided with a programmatic interface by
<a href="Utility_Libraries.html#%28part._util..rkt%29" data-pltdoc="x">the <span class="stt">"util.rkt"</span> library</a>.</p><h4 x-source-module="(lib "planet/planet.scrbl")" x-source-pkg="planet-doc" x-part-tag=""create"">3.1<tt> </tt><a name="(part._create)"></a><span class="stt">create</span></h4><p><div class="SIntrapara">Usage:
</div><div class="SIntrapara"><span class="hspace"> </span><span class="stt">raco planet create [ <option> ... ] <path></span></div><div class="SIntrapara">Create a PLaneT archive in the current directory whose contents are the
directory <span class="stt"><path></span>.</div></p><p><div class="SIntrapara"><span class="stt"><option></span> is one of:
</div><div class="SIntrapara"><ul><li><p><span class="stt">-f, --force</span>: force a package to be created even if its info.rkt file contains
errors.</p></li></ul></div></p><h4 x-source-module="(lib "planet/planet.scrbl")" x-source-pkg="planet-doc" x-part-tag=""install"">3.2<tt> </tt><a name="(part._install)"></a><span class="stt">install</span></h4><p><div class="SIntrapara">Usage:
</div><div class="SIntrapara"><span class="hspace"> </span><span class="stt">raco planet install <owner> <pkg> <maj> <min></span></div><div class="SIntrapara">Download and install the package that <span class="RktPn">(</span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=require.html%23%2528form._%2528%2528lib._racket%252Fprivate%252Fbase..rkt%2529._require%2529%2529&version=6.7" class="RktStxLink Sq" data-pltdoc="x">require</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&rel=require.html%23%2528form._%2528%2528lib._racket%252Fprivate%252Fbase..rkt%2529._planet%2529%2529&version=6.7" class="RktStxLink Sq" data-pltdoc="x">planet</a></span><span class="stt"> </span><span class="RktVal">"file.rkt"</span><span class="stt"> </span><span class="RktPn">(</span><span class="RktSym"><owner></span><span class="stt"> </span><span class="RktSym"><pkg></span><span class="stt"> </span><span class="RktSym"><maj></span><span class="stt"> </span><span class="RktSym"><min></span><span class="RktPn">)</span><span class="RktPn">)</span><span class="RktPn">)</span>
would install.</div></p><h4 x-source-module="(lib "planet/planet.scrbl")" x-source-pkg="planet-doc" x-part-tag=""remove"">3.3<tt> </tt><a name="(part._remove)"></a><span class="stt">remove</span></h4><p><div class="SIntrapara">Usage:
</div><div class="SIntrapara"><span class="hspace"> </span><span class="stt">raco planet remove [ <option> ... ] <owner> <pkg> <maj> <min></span></div><div class="SIntrapara">Remove the specified package from the local cache, optionally also removing its
distribution file.</div></p><p><div class="SIntrapara"><span class="stt"><option></span> is one of:
</div><div class="SIntrapara"><ul><li><p><span class="stt">-e, --erase</span>: also remove the package’s distribution file from the
uninstalled-package cache</p></li></ul></div></p><h4 x-source-module="(lib "planet/planet.scrbl")" x-source-pkg="planet-doc" x-part-tag=""show"">3.4<tt> </tt><a name="(part._show)"></a><span class="stt">show</span></h4><p><div class="SIntrapara">Usage:
</div><div class="SIntrapara"><span class="hspace"> </span><span class="stt">raco planet show [ <option> ... ]</span></div><div class="SIntrapara">List the packages installed in the local cache.</div></p><p><div class="SIntrapara"><span class="stt"><option></span> is one of:
</div><div class="SIntrapara"><ul><li><p><span class="stt">-p, --packages</span>: show packages only (default)</p></li><li><p><span class="stt">-l, --linkage</span>: show linkage table only</p></li><li><p><span class="stt">-a, --all</span>: show packages and linkage</p></li></ul></div></p><h4 x-source-module="(lib "planet/planet.scrbl")" x-source-pkg="planet-doc" x-part-tag=""clearlinks"">3.5<tt> </tt><a name="(part._clearlinks)"></a><span class="stt">clearlinks</span></h4><p><div class="SIntrapara">Usage:
</div><div class="SIntrapara"><span class="hspace"> </span><span class="stt">raco planet clearlinks</span></div><div class="SIntrapara">Clear the linkage table, allowing upgrades.</div></p><h4 x-source-module="(lib "planet/planet.scrbl")" x-source-pkg="planet-doc" x-part-tag=""fileinject"">3.6<tt> </tt><a name="(part._fileinject)"></a><span class="stt">fileinject</span></h4><p><div class="SIntrapara">Usage:
</div><div class="SIntrapara"><span class="hspace"> </span><span class="stt">raco planet fileinject <owner> <plt-file> <maj> <min></span></div><div class="SIntrapara">Install local file <plt-file> into the planet cache as though it had been
downloaded from the planet server. It is treated as though it had the given owner name as its owner name,
the given file’s filename as the its package name, and the given major and minor version numbers.</div></p><h4 x-source-module="(lib "planet/planet.scrbl")" x-source-pkg="planet-doc" x-part-tag=""link"">3.7<tt> </tt><a name="(part._link)"></a><span class="stt">link</span></h4><p><div class="SIntrapara">Usage:
</div><div class="SIntrapara"><span class="hspace"> </span><span class="stt">raco planet link <owner> <pkg> <maj> <min> <path></span></div><div class="SIntrapara">Create a development link (see <a href="Developing_Packages_for_PLaneT.html#%28part._devlinks%29" data-pltdoc="x">Development Links</a>) between the given
package specifier and the specified directory name.</div></p><h4 x-source-module="(lib "planet/planet.scrbl")" x-source-pkg="planet-doc" x-part-tag=""unlink"">3.8<tt> </tt><a name="(part._unlink)"></a><span class="stt">unlink</span></h4><p><div class="SIntrapara">Usage:
</div><div class="SIntrapara"><span class="hspace"> </span><span class="stt">raco planet unlink [ <option> ] <owner> <pkg> <maj> <min></span></div><div class="SIntrapara">Remove any development link (see <a href="Developing_Packages_for_PLaneT.html#%28part._devlinks%29" data-pltdoc="x">Development Links</a>) associated with
the given package.</div></p><p><div class="SIntrapara"><span class="stt"><option></span> can only be:
</div><div class="SIntrapara"><ul><li><p><span class="stt">-q, --quiet</span>: don’t signal an error on nonexistent links</p></li></ul></div></p><h4 x-source-module="(lib "planet/planet.scrbl")" x-source-pkg="planet-doc" x-part-tag=""fetch"">3.9<tt> </tt><a name="(part._fetch)"></a><span class="stt">fetch</span></h4><p><div class="SIntrapara">Usage:
</div><div class="SIntrapara"><span class="hspace"> </span><span class="stt">raco planet fetch <owner> <pkg> <maj> <min></span></div><div class="SIntrapara">Download the given package file from the central PLaneT repository without installing it.</div></p><h4 x-source-module="(lib "planet/planet.scrbl")" x-source-pkg="planet-doc" x-part-tag=""url"">3.10<tt> </tt><a name="(part._url)"></a><span class="stt">url</span></h4><p><div class="SIntrapara">Usage:
</div><div class="SIntrapara"><span class="hspace"> </span><span class="stt">raco planet url <owner> <pkg> <maj> <min></span></div><div class="SIntrapara">Get a URL for the given package.</div></p><p>This is never necessary for normal use of planet, but may be helpful in some
circumstances for retrieving packages.</p><h4 x-source-module="(lib "planet/planet.scrbl")" x-source-pkg="planet-doc" x-part-tag=""open"">3.11<tt> </tt><a name="(part._open)"></a><span class="stt">open</span></h4><p><div class="SIntrapara">Usage:
</div><div class="SIntrapara"><span class="hspace"> </span><span class="stt">raco planet open <plt-file> <target></span></div><div class="SIntrapara">Unpack the contents of the given package into the given directory without
installing.</div></p><p>This command is not necessary for normal use of planet. It is intended to allow
you to inspect package contents offline without needing to install the package.</p><h4 x-source-module="(lib "planet/planet.scrbl")" x-source-pkg="planet-doc" x-part-tag=""structure"">3.12<tt> </tt><a name="(part._structure)"></a><span class="stt">structure</span></h4><p><div class="SIntrapara">Usage:
</div><div class="SIntrapara"><span class="hspace"> </span><span class="stt">raco planet structure <plt-file></span></div><div class="SIntrapara">Print the structure of the PLaneT archive named by <plt-file> to the standard
output port.</div></p><p>This command does not unpack or install the named .plt file.</p><h4 x-source-module="(lib "planet/planet.scrbl")" x-source-pkg="planet-doc" x-part-tag=""print"">3.13<tt> </tt><a name="(part._print)"></a><span class="stt">print</span></h4><p><div class="SIntrapara">Usage:
</div><div class="SIntrapara"><span class="hspace"> </span><span class="stt">raco planet print <plt-file> <path></span></div></p><p>Print the contents of the file named by <path>, which must be a relative path
within the PLaneT archive named by <plt-file>, to the standard output port.</p><p>This command does not unpack or install the named .plt file.</p><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.7", "../");" 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.7");">top</a></span><span class="navright"> <a href="search-order.html" title="backward to "2 The PLaneT Search Order"" data-pltdoc="x">← prev</a> <a href="index.html" title="up to "PLaneT: Automatic Package Distribution"" data-pltdoc="x">up</a> <a href="hash-lang-planet.html" title="forward to "4 The planet Language"" data-pltdoc="x">next →</a></span> </div></div></div><div id="contextindicator"> </div></body></html>
|