src/etc/man/cargo-rustdoc.1 - rust-lang/cargo - Git at Google

 '\" t
 .TH "CARGO\-RUSTDOC" "1"
 .nh
 .ad l
 .ss \n[.ss] 0
 .SH "NAME"
 cargo\-rustdoc \[em] Build a package\[cq]s documentation, using specified custom flags
 .SH "SYNOPSIS"
 \fBcargo rustdoc\fR [\fIoptions\fR] [\fB\-\-\fR \fIargs\fR]
 .SH "DESCRIPTION"
 The specified target for the current package (or package specified by \fB\-p\fR if
 provided) will be documented with the specified \fIargs\fR being passed to the
 final rustdoc invocation. Dependencies will not be documented as part of this
 command. Note that rustdoc will still unconditionally receive arguments such
 as \fB\-L\fR, \fB\-\-extern\fR, and \fB\-\-crate\-type\fR, and the specified \fIargs\fR will simply
 be added to the rustdoc invocation.
 .sp
 See <https://doc.rust\-lang.org/rustdoc/index.html> for documentation on rustdoc
 flags.
 .sp
 This command requires that only one target is being compiled when additional
 arguments are provided. If more than one target is available for the current
 package the filters of \fB\-\-lib\fR, \fB\-\-bin\fR, etc, must be used to select which
 target is compiled.
 .sp
 To pass flags to all rustdoc processes spawned by Cargo, use the
 \fBRUSTDOCFLAGS\fR \fIenvironment variable\fR <https://doc.rust\-lang.org/cargo/reference/environment\-variables.html>
 or the \fBbuild.rustdocflags\fR \fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
 .SH "OPTIONS"
 .SS "Documentation Options"
 .sp
 \fB\-\-open\fR
 .RS 4
 Open the docs in a browser after building them. This will use your default
 browser unless you define another one in the \fBBROWSER\fR environment variable
 or use the \fI\f(BIdoc.browser\fI\fR <https://doc.rust\-lang.org/cargo/reference/config.html#docbrowser> configuration
 option.
 .RE
 .SS "Package Selection"
 By default, the package in the current working directory is selected. The \fB\-p\fR
 flag can be used to choose a different package in a workspace.
 .sp
 \fB\-p\fR \fIspec\fR,
 \fB\-\-package\fR \fIspec\fR
 .RS 4
 The package to document. See \fBcargo\-pkgid\fR(1) for the SPEC
 format.
 .RE
 .SS "Target Selection"
 When no target selection options are given, \fBcargo rustdoc\fR 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
 \fBrequired\-features\fR that are missing.
 .sp
 Passing target selection flags will document only the specified
 targets.
 .sp
 Note that \fB\-\-bin\fR, \fB\-\-example\fR, \fB\-\-test\fR and \fB\-\-bench\fR flags also
 support common Unix glob patterns like \fB*\fR, \fB?\fR and \fB[]\fR\&. 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.
 .sp
 \fB\-\-lib\fR
 .RS 4
 Document the package\[cq]s library.
 .RE
 .sp
 \fB\-\-bin\fR \fIname\fR\[u2026]
 .RS 4
 Document the specified binary. This flag may be specified multiple times
 and supports common Unix glob patterns.
 .RE
 .sp
 \fB\-\-bins\fR
 .RS 4
 Document all binary targets.
 .RE
 .sp
 \fB\-\-example\fR \fIname\fR\[u2026]
 .RS 4
 Document the specified example. This flag may be specified multiple times
 and supports common Unix glob patterns.
 .RE
 .sp
 \fB\-\-examples\fR
 .RS 4
 Document all example targets.
 .RE
 .sp
 \fB\-\-test\fR \fIname\fR\[u2026]
 .RS 4
 Document the specified integration test. This flag may be specified
 multiple times and supports common Unix glob patterns.
 .RE
 .sp
 \fB\-\-tests\fR
 .RS 4
 Document all targets that have the \fBtest = true\fR 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 \fBtest\fR flag in the
 manifest settings for the target.
 .RE
 .sp
 \fB\-\-bench\fR \fIname\fR\[u2026]
 .RS 4
 Document the specified benchmark. This flag may be specified multiple
 times and supports common Unix glob patterns.
 .RE
 .sp
 \fB\-\-benches\fR
 .RS 4
 Document all targets that have the \fBbench = true\fR
 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 \fBbench\fR flag in the
 manifest settings for the target.
 .RE
 .sp
 \fB\-\-all\-targets\fR
 .RS 4
 Document all targets. This is equivalent to specifying \fB\-\-lib \-\-bins \-\-tests \-\-benches \-\-examples\fR\&.
 .RE
 .SS "Feature Selection"
 The feature flags allow you to control which features are enabled. When no
 feature options are given, the \fBdefault\fR feature is activated for every
 selected package.
 .sp
 See \fIthe features documentation\fR <https://doc.rust\-lang.org/cargo/reference/features.html#command\-line\-feature\-options>
 for more details.
 .sp
 \fB\-F\fR \fIfeatures\fR,
 \fB\-\-features\fR \fIfeatures\fR
 .RS 4
 Space or comma separated list of features to activate. Features of workspace
 members may be enabled with \fBpackage\-name/feature\-name\fR syntax. This flag may
 be specified multiple times, which enables all specified features.
 .RE
 .sp
 \fB\-\-all\-features\fR
 .RS 4
 Activate all available features of all selected packages.
 .RE
 .sp
 \fB\-\-no\-default\-features\fR
 .RS 4
 Do not activate the \fBdefault\fR feature of the selected packages.
 .RE
 .SS "Compilation Options"
 .sp
 \fB\-\-target\fR \fItriple\fR
 .RS 4
 Document 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/reference/build\-cache.html> documentation for more details.
 .RE
 .sp
 \fB\-r\fR,
 \fB\-\-release\fR
 .RS 4
 Document optimized artifacts with the \fBrelease\fR profile.
 See also the \fB\-\-profile\fR option for choosing a specific profile by name.
 .RE
 .sp
 \fB\-\-profile\fR \fIname\fR
 .RS 4
 Document with the given profile.
 See \fIthe reference\fR <https://doc.rust\-lang.org/cargo/reference/profiles.html> for more details on profiles.
 .RE
 .sp
 \fB\-\-timings=\fR\fIfmts\fR
 .RS 4
 Output information how long each compilation takes, and track concurrency
 information over time. Accepts an optional comma\-separated list of output
 formats; \fB\-\-timings\fR without an argument will default to \fB\-\-timings=html\fR\&.
 Specifying an output format (rather than the default) is unstable and requires
 \fB\-Zunstable\-options\fR\&. Valid output formats:
 .sp
 .RS 4
 \h'-04'\(bu\h'+03'\fBhtml\fR (unstable, requires \fB\-Zunstable\-options\fR): Write a human\-readable file \fBcargo\-timing.html\fR to the
 \fBtarget/cargo\-timings\fR directory with a report of the compilation. Also write
 a report to the same directory with a timestamp in the filename if you want
 to look at older runs. HTML output is suitable for human consumption only,
 and does not provide machine\-readable timing data.
 .RE
 .sp
 .RS 4
 \h'-04'\(bu\h'+03'\fBjson\fR (unstable, requires \fB\-Zunstable\-options\fR): Emit machine\-readable JSON
 information about timing information.
 .RE
 .RE
 .SS "Output Options"
 .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
 .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'+03'\fBauto\fR (default): Automatically detect if color support is available on the
 terminal.
 .RE
 .sp
 .RS 4
 \h'-04'\(bu\h'+03'\fBalways\fR: Always display colors.
 .RE
 .sp
 .RS 4
 \h'-04'\(bu\h'+03'\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
 .sp
 \fB\-\-message\-format\fR \fIfmt\fR
 .RS 4
 The output format for diagnostic messages. Can be specified multiple times
 and consists of comma\-separated values. Valid values:
 .sp
 .RS 4
 \h'-04'\(bu\h'+03'\fBhuman\fR (default): Display in a human\-readable text format. Conflicts with
 \fBshort\fR and \fBjson\fR\&.
 .RE
 .sp
 .RS 4
 \h'-04'\(bu\h'+03'\fBshort\fR: Emit shorter, human\-readable text messages. Conflicts with \fBhuman\fR
 and \fBjson\fR\&.
 .RE
 .sp
 .RS 4
 \h'-04'\(bu\h'+03'\fBjson\fR: Emit JSON messages to stdout. See
 \fIthe reference\fR <https://doc.rust\-lang.org/cargo/reference/external\-tools.html#json\-messages>
 for more details. Conflicts with \fBhuman\fR and \fBshort\fR\&.
 .RE
 .sp
 .RS 4
 \h'-04'\(bu\h'+03'\fBjson\-diagnostic\-short\fR: Ensure the \fBrendered\fR field of JSON messages contains
 the \[lq]short\[rq] rendering from rustc. Cannot be used with \fBhuman\fR or \fBshort\fR\&.
 .RE
 .sp
 .RS 4
 \h'-04'\(bu\h'+03'\fBjson\-diagnostic\-rendered\-ansi\fR: Ensure the \fBrendered\fR field of JSON messages
 contains embedded ANSI color codes for respecting rustc\[cq]s default color
 scheme. Cannot be used with \fBhuman\fR or \fBshort\fR\&.
 .RE
 .sp
 .RS 4
 \h'-04'\(bu\h'+03'\fBjson\-render\-diagnostics\fR: Instruct Cargo to not include rustc diagnostics
 in JSON messages printed, but instead Cargo itself should render the
 JSON diagnostics coming from rustc. Cargo\[cq]s own JSON diagnostics and others
 coming from rustc are still emitted. Cannot be used with \fBhuman\fR or \fBshort\fR\&.
 .RE
 .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\-\-ignore\-rust\-version\fR
 .RS 4
 Ignore \fBrust\-version\fR specification in packages.
 .RE
 .sp
 \fB\-\-locked\fR
 .RS 4
 Asserts that the exact same dependencies and versions are used as when the
 existing \fBCargo.lock\fR file was originally generated. Cargo will exit with an
 error when either of the following scenarios arises:
 .sp
 .RS 4
 \h'-04'\(bu\h'+03'The lock file is missing.
 .RE
 .sp
 .RS 4
 \h'-04'\(bu\h'+03'Cargo attempted to change the lock file due to a different dependency resolution.
 .RE
 .sp
 It may be used in environments where deterministic builds are desired,
 such as in CI pipelines.
 .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
 .sp
 \fB\-\-lockfile\-path\fR \fIPATH\fR
 .RS 4
 Changes the path of the lockfile from the default (\fB<workspace_root>/Cargo.lock\fR) to \fIPATH\fR\&. \fIPATH\fR must end with
 \fBCargo.lock\fR (e.g. \fB\-\-lockfile\-path /tmp/temporary\-lockfile/Cargo.lock\fR). Note that providing
 \fB\-\-lockfile\-path\fR will ignore existing lockfile at the default path, and instead will
 either use the lockfile from \fIPATH\fR, or write a new lockfile into the provided \fIPATH\fR if it doesn\[cq]t exist.
 This flag can be used to run most commands in read\-only directories, writing lockfile into the provided \fIPATH\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#14421\fR <https://github.com/rust\-lang/cargo/issues/14421>).
 .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
 .SS "Miscellaneous Options"
 .sp
 \fB\-j\fR \fIN\fR,
 \fB\-\-jobs\fR \fIN\fR
 .RS 4
 Number of parallel jobs to run. May also be specified with the
 \fBbuild.jobs\fR \fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&. Defaults to
 the number of logical CPUs. If negative, it sets the maximum number of
 parallel jobs to the number of logical CPUs plus provided value. If
 a string \fBdefault\fR is provided, it sets the value back to defaults.
 Should not be 0.
 .RE
 .sp
 \fB\-\-keep\-going\fR
 .RS 4
 Build as many crates in the dependency graph as possible, rather than aborting
 the build on the first one that fails to build.
 .sp
 For example if the current package depends on dependencies \fBfails\fR and \fBworks\fR,
 one of which fails to build, \fBcargo rustdoc \-j1\fR may or may not build the
 one that succeeds (depending on which one of the two builds Cargo picked to run
 first), whereas \fBcargo rustdoc \-j1 \-\-keep\-going\fR would definitely run both
 builds, even if the one run first fails.
 .RE
 .sp
 \fB\-\-output\-format\fR
 .RS 4
 The output type for the documentation emitted. Valid values:
 .sp
 .RS 4
 \h'-04'\(bu\h'+03'\fBhtml\fR (default): Emit the documentation in HTML format.
 .RE
 .sp
 .RS 4
 \h'-04'\(bu\h'+03'\fBjson\fR: Emit the documentation in the \fIexperimental JSON format\fR <https://doc.rust\-lang.org/nightly/nightly\-rustc/rustdoc_json_types>\&.
 .RE
 .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.
 .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'+03'\fB0\fR: Cargo succeeded.
 .RE
 .sp
 .RS 4
 \h'-04'\(bu\h'+03'\fB101\fR: Cargo failed to complete.
 .RE
 .SH "EXAMPLES"
 .sp
 .RS 4
 \h'-04' 1.\h'+01'Build documentation with custom CSS included from a given file:
 .sp
 .RS 4
 .nf
 cargo rustdoc \-\-lib \-\- \-\-extend\-css extra.css
 .fi
 .RE
 .RE
 .SH "SEE ALSO"
 \fBcargo\fR(1), \fBcargo\-doc\fR(1), \fBrustdoc\fR(1)
	'\" t
	.TH "CARGO\-RUSTDOC" "1"
	.nh
	.ad l
	.ss \n[.ss] 0
	.SH "NAME"
	cargo\-rustdoc \[em] Build a package\[cq]s documentation, using specified custom flags
	.SH "SYNOPSIS"
	\fBcargo rustdoc\fR [\fIoptions\fR] [\fB\-\-\fR \fIargs\fR]
	.SH "DESCRIPTION"
	The specified target for the current package (or package specified by \fB\-p\fR if
	provided) will be documented with the specified \fIargs\fR being passed to the
	final rustdoc invocation. Dependencies will not be documented as part of this
	command. Note that rustdoc will still unconditionally receive arguments such
	as \fB\-L\fR, \fB\-\-extern\fR, and \fB\-\-crate\-type\fR, and the specified \fIargs\fR will simply
	be added to the rustdoc invocation.
	.sp
	See <https://doc.rust\-lang.org/rustdoc/index.html> for documentation on rustdoc
	flags.
	.sp
	This command requires that only one target is being compiled when additional
	arguments are provided. If more than one target is available for the current
	package the filters of \fB\-\-lib\fR, \fB\-\-bin\fR, etc, must be used to select which
	target is compiled.
	.sp
	To pass flags to all rustdoc processes spawned by Cargo, use the
	\fBRUSTDOCFLAGS\fR \fIenvironment variable\fR <https://doc.rust\-lang.org/cargo/reference/environment\-variables.html>
	or the \fBbuild.rustdocflags\fR \fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
	.SH "OPTIONS"
	.SS "Documentation Options"
	.sp
	\fB\-\-open\fR
	.RS 4
	Open the docs in a browser after building them. This will use your default
	browser unless you define another one in the \fBBROWSER\fR environment variable
	or use the \fI\f(BIdoc.browser\fI\fR <https://doc.rust\-lang.org/cargo/reference/config.html#docbrowser> configuration
	option.
	.RE
	.SS "Package Selection"
	By default, the package in the current working directory is selected. The \fB\-p\fR
	flag can be used to choose a different package in a workspace.
	.sp
	\fB\-p\fR \fIspec\fR,
	\fB\-\-package\fR \fIspec\fR
	.RS 4
	The package to document. See \fBcargo\-pkgid\fR(1) for the SPEC
	format.
	.RE
	.SS "Target Selection"
	When no target selection options are given, \fBcargo rustdoc\fR 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
	\fBrequired\-features\fR that are missing.
	.sp
	Passing target selection flags will document only the specified
	targets.
	.sp
	Note that \fB\-\-bin\fR, \fB\-\-example\fR, \fB\-\-test\fR and \fB\-\-bench\fR flags also
	support common Unix glob patterns like \fB*\fR, \fB?\fR and \fB[]\fR\&. 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.
	.sp
	\fB\-\-lib\fR
	.RS 4
	Document the package\[cq]s library.
	.RE
	.sp
	\fB\-\-bin\fR \fIname\fR\[u2026]
	.RS 4
	Document the specified binary. This flag may be specified multiple times
	and supports common Unix glob patterns.
	.RE
	.sp
	\fB\-\-bins\fR
	.RS 4
	Document all binary targets.
	.RE
	.sp
	\fB\-\-example\fR \fIname\fR\[u2026]
	.RS 4
	Document the specified example. This flag may be specified multiple times
	and supports common Unix glob patterns.
	.RE
	.sp
	\fB\-\-examples\fR
	.RS 4
	Document all example targets.
	.RE
	.sp
	\fB\-\-test\fR \fIname\fR\[u2026]
	.RS 4
	Document the specified integration test. This flag may be specified
	multiple times and supports common Unix glob patterns.
	.RE
	.sp
	\fB\-\-tests\fR
	.RS 4
	Document all targets that have the \fBtest = true\fR 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 \fBtest\fR flag in the
	manifest settings for the target.
	.RE
	.sp
	\fB\-\-bench\fR \fIname\fR\[u2026]
	.RS 4
	Document the specified benchmark. This flag may be specified multiple
	times and supports common Unix glob patterns.
	.RE
	.sp
	\fB\-\-benches\fR
	.RS 4
	Document all targets that have the \fBbench = true\fR
	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 \fBbench\fR flag in the
	manifest settings for the target.
	.RE
	.sp
	\fB\-\-all\-targets\fR
	.RS 4
	Document all targets. This is equivalent to specifying \fB\-\-lib \-\-bins \-\-tests \-\-benches \-\-examples\fR\&.
	.RE
	.SS "Feature Selection"
	The feature flags allow you to control which features are enabled. When no
	feature options are given, the \fBdefault\fR feature is activated for every
	selected package.
	.sp
	See \fIthe features documentation\fR <https://doc.rust\-lang.org/cargo/reference/features.html#command\-line\-feature\-options>
	for more details.
	.sp
	\fB\-F\fR \fIfeatures\fR,
	\fB\-\-features\fR \fIfeatures\fR
	.RS 4
	Space or comma separated list of features to activate. Features of workspace
	members may be enabled with \fBpackage\-name/feature\-name\fR syntax. This flag may
	be specified multiple times, which enables all specified features.
	.RE
	.sp
	\fB\-\-all\-features\fR
	.RS 4
	Activate all available features of all selected packages.
	.RE
	.sp
	\fB\-\-no\-default\-features\fR
	.RS 4
	Do not activate the \fBdefault\fR feature of the selected packages.
	.RE
	.SS "Compilation Options"
	.sp
	\fB\-\-target\fR \fItriple\fR
	.RS 4
	Document 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/reference/build\-cache.html> documentation for more details.
	.RE
	.sp
	\fB\-r\fR,
	\fB\-\-release\fR
	.RS 4
	Document optimized artifacts with the \fBrelease\fR profile.
	See also the \fB\-\-profile\fR option for choosing a specific profile by name.
	.RE
	.sp
	\fB\-\-profile\fR \fIname\fR
	.RS 4
	Document with the given profile.
	See \fIthe reference\fR <https://doc.rust\-lang.org/cargo/reference/profiles.html> for more details on profiles.
	.RE
	.sp
	\fB\-\-timings=\fR\fIfmts\fR
	.RS 4
	Output information how long each compilation takes, and track concurrency
	information over time. Accepts an optional comma\-separated list of output
	formats; \fB\-\-timings\fR without an argument will default to \fB\-\-timings=html\fR\&.
	Specifying an output format (rather than the default) is unstable and requires
	\fB\-Zunstable\-options\fR\&. Valid output formats:
	.sp
	.RS 4
	\h'-04'\(bu\h'+03'\fBhtml\fR (unstable, requires \fB\-Zunstable\-options\fR): Write a human\-readable file \fBcargo\-timing.html\fR to the
	\fBtarget/cargo\-timings\fR directory with a report of the compilation. Also write
	a report to the same directory with a timestamp in the filename if you want
	to look at older runs. HTML output is suitable for human consumption only,
	and does not provide machine\-readable timing data.
	.RE
	.sp
	.RS 4
	\h'-04'\(bu\h'+03'\fBjson\fR (unstable, requires \fB\-Zunstable\-options\fR): Emit machine\-readable JSON
	information about timing information.
	.RE
	.RE
	.SS "Output Options"
	.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
	.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'+03'\fBauto\fR (default): Automatically detect if color support is available on the
	terminal.
	.RE
	.sp
	.RS 4
	\h'-04'\(bu\h'+03'\fBalways\fR: Always display colors.
	.RE
	.sp
	.RS 4
	\h'-04'\(bu\h'+03'\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
	.sp
	\fB\-\-message\-format\fR \fIfmt\fR
	.RS 4
	The output format for diagnostic messages. Can be specified multiple times
	and consists of comma\-separated values. Valid values:
	.sp
	.RS 4
	\h'-04'\(bu\h'+03'\fBhuman\fR (default): Display in a human\-readable text format. Conflicts with
	\fBshort\fR and \fBjson\fR\&.
	.RE
	.sp
	.RS 4
	\h'-04'\(bu\h'+03'\fBshort\fR: Emit shorter, human\-readable text messages. Conflicts with \fBhuman\fR
	and \fBjson\fR\&.
	.RE
	.sp
	.RS 4
	\h'-04'\(bu\h'+03'\fBjson\fR: Emit JSON messages to stdout. See
	\fIthe reference\fR <https://doc.rust\-lang.org/cargo/reference/external\-tools.html#json\-messages>
	for more details. Conflicts with \fBhuman\fR and \fBshort\fR\&.
	.RE
	.sp
	.RS 4
	\h'-04'\(bu\h'+03'\fBjson\-diagnostic\-short\fR: Ensure the \fBrendered\fR field of JSON messages contains
	the \[lq]short\[rq] rendering from rustc. Cannot be used with \fBhuman\fR or \fBshort\fR\&.
	.RE
	.sp
	.RS 4
	\h'-04'\(bu\h'+03'\fBjson\-diagnostic\-rendered\-ansi\fR: Ensure the \fBrendered\fR field of JSON messages
	contains embedded ANSI color codes for respecting rustc\[cq]s default color
	scheme. Cannot be used with \fBhuman\fR or \fBshort\fR\&.
	.RE
	.sp
	.RS 4
	\h'-04'\(bu\h'+03'\fBjson\-render\-diagnostics\fR: Instruct Cargo to not include rustc diagnostics
	in JSON messages printed, but instead Cargo itself should render the
	JSON diagnostics coming from rustc. Cargo\[cq]s own JSON diagnostics and others
	coming from rustc are still emitted. Cannot be used with \fBhuman\fR or \fBshort\fR\&.
	.RE
	.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\-\-ignore\-rust\-version\fR
	.RS 4
	Ignore \fBrust\-version\fR specification in packages.
	.RE
	.sp
	\fB\-\-locked\fR
	.RS 4
	Asserts that the exact same dependencies and versions are used as when the
	existing \fBCargo.lock\fR file was originally generated. Cargo will exit with an
	error when either of the following scenarios arises:
	.sp
	.RS 4
	\h'-04'\(bu\h'+03'The lock file is missing.
	.RE
	.sp
	.RS 4
	\h'-04'\(bu\h'+03'Cargo attempted to change the lock file due to a different dependency resolution.
	.RE
	.sp
	It may be used in environments where deterministic builds are desired,
	such as in CI pipelines.
	.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
	.sp
	\fB\-\-lockfile\-path\fR \fIPATH\fR
	.RS 4
	Changes the path of the lockfile from the default (\fB<workspace_root>/Cargo.lock\fR) to \fIPATH\fR\&. \fIPATH\fR must end with
	\fBCargo.lock\fR (e.g. \fB\-\-lockfile\-path /tmp/temporary\-lockfile/Cargo.lock\fR). Note that providing
	\fB\-\-lockfile\-path\fR will ignore existing lockfile at the default path, and instead will
	either use the lockfile from \fIPATH\fR, or write a new lockfile into the provided \fIPATH\fR if it doesn\[cq]t exist.
	This flag can be used to run most commands in read\-only directories, writing lockfile into the provided \fIPATH\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#14421\fR <https://github.com/rust\-lang/cargo/issues/14421>).
	.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
	.SS "Miscellaneous Options"
	.sp
	\fB\-j\fR \fIN\fR,
	\fB\-\-jobs\fR \fIN\fR
	.RS 4
	Number of parallel jobs to run. May also be specified with the
	\fBbuild.jobs\fR \fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&. Defaults to
	the number of logical CPUs. If negative, it sets the maximum number of
	parallel jobs to the number of logical CPUs plus provided value. If
	a string \fBdefault\fR is provided, it sets the value back to defaults.
	Should not be 0.
	.RE
	.sp
	\fB\-\-keep\-going\fR
	.RS 4
	Build as many crates in the dependency graph as possible, rather than aborting
	the build on the first one that fails to build.
	.sp
	For example if the current package depends on dependencies \fBfails\fR and \fBworks\fR,
	one of which fails to build, \fBcargo rustdoc \-j1\fR may or may not build the
	one that succeeds (depending on which one of the two builds Cargo picked to run
	first), whereas \fBcargo rustdoc \-j1 \-\-keep\-going\fR would definitely run both
	builds, even if the one run first fails.
	.RE
	.sp
	\fB\-\-output\-format\fR
	.RS 4
	The output type for the documentation emitted. Valid values:
	.sp
	.RS 4
	\h'-04'\(bu\h'+03'\fBhtml\fR (default): Emit the documentation in HTML format.
	.RE
	.sp
	.RS 4
	\h'-04'\(bu\h'+03'\fBjson\fR: Emit the documentation in the \fIexperimental JSON format\fR <https://doc.rust\-lang.org/nightly/nightly\-rustc/rustdoc_json_types>\&.
	.RE
	.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.
	.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'+03'\fB0\fR: Cargo succeeded.
	.RE
	.sp
	.RS 4
	\h'-04'\(bu\h'+03'\fB101\fR: Cargo failed to complete.
	.RE
	.SH "EXAMPLES"
	.sp
	.RS 4
	\h'-04' 1.\h'+01'Build documentation with custom CSS included from a given file:
	.sp
	.RS 4
	.nf
	cargo rustdoc \-\-lib \-\- \-\-extend\-css extra.css
	.fi
	.RE
	.RE
	.SH "SEE ALSO"
	\fBcargo\fR(1), \fBcargo\-doc\fR(1), \fBrustdoc\fR(1)