/usr/share/doc/racket/pkg/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 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 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 | <!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="git-workflow.html" class="tocviewlink" data-pltdoc="x">Developing Packages with Git</a></td></tr><tr><td align="right">7 </td><td><a href="apis.html" class="tocviewlink" data-pltdoc="x">Package APIs</a></td></tr><tr><td align="right">8 </td><td><a href="catalog-protocol.html" class="tocviewlink" data-pltdoc="x">Package Catalog Protocol</a></td></tr><tr><td align="right">9 </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">10 </td><td><a href="FAQ.html" class="tocviewlink" data-pltdoc="x">FAQ</a></td></tr><tr><td align="right">11 </td><td><a href="Future_Plans.html" class="tocviewlink" data-pltdoc="x">Future Plans</a></td></tr><tr><td align="right">12 </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-new%29" class="tocviewlink" data-pltdoc="x"><span class="stt">raco pkg new</span></a></td></tr><tr><td align="right">3.5 </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.6 </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.7 </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.8 </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.9 </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.10 </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.11 </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><tr><td align="right">3.12 </td><td><a href="#%28part._raco-pkg-archive%29" class="tocviewlink" data-pltdoc="x"><span class="stt">raco pkg archive</span></a></td></tr><tr><td align="right">3.13 </td><td><a href="#%28part._raco-pkg-empty-trash%29" class="tocviewlink" data-pltdoc="x"><span class="stt">raco pkg empty-<wbr></wbr>trash</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-new%29" class="tocsubseclink" data-pltdoc="x"><span class="stt">raco pkg new</span></a></td></tr><tr><td><span class="tocsublinknumber">3.5<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.6<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.7<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.8<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.9<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.10<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.11<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><tr><td><span class="tocsublinknumber">3.12<tt> </tt></span><a href="#%28part._raco-pkg-archive%29" class="tocsubseclink" data-pltdoc="x"><span class="stt">raco pkg archive</span></a></td></tr><tr><td><span class="tocsublinknumber">3.13<tt> </tt></span><a href="#%28part._raco-pkg-empty-trash%29" class="tocsubseclink" data-pltdoc="x"><span class="stt">raco pkg empty-<wbr></wbr>trash</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="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-source-pkg="racket-doc" 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-source-pkg="racket-doc" 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 <a href="Package_Concepts.html#%28part._concept~3aauto%29" data-pltdoc="x">auto-installed</a> (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 and the <span class="nobreak"><span class="stt">--clone</span></span>
flag is not 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>If no <span class="sroman">‹<span style="font-style: italic">pkg-source</span>›</span>s are supplied and the <span class="nobreak"><span class="stt">--clone</span></span>
flag is supplied, then the clone directory’s name is used as the
only <span class="sroman">‹<span style="font-style: italic">pkg-source</span>›</span> argument. See the <span class="nobreak"><span class="stt">--clone</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">git</span>, <span class="stt">github</span>,
or <span class="stt">name</span>. The type 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">--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 Git or 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 non-<a href="#%28tech._interactive._mode%29" class="techoutside" data-pltdoc="x"><span class="techinside">interactive mode</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 the user whether packages should be installed or updated. This behavior is the default in <a href="#%28tech._interactive._mode%29" class="techoutside" data-pltdoc="x"><span class="techinside">interactive mode</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 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 or the directory name was reported by
a catalog instead of specified directly.</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., the 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">--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">--clone</span></span> <span class="sroman">‹<span style="font-style: italic">dir</span>›</span> —<wbr></wbr> A Git or GitHub <a href="Package_Concepts.html#%28tech._package._source%29" class="techoutside" data-pltdoc="x"><span class="techinside">package
source</span></a> is cloned as <span class="sroman">‹<span style="font-style: italic">dir</span>›</span> and locally linked as the
package implementation. See also <a href="git-workflow.html#%28part._clone-link%29" data-pltdoc="x">Linking a Git Checkout as a Clone</a>.</p><p>If no <span class="sroman">‹<span style="font-style: italic">pkg-source</span>›</span> is supplied, then the last path element
of <span class="sroman">‹<span style="font-style: italic">dir</span>›</span> is used as a package name and used as a
<span class="sroman">‹<span style="font-style: italic">pkg-source</span>›</span> argument.</p><p>Multiple <span class="sroman">‹<span style="font-style: italic">pkg-source</span>›</span>
arguments make sense only if they all specify the same Git
repository (with different paths into the repository). The
<span class="nobreak"><span class="stt">--clone</span></span> flag implies <span class="nobreak"><span class="stt">--type</span></span> in the sense that each
<span class="sroman">‹<span style="font-style: italic">pkg-source</span>›</span> must be either a Git or GitHub
<a href="Package_Concepts.html#%28tech._package._source%29" class="techoutside" data-pltdoc="x"><span class="techinside">package source</span></a> or a <a href="Package_Concepts.html#%28tech._package._name%29" class="techoutside" data-pltdoc="x"><span class="techinside">package name</span></a>, where a
<a href="Package_Concepts.html#%28tech._package._name%29" class="techoutside" data-pltdoc="x"><span class="techinside">package name</span></a> must be mapped by the <a href="Package_Concepts.html#%28tech._package._catalog%29" class="techoutside" data-pltdoc="x"><span class="techinside">package catalog</span></a> to a
Git or GitHub <a href="Package_Concepts.html#%28tech._package._source%29" class="techoutside" data-pltdoc="x"><span class="techinside">package source</span></a>.</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>.
See also <a href="strip.html" data-pltdoc="x">Source, Binary, and Built Packages</a>.</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>.
See also <a href="strip.html" data-pltdoc="x">Source, Binary, and Built Packages</a>.</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> Uses <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> Ignores any <span class="sroman">‹<span style="font-style: italic">pkg-source</span>›</span>
whose name corresponds to an already-installed package, except for promoting <a href="Package_Concepts.html#%28part._concept~3aauto%29" data-pltdoc="x">auto-installed</a>
packages to explicitly installed.</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">--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><div class="SIntrapara"><span class="nobreak"><span class="stt">--multi-clone</span></span> <span class="sroman">‹<span style="font-style: italic">mode</span>›</span> —<wbr></wbr> Specifies the handling
of packages that are from the same Git repository but are installed
with different clone-linking modes or different clone directories.
(See also <a href="git-workflow.html" data-pltdoc="x">Developing Packages with Git</a>.)
The following modes are available:
</div><div class="SIntrapara"><ul><li><p><span class="stt">convert</span> —<wbr></wbr> Converts non-clone-linked packages (either newly or previously installed)
to clone-linked packages, assuming that the packages that are clone-linked
all use the same clone directory. If clone-linked packages currently use
different clone directories, installation fails.</p></li><li><p><span class="stt">ask</span> —<wbr></wbr> In the case when packages can be converted, ask the user whether to convert
or allow the different clone-linking modes or clone directories. If converting
is not an option, the installation fails. This clone-handling mode is the default
in <a href="#%28tech._interactive._mode%29" class="techoutside" data-pltdoc="x"><span class="techinside">interactive mode</span></a>.</p></li><li><p><span class="stt">fail</span> —<wbr></wbr> Reports an error and cancels the installation (the default in non-<a href="#%28tech._interactive._mode%29" class="techoutside" data-pltdoc="x"><span class="techinside">interactive mode</span></a>).</p></li><li><p><span class="stt">force</span> —<wbr></wbr> Allows packages to have different clone-linking modes or clone directories.</p></li></ul></div></p></li><li><p><span class="nobreak"><span class="stt">--pull</span></span> <span class="sroman">‹<span style="font-style: italic">mode</span>›</span> —<wbr></wbr> Specifies the way that commits
are merged to clone-linked packages (see <a href="git-workflow.html" data-pltdoc="x">Developing Packages with Git</a>)
on installation or update. The following modes are available:</p><ul><li><p><span class="stt">ff-only</span> —<wbr></wbr> Commits are merged using <span class="nobreak"><span class="stt">--ff-only</span></span>, and installation fails
if the fast-forward merge fails.</p></li><li><p><span class="stt">try</span> —<wbr></wbr> Like <span class="stt">ff-only</span>, but if the fast-forward fails, the repository checkout is
left as-is, and installation continues.</p></li><li><p><span class="stt">rebase</span> —<wbr></wbr> Commits are merged using <span class="stt">git rebase</span> instead of <span class="stt">git merge</span>.</p></li></ul></li><li><p><span class="nobreak"><span class="stt">--dry-run</span></span> —<wbr></wbr> Prevents changes to the current installation. All installation and update work is
staged and checked, but the final installation step is skipped.</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> Installs and runs <span class="stt">raco setup</span> with <span class="sroman">‹<span style="font-style: italic">n</span>›</span> parallel jobs.</p></li><li><p><span class="nobreak"><span class="stt">--batch</span></span> —<wbr></wbr> Disables <a name="(tech._interactive._mode)"></a><span style="font-style: italic">interactive mode</span>, suppressing potential prompts for a user
(e.g., about package dependencies or clone sharing).</p></li><li><p><span class="nobreak"><span class="stt">--no-trash</span></span> —<wbr></wbr> Refrains from moving updated or removed packages to a trash folder.</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><p class="SHistory">Changed in version 6.1.1.5: Added the <span class="nobreak"><span class="stt">--batch</span></span>, <span class="nobreak"><span class="stt">--clone</span></span>, and
<span class="nobreak"><span class="stt">--multi-clone</span></span> flags. Changed in version 6.1.1.6: Added the <span class="nobreak"><span class="stt">--no-trash</span></span> flag, and changed
the <span class="nobreak"><span class="stt">--deps</span></span> default to depend only on interactive mode. Changed in version 6.1.1.8: Added the <span class="nobreak"><span class="stt">--pull</span></span> flag. Changed in version 6.4.0.14: Added the <span class="nobreak"><span class="stt">--dry-run</span></span> flag.</p><h4 x-source-module="(lib "pkg/scribblings/pkg.scrbl")" x-source-pkg="racket-doc" 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>The treatment of a <span class="sroman">‹<span style="font-style: italic">pkg-source</span>›</span> depends on the way that it parses:</p><ul><li><p>When a <span class="sroman">‹<span style="font-style: italic">pkg-source</span>›</span> parses as a <a href="Package_Concepts.html#%28tech._package._name%29" class="techoutside" data-pltdoc="x"><span class="techinside">package name</span></a>,
then the named package must be installed already, and it is
checked for updates. The <span class="nobreak"><span class="stt">--lookup</span></span> and <span class="nobreak"><span class="stt">--clone</span></span> flags
change this interpretation of <span class="sroman">‹<span style="font-style: italic">pkg-source</span>›</span>.</p></li><li><p>If <span class="sroman">‹<span style="font-style: italic">pkg-source</span>›</span> parses as a directory <a href="Package_Concepts.html#%28tech._package._source%29" class="techoutside" data-pltdoc="x"><span class="techinside">package
source</span></a>, and if the named package is installed as a link to a
<a href="git-workflow.html#%28part._clone-link%29" data-pltdoc="x">Git repository clone</a>, then the clone is checked for
updates. The <span class="nobreak"><span class="stt">--link</span></span>, <span class="nobreak"><span class="stt">--static-link</span></span>, and
<span class="nobreak"><span class="stt">--copy</span></span> flags change this interpretation of
<span class="sroman">‹<span style="font-style: italic">pkg-source</span>›</span>.</p></li><li><p>Otherwise, <span class="sroman">‹<span style="font-style: italic">pkg-source</span>›</span> specifies a <a href="Package_Concepts.html#%28tech._package._source%29" class="techoutside" data-pltdoc="x"><span class="techinside">package
source</span></a> to replace the current installation of the named package.</p></li></ul><p>If no <span class="sroman">‹<span style="font-style: italic">pkg-source</span>›</span>, <span class="nobreak"><span class="stt">--all</span></span> or <span class="nobreak"><span class="stt">-a</span></span> flag, or
<span class="nobreak"><span class="stt">--clone</span></span> flag is specified, and if the current directory is
within a package, then the enclosing package is updated. If no
<span class="sroman">‹<span style="font-style: italic">pkg-source</span>›</span> is specified, but <span class="nobreak"><span class="stt">--clone</span></span> is supplied, then
the clone directory’s name is used as the only <span class="sroman">‹<span style="font-style: italic">pkg-source</span>›</span>
argument.</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> Updates 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> 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 that is looked
up in a catalog, instead of the name of an installed package
that may have updates from its current source. (If the named
package was installed through a package name, then there’s
effectively no difference, unless a different catalog is
used.)</p><p>By default, if <span class="sroman">‹<span style="font-style: italic">pkg-source</span>›</span> refers to a package that is
currently linked as a <a href="git-workflow.html#%28part._clone-link%29" data-pltdoc="x">Git repository
clone</a>, then replacing the installation with a
catalog-specified source has the effect of removing the clone
link. However, the <span class="nobreak"><span class="stt">--lookup</span></span> flag can be combined with the
<span class="nobreak"><span class="stt">--clone</span></span> flag (assuming that the catalog maps the package
to a Git repository) so that the resulting installation is a
linked repository clone.</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>, but a
directory package source is treated as a link by default only
when it does not correspond to a link or a Git repository
clone.</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">--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">--clone</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>, except that a <span class="sroman">‹<span style="font-style: italic">pkg-source</span>›</span> as a
<a href="Package_Concepts.html#%28tech._package._name%29" class="techoutside" data-pltdoc="x"><span class="techinside">package name</span></a> is treated as the name of an installed
package (unless <span class="nobreak"><span class="stt">--lookup</span></span> is specified). In that case, the package must be currently installed
from a Git or GitHub source—<wbr></wbr>possibly as directed by a
catalog—<wbr></wbr>and that source is used for the clone (which replaces
the existing package installation).</p><p>To convert a clone-linked package to a normal installation, use
<a href="#%28part._raco-pkg-update%29" class="plainlink" data-pltdoc="x"><span class="stt">raco pkg update</span></a> either with the <span class="nobreak"><span class="stt">--lookup</span></span> flag or with
a replacement <a href="Package_Concepts.html#%28tech._package._source%29" class="techoutside" data-pltdoc="x"><span class="techinside">package source</span></a> that is not a package name.</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> 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">--skip-uninstalled</span></span> —<wbr></wbr> Ignores any <span class="sroman">‹<span style="font-style: italic">pkg-source</span>›</span> that does not correspond to an installed package.</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">--multi-clone</span></span> <span class="sroman">‹<span style="font-style: italic">mode</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 when
<span class="nobreak"><span class="stt">--lookup</span></span> is specified and <span class="nobreak"><span class="stt">--clone</span></span> is not specified, then conversion goes from
clone to non-clone linking—<wbr></wbr>but only for sharing differences implied by the immediate
command-line arguments compared against existing package installations.</p></li><li><p><span class="nobreak"><span class="stt">--pull</span></span> <span class="sroman">‹<span style="font-style: italic">mode</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">--dry-run</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><li><p><span class="nobreak"><span class="stt">--batch</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-trash</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"><p class="SHistory">Changed in version 6.1.1.5: Added the <span class="nobreak"><span class="stt">--batch</span></span>, <span class="nobreak"><span class="stt">--clone</span></span>, and
<span class="nobreak"><span class="stt">--multi-clone</span></span> flags, and
added update of enclosing package
when no arguments are provided. Changed in version 6.1.1.6: Added the <span class="nobreak"><span class="stt">--no-trash</span></span> flag, and changed
the <span class="nobreak"><span class="stt">--deps</span></span> default to depend only on interactive mode. Changed in version 6.1.1.8: Added the <span class="nobreak"><span class="stt">--skip-uninstalled</span></span> and <span class="nobreak"><span class="stt">--pull</span></span> flags.</p></div><div class="SIntrapara">#:changed "6.4.0.14" Added the <span class="nobreak"><span class="stt">--dry-run</span></span> flag.</div></p><h4 x-source-module="(lib "pkg/scribblings/pkg.scrbl")" x-source-pkg="racket-doc" 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> “Removes” explicitly installed packages by demoting them to <a href="Package_Concepts.html#%28part._concept~3aauto%29" data-pltdoc="x">auto-installed</a>
(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> Ignores 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>,
removes <a href="Package_Concepts.html#%28part._concept~3aauto%29" data-pltdoc="x">auto-installed</a> 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">--dry-run</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><li><p><span class="nobreak"><span class="stt">--batch</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-trash</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 class="SHistory">Changed in version 6.1.1.5: Added the <span class="nobreak"><span class="stt">--batch</span></span> flag. Changed in version 6.1.1.6: Added the <span class="nobreak"><span class="stt">--no-trash</span></span> flag. Changed in version 6.4.0.14: Added the <span class="nobreak"><span class="stt">--dry-run</span></span> flag.</p><h4 x-source-module="(lib "pkg/scribblings/pkg.scrbl")" x-source-pkg="racket-doc" x-part-tag=""raco-pkg-new"">3.4<tt> </tt><a name="(part._raco-pkg-new)"></a><span class="stt">raco pkg new</span></h4><p><a href="#%28part._raco-pkg-new%29" class="plainlink" data-pltdoc="x"><span class="stt">raco pkg new</span></a> <span class="sroman">‹<span style="font-style: italic">pkg</span>›</span> —<wbr></wbr>
Populates a directory with the stubs for a new package, where
<span class="sroman">‹<span style="font-style: italic">pkg</span>›</span> is the name of the new package.
If <span class="sroman">‹<span style="font-style: italic">pkg</span>›</span> already exists as a directory in the current directory, no new
package is created.</p><p class="SHistory">Added in version 6.1.1.5.</p><h4 x-source-module="(lib "pkg/scribblings/pkg.scrbl")" x-source-pkg="racket-doc" x-part-tag=""raco-pkg-show"">3.5<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> ... <span class="sroman">‹<span style="font-style: italic">pkg</span>›</span> ... —<wbr></wbr> Prints information about currently installed packages.</p><p>If <span class="sroman">‹<span style="font-style: italic">pkg</span>›</span>s are specified, then only those packages are shown.
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 <a href="Package_Concepts.html#%28part._concept~3aauto%29" data-pltdoc="x">auto-installed</a>. If a package is
explicitly specified, it is shown even if it is marked as
auto-installed. Unless <span class="nobreak"><span class="stt">-l</span></span> or <span class="nobreak"><span class="stt">--long</span></span> is specified,
the output is roughly constrained to 80 columns or the number of columns specified by the <span class="stt">COLUMNS</span>
environment variable. Unless <span class="nobreak"><span class="stt">--full-checksum</span></span> is specified,
checksums are abbreviated to 8 characters.</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 <a href="Package_Concepts.html#%28part._concept~3aauto%29" data-pltdoc="x">auto-installed</a> packages in the listing.</p></li><li><p><span class="nobreak"><span class="stt">-l</span></span> or <span class="nobreak"><span class="stt">--long</span></span> —<wbr></wbr> Shows complete columns, instead of abbreviating to a width,
and use a more regular (but less
human-readable) format for some columns.</p></li><li><p><span class="nobreak"><span class="stt">--rx</span></span> —<wbr></wbr> Treats the <span class="sroman">‹<span style="font-style: italic">pkg</span>›</span>s as regular expressions
for displaying specific packages.</p></li><li><p><span class="nobreak"><span class="stt">--full-checksum</span></span> —<wbr></wbr> Prints the full instead of the
abbreviated checksum.</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 to show 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><p class="SHistory">Changed in version 6.1.1.5: Added <span class="nobreak"><span class="stt">-l</span></span>/<span class="nobreak"><span class="stt">--long</span></span> and
<span class="stt">COLUMNS</span> support. Changed in version 6.1.1.6: Added explicit <span class="sroman">‹<span style="font-style: italic">pkg</span>›</span>s and
<span class="nobreak"><span class="stt">--rx</span></span> and <span class="nobreak"><span class="stt">--full-sha</span></span>.</p><h4 x-source-module="(lib "pkg/scribblings/pkg.scrbl")" x-source-pkg="racket-doc" x-part-tag=""raco-pkg-migrate"">3.6<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">--dry-run</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><p class="SHistory">Changed in version 6.4.0.14: Added the <span class="nobreak"><span class="stt">--dry-run</span></span> flag.</p><h4 x-source-module="(lib "pkg/scribblings/pkg.scrbl")" x-source-pkg="racket-doc" x-part-tag=""raco-pkg-create"">3.7<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
Git 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> Treats <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> Treats <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> Bundles 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> Bundles 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> Bundles 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> Bundles 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-source-pkg="racket-doc" x-part-tag=""raco-pkg-config"">3.8<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>
Views and modifies 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 and corresponding <span class="sroman">‹<span style="font-style: italic">val</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>. An empty-string
<span class="sroman">‹<span style="font-style: italic">val</span>›</span> is replaced by the sequence of catalogs for the default configuration.
A <span class="sroman">‹<span style="font-style: italic">val</span>›</span> that does not start with alphabetic characters followed by <span class="RktInBG"><span class="hspace"></span><span class="RktIn">://</span><span class="hspace"></span></span>
is treated as a path relative to the configuration directory (as
reported by <span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=raco&rel=dirs.html%23%2528def._%2528%2528lib._setup%252Fdirs..rkt%2529._find-config-dir%2529%2529&version=6.7" class="RktValLink Sq" data-pltdoc="x">find-config-dir</a></span>).</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><li><p><span class="stt">git-checkout-credentials</span> —<wbr></wbr> A list that starts with a format
specification (currently only <span class="RktVal">'</span><span class="RktVal">basic</span> is supported), followed
by git credentials in the form <span class="sroman">‹<span style="font-style: italic">username</span>›</span><span class="RktInBG"><span class="hspace"></span><span class="RktIn">:</span><span class="hspace"></span></span><span class="sroman">‹<span style="font-style: italic">password</span>›</span>
that are tried when downloading packages with git sources using the
HTTP or HTTPS protocols. The credentials are currently stored
<span style="font-weight: bold">unencrypted</span> on the filesystem.</p></li><li><p><span class="stt">trash-max-packages</span> —<wbr></wbr> A limit on the number of package implementations
that are kept in a trash folder when the package is removed or updated.</p></li><li><p><span class="stt">trash-max-seconds</span> —<wbr></wbr> A limit on the time since a package is removed or
updated that its implementation is kept in the trash folder. Package implementations are
removed from a trash folder only when another package is potentially added
to the trash folder or <a href="#%28part._raco-pkg-empty-trash%29" class="plainlink" data-pltdoc="x"><span class="stt">raco pkg empty-trash</span></a> is used.</p></li><li><p><span class="stt">network-retries</span> —<wbr></wbr> The number of times to retry a network communication that
fails due to a connection error.</p></li></ul></div></p><p class="SHistory">Changed in version 6.1.1.6: Added <span class="stt">trash-max-packages</span> and <span class="stt">trash-max-seconds</span>. Changed in version 6.3: Added <span class="stt">network-retries</span>. Changed in version 6.6.0.5: Added <span class="stt">git-checkout-credentials</span>.</p><h4 x-source-module="(lib "pkg/scribblings/pkg.scrbl")" x-source-pkg="racket-doc" x-part-tag=""raco-pkg-catalog-show"">3.9<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> Shows 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> Shows 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> Shows 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> Queries <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> Queries 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-source-pkg="racket-doc" x-part-tag=""raco-pkg-catalog-copy"">3.10<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> Writes 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> Copies 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-source-pkg="racket-doc" x-part-tag=""raco-pkg-catalog-archive"">3.11<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> Writes 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> Copies 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><li><p><div class="SIntrapara"><span class="nobreak"><span class="stt">--pkg-fail</span></span> <span class="sroman">‹<span style="font-style: italic">mode</span>›</span> —<wbr></wbr> Determines handling of failure for an individual
package, such as when a <span class="sroman">‹<span style="font-style: italic">src-catalog</span>›</span> contains a bad package source. The
following <span class="sroman">‹<span style="font-style: italic">mode</span>›</span>s are available:
</div><div class="SIntrapara"><ul><li><p><span class="stt">fail</span> (the default) —<wbr></wbr> archiving stops and fails;</p></li><li><p><span class="stt">skip</span> —<wbr></wbr> the package is skipped and omitted from the archive catalog; or</p></li><li><p><span class="stt">continue</span> —<wbr></wbr> like <span class="stt">skip</span>, but <span class="stt">raco pkg catalog-archive</span>
exits with a status code of <span class="stt">5</span> if any package was skipped.</p></li></ul></div></p></li></ul><p class="SHistory">Added in version 6.0.17.</p><h4 x-source-module="(lib "pkg/scribblings/pkg.scrbl")" x-source-pkg="racket-doc" x-part-tag=""raco-pkg-archive"">3.12<tt> </tt><a name="(part._raco-pkg-archive)"></a><span class="stt">raco pkg archive</span></h4><p><a href="#%28part._raco-pkg-archive%29" class="plainlink" data-pltdoc="x"><span class="stt">raco pkg 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">pkg</span>›</span> ...
—<wbr></wbr> Copies information from installed packages named by <span class="sroman">‹<span style="font-style: italic">pkgs</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 copied 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">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">--include-deps</span></span> —<wbr></wbr> Includes the dependencies of the specified packages
in the resulting catalog.</p></li><li><p><span class="nobreak"><span class="stt">--exclude</span></span> <span class="sroman">‹<span style="font-style: italic">pkg</span>›</span> —<wbr></wbr> Omits the specified <span class="sroman">‹<span style="font-style: italic">pkg</span>›</span> from the
resulting catalog. This also causes the dependencies of <span class="sroman">‹<span style="font-style: italic">pkg</span>›</span> to be
omitted if <span class="nobreak"><span class="stt">--include-deps</span></span> is specified. This flag can be provided multiple times.</p></li><li><p><span class="nobreak"><span class="stt">--relative</span></span> —<wbr></wbr> Writes package sources to <span class="sroman">‹<span style="font-style: italic">dest-catalog</span>›</span> in relative-path form.</p></li></ul><p class="SHistory">Added in version 6.1.0.8.</p><h4 x-source-module="(lib "pkg/scribblings/pkg.scrbl")" x-source-pkg="racket-doc" x-part-tag=""raco-pkg-empty-trash"">3.13<tt> </tt><a name="(part._raco-pkg-empty-trash)"></a><span class="stt">raco pkg empty-trash</span></h4><p><a href="#%28part._raco-pkg-empty-trash%29" class="plainlink" data-pltdoc="x"><span class="stt">raco pkg empty-trash</span></a> <span class="sroman">‹<span style="font-style: italic">option</span>›</span> ...
—<wbr></wbr> Removes or lists package implementations that were previously removed or updated and
are currently in the trash directory
for the specified <a href="Package_Concepts.html#%28tech._package._scope%29" class="techoutside" data-pltdoc="x"><span class="techinside">package scope</span></a>. The <span class="stt">trash-max-packages</span> and
<span class="stt">trash-max-seconds</span> configuration keys (see <a href="#%28part._raco-pkg-config%29" class="plainlink" data-pltdoc="x"><span class="stt">raco pkg config</span></a>) control
how many packages are kept in the trash directory and for how long.</p><p>The <span class="stt">empty-trash</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">--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> 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">--list</span></span> or <span class="nobreak"><span class="stt">-l</span></span> —<wbr></wbr> Shows the trash directory path and its content, instead of
removing the current content.</p></li></ul><p class="SHistory">Added in version 6.1.1.6.</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="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>
|