diff options
Diffstat (limited to 'src/doc/src/commands/cargo.md')
-rw-r--r-- | src/doc/src/commands/cargo.md | 331 |
1 files changed, 331 insertions, 0 deletions
diff --git a/src/doc/src/commands/cargo.md b/src/doc/src/commands/cargo.md new file mode 100644 index 0000000..716cd65 --- /dev/null +++ b/src/doc/src/commands/cargo.md @@ -0,0 +1,331 @@ +# cargo(1) + +## NAME + +cargo --- The Rust package manager + +## SYNOPSIS + +`cargo` [_options_] _command_ [_args_]\ +`cargo` [_options_] `--version`\ +`cargo` [_options_] `--list`\ +`cargo` [_options_] `--help`\ +`cargo` [_options_] `--explain` _code_ + +## DESCRIPTION + +This program is a package manager and build tool for the Rust language, +available at <https://rust-lang.org>. + +## COMMANDS + +### Build Commands + +[cargo-bench(1)](cargo-bench.html)\ + Execute benchmarks of a package. + +[cargo-build(1)](cargo-build.html)\ + Compile a package. + +[cargo-check(1)](cargo-check.html)\ + Check a local package and all of its dependencies for errors. + +[cargo-clean(1)](cargo-clean.html)\ + Remove artifacts that Cargo has generated in the past. + +[cargo-doc(1)](cargo-doc.html)\ + Build a package's documentation. + +[cargo-fetch(1)](cargo-fetch.html)\ + Fetch dependencies of a package from the network. + +[cargo-fix(1)](cargo-fix.html)\ + Automatically fix lint warnings reported by rustc. + +[cargo-run(1)](cargo-run.html)\ + Run a binary or example of the local package. + +[cargo-rustc(1)](cargo-rustc.html)\ + Compile a package, and pass extra options to the compiler. + +[cargo-rustdoc(1)](cargo-rustdoc.html)\ + Build a package's documentation, using specified custom flags. + +[cargo-test(1)](cargo-test.html)\ + Execute unit and integration tests of a package. + +### Manifest Commands + +[cargo-generate-lockfile(1)](cargo-generate-lockfile.html)\ + Generate `Cargo.lock` for a project. + +[cargo-locate-project(1)](cargo-locate-project.html)\ + Print a JSON representation of a `Cargo.toml` file's location. + +[cargo-metadata(1)](cargo-metadata.html)\ + Output the resolved dependencies of a package in machine-readable format. + +[cargo-pkgid(1)](cargo-pkgid.html)\ + Print a fully qualified package specification. + +[cargo-tree(1)](cargo-tree.html)\ + Display a tree visualization of a dependency graph. + +[cargo-update(1)](cargo-update.html)\ + Update dependencies as recorded in the local lock file. + +[cargo-vendor(1)](cargo-vendor.html)\ + Vendor all dependencies locally. + +[cargo-verify-project(1)](cargo-verify-project.html)\ + Check correctness of crate manifest. + +### Package Commands + +[cargo-init(1)](cargo-init.html)\ + Create a new Cargo package in an existing directory. + +[cargo-install(1)](cargo-install.html)\ + Build and install a Rust binary. + +[cargo-new(1)](cargo-new.html)\ + Create a new Cargo package. + +[cargo-search(1)](cargo-search.html)\ + Search packages in crates.io. + +[cargo-uninstall(1)](cargo-uninstall.html)\ + Remove a Rust binary. + +### Publishing Commands + +[cargo-login(1)](cargo-login.html)\ + Save an API token from the registry locally. + +[cargo-owner(1)](cargo-owner.html)\ + Manage the owners of a crate on the registry. + +[cargo-package(1)](cargo-package.html)\ + Assemble the local package into a distributable tarball. + +[cargo-publish(1)](cargo-publish.html)\ + Upload a package to the registry. + +[cargo-yank(1)](cargo-yank.html)\ + Remove a pushed crate from the index. + +### General Commands + +[cargo-help(1)](cargo-help.html)\ + Display help information about Cargo. + +[cargo-version(1)](cargo-version.html)\ + Show version information. + +## OPTIONS + +### Special Options + +<dl> + +<dt class="option-term" id="option-cargo--V"><a class="option-anchor" href="#option-cargo--V"></a><code>-V</code></dt> +<dt class="option-term" id="option-cargo---version"><a class="option-anchor" href="#option-cargo---version"></a><code>--version</code></dt> +<dd class="option-desc">Print version info and exit. If used with <code>--verbose</code>, prints extra +information.</dd> + + +<dt class="option-term" id="option-cargo---list"><a class="option-anchor" href="#option-cargo---list"></a><code>--list</code></dt> +<dd class="option-desc">List all installed Cargo subcommands. If used with <code>--verbose</code>, prints extra +information.</dd> + + +<dt class="option-term" id="option-cargo---explain"><a class="option-anchor" href="#option-cargo---explain"></a><code>--explain</code> <em>code</em></dt> +<dd class="option-desc">Run <code>rustc --explain CODE</code> which will print out a detailed explanation of an +error message (for example, <code>E0004</code>).</dd> + + +</dl> + +### Display Options + +<dl> + +<dt class="option-term" id="option-cargo--v"><a class="option-anchor" href="#option-cargo--v"></a><code>-v</code></dt> +<dt class="option-term" id="option-cargo---verbose"><a class="option-anchor" href="#option-cargo---verbose"></a><code>--verbose</code></dt> +<dd class="option-desc">Use verbose output. May be specified twice for “very verbose” output which +includes extra output such as dependency warnings and build script output. +May also be specified with the <code>term.verbose</code> +<a href="../reference/config.html">config value</a>.</dd> + + +<dt class="option-term" id="option-cargo--q"><a class="option-anchor" href="#option-cargo--q"></a><code>-q</code></dt> +<dt class="option-term" id="option-cargo---quiet"><a class="option-anchor" href="#option-cargo---quiet"></a><code>--quiet</code></dt> +<dd class="option-desc">Do not print cargo log messages. +May also be specified with the <code>term.quiet</code> +<a href="../reference/config.html">config value</a>.</dd> + + +<dt class="option-term" id="option-cargo---color"><a class="option-anchor" href="#option-cargo---color"></a><code>--color</code> <em>when</em></dt> +<dd class="option-desc">Control when colored output is used. Valid values:</p> +<ul> +<li><code>auto</code> (default): Automatically detect if color support is available on the +terminal.</li> +<li><code>always</code>: Always display colors.</li> +<li><code>never</code>: Never display colors.</li> +</ul> +<p>May also be specified with the <code>term.color</code> +<a href="../reference/config.html">config value</a>.</dd> + + + +</dl> + +### Manifest Options + +<dl> +<dt class="option-term" id="option-cargo---frozen"><a class="option-anchor" href="#option-cargo---frozen"></a><code>--frozen</code></dt> +<dt class="option-term" id="option-cargo---locked"><a class="option-anchor" href="#option-cargo---locked"></a><code>--locked</code></dt> +<dd class="option-desc">Either of these flags requires that the <code>Cargo.lock</code> file is +up-to-date. If the lock file is missing, or it needs to be updated, Cargo will +exit with an error. The <code>--frozen</code> flag also prevents Cargo from +attempting to access the network to determine if it is out-of-date.</p> +<p>These may be used in environments where you want to assert that the +<code>Cargo.lock</code> file is up-to-date (such as a CI build) or want to avoid network +access.</dd> + + +<dt class="option-term" id="option-cargo---offline"><a class="option-anchor" href="#option-cargo---offline"></a><code>--offline</code></dt> +<dd class="option-desc">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.</p> +<p>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 <a href="cargo-fetch.html">cargo-fetch(1)</a> command to download dependencies before going +offline.</p> +<p>May also be specified with the <code>net.offline</code> <a href="../reference/config.html">config value</a>.</dd> + + +</dl> + +### Common Options + +<dl> + +<dt class="option-term" id="option-cargo-+toolchain"><a class="option-anchor" href="#option-cargo-+toolchain"></a><code>+</code><em>toolchain</em></dt> +<dd class="option-desc">If Cargo has been installed with rustup, and the first argument to <code>cargo</code> +begins with <code>+</code>, it will be interpreted as a rustup toolchain name (such +as <code>+stable</code> or <code>+nightly</code>). +See the <a href="https://rust-lang.github.io/rustup/overrides.html">rustup documentation</a> +for more information about how toolchain overrides work.</dd> + + +<dt class="option-term" id="option-cargo---config"><a class="option-anchor" href="#option-cargo---config"></a><code>--config</code> <em>KEY=VALUE</em> or <em>PATH</em></dt> +<dd class="option-desc">Overrides a Cargo configuration value. The argument should be in TOML syntax of <code>KEY=VALUE</code>, +or provided as a path to an extra configuration file. This flag may be specified multiple times. +See the <a href="../reference/config.html#command-line-overrides">command-line overrides section</a> for more information.</dd> + + +<dt class="option-term" id="option-cargo--C"><a class="option-anchor" href="#option-cargo--C"></a><code>-C</code> <em>PATH</em></dt> +<dd class="option-desc">Changes the current working directory before executing any specified operations. This affects +things like where cargo looks by default for the project manifest (<code>Cargo.toml</code>), as well as +the directories searched for discovering <code>.cargo/config.toml</code>, for example.</p> +<p>This option is only available on the <a href="https://doc.rust-lang.org/book/appendix-07-nightly-rust.html">nightly +channel</a> and +requires the <code>-Z unstable-options</code> flag to enable (see +<a href="https://github.com/rust-lang/cargo/issues/10098">#10098</a>).</dd> + + +<dt class="option-term" id="option-cargo--h"><a class="option-anchor" href="#option-cargo--h"></a><code>-h</code></dt> +<dt class="option-term" id="option-cargo---help"><a class="option-anchor" href="#option-cargo---help"></a><code>--help</code></dt> +<dd class="option-desc">Prints help information.</dd> + + +<dt class="option-term" id="option-cargo--Z"><a class="option-anchor" href="#option-cargo--Z"></a><code>-Z</code> <em>flag</em></dt> +<dd class="option-desc">Unstable (nightly-only) flags to Cargo. Run <code>cargo -Z help</code> for details.</dd> + + +</dl> + + +## ENVIRONMENT + +See [the reference](../reference/environment-variables.html) for +details on environment variables that Cargo reads. + + +## EXIT STATUS + +* `0`: Cargo succeeded. +* `101`: Cargo failed to complete. + + +## FILES + +`~/.cargo/`\ + Default location for Cargo's "home" directory where it +stores various files. The location can be changed with the `CARGO_HOME` +environment variable. + +`$CARGO_HOME/bin/`\ + Binaries installed by [cargo-install(1)](cargo-install.html) will be located here. If using +[rustup], executables distributed with Rust are also located here. + +`$CARGO_HOME/config.toml`\ + The global configuration file. See [the reference](../reference/config.html) +for more information about configuration files. + +`.cargo/config.toml`\ + Cargo automatically searches for a file named `.cargo/config.toml` in the +current directory, and all parent directories. These configuration files +will be merged with the global configuration file. + +`$CARGO_HOME/credentials.toml`\ + Private authentication information for logging in to a registry. + +`$CARGO_HOME/registry/`\ + This directory contains cached downloads of the registry index and any +downloaded dependencies. + +`$CARGO_HOME/git/`\ + This directory contains cached downloads of git dependencies. + +Please note that the internal structure of the `$CARGO_HOME` directory is not +stable yet and may be subject to change. + +[rustup]: https://rust-lang.github.io/rustup/ + +## EXAMPLES + +1. Build a local package and all of its dependencies: + + cargo build + +2. Build a package with optimizations: + + cargo build --release + +3. Run tests for a cross-compiled target: + + cargo test --target i686-unknown-linux-gnu + +4. Create a new package that builds an executable: + + cargo new foobar + +5. Create a package in the current directory: + + mkdir foo && cd foo + cargo init . + +6. Learn about a command's options and usage: + + cargo help clean + +## BUGS + +See <https://github.com/rust-lang/cargo/issues> for issues. + +## SEE ALSO +[rustc(1)](https://doc.rust-lang.org/rustc/index.html), [rustdoc(1)](https://doc.rust-lang.org/rustdoc/index.html) |