MAN page from OpenSuSE cargo-1.53.0-lp152.3.11.1.x86_64.rpm
CARGO\-CLEAN
Section: Misc. Reference Manual Pages (1)
Index NAME
cargo-clean - Remove generated artifacts
SYNOPSIS
cargo clean [
options]
DESCRIPTION
Remove artifacts from the target directory that Cargo has generated in thepast.
With no options, cargo clean will delete the entire target directory.
OPTIONS
Package Selection
When no packages are selected, all packages and all dependencies in theworkspace are cleaned.
-p spec..., --package spec...
- Clean only the specified packages. This flag may be specifiedmultiple times. See cargo-pkgid(1) for the SPEC format.
Clean Options
--doc
- This option will cause cargo clean to remove only the doc directory inthe target directory.
--release
- Clean all artifacts that were built with the release or bench profiles.
--target-dir directory
- Directory for all generated artifacts and intermediate files. May also bespecified with the CARGO_TARGET_DIR environment variable, or thebuild.target-dir config value <https://doc.rust-lang.org/cargo/reference/config.html>.Defaults to target in the root of the workspace.
--target triple
- Clean for the given architecture. The default is the hostarchitecture. The general format of the triple is<arch><sub>-<vendor>-<sys>-<abi>. Run rustc --print target-list for alist of supported targets.
This may also be specified with the build.targetconfig value <https://doc.rust-lang.org/cargo/reference/config.html>.
Note that specifying this flag makes Cargo run in a different mode where thetarget artifacts are placed in a separate directory. See thebuild cache <https://doc.rust-lang.org/cargo/guide/build-cache.html> documentation for more details.
Display Options
-v, --verbose
- Use verbose output. May be specified twice for "very verbose" output whichincludes extra output such as dependency warnings and build script output.May also be specified with the term.verboseconfig value <https://doc.rust-lang.org/cargo/reference/config.html>.
-q, --quiet
- No output printed to stdout.
--color when
- Control when colored output is used. Valid values:
- *auto (default): Automatically detect if color support is available on theterminal.
- *always: Always display colors.
- *never: Never display colors.
May also be specified with the term.colorconfig value <https://doc.rust-lang.org/cargo/reference/config.html>.
Manifest Options
--manifest-path path
- Path to the Cargo.toml file. By default, Cargo searches for theCargo.toml file in the current directory or any parent directory.
--frozen, --locked
- Either of these flags requires that the Cargo.lock file isup-to-date. If the lock file is missing, or it needs to be updated, Cargo willexit with an error. The --frozen flag also prevents Cargo fromattempting to access the network to determine if it is out-of-date.
These may be used in environments where you want to assert that theCargo.lock file is up-to-date (such as a CI build) or want to avoid networkaccess.
--offline
- Prevents Cargo from accessing the network for any reason. Without thisflag, Cargo will stop with an error if it needs to access the network andthe network is not available. With this flag, Cargo will attempt toproceed without the network if possible.
Beware that this may result in different dependency resolution than onlinemode. Cargo will restrict itself to crates that are downloaded locally, evenif there might be a newer version as indicated in the local copy of the index.See the cargo-fetch(1) command to download dependencies before goingoffline.
May also be specified with the net.offline config value <https://doc.rust-lang.org/cargo/reference/config.html>.
Common Options
+toolchain
- If Cargo has been installed with rustup, and the first argument to cargobegins with +, it will be interpreted as a rustup toolchain name (suchas +stable or +nightly).See the rustup documentation <https://rust-lang.github.io/rustup/overrides.html>for more information about how toolchain overrides work.
-h, --help
- Prints help information.
-Z flag
- Unstable (nightly-only) flags to Cargo. Run cargo -Z help for details.
ENVIRONMENT
See
the reference <
https://doc.rust-lang.org/cargo/reference/environment-variables.html> fordetails on environment variables that Cargo reads.
EXIT STATUS
- *0: Cargo succeeded.
- *101: Cargo failed to complete.
EXAMPLES
- 1.Remove the entire target directory:
cargo clean
- 2.Remove only the release artifacts:
cargo clean --release
SEE ALSO
cargo(1),
cargo-build(1)
Index
- NAME
- SYNOPSIS
- DESCRIPTION
- OPTIONS
- Package Selection
- Clean Options
- Display Options
- Manifest Options
- Common Options
- ENVIRONMENT
- EXIT STATUS
- EXAMPLES
- SEE ALSO
This document was created byman2html,using the manual pages.