-
Notifications
You must be signed in to change notification settings - Fork 2.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add cargo-info subcommand and add man page
- Loading branch information
1 parent
9d164aa
commit 24ef77a
Showing
10 changed files
with
611 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
# cargo-info(1) | ||
|
||
## NAME | ||
|
||
cargo-info --- Display information about a package in the registry. Default registry is crates.io | ||
|
||
## SYNOPSIS | ||
|
||
`cargo info` [_options_] _spec_ | ||
|
||
## DESCRIPTION | ||
|
||
This command displays information about a package in the registry. It fetches data from the package's Cargo.toml file | ||
and presents it in a human-readable format. | ||
|
||
## OPTIONS | ||
|
||
### Info Options | ||
|
||
{{#options}} | ||
|
||
{{#option "_spec_" }} | ||
|
||
Fetch information about the specified package. The _spec_ can be a package ID, see {{man "cargo-pkgid" 1}} for the SPEC | ||
format. | ||
If the specified package is part of the current workspace, information from the local Cargo.toml file will be displayed. | ||
If the `Cargo.lock` file does not exist, it will be created. If no version is specified, the appropriate version will be | ||
selected based on the Minimum Supported Rust Version (MSRV). | ||
|
||
{{/option}} | ||
{{> options-index }} | ||
{{> options-registry }} | ||
{{/options}} | ||
|
||
### Display Options | ||
|
||
{{#options}} | ||
{{> options-display }} | ||
{{/options}} | ||
|
||
### Manifest Options | ||
|
||
{{#options}} | ||
{{> options-locked }} | ||
{{/options}} | ||
|
||
{{> section-options-common }} | ||
|
||
{{> section-environment }} | ||
|
||
{{> section-exit-status }} | ||
|
||
## EXAMPLES | ||
|
||
1. Inspect the `serde` package from crates.io: | ||
|
||
cargo info serde | ||
2. Inspect the `serde` package with version `1.0.0`: | ||
|
||
cargo info [email protected] | ||
3. Inspect the `serde` package form the local registry: | ||
|
||
cargo info serde --registry my-registry | ||
|
||
## SEE ALSO | ||
|
||
{{man "cargo" 1}}, {{man "cargo-search" 1}} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,156 @@ | ||
CARGO-INFO(1) | ||
|
||
NAME | ||
cargo-info — Display information about a package in the registry. | ||
Default registry is crates.io | ||
|
||
SYNOPSIS | ||
cargo info [options] spec | ||
|
||
DESCRIPTION | ||
This command displays information about a package in the registry. It | ||
fetches data from the package’s Cargo.toml file and presents it in a | ||
human-readable format. | ||
|
||
OPTIONS | ||
Info Options | ||
spec | ||
Fetch information about the specified package. The spec can be a | ||
package ID, see cargo-pkgid(1) for the SPEC format. If the specified | ||
package is part of the current workspace, information from the local | ||
Cargo.toml file will be displayed. If the Cargo.lock file does not | ||
exist, it will be created. If no version is specified, the | ||
appropriate version will be selected based on the Minimum Supported | ||
Rust Version (MSRV). | ||
|
||
--index index | ||
The URL of the registry index to use. | ||
|
||
--registry registry | ||
Name of the registry to use. Registry names are defined in Cargo | ||
config files | ||
<https://doc.rust-lang.org/cargo/reference/config.html>. If not | ||
specified, the default registry is used, which is defined by the | ||
registry.default config key which defaults to crates-io. | ||
|
||
Display Options | ||
-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 | ||
Do not print cargo log messages. May also be specified with the | ||
term.quiet config value | ||
<https://doc.rust-lang.org/cargo/reference/config.html>. | ||
|
||
--color when | ||
Control when colored output is used. Valid values: | ||
|
||
o auto (default): Automatically detect if color support is | ||
available on the terminal. | ||
|
||
o always: Always display colors. | ||
|
||
o never: Never display colors. | ||
|
||
May also be specified with the term.color config value | ||
<https://doc.rust-lang.org/cargo/reference/config.html>. | ||
|
||
Manifest Options | ||
--locked | ||
Asserts that the exact same dependencies and versions are used as | ||
when the existing Cargo.lock file was originally generated. Cargo | ||
will exit with an error when either of the following scenarios | ||
arises: | ||
|
||
o The lock file is missing. | ||
|
||
o Cargo attempted to change the lock file due to a different | ||
dependency resolution. | ||
|
||
It may be used in environments where deterministic builds are | ||
desired, such as in CI pipelines. | ||
|
||
--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>. | ||
|
||
--frozen | ||
Equivalent to specifying both --locked and --offline. | ||
|
||
Common Options | ||
+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. | ||
|
||
--config KEY=VALUE or PATH | ||
Overrides a Cargo configuration value. The argument should be in | ||
TOML syntax of KEY=VALUE, or provided as a path to an extra | ||
configuration file. This flag may be specified multiple times. See | ||
the command-line overrides section | ||
<https://doc.rust-lang.org/cargo/reference/config.html#command-line-overrides> | ||
for more information. | ||
|
||
-C PATH | ||
Changes the current working directory before executing any specified | ||
operations. This affects things like where cargo looks by default | ||
for the project manifest (Cargo.toml), as well as the directories | ||
searched for discovering .cargo/config.toml, for example. This | ||
option must appear before the command name, for example cargo -C | ||
path/to/my-project build. | ||
|
||
This option is only available on the nightly channel | ||
<https://doc.rust-lang.org/book/appendix-07-nightly-rust.html> and | ||
requires the -Z unstable-options flag to enable (see #10098 | ||
<https://github.com/rust-lang/cargo/issues/10098>). | ||
|
||
-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> | ||
for details on environment variables that Cargo reads. | ||
|
||
EXIT STATUS | ||
o 0: Cargo succeeded. | ||
|
||
o 101: Cargo failed to complete. | ||
|
||
EXAMPLES | ||
1. Inspect the serde package from crates.io: | ||
|
||
cargo info serde | ||
|
||
2. Inspect the serde package with version 1.0.0: | ||
|
||
cargo info [email protected] | ||
|
||
3. Inspect the serde package form the local registry: | ||
|
||
cargo info serde --registry my-registry | ||
|
||
SEE ALSO | ||
cargo(1), cargo-search(1) | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.