diff options
Diffstat (limited to 'src/tools/cargo/src/etc/man/cargo-locate-project.1')
| -rw-r--r-- | src/tools/cargo/src/etc/man/cargo-locate-project.1 | 150 |
1 files changed, 150 insertions, 0 deletions
diff --git a/src/tools/cargo/src/etc/man/cargo-locate-project.1 b/src/tools/cargo/src/etc/man/cargo-locate-project.1 new file mode 100644 index 000000000..2fbbe183b --- /dev/null +++ b/src/tools/cargo/src/etc/man/cargo-locate-project.1 @@ -0,0 +1,150 @@ +'\" t +.TH "CARGO\-LOCATE\-PROJECT" "1" +.nh +.ad l +.ss \n[.ss] 0 +.SH "NAME" +cargo\-locate\-project \[em] Print a JSON representation of a Cargo.toml file\[cq]s location +.SH "SYNOPSIS" +\fBcargo locate\-project\fR [\fIoptions\fR] +.SH "DESCRIPTION" +This command will print a JSON object to stdout with the full path to the manifest. The +manifest is found by searching upward for a file named \fBCargo.toml\fR starting from the current +working directory. +.sp +If the project happens to be a part of a workspace, the manifest of the project, rather than +the workspace root, is output. This can be overridden by the \fB\-\-workspace\fR flag. The root +workspace is found by traversing further upward or by using the field \fBpackage.workspace\fR after +locating the manifest of a workspace member. +.SH "OPTIONS" +.sp +\fB\-\-workspace\fR +.RS 4 +Locate the \fBCargo.toml\fR at the root of the workspace, as opposed to the current +workspace member. +.RE +.SS "Display Options" +.sp +\fB\-\-message\-format\fR \fIfmt\fR +.RS 4 +The representation in which to print the project location. Valid values: +.sp +.RS 4 +\h'-04'\(bu\h'+02'\fBjson\fR (default): JSON object with the path under the key \[lq]root\[rq]\&. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+02'\fBplain\fR: Just the path. +.RE +.RE +.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'+02'\fBauto\fR (default): Automatically detect if color support is available on the +terminal. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+02'\fBalways\fR: Always display colors. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+02'\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 +.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 +.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 +.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'+02'\fB0\fR: Cargo succeeded. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+02'\fB101\fR: Cargo failed to complete. +.RE +.SH "EXAMPLES" +.sp +.RS 4 +\h'-04' 1.\h'+01'Display the path to the manifest based on the current directory: +.sp +.RS 4 +.nf +cargo locate\-project +.fi +.RE +.RE +.SH "SEE ALSO" +\fBcargo\fR(1), \fBcargo\-metadata\fR(1) |