| '\" t |
| .\" Title: cargo-search |
| .\" Author: [see the "AUTHOR(S)" section] |
| .\" Generator: Asciidoctor 1.5.8 |
| .\" Date: 2019-01-23 |
| .\" Manual: \ \& |
| .\" Source: \ \& |
| .\" Language: English |
| .\" |
| .TH "CARGO\-SEARCH" "1" "2019-01-23" "\ \&" "\ \&" |
| .ie \n(.g .ds Aq \(aq |
| .el .ds Aq ' |
| .ss \n[.ss] 0 |
| .nh |
| .ad l |
| .de URL |
| \fI\\$2\fP <\\$1>\\$3 |
| .. |
| .als MTO URL |
| .if \n[.g] \{\ |
| . mso www.tmac |
| . am URL |
| . ad l |
| . . |
| . am MTO |
| . ad l |
| . . |
| . LINKSTYLE blue R < > |
| .\} |
| .SH "NAME" |
| cargo\-search \- Search packages in crates.io |
| .SH "SYNOPSIS" |
| .sp |
| \fBcargo search [\fIOPTIONS\fP] [\fIQUERY\fP...]\fP |
| .SH "DESCRIPTION" |
| .sp |
| This performs a textual search for crates on \c |
| .URL "https://crates.io" "" "." |
| The matching |
| crates will be displayed along with their description in TOML format suitable |
| for copying into a \fBCargo.toml\fP manifest. |
| .SH "OPTIONS" |
| .SS "Search Options" |
| .sp |
| \fB\-\-limit\fP \fILIMIT\fP |
| .RS 4 |
| Limit the number of results (default: 10, max: 100). |
| .RE |
| .sp |
| \fB\-\-index\fP \fIINDEX\fP |
| .RS 4 |
| The URL of the registry index to use. |
| .RE |
| .sp |
| \fB\-\-registry\fP \fIREGISTRY\fP |
| .RS 4 |
| Name of the registry to use. Registry names are defined in \c |
| .URL "https://doc.rust\-lang.org/cargo/reference/config.html" "Cargo config files" "." |
| If not specified, the default registry is used, which is defined by the |
| \fBregistry.default\fP config key which defaults to \fBcrates\-io\fP. |
| .RE |
| .SS "Display Options" |
| .sp |
| \fB\-v\fP, \fB\-\-verbose\fP |
| .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\fP |
| .URL "https://doc.rust\-lang.org/cargo/reference/config.html" "config value" "." |
| .RE |
| .sp |
| \fB\-q\fP, \fB\-\-quiet\fP |
| .RS 4 |
| No output printed to stdout. |
| .RE |
| .sp |
| \fB\-\-color\fP \fIWHEN\fP |
| .RS 4 |
| Control when colored output is used. Valid values: |
| .sp |
| .RS 4 |
| .ie n \{\ |
| \h'-04'\(bu\h'+03'\c |
| .\} |
| .el \{\ |
| . sp -1 |
| . IP \(bu 2.3 |
| .\} |
| \fBauto\fP (default): Automatically detect if color support is available on the |
| terminal. |
| .RE |
| .sp |
| .RS 4 |
| .ie n \{\ |
| \h'-04'\(bu\h'+03'\c |
| .\} |
| .el \{\ |
| . sp -1 |
| . IP \(bu 2.3 |
| .\} |
| \fBalways\fP: Always display colors. |
| .RE |
| .sp |
| .RS 4 |
| .ie n \{\ |
| \h'-04'\(bu\h'+03'\c |
| .\} |
| .el \{\ |
| . sp -1 |
| . IP \(bu 2.3 |
| .\} |
| \fBnever\fP: Never display colors. |
| .RE |
| .sp |
| May also be specified with the \fBterm.color\fP |
| .URL "https://doc.rust\-lang.org/cargo/reference/config.html" "config value" "." |
| .RE |
| .SS "Common Options" |
| .sp |
| \fB\-h\fP, \fB\-\-help\fP |
| .RS 4 |
| Prints help information. |
| .RE |
| .sp |
| \fB\-Z\fP \fIFLAG\fP... |
| .RS 4 |
| Unstable (nightly\-only) flags to Cargo. Run \fBcargo \-Z help\fP for |
| details. |
| .RE |
| .SH "ENVIRONMENT" |
| .sp |
| See \c |
| .URL "https://doc.rust\-lang.org/cargo/reference/environment\-variables.html" "the reference" " " |
| for |
| details on environment variables that Cargo reads. |
| .SH "EXIT STATUS" |
| .sp |
| 0 |
| .RS 4 |
| Cargo succeeded. |
| .RE |
| .sp |
| 101 |
| .RS 4 |
| Cargo failed to complete. |
| .RE |
| .SH "EXAMPLES" |
| .sp |
| .RS 4 |
| .ie n \{\ |
| \h'-04' 1.\h'+01'\c |
| .\} |
| .el \{\ |
| . sp -1 |
| . IP " 1." 4.2 |
| .\} |
| Search for a package from crates.io: |
| .sp |
| .if n .RS 4 |
| .nf |
| cargo search serde |
| .fi |
| .if n .RE |
| .RE |
| .SH "SEE ALSO" |
| .sp |
| \fBcargo\fP(1), \fBcargo\-install\fP(1), \fBcargo\-publish\fP(1) |
