man-pages/man1/cargo-search.1.html
2021-03-31 01:06:50 +01:00

224 lines
5.0 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of CARGO-SEARCH</TITLE>
</HEAD><BODY>
<H1>CARGO-SEARCH</H1>
Section: &nbsp; (1)<BR>Updated: 2019-09-05<BR><A HREF="#index">Index</A>
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>
cargo-search - Search packages in crates.io
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>
<P>
<B>cargo search [</B><I>OPTIONS</I>] [<I>QUERY</I>...]
<A NAME="lbAD">&nbsp;</A>
<H2>DESCRIPTION</H2>
<P>
This performs a textual search for crates on
<I></I> &lt;<A HREF="https://crates.io">https://crates.io</A>&gt;.
The matching
crates will be displayed along with their description in TOML format suitable
for copying into a <B>Cargo.toml</B> manifest.
<A NAME="lbAE">&nbsp;</A>
<H2>OPTIONS</H2>
<A NAME="lbAF">&nbsp;</A>
<H3>Search Options</H3>
<P>
<B>--limit</B> <I>LIMIT</I>
<DL COMPACT><DT id="1"><DD>
Limit the number of results (default: 10, max: 100).
</DL>
<P>
<B>--index</B> <I>INDEX</I>
<DL COMPACT><DT id="2"><DD>
The URL of the registry index to use.
</DL>
<P>
<B>--registry</B> <I>REGISTRY</I>
<DL COMPACT><DT id="3"><DD>
Name of the registry to use. Registry names are defined in
<I>Cargo config files</I> &lt;<A HREF="https://doc.rust-lang.org/cargo/reference/config.html">https://doc.rust-lang.org/cargo/reference/config.html</A>&gt;.
If not specified, the default registry is used, which is defined by the
<B>registry.default</B> config key which defaults to <B>crates-io</B>.
</DL>
<A NAME="lbAG">&nbsp;</A>
<H3>Display Options</H3>
<P>
<B>-v</B>, <B>--verbose</B>
<DL COMPACT><DT id="4"><DD>
Use verbose output. May be specified twice for &quot;very verbose&quot; output which
includes extra output such as dependency warnings and build script output.
May also be specified with the <B>term.verbose</B>
<I>config value</I> &lt;<A HREF="https://doc.rust-lang.org/cargo/reference/config.html">https://doc.rust-lang.org/cargo/reference/config.html</A>&gt;.
</DL>
<P>
<B>-q</B>, <B>--quiet</B>
<DL COMPACT><DT id="5"><DD>
No output printed to stdout.
</DL>
<P>
<B>--color</B> <I>WHEN</I>
<DL COMPACT><DT id="6"><DD>
Control when colored output is used. Valid values:
<P>
<DL COMPACT><DT id="7"><DD>
&bull;
<B>auto</B> (default): Automatically detect if color support is available on the
terminal.
</DL>
<P>
<DL COMPACT><DT id="8"><DD>
&bull;
<B>always</B>: Always display colors.
</DL>
<P>
<DL COMPACT><DT id="9"><DD>
&bull;
<B>never</B>: Never display colors.
</DL>
<P>
May also be specified with the <B>term.color</B>
<I>config value</I> &lt;<A HREF="https://doc.rust-lang.org/cargo/reference/config.html">https://doc.rust-lang.org/cargo/reference/config.html</A>&gt;.
</DL>
<A NAME="lbAH">&nbsp;</A>
<H3>Common Options</H3>
<P>
<B>+TOOLCHAIN</B>
<DL COMPACT><DT id="10"><DD>
If Cargo has been installed with rustup, and the first argument to <B>cargo</B>
begins with <B>+</B>, it will be interpreted as a rustup toolchain name (such
as <B>+stable</B> or <B>+nightly</B>).
See the
<I>rustup documentation</I> &lt;<A HREF="https://github.com/rust-lang/rustup/">https://github.com/rust-lang/rustup/</A>&gt;
for more information about how toolchain overrides work.
</DL>
<P>
<B>-h</B>, <B>--help</B>
<DL COMPACT><DT id="11"><DD>
Prints help information.
</DL>
<P>
<B>-Z</B> <I>FLAG</I>...
<DL COMPACT><DT id="12"><DD>
Unstable (nightly-only) flags to Cargo. Run <B>cargo -Z help</B> for
details.
</DL>
<A NAME="lbAI">&nbsp;</A>
<H2>ENVIRONMENT</H2>
<P>
See
<I>the reference</I> &lt;<A HREF="https://doc.rust-lang.org/cargo/reference/environment-variables.html">https://doc.rust-lang.org/cargo/reference/environment-variables.html</A>&gt;
for
details on environment variables that Cargo reads.
<A NAME="lbAJ">&nbsp;</A>
<H2>EXIT STATUS</H2>
<P>
0
<DL COMPACT><DT id="13"><DD>
Cargo succeeded.
</DL>
<P>
101
<DL COMPACT><DT id="14"><DD>
Cargo failed to complete.
</DL>
<A NAME="lbAK">&nbsp;</A>
<H2>EXAMPLES</H2>
<P>
<DL COMPACT><DT id="15"><DD>
1.
Search for a package from crates.io:
<P>
<DL COMPACT><DT id="16"><DD>
<PRE>
cargo search serde
</PRE>
</DL>
</DL>
<A NAME="lbAL">&nbsp;</A>
<H2>SEE ALSO</H2>
<P>
<B><A HREF="/cgi-bin/man/man2html?1+cargo">cargo</A></B>(1), <B><A HREF="/cgi-bin/man/man2html?1+cargo-install">cargo-install</A></B>(1), <B><A HREF="/cgi-bin/man/man2html?1+cargo-publish">cargo-publish</A></B>(1)
<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT id="17"><A HREF="#lbAB">NAME</A><DD>
<DT id="18"><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT id="19"><A HREF="#lbAD">DESCRIPTION</A><DD>
<DT id="20"><A HREF="#lbAE">OPTIONS</A><DD>
<DL>
<DT id="21"><A HREF="#lbAF">Search Options</A><DD>
<DT id="22"><A HREF="#lbAG">Display Options</A><DD>
<DT id="23"><A HREF="#lbAH">Common Options</A><DD>
</DL>
<DT id="24"><A HREF="#lbAI">ENVIRONMENT</A><DD>
<DT id="25"><A HREF="#lbAJ">EXIT STATUS</A><DD>
<DT id="26"><A HREF="#lbAK">EXAMPLES</A><DD>
<DT id="27"><A HREF="#lbAL">SEE ALSO</A><DD>
</DL>
<HR>
This document was created by
<A HREF="/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 00:05:08 GMT, March 31, 2021
</BODY>
</HTML>