mirror of https://github.com/rust-lang/cargo
233 lines
7.0 KiB
Groff
233 lines
7.0 KiB
Groff
'\" t
|
|
.TH "CARGO\-CLEAN" "1"
|
|
.nh
|
|
.ad l
|
|
.ss \n[.ss] 0
|
|
.SH "NAME"
|
|
cargo\-clean \[em] Remove generated artifacts
|
|
.SH "SYNOPSIS"
|
|
\fBcargo clean\fR [\fIoptions\fR]
|
|
.SH "DESCRIPTION"
|
|
Remove artifacts from the target directory that Cargo has generated in the
|
|
past.
|
|
.sp
|
|
With no options, \fBcargo clean\fR will delete the entire target directory.
|
|
.SH "OPTIONS"
|
|
.SS "Package Selection"
|
|
When no packages are selected, all packages and all dependencies in the
|
|
workspace are cleaned.
|
|
.sp
|
|
\fB\-p\fR \fIspec\fR\[u2026],
|
|
\fB\-\-package\fR \fIspec\fR\[u2026]
|
|
.RS 4
|
|
Clean only the specified packages. This flag may be specified
|
|
multiple times. See \fBcargo\-pkgid\fR(1) for the SPEC format.
|
|
.RE
|
|
.SS "Clean Options"
|
|
.sp
|
|
\fB\-\-dry\-run\fR
|
|
.RS 4
|
|
Displays a summary of what would be deleted without deleting anything.
|
|
Use with \fB\-\-verbose\fR to display the actual files that would be deleted.
|
|
.RE
|
|
.sp
|
|
\fB\-\-doc\fR
|
|
.RS 4
|
|
This option will cause \fBcargo clean\fR to remove only the \fBdoc\fR directory in
|
|
the target directory.
|
|
.RE
|
|
.sp
|
|
\fB\-\-release\fR
|
|
.RS 4
|
|
Remove all artifacts in the \fBrelease\fR directory.
|
|
.RE
|
|
.sp
|
|
\fB\-\-profile\fR \fIname\fR
|
|
.RS 4
|
|
Remove all artifacts in the directory with the given profile name.
|
|
.RE
|
|
.sp
|
|
\fB\-\-target\-dir\fR \fIdirectory\fR
|
|
.RS 4
|
|
Directory for all generated artifacts and intermediate files. May also be
|
|
specified with the \fBCARGO_TARGET_DIR\fR environment variable, or the
|
|
\fBbuild.target\-dir\fR \fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
|
Defaults to \fBtarget\fR in the root of the workspace.
|
|
.RE
|
|
.sp
|
|
\fB\-\-target\fR \fItriple\fR
|
|
.RS 4
|
|
Clean for the given architecture. The default is the host architecture. The general format of the triple is
|
|
\fB<arch><sub>\-<vendor>\-<sys>\-<abi>\fR\&. Run \fBrustc \-\-print target\-list\fR for a
|
|
list of supported targets. This flag may be specified multiple times.
|
|
.sp
|
|
This may also be specified with the \fBbuild.target\fR
|
|
\fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
|
.sp
|
|
Note that specifying this flag makes Cargo run in a different mode where the
|
|
target artifacts are placed in a separate directory. See the
|
|
\fIbuild cache\fR <https://doc.rust\-lang.org/cargo/guide/build\-cache.html> documentation for more details.
|
|
.RE
|
|
.SS "Display Options"
|
|
.sp
|
|
\fB\-v\fR,
|
|
\fB\-\-verbose\fR
|
|
.RS 4
|
|
Use verbose output. May be specified twice for \[lq]very verbose\[rq] output which
|
|
includes extra output such as dependency warnings and build script output.
|
|
May also be specified with the \fBterm.verbose\fR
|
|
\fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
|
.RE
|
|
.sp
|
|
\fB\-q\fR,
|
|
\fB\-\-quiet\fR
|
|
.RS 4
|
|
Do not print cargo log messages.
|
|
May also be specified with the \fBterm.quiet\fR
|
|
\fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
|
.RE
|
|
.sp
|
|
\fB\-\-color\fR \fIwhen\fR
|
|
.RS 4
|
|
Control when colored output is used. Valid values:
|
|
.sp
|
|
.RS 4
|
|
\h'-04'\(bu\h'+02'\fBauto\fR (default): Automatically detect if color support is available on the
|
|
terminal.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
\h'-04'\(bu\h'+02'\fBalways\fR: Always display colors.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
\h'-04'\(bu\h'+02'\fBnever\fR: Never display colors.
|
|
.RE
|
|
.sp
|
|
May also be specified with the \fBterm.color\fR
|
|
\fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
|
.RE
|
|
.SS "Manifest Options"
|
|
.sp
|
|
\fB\-\-manifest\-path\fR \fIpath\fR
|
|
.RS 4
|
|
Path to the \fBCargo.toml\fR file. By default, Cargo searches for the
|
|
\fBCargo.toml\fR file in the current directory or any parent directory.
|
|
.RE
|
|
.sp
|
|
\fB\-\-locked\fR
|
|
.RS 4
|
|
Ensures that Cargo uses the exact version of every dependency captured in the
|
|
existing \fBCargo.lock\fR file. Cargo will exit with an error when either of the
|
|
following scenarios arises:
|
|
.sp
|
|
.RS 4
|
|
\h'-04'\(bu\h'+02'The lock file is missing.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
\h'-04'\(bu\h'+02'The dependency resolution has changed, often caused by modifying dependencies
|
|
in the \fBCargo.toml\fR file.
|
|
.RE
|
|
.sp
|
|
It may be used in environments where you want to assert that the \fBCargo.lock\fR
|
|
file is up\-to\-date for reproducibility reasons, such as in a CI build.
|
|
.RE
|
|
.sp
|
|
\fB\-\-offline\fR
|
|
.RS 4
|
|
Prevents Cargo from accessing the network for any reason. Without this
|
|
flag, Cargo will stop with an error if it needs to access the network and
|
|
the network is not available. With this flag, Cargo will attempt to
|
|
proceed without the network if possible.
|
|
.sp
|
|
Beware that this may result in different dependency resolution than online
|
|
mode. Cargo will restrict itself to crates that are downloaded locally, even
|
|
if there might be a newer version as indicated in the local copy of the index.
|
|
See the \fBcargo\-fetch\fR(1) command to download dependencies before going
|
|
offline.
|
|
.sp
|
|
May also be specified with the \fBnet.offline\fR \fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
|
.RE
|
|
.sp
|
|
\fB\-\-frozen\fR
|
|
.RS 4
|
|
Equivalent to specifying both \fB\-\-locked\fR and \fB\-\-offline\fR\&.
|
|
.RE
|
|
.SS "Common Options"
|
|
.sp
|
|
\fB+\fR\fItoolchain\fR
|
|
.RS 4
|
|
If Cargo has been installed with rustup, and the first argument to \fBcargo\fR
|
|
begins with \fB+\fR, it will be interpreted as a rustup toolchain name (such
|
|
as \fB+stable\fR or \fB+nightly\fR).
|
|
See the \fIrustup documentation\fR <https://rust\-lang.github.io/rustup/overrides.html>
|
|
for more information about how toolchain overrides work.
|
|
.RE
|
|
.sp
|
|
\fB\-\-config\fR \fIKEY=VALUE\fR or \fIPATH\fR
|
|
.RS 4
|
|
Overrides a Cargo configuration value. The argument should be in TOML syntax of \fBKEY=VALUE\fR,
|
|
or provided as a path to an extra configuration file. This flag may be specified multiple times.
|
|
See the \fIcommand\-line overrides section\fR <https://doc.rust\-lang.org/cargo/reference/config.html#command\-line\-overrides> for more information.
|
|
.RE
|
|
.sp
|
|
\fB\-C\fR \fIPATH\fR
|
|
.RS 4
|
|
Changes the current working directory before executing any specified operations. This affects
|
|
things like where cargo looks by default for the project manifest (\fBCargo.toml\fR), as well as
|
|
the directories searched for discovering \fB\&.cargo/config.toml\fR, for example. This option must
|
|
appear before the command name, for example \fBcargo \-C path/to/my\-project build\fR\&.
|
|
.sp
|
|
This option is only available on the \fInightly
|
|
channel\fR <https://doc.rust\-lang.org/book/appendix\-07\-nightly\-rust.html> and
|
|
requires the \fB\-Z unstable\-options\fR flag to enable (see
|
|
\fI#10098\fR <https://github.com/rust\-lang/cargo/issues/10098>).
|
|
.RE
|
|
.sp
|
|
\fB\-h\fR,
|
|
\fB\-\-help\fR
|
|
.RS 4
|
|
Prints help information.
|
|
.RE
|
|
.sp
|
|
\fB\-Z\fR \fIflag\fR
|
|
.RS 4
|
|
Unstable (nightly\-only) flags to Cargo. Run \fBcargo \-Z help\fR for details.
|
|
.RE
|
|
.SH "ENVIRONMENT"
|
|
See \fIthe reference\fR <https://doc.rust\-lang.org/cargo/reference/environment\-variables.html> for
|
|
details on environment variables that Cargo reads.
|
|
.SH "EXIT STATUS"
|
|
.sp
|
|
.RS 4
|
|
\h'-04'\(bu\h'+02'\fB0\fR: Cargo succeeded.
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
\h'-04'\(bu\h'+02'\fB101\fR: Cargo failed to complete.
|
|
.RE
|
|
.SH "EXAMPLES"
|
|
.sp
|
|
.RS 4
|
|
\h'-04' 1.\h'+01'Remove the entire target directory:
|
|
.sp
|
|
.RS 4
|
|
.nf
|
|
cargo clean
|
|
.fi
|
|
.RE
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
\h'-04' 2.\h'+01'Remove only the release artifacts:
|
|
.sp
|
|
.RS 4
|
|
.nf
|
|
cargo clean \-\-release
|
|
.fi
|
|
.RE
|
|
.RE
|
|
.SH "SEE ALSO"
|
|
\fBcargo\fR(1), \fBcargo\-build\fR(1)
|