Matthew Maurer | 5423635 | 2020-04-22 09:37:40 -0700 | [diff] [blame] | 1 | '\" t |
| 2 | .\" Title: cargo-uninstall |
| 3 | .\" Author: [see the "AUTHOR(S)" section] |
| 4 | .\" Generator: Asciidoctor 2.0.10 |
| 5 | .\" Date: 2019-06-03 |
| 6 | .\" Manual: \ \& |
| 7 | .\" Source: \ \& |
| 8 | .\" Language: English |
| 9 | .\" |
| 10 | .TH "CARGO\-UNINSTALL" "1" "2019-06-03" "\ \&" "\ \&" |
| 11 | .ie \n(.g .ds Aq \(aq |
| 12 | .el .ds Aq ' |
| 13 | .ss \n[.ss] 0 |
| 14 | .nh |
| 15 | .ad l |
| 16 | .de URL |
| 17 | \fI\\$2\fP <\\$1>\\$3 |
| 18 | .. |
| 19 | .als MTO URL |
| 20 | .if \n[.g] \{\ |
| 21 | . mso www.tmac |
| 22 | . am URL |
| 23 | . ad l |
| 24 | . . |
| 25 | . am MTO |
| 26 | . ad l |
| 27 | . . |
| 28 | . LINKSTYLE blue R < > |
| 29 | .\} |
| 30 | .SH "NAME" |
| 31 | cargo\-uninstall \- Remove a Rust binary |
| 32 | .SH "SYNOPSIS" |
| 33 | .sp |
| 34 | \fBcargo uninstall [\fIOPTIONS\fP] [\fISPEC\fP...]\fP |
| 35 | .SH "DESCRIPTION" |
| 36 | .sp |
| 37 | This command removes a package installed with \fBcargo\-install\fP(1). The \fISPEC\fP |
| 38 | argument is a package ID specification of the package to remove (see |
| 39 | \fBcargo\-pkgid\fP(1)). |
| 40 | .sp |
| 41 | By default all binaries are removed for a crate but the \fB\-\-bin\fP and |
| 42 | \fB\-\-example\fP flags can be used to only remove particular binaries. |
| 43 | .sp |
| 44 | The installation root is determined, in order of precedence: |
| 45 | .sp |
| 46 | .RS 4 |
| 47 | .ie n \{\ |
| 48 | \h'-04'\(bu\h'+03'\c |
| 49 | .\} |
| 50 | .el \{\ |
| 51 | . sp -1 |
| 52 | . IP \(bu 2.3 |
| 53 | .\} |
| 54 | \fB\-\-root\fP option |
| 55 | .RE |
| 56 | .sp |
| 57 | .RS 4 |
| 58 | .ie n \{\ |
| 59 | \h'-04'\(bu\h'+03'\c |
| 60 | .\} |
| 61 | .el \{\ |
| 62 | . sp -1 |
| 63 | . IP \(bu 2.3 |
| 64 | .\} |
| 65 | \fBCARGO_INSTALL_ROOT\fP environment variable |
| 66 | .RE |
| 67 | .sp |
| 68 | .RS 4 |
| 69 | .ie n \{\ |
| 70 | \h'-04'\(bu\h'+03'\c |
| 71 | .\} |
| 72 | .el \{\ |
| 73 | . sp -1 |
| 74 | . IP \(bu 2.3 |
| 75 | .\} |
| 76 | \fBinstall.root\fP Cargo \c |
| 77 | .URL "https://doc.rust\-lang.org/cargo/reference/config.html" "config value" "" |
| 78 | .RE |
| 79 | .sp |
| 80 | .RS 4 |
| 81 | .ie n \{\ |
| 82 | \h'-04'\(bu\h'+03'\c |
| 83 | .\} |
| 84 | .el \{\ |
| 85 | . sp -1 |
| 86 | . IP \(bu 2.3 |
| 87 | .\} |
| 88 | \fBCARGO_HOME\fP environment variable |
| 89 | .RE |
| 90 | .sp |
| 91 | .RS 4 |
| 92 | .ie n \{\ |
| 93 | \h'-04'\(bu\h'+03'\c |
| 94 | .\} |
| 95 | .el \{\ |
| 96 | . sp -1 |
| 97 | . IP \(bu 2.3 |
| 98 | .\} |
| 99 | \fB$HOME/.cargo\fP |
| 100 | .RE |
| 101 | .SH "OPTIONS" |
| 102 | .SS "Install Options" |
| 103 | .sp |
| 104 | \fB\-p\fP, \fB\-\-package\fP \fISPEC\fP... |
| 105 | .RS 4 |
| 106 | Package to uninstall. |
| 107 | .RE |
| 108 | .sp |
| 109 | \fB\-\-bin\fP \fINAME\fP... |
| 110 | .RS 4 |
| 111 | Only uninstall the binary \fINAME\fP. |
| 112 | .RE |
| 113 | .sp |
| 114 | \fB\-\-root\fP \fIDIR\fP |
| 115 | .RS 4 |
| 116 | Directory to uninstall packages from. |
| 117 | .RE |
| 118 | .SS "Display Options" |
| 119 | .sp |
| 120 | \fB\-v\fP, \fB\-\-verbose\fP |
| 121 | .RS 4 |
| 122 | Use verbose output. May be specified twice for "very verbose" output which |
| 123 | includes extra output such as dependency warnings and build script output. |
| 124 | May also be specified with the \fBterm.verbose\fP |
| 125 | .URL "https://doc.rust\-lang.org/cargo/reference/config.html" "config value" "." |
| 126 | .RE |
| 127 | .sp |
| 128 | \fB\-q\fP, \fB\-\-quiet\fP |
| 129 | .RS 4 |
| 130 | No output printed to stdout. |
| 131 | .RE |
| 132 | .sp |
| 133 | \fB\-\-color\fP \fIWHEN\fP |
| 134 | .RS 4 |
| 135 | Control when colored output is used. Valid values: |
| 136 | .sp |
| 137 | .RS 4 |
| 138 | .ie n \{\ |
| 139 | \h'-04'\(bu\h'+03'\c |
| 140 | .\} |
| 141 | .el \{\ |
| 142 | . sp -1 |
| 143 | . IP \(bu 2.3 |
| 144 | .\} |
| 145 | \fBauto\fP (default): Automatically detect if color support is available on the |
| 146 | terminal. |
| 147 | .RE |
| 148 | .sp |
| 149 | .RS 4 |
| 150 | .ie n \{\ |
| 151 | \h'-04'\(bu\h'+03'\c |
| 152 | .\} |
| 153 | .el \{\ |
| 154 | . sp -1 |
| 155 | . IP \(bu 2.3 |
| 156 | .\} |
| 157 | \fBalways\fP: Always display colors. |
| 158 | .RE |
| 159 | .sp |
| 160 | .RS 4 |
| 161 | .ie n \{\ |
| 162 | \h'-04'\(bu\h'+03'\c |
| 163 | .\} |
| 164 | .el \{\ |
| 165 | . sp -1 |
| 166 | . IP \(bu 2.3 |
| 167 | .\} |
| 168 | \fBnever\fP: Never display colors. |
| 169 | .RE |
| 170 | .sp |
| 171 | May also be specified with the \fBterm.color\fP |
| 172 | .URL "https://doc.rust\-lang.org/cargo/reference/config.html" "config value" "." |
| 173 | .RE |
| 174 | .SS "Common Options" |
| 175 | .sp |
| 176 | \fB\-h\fP, \fB\-\-help\fP |
| 177 | .RS 4 |
| 178 | Prints help information. |
| 179 | .RE |
| 180 | .sp |
| 181 | \fB\-Z\fP \fIFLAG\fP... |
| 182 | .RS 4 |
| 183 | Unstable (nightly\-only) flags to Cargo. Run \fBcargo \-Z help\fP for |
| 184 | details. |
| 185 | .RE |
| 186 | .SH "ENVIRONMENT" |
| 187 | .sp |
| 188 | See \c |
| 189 | .URL "https://doc.rust\-lang.org/cargo/reference/environment\-variables.html" "the reference" " " |
| 190 | for |
| 191 | details on environment variables that Cargo reads. |
| 192 | .SH "EXIT STATUS" |
| 193 | .sp |
| 194 | 0 |
| 195 | .RS 4 |
| 196 | Cargo succeeded. |
| 197 | .RE |
| 198 | .sp |
| 199 | 101 |
| 200 | .RS 4 |
| 201 | Cargo failed to complete. |
| 202 | .RE |
| 203 | .SH "EXAMPLES" |
| 204 | .sp |
| 205 | .RS 4 |
| 206 | .ie n \{\ |
| 207 | \h'-04' 1.\h'+01'\c |
| 208 | .\} |
| 209 | .el \{\ |
| 210 | . sp -1 |
| 211 | . IP " 1." 4.2 |
| 212 | .\} |
| 213 | Uninstall a previously installed package. |
| 214 | .sp |
| 215 | .if n .RS 4 |
| 216 | .nf |
| 217 | cargo uninstall ripgrep |
| 218 | .fi |
| 219 | .if n .RE |
| 220 | .RE |
| 221 | .SH "SEE ALSO" |
| 222 | .sp |
| 223 | \fBcargo\fP(1), \fBcargo\-install\fP(1) |