/usr/share/doc/racket/pkg/cmdline.html is in racket-doc 6.1-4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 | <!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 Using raco pkg</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">Package Management in Racket</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="getting-started.html" class="tocviewlink" data-pltdoc="x">Getting Started with Packages</a></td></tr><tr><td align="right">2 </td><td><a href="Package_Concepts.html" class="tocviewlink" data-pltdoc="x">Package Concepts</a></td></tr><tr><td align="right">3 </td><td><a href="" class="tocviewselflink" data-pltdoc="x">Using <span class="stt">raco pkg</span></a></td></tr><tr><td align="right">4 </td><td><a href="metadata.html" class="tocviewlink" data-pltdoc="x">Package Metadata</a></td></tr><tr><td align="right">5 </td><td><a href="strip.html" class="tocviewlink" data-pltdoc="x">Source, Binary, and Built Packages</a></td></tr><tr><td align="right">6 </td><td><a href="apis.html" class="tocviewlink" data-pltdoc="x">Package APIs</a></td></tr><tr><td align="right">7 </td><td><a href="catalog-protocol.html" class="tocviewlink" data-pltdoc="x">Package Catalog Protocol</a></td></tr><tr><td align="right">8 </td><td><a href="PLaneT_Compatibility.html" class="tocviewlink" data-pltdoc="x"><span class="planetName">PLane<span class="mywbr"> </span>T</span> Compatibility</a></td></tr><tr><td align="right">9 </td><td><a href="FAQ.html" class="tocviewlink" data-pltdoc="x">FAQ</a></td></tr><tr><td align="right">10 </td><td><a href="Future_Plans.html" class="tocviewlink" data-pltdoc="x">Future Plans</a></td></tr><tr><td align="right">11 </td><td><a href="implementation.html" class="tocviewlink" data-pltdoc="x">How Package Installation and Distribution Works</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">Using <span class="stt">raco pkg</span></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._raco-pkg-install%29" class="tocviewlink" data-pltdoc="x"><span class="stt">raco pkg install</span></a></td></tr><tr><td align="right">3.2 </td><td><a href="#%28part._raco-pkg-update%29" class="tocviewlink" data-pltdoc="x"><span class="stt">raco pkg update</span></a></td></tr><tr><td align="right">3.3 </td><td><a href="#%28part._raco-pkg-remove%29" class="tocviewlink" data-pltdoc="x"><span class="stt">raco pkg remove</span></a></td></tr><tr><td align="right">3.4 </td><td><a href="#%28part._raco-pkg-show%29" class="tocviewlink" data-pltdoc="x"><span class="stt">raco pkg show</span></a></td></tr><tr><td align="right">3.5 </td><td><a href="#%28part._raco-pkg-migrate%29" class="tocviewlink" data-pltdoc="x"><span class="stt">raco pkg migrate</span></a></td></tr><tr><td align="right">3.6 </td><td><a href="#%28part._raco-pkg-create%29" class="tocviewlink" data-pltdoc="x"><span class="stt">raco pkg create</span></a></td></tr><tr><td align="right">3.7 </td><td><a href="#%28part._raco-pkg-config%29" class="tocviewlink" data-pltdoc="x"><span class="stt">raco pkg config</span></a></td></tr><tr><td align="right">3.8 </td><td><a href="#%28part._raco-pkg-catalog-show%29" class="tocviewlink" data-pltdoc="x"><span class="stt">raco pkg catalog-<wbr></wbr>show</span></a></td></tr><tr><td align="right">3.9 </td><td><a href="#%28part._raco-pkg-catalog-copy%29" class="tocviewlink" data-pltdoc="x"><span class="stt">raco pkg catalog-<wbr></wbr>copy</span></a></td></tr><tr><td align="right">3.10 </td><td><a href="#%28part._raco-pkg-catalog-archive%29" class="tocviewlink" data-pltdoc="x"><span class="stt">raco pkg catalog-<wbr></wbr>archive</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._raco-pkg-install%29" class="tocsubseclink" data-pltdoc="x"><span class="stt">raco pkg install</span></a></td></tr><tr><td><span class="tocsublinknumber">3.2<tt> </tt></span><a href="#%28part._raco-pkg-update%29" class="tocsubseclink" data-pltdoc="x"><span class="stt">raco pkg update</span></a></td></tr><tr><td><span class="tocsublinknumber">3.3<tt> </tt></span><a href="#%28part._raco-pkg-remove%29" class="tocsubseclink" data-pltdoc="x"><span class="stt">raco pkg remove</span></a></td></tr><tr><td><span class="tocsublinknumber">3.4<tt> </tt></span><a href="#%28part._raco-pkg-show%29" class="tocsubseclink" data-pltdoc="x"><span class="stt">raco pkg show</span></a></td></tr><tr><td><span class="tocsublinknumber">3.5<tt> </tt></span><a href="#%28part._raco-pkg-migrate%29" class="tocsubseclink" data-pltdoc="x"><span class="stt">raco pkg migrate</span></a></td></tr><tr><td><span class="tocsublinknumber">3.6<tt> </tt></span><a href="#%28part._raco-pkg-create%29" class="tocsubseclink" data-pltdoc="x"><span class="stt">raco pkg create</span></a></td></tr><tr><td><span class="tocsublinknumber">3.7<tt> </tt></span><a href="#%28part._raco-pkg-config%29" class="tocsubseclink" data-pltdoc="x"><span class="stt">raco pkg config</span></a></td></tr><tr><td><span class="tocsublinknumber">3.8<tt> </tt></span><a href="#%28part._raco-pkg-catalog-show%29" class="tocsubseclink" data-pltdoc="x"><span class="stt">raco pkg catalog-<wbr></wbr>show</span></a></td></tr><tr><td><span class="tocsublinknumber">3.9<tt> </tt></span><a href="#%28part._raco-pkg-catalog-copy%29" class="tocsubseclink" data-pltdoc="x"><span class="stt">raco pkg catalog-<wbr></wbr>copy</span></a></td></tr><tr><td><span class="tocsublinknumber">3.10<tt> </tt></span><a href="#%28part._raco-pkg-catalog-archive%29" class="tocsubseclink" data-pltdoc="x"><span class="stt">raco pkg catalog-<wbr></wbr>archive</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.1", "../");" onfocus="this.style.color="black"; this.style.textAlign="left"; if (this.value == "...search manuals...") this.value="";" onblur="if (this.value.match(/^ *$/)) { this.style.color="#888"; this.style.textAlign="center"; this.value="...search manuals..."; }"/></form> <a href="../index.html" title="up to the documentation top" data-pltdoc="x" onclick="return GotoPLTRoot("6.1");">top</a></span><span class="navright"> <a href="Package_Concepts.html" title="backward to "2 Package Concepts"" data-pltdoc="x">← prev</a> <a href="index.html" title="up to "Package Management in Racket"" data-pltdoc="x">up</a> <a href="metadata.html" title="forward to "4 Package Metadata"" data-pltdoc="x">next →</a></span> </div><h3 x-source-module="(lib "pkg/scribblings/pkg.scrbl")" x-part-tag=""cmdline"">3<tt> </tt><a name="(part._cmdline)"></a>Using <span class="stt">raco pkg</span></h3><p>The <span class="stt">raco pkg</span> command provides package-management tools via
sub-commands.</p><h4 x-source-module="(lib "pkg/scribblings/pkg.scrbl")" x-part-tag=""raco-pkg-install"">3.1<tt> </tt><a name="(part._raco-pkg-install)"></a><span class="stt">raco pkg install</span></h4><p><a href="#%28part._raco-pkg-install%29" class="plainlink" data-pltdoc="x"><span class="stt">raco pkg install</span></a> <span class="sroman">‹<span style="font-style: italic">option</span>›</span> ... <span class="sroman">‹<span style="font-style: italic">pkg-source</span>›</span> ...
—<wbr></wbr> Installs the given <a href="Package_Concepts.html#%28tech._package._source%29" class="techoutside" data-pltdoc="x"><span class="techinside">package sources</span></a> (eliminating exact-duplicate <span class="sroman">‹<span style="font-style: italic">pkg-source</span>›</span>s).
If a given <span class="sroman">‹<span style="font-style: italic">pkg-source</span>›</span> is “auto-installed” (to satisfy some other package’s
dependency), then it is promoted to explicitly installed.</p><p>If no <span class="sroman">‹<span style="font-style: italic">pkg-source</span>›</span>s are supplied, the current directory is
installed as a link. See the <span class="nobreak"><span class="stt">--link</span></span> flag below for more details.</p><p>The <span class="stt">install</span> sub-command accepts
the following <span class="sroman">‹<span style="font-style: italic">option</span>›</span>s:</p><ul><li><p><span class="nobreak"><span class="stt">--type</span></span> <span class="sroman">‹<span style="font-style: italic">type</span>›</span> or <span class="nobreak"><span class="stt">-t</span></span> <span class="sroman">‹<span style="font-style: italic">type</span>›</span> —<wbr></wbr> specifies an interpretation of the package source,
where <span class="sroman">‹<span style="font-style: italic">type</span>›</span> is either <span class="stt">file</span>, <span class="stt">dir</span>, <span class="stt">file-url</span>, <span class="stt">dir-url</span>, <span class="stt">github</span>,
or <span class="stt">name</span>.</p></li><li><p><span class="nobreak"><span class="stt">--name</span></span> <span class="sroman">‹<span style="font-style: italic">pkg</span>›</span> or <span class="nobreak"><span class="stt">-n</span></span> <span class="sroman">‹<span style="font-style: italic">pkg</span>›</span> —<wbr></wbr> specifies the name of the package,
which makes sense only when a single <span class="sroman">‹<span style="font-style: italic">pkg-source</span>›</span> is provided. The name is normally
inferred for each <span class="sroman">‹<span style="font-style: italic">pkg-source</span>›</span>.</p></li><li><p><span class="nobreak"><span class="stt">--checksum</span></span> <span class="sroman">‹<span style="font-style: italic">checksum</span>›</span> —<wbr></wbr> specifies a checksum for the package,
which normally makes sense only when a single <span class="sroman">‹<span style="font-style: italic">pkg-source</span>›</span> is provided. The use of
<span class="sroman">‹<span style="font-style: italic">checksum</span>›</span> depends on <span class="sroman">‹<span style="font-style: italic">pkg-source</span>›</span>: for a GitHub source, <span class="sroman">‹<span style="font-style: italic">checksum</span>›</span> selects a checksum;
for a <a href="Package_Concepts.html#%28tech._package._name%29" class="techoutside" data-pltdoc="x"><span class="techinside">package name</span></a>, file path, or remote URL as a source, <span class="sroman">‹<span style="font-style: italic">checksum</span>›</span> specifies an expected checksum;
for a directory path (including a remote directory URL without a <span class="stt">".CHECKSUM"</span> file) as a source,
<span class="sroman">‹<span style="font-style: italic">checksum</span>›</span> assigns a checksum.</p></li><li><p><div class="SIntrapara"><span class="nobreak"><span class="stt">--deps</span></span> <span class="sroman">‹<span style="font-style: italic">behavior</span>›</span> —<wbr></wbr> Selects the behavior for dependencies, where <span class="sroman">‹<span style="font-style: italic">behavior</span>›</span> is one of
</div><div class="SIntrapara"><ul><li><p><span class="stt">fail</span> —<wbr></wbr> Cancels the installation if dependencies are uninstalled or version requirements are unmet.
This behavior is the default for a <span class="sroman">‹<span style="font-style: italic">pkg-source</span>›</span> that is not a <a href="Package_Concepts.html#%28tech._package._name%29" class="techoutside" data-pltdoc="x"><span class="techinside">package name</span></a>.</p></li><li><p><span class="stt">force</span> —<wbr></wbr> Installs the package(s) despite missing dependencies or version requirements.
Forcing an installation may leave package content in an inconsistent state.</p></li><li><p><span class="stt">search-ask</span> —<wbr></wbr> Looks for dependencies (when uninstalled) or updates (when version requirements are unmet)
via the configured <a href="Package_Concepts.html#%28tech._package._catalog%29" class="techoutside" data-pltdoc="x"><span class="techinside">package catalogs</span></a>,
but asks if you would like the packages installed or updated. This behavior is the default for a
<span class="sroman">‹<span style="font-style: italic">pkg-source</span>›</span> that is a <a href="Package_Concepts.html#%28tech._package._name%29" class="techoutside" data-pltdoc="x"><span class="techinside">package name</span></a>.</p></li><li><p><span class="stt">search-auto</span> —<wbr></wbr> Like <span class="stt">search-ask</span>, but does not ask for permission to install or update.</p></li></ul></div></p></li><li><p><span class="nobreak"><span class="stt">--auto</span></span> —<wbr></wbr> Shorthand for <span class="nobreak"><span class="stt">--deps</span></span><span class="stt"> search-auto</span>.</p></li><li><p><span class="nobreak"><span class="stt">--update-deps</span></span> —<wbr></wbr> With <span class="stt">search-ask</span> or <span class="stt">search-auto</span> dependency behavior, checks
already-installed dependencies transitively for updates (even when
not forced by version requirements), asking or automatically updating a
package when an update is available. When a package is updated or installed,
unless <span class="nobreak"><span class="stt">--skip-implies</span></span> is specified, any package that
it implies (see <a href="metadata.html" data-pltdoc="x">Package Metadata</a>) is automatically updated independent of the behavior
requested via <span class="nobreak"><span class="stt">--update-deps</span></span> and <span class="nobreak"><span class="stt">--deps</span></span>.</p></li><li><p><span class="nobreak"><span class="stt">--skip-implies</span></span> —<wbr></wbr> Disables special treatment of dependencies that are listed
in <span class="RktSym">implies</span> (see <a href="metadata.html" data-pltdoc="x">Package Metadata</a>) for an installed or updated package.</p></li><li><p><span class="nobreak"><span class="stt">--link</span></span> —<wbr></wbr> Implies <span class="stt">--type dir</span> (and overrides any specified type),
and links the existing directory as an installed package, instead of copying the
directory’s content to install. Directory <a href="Package_Concepts.html#%28tech._package._source%29" class="techoutside" data-pltdoc="x"><span class="techinside">package sources</span></a> are treated as links
by default, unless <span class="nobreak"><span class="stt">--copy</span></span> is specified.</p><p>The package is identified
as a <a href="Package_Concepts.html#%28tech._single._collection._package%29" class="techoutside" data-pltdoc="x"><span class="techinside">single-collection package</span></a> or a <a href="Package_Concepts.html#%28tech._multi._collection._package%29" class="techoutside" data-pltdoc="x"><span class="techinside">multi-collection package</span></a> at the
time that it is installed, and that categorization does not change even if the <span class="RktSym">collection</span>
definition in <span class="stt">"info.rkt"</span> is changed (i.e., he package must be removed and re-installed
for the change to take effect).</p></li><li><p><span class="nobreak"><span class="stt">--static-link</span></span> —<wbr></wbr> Implies <span class="nobreak"><span class="stt">--link</span></span>, and also indicates that subdirectories
of the given directory will not change for each given directory that implements a
<a href="Package_Concepts.html#%28tech._multi._collection._package%29" class="techoutside" data-pltdoc="x"><span class="techinside">multi-collection package</span></a>.</p></li><li><p><span class="nobreak"><span class="stt">--pkgs</span></span> —<wbr></wbr> Disables default installation of the current directory when no <span class="sroman">‹<span style="font-style: italic">pkg-source</span>›</span>s
are supplied.</p></li><li><p><span class="nobreak"><span class="stt">--copy</span></span> —<wbr></wbr> Disables default handling of directory <a href="Package_Concepts.html#%28tech._package._source%29" class="techoutside" data-pltdoc="x"><span class="techinside">package sources</span></a> as links,
and instead treats them like other sources: package content is copied to install.</p></li><li><p><span class="nobreak"><span class="stt">--binary</span></span> —<wbr></wbr> Strips source elements of a package before installing, and implies <span class="nobreak"><span class="stt">--copy</span></span>.</p></li><li><p><span class="nobreak"><span class="stt">--source</span></span> —<wbr></wbr> Strips built elements of a package before installing, and implies <span class="nobreak"><span class="stt">--copy</span></span>.</p></li><li><p><div class="SIntrapara"><span class="nobreak"><span class="stt">--scope</span></span> <span class="sroman">‹<span style="font-style: italic">scope</span>›</span> —<wbr></wbr> Selects the <a href="Package_Concepts.html#%28tech._package._scope%29" class="techoutside" data-pltdoc="x"><span class="techinside">package scope</span></a> for installation, where <span class="sroman">‹<span style="font-style: italic">scope</span>›</span> is one of
</div><div class="SIntrapara"><ul><li><p><span class="stt">installation</span> —<wbr></wbr> Install packages for all users of a Racket installation, rather than user-specific.</p></li><li><p><span class="stt">user</span> —<wbr></wbr> Install packages for the current user and current installation’s name/version.</p></li></ul></div><div class="SIntrapara">The default package scope is normally <span class="stt">user</span>, but it can be configured with
<a href="#%28part._raco-pkg-config%29" class="plainlink" data-pltdoc="x"><span class="stt">raco pkg config</span></a><span class="stt"> --set default-scope </span><span class="sroman">‹<span style="font-style: italic">scope</span>›</span>.
The default installation name is normally the Racket version, but it can be configured with
<a href="#%28part._raco-pkg-config%29" class="plainlink" data-pltdoc="x"><span class="stt">raco pkg config</span></a><span class="stt"> --set name </span><span class="sroman">‹<span style="font-style: italic">name</span>›</span>.</div></p></li><li><p><span class="nobreak"><span class="stt">-i</span></span> or <span class="nobreak"><span class="stt">--installation</span></span> —<wbr></wbr> Shorthand for <span class="stt">--scope installation</span>.</p></li><li><p><span class="nobreak"><span class="stt">-u</span></span> or <span class="nobreak"><span class="stt">--user</span></span> —<wbr></wbr> Shorthand for <span class="stt">--scope user</span>.</p></li><li><p><span class="nobreak"><span class="stt">--scope-dir</span></span> <span class="sroman">‹<span style="font-style: italic">dir</span>›</span> —<wbr></wbr> Select <span class="sroman">‹<span style="font-style: italic">dir</span>›</span> as the <a href="Package_Concepts.html#%28tech._package._scope%29" class="techoutside" data-pltdoc="x"><span class="techinside">package scope</span></a>.</p></li><li><p><span class="nobreak"><span class="stt">--catalog</span></span> <span class="sroman">‹<span style="font-style: italic">catalog</span>›</span> —<wbr></wbr> Use <span class="sroman">‹<span style="font-style: italic">catalog</span>›</span> instead of of the currently configured
<a href="Package_Concepts.html#%28tech._package._catalog%29" class="techoutside" data-pltdoc="x"><span class="techinside">package catalogs</span></a>.</p></li><li><p><span class="nobreak"><span class="stt">--skip-installed</span></span> —<wbr></wbr> Ignore any <span class="sroman">‹<span style="font-style: italic">pkg-source</span>›</span>
whose name corresponds to an already-installed package, except for promoting auto-installed
packages to explicitly installed.</p></li><li><p><span class="nobreak"><span class="stt">--all-platforms</span></span> —<wbr></wbr> Considers package dependencies independent of the current platform
(instead of filtering dependencies to platforms other than the current one).</p></li><li><p><span class="nobreak"><span class="stt">--force</span></span> —<wbr></wbr> Ignores module conflicts, including conflicts due to installing a single
package in multiple scopes. Forcing an installation may leave package content in an
inconsistent state.</p></li><li><p><span class="nobreak"><span class="stt">--ignore-checksums</span></span> —<wbr></wbr> Ignores errors verifying package <a href="Package_Concepts.html#%28tech._checksum%29" class="techoutside" data-pltdoc="x"><span class="techinside">checksums</span></a> (unsafe).</p></li><li><p><span class="nobreak"><span class="stt">--strict-doc-conflicts</span></span> —<wbr></wbr> Refuses to install in user <a href="Package_Concepts.html#%28tech._package._scope%29" class="techoutside" data-pltdoc="x"><span class="techinside">package scope</span></a> when
documentation-directory names would conflict with other packages. “Conflicting”
documentation names are normally allowed for installation in user <a href="Package_Concepts.html#%28tech._package._scope%29" class="techoutside" data-pltdoc="x"><span class="techinside">package scope</span></a>,
but strict checking ensures that installation would succeed in other <a href="Package_Concepts.html#%28tech._package._scope%29" class="techoutside" data-pltdoc="x"><span class="techinside">package scopes</span></a>.</p></li><li><p><span class="nobreak"><span class="stt">--no-cache</span></span> —<wbr></wbr> Disables use of the download cache.</p></li><li><p><span class="nobreak"><span class="stt">--no-setup</span></span> —<wbr></wbr> Does not run <span class="stt">raco setup</span> after installation. This behavior is also the case if the
environment variable <span class="stt">PLT_PKG_NOSETUP</span> is set to any non-empty value.</p></li><li><p><span class="nobreak"><span class="stt">--jobs</span></span> <span class="sroman">‹<span style="font-style: italic">n</span>›</span> or <span class="nobreak"><span class="stt">-j</span></span> <span class="sroman">‹<span style="font-style: italic">n</span>›</span> —<wbr></wbr> Install and setup with <span class="sroman">‹<span style="font-style: italic">n</span>›</span> parallel jobs.</p></li><li><p><span class="nobreak"><span class="stt">--fail-fast</span></span> —<wbr></wbr> Breaks <span class="stt">raco setup</span> as soon as any error is encountered.</p></li></ul><h4 x-source-module="(lib "pkg/scribblings/pkg.scrbl")" x-part-tag=""raco-pkg-update"">3.2<tt> </tt><a name="(part._raco-pkg-update)"></a><span class="stt">raco pkg update</span></h4><p><a href="#%28part._raco-pkg-update%29" class="plainlink" data-pltdoc="x"><span class="stt">raco pkg update</span></a> <span class="sroman">‹<span style="font-style: italic">option</span>›</span> ... <span class="sroman">‹<span style="font-style: italic">pkg-source</span>›</span> ...
—<wbr></wbr> Checks the specified package names for <a href="Package_Concepts.html#%28tech._package._update%29" class="techoutside" data-pltdoc="x"><span class="techinside">package updates</span></a> or
replaces existing package installations with the given sources. If an
update or replacement cannot be installed (e.g. it conflicts with
another installed package), then this command fails without installing
any of the <span class="sroman">‹<span style="font-style: italic">pkg-source</span>›</span>s (or their dependencies).</p><p>If a <a href="Package_Concepts.html#%28tech._package._scope%29" class="techoutside" data-pltdoc="x"><span class="techinside">package scope</span></a> is not specified, the scope is inferred from
the given <span class="sroman">‹<span style="font-style: italic">pkg-source</span>›</span>s.</p><p>The <span class="stt">update</span> sub-command accepts
the following <span class="sroman">‹<span style="font-style: italic">option</span>›</span>s:</p><ul><li><p><span class="nobreak"><span class="stt">--all</span></span> or <span class="nobreak"><span class="stt">-a</span></span> —<wbr></wbr> Update all packages, if no packages are given in the argument list.</p></li><li><p><span class="nobreak"><span class="stt">--lookup</span></span> —<wbr></wbr> Checks Causes a <a href="Package_Concepts.html#%28tech._package._name%29" class="techoutside" data-pltdoc="x"><span class="techinside">package name</span></a> as a <span class="sroman">‹<span style="font-style: italic">pkg-source</span>›</span> to be used
as a replacement, instead of the name of a installed package that may have updates.
(If the named package was installed through a package name, then there’s effectively
no difference.)</p></li><li><p><span class="nobreak"><span class="stt">--type</span></span> <span class="sroman">‹<span style="font-style: italic">type</span>›</span> or <span class="nobreak"><span class="stt">-t</span></span> <span class="sroman">‹<span style="font-style: italic">type</span>›</span> —<wbr></wbr> Same as for <a href="#%28part._raco-pkg-install%29" class="plainlink" data-pltdoc="x"><span class="stt">raco pkg install</span></a>.</p></li><li><p><span class="nobreak"><span class="stt">--name</span></span> <span class="sroman">‹<span style="font-style: italic">pkg</span>›</span> or <span class="nobreak"><span class="stt">-n</span></span> <span class="sroman">‹<span style="font-style: italic">pkg</span>›</span> —<wbr></wbr> Same as for <a href="#%28part._raco-pkg-install%29" class="plainlink" data-pltdoc="x"><span class="stt">raco pkg install</span></a>.</p></li><li><p><span class="nobreak"><span class="stt">--checksum</span></span> <span class="sroman">‹<span style="font-style: italic">checksum</span>›</span> —<wbr></wbr> Same as for <a href="#%28part._raco-pkg-install%29" class="plainlink" data-pltdoc="x"><span class="stt">raco pkg install</span></a>.</p></li><li><p><span class="nobreak"><span class="stt">--deps</span></span> <span class="sroman">‹<span style="font-style: italic">behavior</span>›</span> —<wbr></wbr> Same as for <a href="#%28part._raco-pkg-install%29" class="plainlink" data-pltdoc="x"><span class="stt">raco pkg install</span></a>.</p></li><li><p><span class="nobreak"><span class="stt">--auto</span></span> —<wbr></wbr> Shorthand for <span class="nobreak"><span class="stt">--deps</span></span><span class="stt"> search-auto</span> plus <span class="nobreak"><span class="stt">--update-deps</span></span>.</p></li><li><p><span class="nobreak"><span class="stt">--update-deps</span></span> —<wbr></wbr> Same as for <a href="#%28part._raco-pkg-install%29" class="plainlink" data-pltdoc="x"><span class="stt">raco pkg install</span></a>, but
implied by <span class="nobreak"><span class="stt">--auto</span></span> only for <a href="#%28part._raco-pkg-update%29" class="plainlink" data-pltdoc="x"><span class="stt">raco pkg update</span></a>.</p></li><li><p><span class="nobreak"><span class="stt">--skip-implies</span></span> —<wbr></wbr> Same as for <a href="#%28part._raco-pkg-install%29" class="plainlink" data-pltdoc="x"><span class="stt">raco pkg install</span></a>.</p></li><li><p><span class="nobreak"><span class="stt">--link</span></span> —<wbr></wbr> Same as for <a href="#%28part._raco-pkg-install%29" class="plainlink" data-pltdoc="x"><span class="stt">raco pkg install</span></a>.</p></li><li><p><span class="nobreak"><span class="stt">--static-link</span></span> —<wbr></wbr> Same as for <a href="#%28part._raco-pkg-install%29" class="plainlink" data-pltdoc="x"><span class="stt">raco pkg install</span></a>.</p></li><li><p><span class="nobreak"><span class="stt">--binary</span></span> —<wbr></wbr> Same as for <a href="#%28part._raco-pkg-install%29" class="plainlink" data-pltdoc="x"><span class="stt">raco pkg install</span></a>.</p></li><li><p><span class="nobreak"><span class="stt">--copy</span></span> —<wbr></wbr> Same as for <a href="#%28part._raco-pkg-install%29" class="plainlink" data-pltdoc="x"><span class="stt">raco pkg install</span></a>.</p></li><li><p><span class="nobreak"><span class="stt">--source</span></span> —<wbr></wbr> Same as for <a href="#%28part._raco-pkg-install%29" class="plainlink" data-pltdoc="x"><span class="stt">raco pkg install</span></a>.</p></li><li><p><span class="nobreak"><span class="stt">--scope</span></span> <span class="sroman">‹<span style="font-style: italic">scope</span>›</span> —<wbr></wbr> Selects a <a href="Package_Concepts.html#%28tech._package._scope%29" class="techoutside" data-pltdoc="x"><span class="techinside">package scope</span></a>, the same as for <a href="#%28part._raco-pkg-install%29" class="plainlink" data-pltdoc="x"><span class="stt">raco pkg install</span></a>.</p></li><li><p><span class="nobreak"><span class="stt">-i</span></span> or <span class="nobreak"><span class="stt">--installation</span></span> —<wbr></wbr> Shorthand for <span class="stt">--scope installation</span>.</p></li><li><p><span class="nobreak"><span class="stt">-u</span></span> or <span class="nobreak"><span class="stt">--user</span></span> —<wbr></wbr> Shorthand for <span class="stt">--scope user</span>.</p></li><li><p><span class="nobreak"><span class="stt">--scope-dir</span></span> <span class="sroman">‹<span style="font-style: italic">dir</span>›</span> —<wbr></wbr> Selects <span class="sroman">‹<span style="font-style: italic">dir</span>›</span> as the <a href="Package_Concepts.html#%28tech._package._scope%29" class="techoutside" data-pltdoc="x"><span class="techinside">package scope</span></a>, the same as for <a href="#%28part._raco-pkg-install%29" class="plainlink" data-pltdoc="x"><span class="stt">raco pkg install</span></a>.</p></li><li><p><span class="nobreak"><span class="stt">--catalog</span></span> <span class="sroman">‹<span style="font-style: italic">catalog</span>›</span> —<wbr></wbr> Same as for <a href="#%28part._raco-pkg-install%29" class="plainlink" data-pltdoc="x"><span class="stt">raco pkg install</span></a>.</p></li><li><p><span class="nobreak"><span class="stt">--all-platforms</span></span> —<wbr></wbr> Same as for <a href="#%28part._raco-pkg-install%29" class="plainlink" data-pltdoc="x"><span class="stt">raco pkg install</span></a>.</p></li><li><p><span class="nobreak"><span class="stt">--force</span></span> —<wbr></wbr> Same as for <a href="#%28part._raco-pkg-install%29" class="plainlink" data-pltdoc="x"><span class="stt">raco pkg install</span></a>.</p></li><li><p><span class="nobreak"><span class="stt">--ignore-checksums</span></span> —<wbr></wbr> Same as for <a href="#%28part._raco-pkg-install%29" class="plainlink" data-pltdoc="x"><span class="stt">raco pkg install</span></a>.</p></li><li><p><span class="nobreak"><span class="stt">--strict-doc-conflicts</span></span> —<wbr></wbr> Same as for <a href="#%28part._raco-pkg-install%29" class="plainlink" data-pltdoc="x"><span class="stt">raco pkg install</span></a>.</p></li><li><p><span class="nobreak"><span class="stt">--no-cache</span></span> —<wbr></wbr> Same as for <a href="#%28part._raco-pkg-install%29" class="plainlink" data-pltdoc="x"><span class="stt">raco pkg install</span></a>.</p></li><li><p><span class="nobreak"><span class="stt">--no-setup</span></span> —<wbr></wbr> Same as for <a href="#%28part._raco-pkg-install%29" class="plainlink" data-pltdoc="x"><span class="stt">raco pkg install</span></a>.</p></li><li><p><span class="nobreak"><span class="stt">--jobs</span></span> <span class="sroman">‹<span style="font-style: italic">n</span>›</span> or <span class="nobreak"><span class="stt">-j</span></span> <span class="sroman">‹<span style="font-style: italic">n</span>›</span> —<wbr></wbr> Same as for <a href="#%28part._raco-pkg-install%29" class="plainlink" data-pltdoc="x"><span class="stt">raco pkg install</span></a>.</p></li></ul><h4 x-source-module="(lib "pkg/scribblings/pkg.scrbl")" x-part-tag=""raco-pkg-remove"">3.3<tt> </tt><a name="(part._raco-pkg-remove)"></a><span class="stt">raco pkg remove</span></h4><p><a href="#%28part._raco-pkg-remove%29" class="plainlink" data-pltdoc="x"><span class="stt">raco pkg remove</span></a> <span class="sroman">‹<span style="font-style: italic">option</span>›</span> ... <span class="sroman">‹<span style="font-style: italic">pkg</span>›</span> ...
—<wbr></wbr> Attempts to remove the given packages. By default, if a package is the dependency
of another package that is not listed, this command fails without
removing any of the <span class="sroman">‹<span style="font-style: italic">pkg</span>›</span>s.</p><p>If a <a href="Package_Concepts.html#%28tech._package._scope%29" class="techoutside" data-pltdoc="x"><span class="techinside">package scope</span></a> is not specified, the scope is inferred from
the given <span class="sroman">‹<span style="font-style: italic">pkg</span>›</span>s.</p><p>The <span class="stt">remove</span> sub-command accepts
the following <span class="sroman">‹<span style="font-style: italic">option</span>›</span>s:</p><ul><li><p><span class="nobreak"><span class="stt">--demote</span></span> —<wbr></wbr> “Remove” explicitly installed packages by demoting them to auto-installed
(leaving auto-installed packages as such). Combined with <span class="nobreak"><span class="stt">--auto</span></span>, removes
packages for which there are no dependencies.</p></li><li><p><span class="nobreak"><span class="stt">--force</span></span> —<wbr></wbr> Ignore dependencies when removing packages.</p></li><li><p><span class="nobreak"><span class="stt">--auto</span></span> —<wbr></wbr> In addition to removing each <span class="sroman">‹<span style="font-style: italic">pkg</span>›</span>,
remove auto-installed packages (i.e., installed by the <span class="stt">search-auto</span> or <span class="stt">search-ask</span>
dependency behavior, or demoted via <span class="nobreak"><span class="stt">--demote</span></span>) that are no longer required by any
explicitly installed package.</p></li><li><p><span class="nobreak"><span class="stt">--scope</span></span> <span class="sroman">‹<span style="font-style: italic">scope</span>›</span> —<wbr></wbr> Selects a <a href="Package_Concepts.html#%28tech._package._scope%29" class="techoutside" data-pltdoc="x"><span class="techinside">package scope</span></a>, the same as for <a href="#%28part._raco-pkg-install%29" class="plainlink" data-pltdoc="x"><span class="stt">raco pkg install</span></a>.</p></li><li><p><span class="nobreak"><span class="stt">-i</span></span> or <span class="nobreak"><span class="stt">--installation</span></span> —<wbr></wbr> Shorthand for <span class="stt">--scope installation</span>.</p></li><li><p><span class="nobreak"><span class="stt">-u</span></span> or <span class="nobreak"><span class="stt">--user</span></span> —<wbr></wbr> Shorthand for <span class="stt">--scope user</span>.</p></li><li><p><span class="nobreak"><span class="stt">--scope-dir</span></span> <span class="sroman">‹<span style="font-style: italic">dir</span>›</span> —<wbr></wbr> Selects <span class="sroman">‹<span style="font-style: italic">dir</span>›</span> as the <a href="Package_Concepts.html#%28tech._package._scope%29" class="techoutside" data-pltdoc="x"><span class="techinside">package scope</span></a>, the same as for <a href="#%28part._raco-pkg-install%29" class="plainlink" data-pltdoc="x"><span class="stt">raco pkg install</span></a>.</p></li><li><p><span class="nobreak"><span class="stt">--no-setup</span></span> —<wbr></wbr> Same as for <a href="#%28part._raco-pkg-install%29" class="plainlink" data-pltdoc="x"><span class="stt">raco pkg install</span></a>.</p></li><li><p><span class="nobreak"><span class="stt">--jobs</span></span> <span class="sroman">‹<span style="font-style: italic">n</span>›</span> or <span class="nobreak"><span class="stt">-j</span></span> <span class="sroman">‹<span style="font-style: italic">n</span>›</span> —<wbr></wbr> Same as for <a href="#%28part._raco-pkg-install%29" class="plainlink" data-pltdoc="x"><span class="stt">raco pkg install</span></a>.</p></li></ul><h4 x-source-module="(lib "pkg/scribblings/pkg.scrbl")" x-part-tag=""raco-pkg-show"">3.4<tt> </tt><a name="(part._raco-pkg-show)"></a><span class="stt">raco pkg show</span></h4><p><a href="#%28part._raco-pkg-show%29" class="plainlink" data-pltdoc="x"><span class="stt">raco pkg show</span></a> <span class="sroman">‹<span style="font-style: italic">option</span>›</span> ... —<wbr></wbr> Print information about currently installed packages.
By default, packages are shown for all <a href="Package_Concepts.html#%28tech._package._scope%29" class="techoutside" data-pltdoc="x"><span class="techinside">package scopes</span></a>, but only for packages
not marked as auto-installed to fulfill dependencies.</p><p>The <span class="stt">show</span> sub-command accepts
the following <span class="sroman">‹<span style="font-style: italic">option</span>›</span>s:</p><ul><li><p><span class="nobreak"><span class="stt">-a</span></span> or <span class="nobreak"><span class="stt">--all</span></span> —<wbr></wbr> Includes auto-installed packages in the listing.</p></li><li><p><span class="nobreak"><span class="stt">-d</span></span> or <span class="nobreak"><span class="stt">--dir</span></span> —<wbr></wbr> Adds a column in the output for the directory where the package is installed.</p></li><li><p><div class="SIntrapara"><span class="nobreak"><span class="stt">--scope</span></span> <span class="sroman">‹<span style="font-style: italic">scope</span>›</span> —<wbr></wbr> Shows only packages in <span class="sroman">‹<span style="font-style: italic">scope</span>›</span>, which is one of
</div><div class="SIntrapara"><ul><li><p><span class="stt">installation</span> —<wbr></wbr> Show only installation-wide packages.</p></li><li><p><span class="stt">user</span> —<wbr></wbr> Show only user-specific packages for the current installation’s name/version
or the name/version specified with <span class="nobreak"><span class="stt">--version</span></span> or <span class="nobreak"><span class="stt">-v</span></span>.</p></li></ul></div><div class="SIntrapara">The default is to show packages for all <a href="Package_Concepts.html#%28tech._package._scope%29" class="techoutside" data-pltdoc="x"><span class="techinside">package scopes</span></a>.</div></p></li><li><p><span class="nobreak"><span class="stt">-i</span></span> or <span class="nobreak"><span class="stt">--installation</span></span> —<wbr></wbr> Shorthand for <span class="stt">--scope installation</span>.</p></li><li><p><span class="nobreak"><span class="stt">-u</span></span> or <span class="nobreak"><span class="stt">--user</span></span> —<wbr></wbr> Shorthand for <span class="stt">--scope user</span>.</p></li><li><p><span class="nobreak"><span class="stt">--scope-dir</span></span> <span class="sroman">‹<span style="font-style: italic">dir</span>›</span> —<wbr></wbr> Shows only packages installed in <span class="sroman">‹<span style="font-style: italic">dir</span>›</span>.</p></li><li><p><span class="nobreak"><span class="stt">--version</span></span> <span class="sroman">‹<span style="font-style: italic">vers</span>›</span> or <span class="nobreak"><span class="stt">-v</span></span> <span class="sroman">‹<span style="font-style: italic">vers</span>›</span> —<wbr></wbr> Show only user-specific packages for
the installation name/version <span class="sroman">‹<span style="font-style: italic">vers</span>›</span>.</p></li></ul><h4 x-source-module="(lib "pkg/scribblings/pkg.scrbl")" x-part-tag=""raco-pkg-migrate"">3.5<tt> </tt><a name="(part._raco-pkg-migrate)"></a><span class="stt">raco pkg migrate</span></h4><p><a href="#%28part._raco-pkg-migrate%29" class="plainlink" data-pltdoc="x"><span class="stt">raco pkg migrate</span></a> <span class="sroman">‹<span style="font-style: italic">option</span>›</span> ... <span class="sroman">‹<span style="font-style: italic">from-version</span>›</span>
—<wbr></wbr> Installs packages that were previously installed in <span class="stt">user</span>
<a href="Package_Concepts.html#%28tech._package._scope%29" class="techoutside" data-pltdoc="x"><span class="techinside">package scope</span></a> for <span class="sroman">‹<span style="font-style: italic">from-version</span>›</span>, where
<span class="sroman">‹<span style="font-style: italic">from-version</span>›</span> is an installation name/version.</p><p><div class="SIntrapara">The <span class="stt">migrate</span> sub-command accepts
the following <span class="sroman">‹<span style="font-style: italic">option</span>›</span>s:
</div><div class="SIntrapara"><ul><li><p><span class="nobreak"><span class="stt">--deps</span></span> <span class="sroman">‹<span style="font-style: italic">behavior</span>›</span> —<wbr></wbr> Same as for <a href="#%28part._raco-pkg-install%29" class="plainlink" data-pltdoc="x"><span class="stt">raco pkg install</span></a>, except that <span class="stt">search-auto</span> is
the default.</p></li><li><p><span class="nobreak"><span class="stt">--binary</span></span> —<wbr></wbr> Same as for <a href="#%28part._raco-pkg-install%29" class="plainlink" data-pltdoc="x"><span class="stt">raco pkg install</span></a>.</p></li><li><p><span class="nobreak"><span class="stt">--source</span></span> —<wbr></wbr> Same as for <a href="#%28part._raco-pkg-install%29" class="plainlink" data-pltdoc="x"><span class="stt">raco pkg install</span></a>.</p></li><li><p><span class="nobreak"><span class="stt">--scope</span></span> <span class="sroman">‹<span style="font-style: italic">scope</span>›</span> —<wbr></wbr> Same as for <a href="#%28part._raco-pkg-install%29" class="plainlink" data-pltdoc="x"><span class="stt">raco pkg install</span></a>.</p></li><li><p><span class="nobreak"><span class="stt">-i</span></span> or <span class="nobreak"><span class="stt">--installation</span></span> —<wbr></wbr> Shorthand for <span class="stt">--scope installation</span>.</p></li><li><p><span class="nobreak"><span class="stt">-u</span></span> or <span class="nobreak"><span class="stt">--user</span></span> —<wbr></wbr> Shorthand for <span class="stt">--scope user</span>.</p></li><li><p><span class="nobreak"><span class="stt">--scope-dir</span></span> <span class="sroman">‹<span style="font-style: italic">dir</span>›</span> —<wbr></wbr> Select <span class="sroman">‹<span style="font-style: italic">dir</span>›</span> as the <a href="Package_Concepts.html#%28tech._package._scope%29" class="techoutside" data-pltdoc="x"><span class="techinside">package scope</span></a>.</p></li><li><p><span class="nobreak"><span class="stt">--catalog</span></span> <span class="sroman">‹<span style="font-style: italic">catalog</span>›</span> —<wbr></wbr> Same as for <a href="#%28part._raco-pkg-install%29" class="plainlink" data-pltdoc="x"><span class="stt">raco pkg install</span></a>.</p></li><li><p><span class="nobreak"><span class="stt">--all-platforms</span></span> —<wbr></wbr> Same as for <a href="#%28part._raco-pkg-install%29" class="plainlink" data-pltdoc="x"><span class="stt">raco pkg install</span></a>.</p></li><li><p><span class="nobreak"><span class="stt">--force</span></span> —<wbr></wbr> Same as for <a href="#%28part._raco-pkg-install%29" class="plainlink" data-pltdoc="x"><span class="stt">raco pkg install</span></a>.</p></li><li><p><span class="nobreak"><span class="stt">--ignore-checksums</span></span> —<wbr></wbr> Same as for <a href="#%28part._raco-pkg-install%29" class="plainlink" data-pltdoc="x"><span class="stt">raco pkg install</span></a>.</p></li><li><p><span class="nobreak"><span class="stt">--strict-doc-conflicts</span></span> —<wbr></wbr> Same as for <a href="#%28part._raco-pkg-install%29" class="plainlink" data-pltdoc="x"><span class="stt">raco pkg install</span></a>.</p></li><li><p><span class="nobreak"><span class="stt">--no-cache</span></span> —<wbr></wbr> Same as for <a href="#%28part._raco-pkg-install%29" class="plainlink" data-pltdoc="x"><span class="stt">raco pkg install</span></a>.</p></li><li><p><span class="nobreak"><span class="stt">--no-setup</span></span> —<wbr></wbr> Same as for <a href="#%28part._raco-pkg-install%29" class="plainlink" data-pltdoc="x"><span class="stt">raco pkg install</span></a>.</p></li><li><p><span class="nobreak"><span class="stt">--jobs</span></span> <span class="sroman">‹<span style="font-style: italic">n</span>›</span> or <span class="nobreak"><span class="stt">-j</span></span> <span class="sroman">‹<span style="font-style: italic">n</span>›</span> —<wbr></wbr> Same as for <a href="#%28part._raco-pkg-install%29" class="plainlink" data-pltdoc="x"><span class="stt">raco pkg install</span></a>.</p></li></ul></div></p><h4 x-source-module="(lib "pkg/scribblings/pkg.scrbl")" x-part-tag=""raco-pkg-create"">3.6<tt> </tt><a name="(part._raco-pkg-create)"></a><span class="stt">raco pkg create</span></h4><p><a href="#%28part._raco-pkg-create%29" class="plainlink" data-pltdoc="x"><span class="stt">raco pkg create</span></a> <span class="sroman">‹<span style="font-style: italic">option</span>›</span> ... <span class="sroman">‹<span style="font-style: italic">directory-or-package</span>›</span>
—<wbr></wbr> Bundles a package into an archive. Bundling
is not needed for a package that is provided directly from a
GitHub repository or other non-archive formats. The <span class="stt">create</span>
sub-command can create an archive from a directory (the default) or
from an installed package. It can also adjust the archive’s content
to include only sources, only compiled bytecode and rendered documentation,
or both—<wbr></wbr>but packages are
normally provided as source and converted to binary form by an
automatic service, instead of by a package author.</p><p>The <span class="stt">create</span> sub-command accepts
the following <span class="sroman">‹<span style="font-style: italic">option</span>›</span>s:</p><ul><li><p><span class="nobreak"><span class="stt">--from-dir</span></span> —<wbr></wbr> Treat <span class="sroman">‹<span style="font-style: italic">directory-or-package</span>›</span> as a directory path; this is the default mode.</p></li><li><p><span class="nobreak"><span class="stt">--from-install</span></span> —<wbr></wbr> Treat <span class="sroman">‹<span style="font-style: italic">directory-or-package</span>›</span> as the name of an installed package
(instead of a directory).</p></li><li><p><span class="nobreak"><span class="stt">--format</span></span> <span class="sroman">‹<span style="font-style: italic">format</span>›</span> —<wbr></wbr> Specifies the archive format.
The allowed <span class="sroman">‹<span style="font-style: italic">format</span>›</span>s are: <span class="stt">zip</span> (the default), <span class="stt">tgz</span>, and <span class="stt">plt</span>.
This option must be specified if <span class="nobreak"><span class="stt">--manifest</span></span> is not present.</p></li><li><p><span class="nobreak"><span class="stt">--manifest</span></span> —<wbr></wbr> Creates a manifest file for a directory, rather than an archive.</p></li><li><p><span class="nobreak"><span class="stt">--as-is</span></span> —<wbr></wbr> Bundle all content of the package directory as is, with no filtering
of sources, compiled files, or repository elements.</p></li><li><p><span class="nobreak"><span class="stt">--source</span></span> —<wbr></wbr> Bundle only sources in the package directory; see <a href="strip.html" data-pltdoc="x">Source, Binary, and Built Packages</a>.</p></li><li><p><span class="nobreak"><span class="stt">--binary</span></span> —<wbr></wbr> Bundle compiled bytecode and rendered
documentation in the package directory; see <a href="strip.html" data-pltdoc="x">Source, Binary, and Built Packages</a>.</p></li><li><p><span class="nobreak"><span class="stt">--built</span></span> —<wbr></wbr> Bundle compiled sources, bytecode, and rendered
documentation in the package directory, filtering repository elements; see <a href="strip.html" data-pltdoc="x">Source, Binary, and Built Packages</a>.</p></li><li><p><span class="nobreak"><span class="stt">--dest</span></span> <span class="sroman">‹<span style="font-style: italic">dest-dir</span>›</span> —<wbr></wbr> Writes generated bundles to <span class="sroman">‹<span style="font-style: italic">dest-dir</span>›</span>.</p></li></ul><h4 x-source-module="(lib "pkg/scribblings/pkg.scrbl")" x-part-tag=""raco-pkg-config"">3.7<tt> </tt><a name="(part._raco-pkg-config)"></a><span class="stt">raco pkg config</span></h4><p><a href="#%28part._raco-pkg-config%29" class="plainlink" data-pltdoc="x"><span class="stt">raco pkg config</span></a> <span class="sroman">‹<span style="font-style: italic">option</span>›</span> ... <span class="sroman">[</span><span class="sroman">‹<span style="font-style: italic">key</span>›</span><span class="sroman">]</span> <span class="sroman">‹<span style="font-style: italic">val</span>›</span> ... —<wbr></wbr>
View and modify the configuration of the package manager. If <span class="sroman">‹<span style="font-style: italic">key</span>›</span> is not provided,
the values for all recognized keys are shown. The <span class="sroman">‹<span style="font-style: italic">val</span>›</span> arguments are allowed
only when <span class="nobreak"><span class="stt">--set</span></span> is used, in which case the <span class="sroman">‹<span style="font-style: italic">val</span>›</span>s are used as the new values
for <span class="sroman">‹<span style="font-style: italic">key</span>›</span>.</p><p>The <span class="stt">config</span> sub-command accepts
with the following <span class="sroman">‹<span style="font-style: italic">option</span>›</span>s:</p><ul><li><p><span class="nobreak"><span class="stt">--set</span></span> —<wbr></wbr> Sets an option, rather than printing it.</p></li><li><p><span class="nobreak"><span class="stt">--scope</span></span> <span class="sroman">‹<span style="font-style: italic">scope</span>›</span> —<wbr></wbr> Selects a <a href="Package_Concepts.html#%28tech._package._scope%29" class="techoutside" data-pltdoc="x"><span class="techinside">package scope</span></a>, the same as for <a href="#%28part._raco-pkg-install%29" class="plainlink" data-pltdoc="x"><span class="stt">raco pkg install</span></a>.
A configuration value set at <span class="stt">installation</span> scope serves
as the default value at <span class="stt">user</span> scope.</p></li><li><p><span class="nobreak"><span class="stt">-i</span></span> or <span class="nobreak"><span class="stt">--installation</span></span> —<wbr></wbr> Shorthand for <span class="stt">--scope installation</span>.</p></li><li><p><span class="nobreak"><span class="stt">-u</span></span> or <span class="nobreak"><span class="stt">--user</span></span> —<wbr></wbr> Shorthand for <span class="stt">--scope user</span>.</p></li><li><p><span class="nobreak"><span class="stt">--scope-dir</span></span> <span class="sroman">‹<span style="font-style: italic">dir</span>›</span> —<wbr></wbr> Same as for <a href="#%28part._raco-pkg-install%29" class="plainlink" data-pltdoc="x"><span class="stt">raco pkg install</span></a>.</p></li></ul><p><div class="SIntrapara">The valid <span class="sroman">‹<span style="font-style: italic">key</span>›</span>s are:
</div><div class="SIntrapara"><ul><li><p><span class="stt">name</span> —<wbr></wbr> A string for the installation’s name, which is used by <span class="stt">user</span>
<a href="Package_Concepts.html#%28tech._package._scope%29" class="techoutside" data-pltdoc="x"><span class="techinside">package scope</span></a> and defaults to the Racket version.</p></li><li><p><span class="stt">catalogs</span> —<wbr></wbr> A list of URLs for <a href="Package_Concepts.html#%28tech._package._catalog%29" class="techoutside" data-pltdoc="x"><span class="techinside">package catalogs</span></a>.</p></li><li><p><span class="stt">default-scope</span> —<wbr></wbr> Either <span class="stt">installation</span> or <span class="stt">user</span>.
The value of this key at <span class="stt">user</span> scope (possibly defaulting from
<span class="stt">installation</span> scope) is
the default <a href="Package_Concepts.html#%28tech._package._scope%29" class="techoutside" data-pltdoc="x"><span class="techinside">package scope</span></a> for <span class="stt">raco pkg</span> commands for which
a scope is not inferred from a given set of package names
(even for <span class="stt">raco pkg config</span>, which is consistent but potentially confusing).</p></li><li><p><span class="stt">download-cache-dir</span> —<wbr></wbr> A directory that holds copies of
downloaded packages, used to avoid re-downloading if the
same URL and checksum combination is requested again. The default cache directory is
user-specific (but not specific to a Racket version or
installation name).</p></li><li><p><span class="stt">download-cache-max-files</span> —<wbr></wbr> A limit on the number of files to
be kept in the download cache directory.</p></li><li><p><span class="stt">download-cache-max-bytes</span> —<wbr></wbr> A limit on the total size of files
that are kept in the download cache directory.</p></li><li><p><span class="stt">doc-open-url</span> —<wbr></wbr> A URL to use in place of a local
filesystem path for viewing (or at least searching)
documentation; an empty string, which is the default, disables
the URL so that the local filesystem is used. This key can be
set only in <span class="stt">installation</span> scope.</p></li></ul></div></p><h4 x-source-module="(lib "pkg/scribblings/pkg.scrbl")" x-part-tag=""raco-pkg-catalog-show"">3.8<tt> </tt><a name="(part._raco-pkg-catalog-show)"></a><span class="stt">raco pkg catalog-show</span></h4><p><a href="#%28part._raco-pkg-catalog-show%29" class="plainlink" data-pltdoc="x"><span class="stt">raco pkg catalog-show</span></a> <span class="sroman">‹<span style="font-style: italic">option</span>›</span> ... <span class="sroman">‹<span style="font-style: italic">package-name</span>›</span> ...
—<wbr></wbr> Consults <a href="Package_Concepts.html#%28tech._package._catalog%29" class="techoutside" data-pltdoc="x"><span class="techinside">package catalogs</span></a> for a package (that is not necessarily installed)
and displays the catalog’s information for the package, such as its source URL and
a checksum.</p><p>The <span class="stt">catalog-show</span> sub-command accepts
the following <span class="sroman">‹<span style="font-style: italic">option</span>›</span>s:</p><ul><li><p><span class="nobreak"><span class="stt">--all</span></span> —<wbr></wbr> Show information for all available packages. When using this flag,
supply no <span class="sroman">‹<span style="font-style: italic">packaee-name</span>›</span>s.</p></li><li><p><span class="nobreak"><span class="stt">--only-names</span></span> —<wbr></wbr> Show only package names. This option is mainly useful with
<span class="nobreak"><span class="stt">--all</span></span>, but when a <span class="sroman">‹<span style="font-style: italic">packaee-name</span>›</span> is provided,
catalogs are consulted to ensure that he package is available.</p></li><li><p><span class="nobreak"><span class="stt">--modules</span></span> —<wbr></wbr> Show the modules that are implemented by a package.</p></li><li><p><span class="nobreak"><span class="stt">--catalog</span></span> <span class="sroman">‹<span style="font-style: italic">catalog</span>›</span> —<wbr></wbr> Query <span class="sroman">‹<span style="font-style: italic">catalog</span>›</span> instead of the currently configured
<a href="Package_Concepts.html#%28tech._package._catalog%29" class="techoutside" data-pltdoc="x"><span class="techinside">package catalogs</span></a>.</p></li><li><p><span class="nobreak"><span class="stt">--version</span></span> <span class="sroman">‹<span style="font-style: italic">version</span>›</span> or <span class="nobreak"><span class="stt">-v</span></span> <span class="sroman">‹<span style="font-style: italic">version</span>›</span> —<wbr></wbr> Query catalogs
for a result specific to <span class="sroman">‹<span style="font-style: italic">version</span>›</span>,
instead of the installation’s Racket version.</p></li></ul><h4 x-source-module="(lib "pkg/scribblings/pkg.scrbl")" x-part-tag=""raco-pkg-catalog-copy"">3.9<tt> </tt><a name="(part._raco-pkg-catalog-copy)"></a><span class="stt">raco pkg catalog-copy</span></h4><p><a href="#%28part._raco-pkg-catalog-copy%29" class="plainlink" data-pltdoc="x"><span class="stt">raco pkg catalog-copy</span></a> <span class="sroman">‹<span style="font-style: italic">option</span>›</span> ... <span class="sroman">‹<span style="font-style: italic">src-catalog</span>›</span> ... <span class="sroman">‹<span style="font-style: italic">dest-catalog</span>›</span>
—<wbr></wbr> Copies information from the <a href="Package_Concepts.html#%28tech._package._catalog%29" class="techoutside" data-pltdoc="x"><span class="techinside">package catalog</span></a> named by <span class="sroman">‹<span style="font-style: italic">src-catalog</span>›</span>s
to a local database or directory <span class="sroman">‹<span style="font-style: italic">dest-catalog</span>›</span>,
which can be used as a new <a href="Package_Concepts.html#%28tech._package._catalog%29" class="techoutside" data-pltdoc="x"><span class="techinside">package catalog</span></a>.</p><p>The <span class="sroman">‹<span style="font-style: italic">src-catalog</span>›</span>s can be remote or local, while <span class="sroman">‹<span style="font-style: italic">dest-catalog</span>›</span> must be local
(i.e., a directory path or a SQLite database path, as inferred from the path).
If a <span class="sroman">‹<span style="font-style: italic">src-catalog</span>›</span> or <span class="sroman">‹<span style="font-style: italic">dest-catalog</span>›</span> does not start with a URL scheme, it is
treated as a filesystem path. Information from multiple <span class="sroman">‹<span style="font-style: italic">src-catalog</span>›</span>s is merged,
with information from earlier <span class="sroman">‹<span style="font-style: italic">src-catalog</span>›</span>s taking precedence over later
<span class="sroman">‹<span style="font-style: italic">src-catalog</span>›</span>s.</p><p>The <span class="stt">catalog-copy</span> sub-command accepts
the following <span class="sroman">‹<span style="font-style: italic">option</span>›</span>s:</p><ul><li><p><span class="nobreak"><span class="stt">--from-config</span></span> —<wbr></wbr> Adds the currently configured
<a href="Package_Concepts.html#%28tech._package._catalog%29" class="techoutside" data-pltdoc="x"><span class="techinside">package catalogs</span></a> to the end of the <span class="sroman">‹<span style="font-style: italic">src-catalog</span>›</span>s list.</p></li><li><p><span class="nobreak"><span class="stt">--force</span></span> —<wbr></wbr> Replaces <span class="sroman">‹<span style="font-style: italic">dest-catalog</span>›</span> if it exists already.</p></li><li><p><span class="nobreak"><span class="stt">--merge</span></span> —<wbr></wbr> Adds to <span class="sroman">‹<span style="font-style: italic">dest-catalog</span>›</span> if it exists already. By default,
information already in <span class="sroman">‹<span style="font-style: italic">dest-catalog</span>›</span> takes precedence
over new information.</p></li><li><p><span class="nobreak"><span class="stt">--override</span></span> —<wbr></wbr> Changes merging so that new information takes precedence
over information already in <span class="sroman">‹<span style="font-style: italic">dest-catalog</span>›</span>.</p></li><li><p><span class="nobreak"><span class="stt">--relative</span></span> —<wbr></wbr> Write package sources to <span class="sroman">‹<span style="font-style: italic">dest-catalog</span>›</span> in relative-path form,
when possible.</p></li><li><p><span class="nobreak"><span class="stt">--version</span></span> <span class="sroman">‹<span style="font-style: italic">version</span>›</span> or <span class="nobreak"><span class="stt">-v</span></span> <span class="sroman">‹<span style="font-style: italic">version</span>›</span> —<wbr></wbr> Copy catalog
results specific to <span class="sroman">‹<span style="font-style: italic">version</span>›</span>
(for catalogs that make a distinction), instead of the installation’s Racket version.</p></li></ul><h4 x-source-module="(lib "pkg/scribblings/pkg.scrbl")" x-part-tag=""raco-pkg-catalog-archive"">3.10<tt> </tt><a name="(part._raco-pkg-catalog-archive)"></a><span class="stt">raco pkg catalog-archive</span></h4><p><a href="#%28part._raco-pkg-catalog-archive%29" class="plainlink" data-pltdoc="x"><span class="stt">raco pkg catalog-archive</span></a> <span class="sroman">‹<span style="font-style: italic">option</span>›</span> ... <span class="sroman">‹<span style="font-style: italic">dest-dir</span>›</span> <span class="sroman">‹<span style="font-style: italic">src-catalog</span>›</span> ...
—<wbr></wbr> Copies information from the <a href="Package_Concepts.html#%28tech._package._catalog%29" class="techoutside" data-pltdoc="x"><span class="techinside">package catalog</span></a> named by <span class="sroman">‹<span style="font-style: italic">src-catalog</span>›</span>s
to a <span class="stt">"catalog"</span> directory catalog in <span class="sroman">‹<span style="font-style: italic">dest-dir</span>›</span>, and also copies
all package sources to a <span class="stt">"pkgs"</span> directory in <span class="sroman">‹<span style="font-style: italic">dest-dir</span>›</span>.</p><p>Packages sources are downloaded and repacked as needed, so that
all packages are written to the <span class="stt">"pkgs"</span> directory as
<span class="stt">".zip"</span> archives. This conversion may change the checksum
on each archived package.</p><p>The <span class="stt">catalog-archive</span> sub-command accepts
the following <span class="sroman">‹<span style="font-style: italic">option</span>›</span>s:</p><ul><li><p><span class="nobreak"><span class="stt">--from-config</span></span> —<wbr></wbr> Adds the currently configured
<a href="Package_Concepts.html#%28tech._package._catalog%29" class="techoutside" data-pltdoc="x"><span class="techinside">package catalogs</span></a> to the end of the <span class="sroman">‹<span style="font-style: italic">src-catalog</span>›</span>s list.</p></li><li><p><span class="nobreak"><span class="stt">--state</span></span> <span class="sroman">‹<span style="font-style: italic">state-database</span>›</span> —<wbr></wbr> To enable incremental
updating, Reads and writes the database <span class="sroman">‹<span style="font-style: italic">state-database</span>›</span>, which must have the suffix
<span class="stt">".sqlite"</span>, as the current state of <span class="sroman">‹<span style="font-style: italic">dest-dir</span>›</span>.</p></li><li><p><span class="nobreak"><span class="stt">--relative</span></span> —<wbr></wbr> Write package sources to <span class="sroman">‹<span style="font-style: italic">dest-catalog</span>›</span> in relative-path form.</p></li><li><p><span class="nobreak"><span class="stt">--version</span></span> <span class="sroman">‹<span style="font-style: italic">version</span>›</span> or <span class="nobreak"><span class="stt">-v</span></span> <span class="sroman">‹<span style="font-style: italic">version</span>›</span> —<wbr></wbr> Copy catalog
results specific to <span class="sroman">‹<span style="font-style: italic">version</span>›</span>
(for catalogs that make a distinction), instead of the installation’s Racket version.</p></li></ul><p class="SHistory">Added in version 6.0.17.</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.1", "../");" onfocus="this.style.color="black"; this.style.textAlign="left"; if (this.value == "...search manuals...") this.value="";" onblur="if (this.value.match(/^ *$/)) { this.style.color="#888"; this.style.textAlign="center"; this.value="...search manuals..."; }"/></form> <a href="../index.html" title="up to the documentation top" data-pltdoc="x" onclick="return GotoPLTRoot("6.1");">top</a></span><span class="navright"> <a href="Package_Concepts.html" title="backward to "2 Package Concepts"" data-pltdoc="x">← prev</a> <a href="index.html" title="up to "Package Management in Racket"" data-pltdoc="x">up</a> <a href="metadata.html" title="forward to "4 Package Metadata"" data-pltdoc="x">next →</a></span> </div></div></div><div id="contextindicator"> </div></body></html>
|