blob: d78a5a53a360b88422124a3c370f4900530983e2 [file] [log] [blame]
Jeff Vander Stoep956d1432020-09-18 13:46:24 +02001'\" t
2.\" Title: cargo-uninstall
3.\" Author: [see the "AUTHOR(S)" section]
4.\" Generator: Asciidoctor 2.0.10
5.\" Date: 2019-09-05
6.\" Manual: \ \&
7.\" Source: \ \&
8.\" Language: English
9.\"
10.TH "CARGO\-UNINSTALL" "1" "2019-09-05" "\ \&" "\ \&"
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"
31cargo\-uninstall \- Remove a Rust binary
32.SH "SYNOPSIS"
33.sp
34\fBcargo uninstall [\fIOPTIONS\fP] [\fISPEC\fP...]\fP
35.SH "DESCRIPTION"
36.sp
37This command removes a package installed with \fBcargo\-install\fP(1). The \fISPEC\fP
38argument is a package ID specification of the package to remove (see
39\fBcargo\-pkgid\fP(1)).
40.sp
41By 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
44The 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
106Package to uninstall.
107.RE
108.sp
109\fB\-\-bin\fP \fINAME\fP...
110.RS 4
111Only uninstall the binary \fINAME\fP.
112.RE
113.sp
114\fB\-\-root\fP \fIDIR\fP
115.RS 4
116Directory to uninstall packages from.
117.RE
118.SS "Display Options"
119.sp
120\fB\-v\fP, \fB\-\-verbose\fP
121.RS 4
122Use verbose output. May be specified twice for "very verbose" output which
123includes extra output such as dependency warnings and build script output.
124May 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
130No output printed to stdout.
131.RE
132.sp
133\fB\-\-color\fP \fIWHEN\fP
134.RS 4
135Control 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
146terminal.
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
171May 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+TOOLCHAIN\fP
177.RS 4
178If Cargo has been installed with rustup, and the first argument to \fBcargo\fP
179begins with \fB+\fP, it will be interpreted as a rustup toolchain name (such
180as \fB+stable\fP or \fB+nightly\fP).
181See the \c
182.URL "https://github.com/rust\-lang/rustup/" "rustup documentation"
183for more information about how toolchain overrides work.
184.RE
185.sp
186\fB\-h\fP, \fB\-\-help\fP
187.RS 4
188Prints help information.
189.RE
190.sp
191\fB\-Z\fP \fIFLAG\fP...
192.RS 4
193Unstable (nightly\-only) flags to Cargo. Run \fBcargo \-Z help\fP for
194details.
195.RE
196.SH "ENVIRONMENT"
197.sp
198See \c
199.URL "https://doc.rust\-lang.org/cargo/reference/environment\-variables.html" "the reference" " "
200for
201details on environment variables that Cargo reads.
202.SH "EXIT STATUS"
203.sp
2040
205.RS 4
206Cargo succeeded.
207.RE
208.sp
209101
210.RS 4
211Cargo failed to complete.
212.RE
213.SH "EXAMPLES"
214.sp
215.RS 4
216.ie n \{\
217\h'-04' 1.\h'+01'\c
218.\}
219.el \{\
220. sp -1
221. IP " 1." 4.2
222.\}
223Uninstall a previously installed package.
224.sp
225.if n .RS 4
226.nf
227cargo uninstall ripgrep
228.fi
229.if n .RE
230.RE
231.SH "SEE ALSO"
232.sp
233\fBcargo\fP(1), \fBcargo\-install\fP(1)