itsscb/cargo
1
0
Fork 0
mirror of https://github.com/rust-lang/cargo.git synced 2025-09-25 11:14:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

Auto merge of #12832 - weihanglo:cargo-login, r=ehuss

Browse Source 
doc(cargo-login): mention args after `--` in manpage
This commit is contained in:
bors 2023-10-17 11:55:04 +00:00
commit 8eb8acbb11
4 changed files with 13 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/doc/man/cargo-login.md
View File

@ -6,7 +6,7 @@ cargo-login --- Log in to a registry
## SYNOPSIS
`cargo login` [_options_] [_token_] -- [_args_]
`cargo login` [_options_] [_token_] [`--` _args_]
## DESCRIPTION
@ -14,6 +14,8 @@ This command will run a credential provider to save a token so that commands
that require authentication, such as {{man "cargo-publish" 1}}, will be
automatically authenticated.
All the arguments following the two dashes (`--`) are passed to the credential provider.
For the default `cargo:token` credential provider, the token is saved
in `$CARGO_HOME/credentials.toml`. `CARGO_HOME` defaults to `.cargo`
in your home directory.

5
src/doc/man/generated_txt/cargo-login.txt
View File

@ -4,13 +4,16 @@ NAME
cargo-login — Log in to a registry
SYNOPSIS
cargo login [options] [token] – [args]
cargo login [options] [token] [-- args]
DESCRIPTION
This command will run a credential provider to save a token so that
commands that require authentication, such as cargo-publish(1), will be
automatically authenticated.
All the arguments following the two dashes (--) are passed to the
credential provider.
For the default cargo:token credential provider, the token is saved in
$CARGO_HOME/credentials.toml. CARGO_HOME defaults to .cargo in your home
directory.

4
src/doc/src/commands/cargo-login.md
View File

@ -6,7 +6,7 @@ cargo-login --- Log in to a registry
## SYNOPSIS
`cargo login` [_options_] [_token_] -- [_args_]
`cargo login` [_options_] [_token_] [`--` _args_]
## DESCRIPTION
@ -14,6 +14,8 @@ This command will run a credential provider to save a token so that commands
that require authentication, such as [cargo-publish(1)](cargo-publish.html), will be
automatically authenticated.
All the arguments following the two dashes (`--`) are passed to the credential provider.
For the default `cargo:token` credential provider, the token is saved
in `$CARGO_HOME/credentials.toml`. `CARGO_HOME` defaults to `.cargo`
in your home directory.

4
src/etc/man/cargo-login.1
View File

@ -6,12 +6,14 @@
.SH "NAME"
cargo\-login \[em] Log in to a registry
.SH "SYNOPSIS"
\fBcargo login\fR [\fIoptions\fR] [\fItoken\fR] \[en] [\fIargs\fR]
\fBcargo login\fR [\fIoptions\fR] [\fItoken\fR] [\fB\-\-\fR \fIargs\fR]
.SH "DESCRIPTION"
This command will run a credential provider to save a token so that commands
that require authentication, such as \fBcargo\-publish\fR(1), will be
automatically authenticated.
.sp
All the arguments following the two dashes (\fB\-\-\fR) are passed to the credential provider.
.sp
For the default \fBcargo:token\fR credential provider, the token is saved
in \fB$CARGO_HOME/credentials.toml\fR\&. \fBCARGO_HOME\fR defaults to \fB\&.cargo\fR
in your home directory.