MAN page from openSUSE Leap 15 cargo-1.32.0-lp150.188.1.x86_64.rpm

CARGO\-RUSTDOC

Section: Cargo Manual (1)
Updated: May 2016
Index

NAME

cargo-rustdoc - Build a package[aq]s documentation, using specifiedcustom flags.

SYNOPSIS

I]cargo rustdoc] [OPTIONS] [--] [<OPTS>...]

DESCRIPTION

The specified target for the current package (or package specified bySPEC if provided) will be documented with the specified <OPTS>...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-L, --extern, and --crate-type, and the specified <OPTS>...will simply be added to the rustdoc invocation.

If the --package argument is given, then SPEC is a package idspecification which indicates which package should be documented.If it is not given, then the current package is documented.For more information on SPEC and its format, see theC]cargo help pkgid] command.

OPTIONS

-h, --help

Print this message.

--open

Open the docs in a browser after the operation.

-p I]SPEC], --package I]SPEC]

Package to document.

-j I]N], --jobs I]N]

Number of parallel jobs, defaults to # of CPUs.

--lib

Build only this package[aq]s library.

--bin I]NAME]

Build only the specified binary.

--example I]NAME]

Build only the specified example.

--test I]NAME]

Build only the specified test target.

--bench I]NAME]

Build only the specified benchmark target.

--release

Build artifacts in release mode, with optimizations.

--features I]FEATURES]

Space-separated list of features to also build.

--all-features

Build all available features.

--no-default-features

Do not build the C]default] feature.

--target I]TRIPLE]

Build for the target triple.

--manifest-path I]PATH]

Path to the manifest to document.

-v, --verbose

Use verbose output.

-q, --quiet

No output printed to stdout.

--color I]WHEN]

Coloring: auto, always, never.

COPYRIGHT

This work is dual-licensed under Apache 2.0 and MIT terms.See I]COPYRIGHT] file in the cargo source distribution.

This document was created byman2html,using the manual pages.