You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
145 lines
4.0 KiB
145 lines
4.0 KiB
'\" t
|
|
.TH "CARGO\-YANK" "1"
|
|
.nh
|
|
.ad l
|
|
.ss \n[.ss] 0
|
|
.SH "NAME"
|
|
cargo\-yank \- Remove a pushed crate from the index
|
|
.SH "SYNOPSIS"
|
|
\fBcargo yank\fR [\fIoptions\fR] \fB\-\-vers\fR \fIversion\fR [\fIcrate\fR]
|
|
.SH "DESCRIPTION"
|
|
The yank command removes a previously published crate's version from the
|
|
server's index. This command does not delete any data, and the crate will
|
|
still be available for download via the registry's download link.
|
|
.sp
|
|
Note that existing crates locked to a yanked version will still be able to
|
|
download the yanked version to use it. Cargo will, however, not allow any new
|
|
crates to be locked to any yanked version.
|
|
.sp
|
|
This command requires you to be authenticated with either the \fB\-\-token\fR option
|
|
or using \fBcargo\-login\fR(1).
|
|
.sp
|
|
If the crate name is not specified, it will use the package name from the
|
|
current directory.
|
|
.SH "OPTIONS"
|
|
.SS "Yank Options"
|
|
.sp
|
|
\fB\-\-vers\fR \fIversion\fR
|
|
.RS 4
|
|
The version to yank or un\-yank.
|
|
.RE
|
|
.sp
|
|
\fB\-\-undo\fR
|
|
.RS 4
|
|
Undo a yank, putting a version back into the index.
|
|
.RE
|
|
.sp
|
|
\fB\-\-token\fR \fItoken\fR
|
|
.RS 4
|
|
API token to use when authenticating. This overrides the token stored in
|
|
the credentials file (which is created by \fBcargo\-login\fR(1)).
|
|
.sp
|
|
\fICargo config\fR <https://doc.rust\-lang.org/cargo/reference/config.html> environment variables can be
|
|
used to override the tokens stored in the credentials file. The token for
|
|
crates.io may be specified with the \fBCARGO_REGISTRY_TOKEN\fR environment
|
|
variable. Tokens for other registries may be specified with environment
|
|
variables of the form \fBCARGO_REGISTRIES_NAME_TOKEN\fR where \fBNAME\fR is the name
|
|
of the registry in all capital letters.
|
|
.RE
|
|
.sp
|
|
\fB\-\-index\fR \fIindex\fR
|
|
.RS 4
|
|
The URL of the registry index to use.
|
|
.RE
|
|
.sp
|
|
\fB\-\-registry\fR \fIregistry\fR
|
|
.RS 4
|
|
Name of the registry to use. Registry names are defined in \fICargo config
|
|
files\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&. If not specified, the default registry is used,
|
|
which is defined by the \fBregistry.default\fR config key which defaults to
|
|
\fBcrates\-io\fR\&.
|
|
.RE
|
|
.SS "Display Options"
|
|
.sp
|
|
\fB\-v\fR,
|
|
\fB\-\-verbose\fR
|
|
.RS 4
|
|
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 \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
|
|
No output printed to stdout.
|
|
.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 "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\-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'Yank a crate from the index:
|
|
.sp
|
|
.RS 4
|
|
.nf
|
|
cargo yank \-\-vers 1.0.7 foo
|
|
.fi
|
|
.RE
|
|
.RE
|
|
.SH "SEE ALSO"
|
|
\fBcargo\fR(1), \fBcargo\-login\fR(1), \fBcargo\-publish\fR(1)
|