blob: 9d5dca9f3f7527fb1df1d788b5407d5c8899b077 [file] [log] [blame]
Matthew Maurerbd398542019-09-05 16:25:08 -07001'\" t
2.\" Title: cargo-locate-project
3.\" Author: [see the "AUTHOR(S)" section]
4.\" Generator: Asciidoctor 1.5.8
5.\" Date: 2018-12-20
6.\" Manual: \ \&
7.\" Source: \ \&
8.\" Language: English
9.\"
10.TH "CARGO\-LOCATE\-PROJECT" "1" "2018-12-20" "\ \&" "\ \&"
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\-locate\-project \- Print a JSON representation of a Cargo.toml file\(aqs location
32.SH "SYNOPSIS"
33.sp
34\fBcargo locate\-project [\fIOPTIONS\fP]\fP
35.SH "DESCRIPTION"
36.sp
37This command will print a JSON object to stdout with the full path to the
38\fBCargo.toml\fP manifest.
39.sp
40See also \fBcargo\-metadata\fP(1) which is capable of returning the path to a
41workspace root.
42.SH "OPTIONS"
43.SS "Display Options"
44.sp
45\fB\-v\fP, \fB\-\-verbose\fP
46.RS 4
47Use verbose output. May be specified twice for "very verbose" output which
48includes extra output such as dependency warnings and build script output.
49May also be specified with the \fBterm.verbose\fP
50.URL "https://doc.rust\-lang.org/cargo/reference/config.html" "config value" "."
51.RE
52.sp
53\fB\-q\fP, \fB\-\-quiet\fP
54.RS 4
55No output printed to stdout.
56.RE
57.sp
58\fB\-\-color\fP \fIWHEN\fP
59.RS 4
60Control when colored output is used. Valid values:
61.sp
62.RS 4
63.ie n \{\
64\h'-04'\(bu\h'+03'\c
65.\}
66.el \{\
67. sp -1
68. IP \(bu 2.3
69.\}
70\fBauto\fP (default): Automatically detect if color support is available on the
71terminal.
72.RE
73.sp
74.RS 4
75.ie n \{\
76\h'-04'\(bu\h'+03'\c
77.\}
78.el \{\
79. sp -1
80. IP \(bu 2.3
81.\}
82\fBalways\fP: Always display colors.
83.RE
84.sp
85.RS 4
86.ie n \{\
87\h'-04'\(bu\h'+03'\c
88.\}
89.el \{\
90. sp -1
91. IP \(bu 2.3
92.\}
93\fBnever\fP: Never display colors.
94.RE
95.sp
96May also be specified with the \fBterm.color\fP
97.URL "https://doc.rust\-lang.org/cargo/reference/config.html" "config value" "."
98.RE
99.SS "Manifest Options"
100.sp
101\fB\-\-manifest\-path\fP \fIPATH\fP
102.RS 4
103Path to the \fBCargo.toml\fP file. By default, Cargo searches in the current
104directory or any parent directory for the \fBCargo.toml\fP file.
105.RE
106.SS "Common Options"
107.sp
108\fB\-h\fP, \fB\-\-help\fP
109.RS 4
110Prints help information.
111.RE
112.sp
113\fB\-Z\fP \fIFLAG\fP...
114.RS 4
115Unstable (nightly\-only) flags to Cargo. Run \fBcargo \-Z help\fP for
116details.
117.RE
118.SH "ENVIRONMENT"
119.sp
120See \c
121.URL "https://doc.rust\-lang.org/cargo/reference/environment\-variables.html" "the reference" " "
122for
123details on environment variables that Cargo reads.
124.SH "EXIT STATUS"
125.sp
1260
127.RS 4
128Cargo succeeded.
129.RE
130.sp
131101
132.RS 4
133Cargo failed to complete.
134.RE
135.SH "EXAMPLES"
136.sp
137.RS 4
138.ie n \{\
139\h'-04' 1.\h'+01'\c
140.\}
141.el \{\
142. sp -1
143. IP " 1." 4.2
144.\}
145Display the path to the manifest based on the current directory:
146.sp
147.if n .RS 4
148.nf
149cargo locate\-project
150.fi
151.if n .RE
152.RE
153.SH "SEE ALSO"
154.sp
155\fBcargo\fP(1), \fBcargo\-metadata\fP(1)