Man1 - cargo-rustdoc.1

–open

Open the docs in a browser after building them. This will use your default browser unless you define another one in the BROWSER environment variable or use the doc.browser https://doc.rust-lang.org/cargo/reference/config.html#docbrowser configuration option.

By default, the package in the current working directory is selected. The -p flag can be used to choose a different package in a workspace.

-p spec, –package spec

The package to document. See *cargo-pkgid*(1) for the SPEC format.

When no target selection options are given, cargo rustdoc will document all binary and library targets of the selected package. The binary will be skipped if its name is the same as the lib target. Binaries are skipped if they have required-features that are missing.

Passing target selection flags will document only the specified targets.

Note that –bin, –example, –test and –bench flags also support common Unix glob patterns like *, ? and []. However, to avoid your shell accidentally expanding glob patterns before Cargo handles them, you must use single quotes or double quotes around each glob pattern.

–lib

Document the package’s library.

–bin name…

Document the specified binary. This flag may be specified multiple times and supports common Unix glob patterns.

–bins

Document all binary targets.

–example name…

Document the specified example. This flag may be specified multiple times and supports common Unix glob patterns.

–examples

Document all example targets.

–test name…

Document the specified integration test. This flag may be specified multiple times and supports common Unix glob patterns.

–tests

Document all targets in test mode that have the test = true manifest flag set. By default this includes the library and binaries built as unittests, and integration tests. Be aware that this will also build any required dependencies, so the lib target may be built twice (once as a unittest, and once as a dependency for binaries, integration tests, etc.). Targets may be enabled or disabled by setting the test flag in the manifest settings for the target.

–bench name…

Document the specified benchmark. This flag may be specified multiple times and supports common Unix glob patterns.

–benches

Document all targets in benchmark mode that have the bench = true manifest flag set. By default this includes the library and binaries built as benchmarks, and bench targets. Be aware that this will also build any required dependencies, so the lib target may be built twice (once as a benchmark, and once as a dependency for binaries, benchmarks, etc.). Targets may be enabled or disabled by setting the bench flag in the manifest settings for the target.

–all-targets

Document all targets. This is equivalent to specifying –lib –bins –tests –benches –examples.

The feature flags allow you to control which features are enabled. When no feature options are given, the default feature is activated for every selected package.

See the features documentation https://doc.rust-lang.org/cargo/reference/features.html#command-line-feature-options for more details.

–features features

Space or comma separated list of features to activate. Features of workspace members may be enabled with package-name/feature-name syntax. This flag may be specified multiple times, which enables all specified features.

–all-features

Activate all available features of all selected packages.

–no-default-features

Do not activate the default feature of the selected packages.

–target triple

Document for the given architecture. The default is the host architecture. The general format of the triple is <arch><sub>-<vendor>-<sys>-<abi>. Run rustc –print target-list for a list of supported targets.

This may also be specified with the build.target config value https://doc.rust-lang.org/cargo/reference/config.html.

Note that specifying this flag makes Cargo run in a different mode where the target artifacts are placed in a separate directory. See the build cache https://doc.rust-lang.org/cargo/guide/build-cache.html documentation for more details.

–release

Document optimized artifacts with the release profile. See also the –profile option for choosing a specific profile by name.

–profile name

Document with the given profile. See the the reference https://doc.rust-lang.org/cargo/reference/profiles.html for more details on profiles.

–ignore-rust-version

Document the target even if the selected Rust compiler is older than the required Rust version as configured in the project’s rust-version field.

–target-dir directory

Directory for all generated artifacts and intermediate files. May also be specified with the CARGO_TARGET_DIR environment variable, or the build.target-dir config value https://doc.rust-lang.org/cargo/reference/config.html. Defaults to target in the root of the workspace.

-v, –verbose

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 term.verbose config 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:

#+begin_quote ·*auto* (default): Automatically detect if color support is available on the terminal.

·*always*: Always display colors.

·*never*: Never display colors.

May also be specified with the term.color config value https://doc.rust-lang.org/cargo/reference/config.html. #+end_quote

–message-format fmt

The output format for diagnostic messages. Can be specified multiple times and consists of comma-separated values. Valid values:

#+begin_quote ·*human* (default): Display in a human-readable text format. Conflicts with short and json.

·*short*: Emit shorter, human-readable text messages. Conflicts with human and json.

·*json*: Emit JSON messages to stdout. See the reference https://doc.rust-lang.org/cargo/reference/external-tools.html#json-messages for more details. Conflicts with human and short.

·*json-diagnostic-short*: Ensure the rendered field of JSON messages contains the “short” rendering from rustc. Cannot be used with human or short.

·*json-diagnostic-rendered-ansi*: Ensure the rendered field of JSON messages contains embedded ANSI color codes for respecting rustc’s default color scheme. Cannot be used with human or short.

·*json-render-diagnostics*: Instruct Cargo to not include rustc diagnostics in in JSON messages printed, but instead Cargo itself should render the JSON diagnostics coming from rustc. Cargo’s own JSON diagnostics and others coming from rustc are still emitted. Cannot be used with human or short.

#+end_quote

–manifest-path path

Path to the Cargo.toml file. By default, Cargo searches for the Cargo.toml file in the current directory or any parent directory.

–frozen, –locked

Either of these flags requires that the Cargo.lock file is up-to-date. If the lock file is missing, or it needs to be updated, Cargo will exit with an error. The –frozen flag also prevents Cargo from attempting to access the network to determine if it is out-of-date.

These may be used in environments where you want to assert that the Cargo.lock file is up-to-date (such as a CI build) or want to avoid network access.

–offline

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.

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 *cargo-fetch*(1) command to download dependencies before going offline.

May also be specified with the net.offline config value https://doc.rust-lang.org/cargo/reference/config.html.

*+*/toolchain/

If Cargo has been installed with rustup, and the first argument to cargo begins with +, it will be interpreted as a rustup toolchain name (such as +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.

-j N, –jobs N

Number of parallel jobs to run. May also be specified with the build.jobs config value https://doc.rust-lang.org/cargo/reference/config.html. Defaults to the number of CPUs.