Add files using upload-large-folder tool
Browse filesThis view is limited to 50 files because it contains too many changes. See raw diff
- rust/.rustup/settings.toml +5 -0
- rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/bin/rust-gdb +28 -0
- rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/bin/rust-gdbgui +67 -0
- rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/bin/rust-lldb +37 -0
- rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/bin/rust-windbg.cmd +8 -0
- rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/etc/target-spec-json-schema.json +1361 -0
- rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-add.1 +369 -0
- rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-bench.1 +562 -0
- rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-build.1 +474 -0
- rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-check.1 +465 -0
- rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-clean.1 +248 -0
- rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-doc.1 +417 -0
- rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-fetch.1 +199 -0
- rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-fix.1 +562 -0
- rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-generate-lockfile.1 +192 -0
- rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-help.1 +167 -0
- rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-info.1 +201 -0
- rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-init.1 +171 -0
- rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-install.1 +538 -0
- rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-locate-project.1 +150 -0
- rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-login.1 +154 -0
- rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-logout.1 +153 -0
- rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-metadata.1 +552 -0
- rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-new.1 +166 -0
- rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-owner.1 +197 -0
- rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-package.1 +472 -0
- rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-pkgid.1 +258 -0
- rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-publish.1 +353 -0
- rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/zsh/site-functions/_cargo +478 -0
- rust/.rustup/update-hashes/stable-x86_64-pc-windows-msvc +1 -0
- sqlite_gui/printsupport/windowsprintersupport.dll +0 -0
- sqlite_gui/translations/qt_ar.qm +0 -0
- sqlite_gui/translations/qt_cs.qm +0 -0
- sqlite_gui/translations/qt_de.qm +0 -0
- sqlite_gui/translations/qt_en.qm +1 -0
- sqlite_gui/translations/qt_es.qm +0 -0
- sqlite_gui/translations/qt_fr.qm +0 -0
- sqlite_gui/translations/qt_it.qm +0 -0
- sqlite_gui/translations/qt_ja.qm +0 -0
- sqlite_gui/translations/qt_ko.qm +0 -0
- sqlite_gui/translations/qt_pl.qm +0 -0
- sqlite_gui/translations/qt_pt.qm +0 -0
- sqlite_gui/translations/qt_ru.qm +0 -0
- sqlite_gui/translations/qt_uk.qm +0 -0
- sqlite_gui/translations/qt_zh_TW.qm +0 -0
- sqlite_gui/translations/qtbase_en.qm +1 -0
- sqlite_gui/translations/qtmultimedia_ar.qm +0 -0
- sqlite_gui/translations/qtmultimedia_cs.qm +0 -0
- sqlite_gui/translations/qtmultimedia_de.qm +0 -0
- sqlite_gui/translations/qtmultimedia_en.qm +1 -0
rust/.rustup/settings.toml
ADDED
|
@@ -0,0 +1,5 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
version = "12"
|
| 2 |
+
default_toolchain = "stable-x86_64-pc-windows-msvc"
|
| 3 |
+
profile = "minimal"
|
| 4 |
+
|
| 5 |
+
[overrides]
|
rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/bin/rust-gdb
ADDED
|
@@ -0,0 +1,28 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
#!/bin/sh
|
| 2 |
+
# Exit if anything fails
|
| 3 |
+
set -e
|
| 4 |
+
|
| 5 |
+
# Prefer rustc in the same directory as this script
|
| 6 |
+
DIR="$(dirname "$0")"
|
| 7 |
+
if [ -x "$DIR/rustc" ]; then
|
| 8 |
+
RUSTC="$DIR/rustc"
|
| 9 |
+
else
|
| 10 |
+
RUSTC="rustc"
|
| 11 |
+
fi
|
| 12 |
+
|
| 13 |
+
# Find out where the pretty printer Python module is
|
| 14 |
+
RUSTC_SYSROOT="$("$RUSTC" --print=sysroot)"
|
| 15 |
+
GDB_PYTHON_MODULE_DIRECTORY="$RUSTC_SYSROOT/lib/rustlib/etc"
|
| 16 |
+
# Get the commit hash for path remapping
|
| 17 |
+
RUSTC_COMMIT_HASH="$("$RUSTC" -vV | sed -n 's/commit-hash: \([a-zA-Z0-9_]*\)/\1/p')"
|
| 18 |
+
|
| 19 |
+
# Run GDB with the additional arguments that load the pretty printers
|
| 20 |
+
# Set the environment variable `RUST_GDB` to overwrite the call to a
|
| 21 |
+
# different/specific command (defaults to `gdb`).
|
| 22 |
+
RUST_GDB="${RUST_GDB:-gdb}"
|
| 23 |
+
PYTHONPATH="$PYTHONPATH:$GDB_PYTHON_MODULE_DIRECTORY" exec ${RUST_GDB} \
|
| 24 |
+
--directory="$GDB_PYTHON_MODULE_DIRECTORY" \
|
| 25 |
+
-iex "add-auto-load-safe-path $GDB_PYTHON_MODULE_DIRECTORY" \
|
| 26 |
+
-iex "set substitute-path /rustc/$RUSTC_COMMIT_HASH $RUSTC_SYSROOT/lib/rustlib/src/rust" \
|
| 27 |
+
"$@"
|
| 28 |
+
|
rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/bin/rust-gdbgui
ADDED
|
@@ -0,0 +1,67 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
#!/bin/sh
|
| 2 |
+
|
| 3 |
+
# Exit if anything fails
|
| 4 |
+
set -e
|
| 5 |
+
|
| 6 |
+
if [ $# -eq 0 ] || [ "$1" = "-h" ] || [ "$1" = "-help" ] || [ "$1" = "--help" ]; then
|
| 7 |
+
echo "
|
| 8 |
+
rust-gdbgui
|
| 9 |
+
===========
|
| 10 |
+
gdbgui - https://gdbgui.com - is a graphical front-end to GDB
|
| 11 |
+
that runs in a browser. This script invokes gdbgui with the Rust
|
| 12 |
+
pretty printers loaded.
|
| 13 |
+
|
| 14 |
+
Simple usage : rust-gdbgui target/debug/myprog
|
| 15 |
+
With arguments: rust-gdbgui 'target/debug/myprog arg1 arg2...'
|
| 16 |
+
(note the quotes)
|
| 17 |
+
|
| 18 |
+
|
| 19 |
+
Hints
|
| 20 |
+
=====
|
| 21 |
+
gdbgui won't be able to find the rust 'main' method automatically, so
|
| 22 |
+
in its options make sure to disable the 'Add breakpoint to main after
|
| 23 |
+
loading executable' setting to avoid a 'File not found: main' warning
|
| 24 |
+
on startup.
|
| 25 |
+
|
| 26 |
+
Instead, type 'main' into gdbgui's file browser and you should get
|
| 27 |
+
auto-completion on the filename. Just pick 'main.rs', add a breakpoint
|
| 28 |
+
by clicking in the line number gutter, and type 'r' or hit the Restart
|
| 29 |
+
icon to start your program running.
|
| 30 |
+
"
|
| 31 |
+
exit 0
|
| 32 |
+
fi
|
| 33 |
+
|
| 34 |
+
# Prefer rustc in the same directory as this script
|
| 35 |
+
DIR="$(dirname "$0")"
|
| 36 |
+
if [ -x "$DIR/rustc" ]; then
|
| 37 |
+
RUSTC="$DIR/rustc"
|
| 38 |
+
else
|
| 39 |
+
RUSTC="rustc"
|
| 40 |
+
fi
|
| 41 |
+
|
| 42 |
+
# Find out where the pretty printer Python module is
|
| 43 |
+
RUSTC_SYSROOT="$("$RUSTC" --print=sysroot)"
|
| 44 |
+
GDB_PYTHON_MODULE_DIRECTORY="$RUSTC_SYSROOT/lib/rustlib/etc"
|
| 45 |
+
# Get the commit hash for path remapping
|
| 46 |
+
RUSTC_COMMIT_HASH="$("$RUSTC" -vV | sed -n 's/commit-hash: \([a-zA-Z0-9_]*\)/\1/p')"
|
| 47 |
+
|
| 48 |
+
# Set the environment variable `RUST_GDB` to overwrite the call to a
|
| 49 |
+
# different/specific command (defaults to `gdb`).
|
| 50 |
+
RUST_GDB="${RUST_GDB:-gdb}"
|
| 51 |
+
|
| 52 |
+
# Set the environment variable `RUST_GDBGUI` to overwrite the call to a
|
| 53 |
+
# different/specific command (defaults to `gdbgui`).
|
| 54 |
+
RUST_GDBGUI="${RUST_GDBGUI:-gdbgui}"
|
| 55 |
+
|
| 56 |
+
# These arguments get passed through to GDB and make it load the
|
| 57 |
+
# Rust pretty printers.
|
| 58 |
+
GDB_ARGS="--directory=\"$GDB_PYTHON_MODULE_DIRECTORY\" \
|
| 59 |
+
-iex \"add-auto-load-safe-path $GDB_PYTHON_MODULE_DIRECTORY\" \
|
| 60 |
+
-iex \"set substitute-path /rustc/$RUSTC_COMMIT_HASH $RUSTC_SYSROOT/lib/rustlib/src/rust\""
|
| 61 |
+
|
| 62 |
+
# Finally we execute gdbgui.
|
| 63 |
+
PYTHONPATH="$PYTHONPATH:$GDB_PYTHON_MODULE_DIRECTORY" \
|
| 64 |
+
exec ${RUST_GDBGUI} \
|
| 65 |
+
--gdb-cmd "${RUST_GDB} ${GDB_ARGS}" \
|
| 66 |
+
"${@}"
|
| 67 |
+
|
rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/bin/rust-lldb
ADDED
|
@@ -0,0 +1,37 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
#!/bin/sh
|
| 2 |
+
|
| 3 |
+
# Exit if anything fails
|
| 4 |
+
set -e
|
| 5 |
+
|
| 6 |
+
# Find the host triple so we can find lldb in rustlib.
|
| 7 |
+
host=$(rustc --print host-tuple)
|
| 8 |
+
|
| 9 |
+
# Find out where to look for the pretty printer Python module
|
| 10 |
+
RUSTC_SYSROOT=$(rustc --print sysroot)
|
| 11 |
+
RUST_LLDB="$RUSTC_SYSROOT/lib/rustlib/$host/bin/lldb"
|
| 12 |
+
|
| 13 |
+
lldb=lldb
|
| 14 |
+
if [ -f "$RUST_LLDB" ]; then
|
| 15 |
+
lldb="$RUST_LLDB"
|
| 16 |
+
else
|
| 17 |
+
if ! command -v "$lldb" > /dev/null; then
|
| 18 |
+
echo "$lldb not found! Please install it." >&2
|
| 19 |
+
exit 1
|
| 20 |
+
else
|
| 21 |
+
LLDB_VERSION=$("$lldb" --version | cut -d ' ' -f3)
|
| 22 |
+
|
| 23 |
+
if [ "$LLDB_VERSION" = "3.5.0" ]; then
|
| 24 |
+
cat << EOF >&2
|
| 25 |
+
***
|
| 26 |
+
WARNING: This version of LLDB has known issues with Rust and cannot display the contents of local variables!
|
| 27 |
+
***
|
| 28 |
+
EOF
|
| 29 |
+
fi
|
| 30 |
+
fi
|
| 31 |
+
fi
|
| 32 |
+
|
| 33 |
+
script_import="command script import \"$RUSTC_SYSROOT/lib/rustlib/etc/lldb_lookup.py\""
|
| 34 |
+
commands_file="$RUSTC_SYSROOT/lib/rustlib/etc/lldb_commands"
|
| 35 |
+
|
| 36 |
+
# Call LLDB with the commands added to the argument list
|
| 37 |
+
exec "$lldb" --one-line-before-file "$script_import" --source-before-file "$commands_file" "$@"
|
rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/bin/rust-windbg.cmd
ADDED
|
@@ -0,0 +1,8 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
@echo off
|
| 2 |
+
setlocal
|
| 3 |
+
|
| 4 |
+
for /f "delims=" %%i in ('rustc --print=sysroot') do set rustc_sysroot=%%i
|
| 5 |
+
|
| 6 |
+
set rust_etc=%rustc_sysroot%\lib\rustlib\etc
|
| 7 |
+
|
| 8 |
+
windbg -c ".nvload %rust_etc%\intrinsic.natvis; .nvload %rust_etc%\liballoc.natvis; .nvload %rust_etc%\libcore.natvis;" %*
|
rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/etc/target-spec-json-schema.json
ADDED
|
@@ -0,0 +1,1361 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
{
|
| 2 |
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
| 3 |
+
"title": "TargetSpecJson",
|
| 4 |
+
"type": "object",
|
| 5 |
+
"properties": {
|
| 6 |
+
"abi": {
|
| 7 |
+
"anyOf": [
|
| 8 |
+
{
|
| 9 |
+
"$ref": "#/$defs/Abi"
|
| 10 |
+
},
|
| 11 |
+
{
|
| 12 |
+
"type": "null"
|
| 13 |
+
}
|
| 14 |
+
]
|
| 15 |
+
},
|
| 16 |
+
"abi-return-struct-as-int": {
|
| 17 |
+
"type": [
|
| 18 |
+
"boolean",
|
| 19 |
+
"null"
|
| 20 |
+
]
|
| 21 |
+
},
|
| 22 |
+
"allow-asm": {
|
| 23 |
+
"type": [
|
| 24 |
+
"boolean",
|
| 25 |
+
"null"
|
| 26 |
+
]
|
| 27 |
+
},
|
| 28 |
+
"allows-weak-linkage": {
|
| 29 |
+
"type": [
|
| 30 |
+
"boolean",
|
| 31 |
+
"null"
|
| 32 |
+
]
|
| 33 |
+
},
|
| 34 |
+
"arch": {
|
| 35 |
+
"$ref": "#/$defs/Arch"
|
| 36 |
+
},
|
| 37 |
+
"archive-format": {
|
| 38 |
+
"type": [
|
| 39 |
+
"string",
|
| 40 |
+
"null"
|
| 41 |
+
]
|
| 42 |
+
},
|
| 43 |
+
"asm-args": {
|
| 44 |
+
"type": [
|
| 45 |
+
"array",
|
| 46 |
+
"null"
|
| 47 |
+
],
|
| 48 |
+
"items": {
|
| 49 |
+
"type": "string"
|
| 50 |
+
}
|
| 51 |
+
},
|
| 52 |
+
"atomic-cas": {
|
| 53 |
+
"type": [
|
| 54 |
+
"boolean",
|
| 55 |
+
"null"
|
| 56 |
+
]
|
| 57 |
+
},
|
| 58 |
+
"binary-format": {
|
| 59 |
+
"anyOf": [
|
| 60 |
+
{
|
| 61 |
+
"$ref": "#/$defs/BinaryFormat"
|
| 62 |
+
},
|
| 63 |
+
{
|
| 64 |
+
"type": "null"
|
| 65 |
+
}
|
| 66 |
+
]
|
| 67 |
+
},
|
| 68 |
+
"c-enum-min-bits": {
|
| 69 |
+
"type": [
|
| 70 |
+
"integer",
|
| 71 |
+
"null"
|
| 72 |
+
],
|
| 73 |
+
"format": "uint64",
|
| 74 |
+
"minimum": 0
|
| 75 |
+
},
|
| 76 |
+
"code-model": {
|
| 77 |
+
"anyOf": [
|
| 78 |
+
{
|
| 79 |
+
"$ref": "#/$defs/CodeModel"
|
| 80 |
+
},
|
| 81 |
+
{
|
| 82 |
+
"type": "null"
|
| 83 |
+
}
|
| 84 |
+
]
|
| 85 |
+
},
|
| 86 |
+
"cpu": {
|
| 87 |
+
"type": [
|
| 88 |
+
"string",
|
| 89 |
+
"null"
|
| 90 |
+
]
|
| 91 |
+
},
|
| 92 |
+
"crt-objects-fallback": {
|
| 93 |
+
"anyOf": [
|
| 94 |
+
{
|
| 95 |
+
"$ref": "#/$defs/LinkSelfContainedDefault"
|
| 96 |
+
},
|
| 97 |
+
{
|
| 98 |
+
"type": "null"
|
| 99 |
+
}
|
| 100 |
+
]
|
| 101 |
+
},
|
| 102 |
+
"crt-static-allows-dylibs": {
|
| 103 |
+
"type": [
|
| 104 |
+
"boolean",
|
| 105 |
+
"null"
|
| 106 |
+
]
|
| 107 |
+
},
|
| 108 |
+
"crt-static-default": {
|
| 109 |
+
"type": [
|
| 110 |
+
"boolean",
|
| 111 |
+
"null"
|
| 112 |
+
]
|
| 113 |
+
},
|
| 114 |
+
"crt-static-respected": {
|
| 115 |
+
"type": [
|
| 116 |
+
"boolean",
|
| 117 |
+
"null"
|
| 118 |
+
]
|
| 119 |
+
},
|
| 120 |
+
"data-layout": {
|
| 121 |
+
"type": "string"
|
| 122 |
+
},
|
| 123 |
+
"debuginfo-kind": {
|
| 124 |
+
"anyOf": [
|
| 125 |
+
{
|
| 126 |
+
"$ref": "#/$defs/DebuginfoKind"
|
| 127 |
+
},
|
| 128 |
+
{
|
| 129 |
+
"type": "null"
|
| 130 |
+
}
|
| 131 |
+
]
|
| 132 |
+
},
|
| 133 |
+
"default-codegen-backend": {
|
| 134 |
+
"type": [
|
| 135 |
+
"string",
|
| 136 |
+
"null"
|
| 137 |
+
]
|
| 138 |
+
},
|
| 139 |
+
"default-codegen-units": {
|
| 140 |
+
"type": [
|
| 141 |
+
"integer",
|
| 142 |
+
"null"
|
| 143 |
+
],
|
| 144 |
+
"format": "uint64",
|
| 145 |
+
"minimum": 0
|
| 146 |
+
},
|
| 147 |
+
"default-dwarf-version": {
|
| 148 |
+
"type": [
|
| 149 |
+
"integer",
|
| 150 |
+
"null"
|
| 151 |
+
],
|
| 152 |
+
"format": "uint32",
|
| 153 |
+
"minimum": 0
|
| 154 |
+
},
|
| 155 |
+
"default-sanitizers": {
|
| 156 |
+
"type": [
|
| 157 |
+
"array",
|
| 158 |
+
"null"
|
| 159 |
+
],
|
| 160 |
+
"items": {
|
| 161 |
+
"$ref": "#/$defs/SanitizerSet"
|
| 162 |
+
}
|
| 163 |
+
},
|
| 164 |
+
"default-uwtable": {
|
| 165 |
+
"type": [
|
| 166 |
+
"boolean",
|
| 167 |
+
"null"
|
| 168 |
+
]
|
| 169 |
+
},
|
| 170 |
+
"default-visibility": {
|
| 171 |
+
"anyOf": [
|
| 172 |
+
{
|
| 173 |
+
"$ref": "#/$defs/SymbolVisibility"
|
| 174 |
+
},
|
| 175 |
+
{
|
| 176 |
+
"type": "null"
|
| 177 |
+
}
|
| 178 |
+
]
|
| 179 |
+
},
|
| 180 |
+
"direct-access-external-data": {
|
| 181 |
+
"type": [
|
| 182 |
+
"boolean",
|
| 183 |
+
"null"
|
| 184 |
+
]
|
| 185 |
+
},
|
| 186 |
+
"disable-redzone": {
|
| 187 |
+
"type": [
|
| 188 |
+
"boolean",
|
| 189 |
+
"null"
|
| 190 |
+
]
|
| 191 |
+
},
|
| 192 |
+
"dll-prefix": {
|
| 193 |
+
"type": [
|
| 194 |
+
"string",
|
| 195 |
+
"null"
|
| 196 |
+
]
|
| 197 |
+
},
|
| 198 |
+
"dll-suffix": {
|
| 199 |
+
"type": [
|
| 200 |
+
"string",
|
| 201 |
+
"null"
|
| 202 |
+
]
|
| 203 |
+
},
|
| 204 |
+
"dll-tls-export": {
|
| 205 |
+
"type": [
|
| 206 |
+
"boolean",
|
| 207 |
+
"null"
|
| 208 |
+
]
|
| 209 |
+
},
|
| 210 |
+
"dynamic-linking": {
|
| 211 |
+
"type": [
|
| 212 |
+
"boolean",
|
| 213 |
+
"null"
|
| 214 |
+
]
|
| 215 |
+
},
|
| 216 |
+
"eh-frame-header": {
|
| 217 |
+
"type": [
|
| 218 |
+
"boolean",
|
| 219 |
+
"null"
|
| 220 |
+
]
|
| 221 |
+
},
|
| 222 |
+
"emit-debug-gdb-scripts": {
|
| 223 |
+
"type": [
|
| 224 |
+
"boolean",
|
| 225 |
+
"null"
|
| 226 |
+
]
|
| 227 |
+
},
|
| 228 |
+
"entry-abi": {
|
| 229 |
+
"anyOf": [
|
| 230 |
+
{
|
| 231 |
+
"$ref": "#/$defs/ExternAbi"
|
| 232 |
+
},
|
| 233 |
+
{
|
| 234 |
+
"type": "null"
|
| 235 |
+
}
|
| 236 |
+
]
|
| 237 |
+
},
|
| 238 |
+
"entry-name": {
|
| 239 |
+
"type": [
|
| 240 |
+
"string",
|
| 241 |
+
"null"
|
| 242 |
+
]
|
| 243 |
+
},
|
| 244 |
+
"env": {
|
| 245 |
+
"anyOf": [
|
| 246 |
+
{
|
| 247 |
+
"$ref": "#/$defs/Env"
|
| 248 |
+
},
|
| 249 |
+
{
|
| 250 |
+
"type": "null"
|
| 251 |
+
}
|
| 252 |
+
]
|
| 253 |
+
},
|
| 254 |
+
"exe-suffix": {
|
| 255 |
+
"type": [
|
| 256 |
+
"string",
|
| 257 |
+
"null"
|
| 258 |
+
]
|
| 259 |
+
},
|
| 260 |
+
"executables": {
|
| 261 |
+
"type": [
|
| 262 |
+
"boolean",
|
| 263 |
+
"null"
|
| 264 |
+
]
|
| 265 |
+
},
|
| 266 |
+
"features": {
|
| 267 |
+
"type": [
|
| 268 |
+
"string",
|
| 269 |
+
"null"
|
| 270 |
+
]
|
| 271 |
+
},
|
| 272 |
+
"frame-pointer": {
|
| 273 |
+
"anyOf": [
|
| 274 |
+
{
|
| 275 |
+
"$ref": "#/$defs/FramePointer"
|
| 276 |
+
},
|
| 277 |
+
{
|
| 278 |
+
"type": "null"
|
| 279 |
+
}
|
| 280 |
+
]
|
| 281 |
+
},
|
| 282 |
+
"function-sections": {
|
| 283 |
+
"type": [
|
| 284 |
+
"boolean",
|
| 285 |
+
"null"
|
| 286 |
+
]
|
| 287 |
+
},
|
| 288 |
+
"generate-arange-section": {
|
| 289 |
+
"type": [
|
| 290 |
+
"boolean",
|
| 291 |
+
"null"
|
| 292 |
+
]
|
| 293 |
+
},
|
| 294 |
+
"has-rpath": {
|
| 295 |
+
"type": [
|
| 296 |
+
"boolean",
|
| 297 |
+
"null"
|
| 298 |
+
]
|
| 299 |
+
},
|
| 300 |
+
"has-thread-local": {
|
| 301 |
+
"type": [
|
| 302 |
+
"boolean",
|
| 303 |
+
"null"
|
| 304 |
+
]
|
| 305 |
+
},
|
| 306 |
+
"has-thumb-interworking": {
|
| 307 |
+
"type": [
|
| 308 |
+
"boolean",
|
| 309 |
+
"null"
|
| 310 |
+
]
|
| 311 |
+
},
|
| 312 |
+
"is-like-aix": {
|
| 313 |
+
"type": [
|
| 314 |
+
"boolean",
|
| 315 |
+
"null"
|
| 316 |
+
]
|
| 317 |
+
},
|
| 318 |
+
"is-like-android": {
|
| 319 |
+
"type": [
|
| 320 |
+
"boolean",
|
| 321 |
+
"null"
|
| 322 |
+
]
|
| 323 |
+
},
|
| 324 |
+
"is-like-darwin": {
|
| 325 |
+
"type": [
|
| 326 |
+
"boolean",
|
| 327 |
+
"null"
|
| 328 |
+
]
|
| 329 |
+
},
|
| 330 |
+
"is-like-gpu": {
|
| 331 |
+
"type": [
|
| 332 |
+
"boolean",
|
| 333 |
+
"null"
|
| 334 |
+
]
|
| 335 |
+
},
|
| 336 |
+
"is-like-msvc": {
|
| 337 |
+
"type": [
|
| 338 |
+
"boolean",
|
| 339 |
+
"null"
|
| 340 |
+
]
|
| 341 |
+
},
|
| 342 |
+
"is-like-solaris": {
|
| 343 |
+
"type": [
|
| 344 |
+
"boolean",
|
| 345 |
+
"null"
|
| 346 |
+
]
|
| 347 |
+
},
|
| 348 |
+
"is-like-vexos": {
|
| 349 |
+
"type": [
|
| 350 |
+
"boolean",
|
| 351 |
+
"null"
|
| 352 |
+
]
|
| 353 |
+
},
|
| 354 |
+
"is-like-wasm": {
|
| 355 |
+
"type": [
|
| 356 |
+
"boolean",
|
| 357 |
+
"null"
|
| 358 |
+
]
|
| 359 |
+
},
|
| 360 |
+
"is-like-windows": {
|
| 361 |
+
"type": [
|
| 362 |
+
"boolean",
|
| 363 |
+
"null"
|
| 364 |
+
]
|
| 365 |
+
},
|
| 366 |
+
"late-link-args": {
|
| 367 |
+
"type": [
|
| 368 |
+
"object",
|
| 369 |
+
"null"
|
| 370 |
+
],
|
| 371 |
+
"additionalProperties": {
|
| 372 |
+
"type": "array",
|
| 373 |
+
"items": {
|
| 374 |
+
"type": "string"
|
| 375 |
+
}
|
| 376 |
+
}
|
| 377 |
+
},
|
| 378 |
+
"late-link-args-dynamic": {
|
| 379 |
+
"type": [
|
| 380 |
+
"object",
|
| 381 |
+
"null"
|
| 382 |
+
],
|
| 383 |
+
"additionalProperties": {
|
| 384 |
+
"type": "array",
|
| 385 |
+
"items": {
|
| 386 |
+
"type": "string"
|
| 387 |
+
}
|
| 388 |
+
}
|
| 389 |
+
},
|
| 390 |
+
"late-link-args-static": {
|
| 391 |
+
"type": [
|
| 392 |
+
"object",
|
| 393 |
+
"null"
|
| 394 |
+
],
|
| 395 |
+
"additionalProperties": {
|
| 396 |
+
"type": "array",
|
| 397 |
+
"items": {
|
| 398 |
+
"type": "string"
|
| 399 |
+
}
|
| 400 |
+
}
|
| 401 |
+
},
|
| 402 |
+
"limit-rdylib-exports": {
|
| 403 |
+
"type": [
|
| 404 |
+
"boolean",
|
| 405 |
+
"null"
|
| 406 |
+
]
|
| 407 |
+
},
|
| 408 |
+
"link-env": {
|
| 409 |
+
"type": [
|
| 410 |
+
"array",
|
| 411 |
+
"null"
|
| 412 |
+
],
|
| 413 |
+
"items": {
|
| 414 |
+
"type": "string"
|
| 415 |
+
}
|
| 416 |
+
},
|
| 417 |
+
"link-env-remove": {
|
| 418 |
+
"type": [
|
| 419 |
+
"array",
|
| 420 |
+
"null"
|
| 421 |
+
],
|
| 422 |
+
"items": {
|
| 423 |
+
"type": "string"
|
| 424 |
+
}
|
| 425 |
+
},
|
| 426 |
+
"link-script": {
|
| 427 |
+
"type": [
|
| 428 |
+
"string",
|
| 429 |
+
"null"
|
| 430 |
+
]
|
| 431 |
+
},
|
| 432 |
+
"link-self-contained": {
|
| 433 |
+
"anyOf": [
|
| 434 |
+
{
|
| 435 |
+
"$ref": "#/$defs/LinkSelfContainedComponentsWrapper"
|
| 436 |
+
},
|
| 437 |
+
{
|
| 438 |
+
"type": "null"
|
| 439 |
+
}
|
| 440 |
+
]
|
| 441 |
+
},
|
| 442 |
+
"linker": {
|
| 443 |
+
"type": [
|
| 444 |
+
"string",
|
| 445 |
+
"null"
|
| 446 |
+
]
|
| 447 |
+
},
|
| 448 |
+
"linker-flavor": {
|
| 449 |
+
"anyOf": [
|
| 450 |
+
{
|
| 451 |
+
"$ref": "#/$defs/LinkerFlavor"
|
| 452 |
+
},
|
| 453 |
+
{
|
| 454 |
+
"type": "null"
|
| 455 |
+
}
|
| 456 |
+
]
|
| 457 |
+
},
|
| 458 |
+
"linker-is-gnu": {
|
| 459 |
+
"type": [
|
| 460 |
+
"boolean",
|
| 461 |
+
"null"
|
| 462 |
+
]
|
| 463 |
+
},
|
| 464 |
+
"lld-flavor": {
|
| 465 |
+
"anyOf": [
|
| 466 |
+
{
|
| 467 |
+
"$ref": "#/$defs/LldFlavor"
|
| 468 |
+
},
|
| 469 |
+
{
|
| 470 |
+
"type": "null"
|
| 471 |
+
}
|
| 472 |
+
]
|
| 473 |
+
},
|
| 474 |
+
"llvm-abiname": {
|
| 475 |
+
"type": [
|
| 476 |
+
"string",
|
| 477 |
+
"null"
|
| 478 |
+
]
|
| 479 |
+
},
|
| 480 |
+
"llvm-args": {
|
| 481 |
+
"type": [
|
| 482 |
+
"array",
|
| 483 |
+
"null"
|
| 484 |
+
],
|
| 485 |
+
"items": {
|
| 486 |
+
"type": "string"
|
| 487 |
+
}
|
| 488 |
+
},
|
| 489 |
+
"llvm-floatabi": {
|
| 490 |
+
"anyOf": [
|
| 491 |
+
{
|
| 492 |
+
"$ref": "#/$defs/FloatAbi"
|
| 493 |
+
},
|
| 494 |
+
{
|
| 495 |
+
"type": "null"
|
| 496 |
+
}
|
| 497 |
+
]
|
| 498 |
+
},
|
| 499 |
+
"llvm-mcount-intrinsic": {
|
| 500 |
+
"type": [
|
| 501 |
+
"string",
|
| 502 |
+
"null"
|
| 503 |
+
]
|
| 504 |
+
},
|
| 505 |
+
"llvm-target": {
|
| 506 |
+
"type": "string"
|
| 507 |
+
},
|
| 508 |
+
"main-needs-argc-argv": {
|
| 509 |
+
"type": [
|
| 510 |
+
"boolean",
|
| 511 |
+
"null"
|
| 512 |
+
]
|
| 513 |
+
},
|
| 514 |
+
"max-atomic-width": {
|
| 515 |
+
"type": [
|
| 516 |
+
"integer",
|
| 517 |
+
"null"
|
| 518 |
+
],
|
| 519 |
+
"format": "uint64",
|
| 520 |
+
"minimum": 0
|
| 521 |
+
},
|
| 522 |
+
"merge-functions": {
|
| 523 |
+
"anyOf": [
|
| 524 |
+
{
|
| 525 |
+
"$ref": "#/$defs/MergeFunctions"
|
| 526 |
+
},
|
| 527 |
+
{
|
| 528 |
+
"type": "null"
|
| 529 |
+
}
|
| 530 |
+
]
|
| 531 |
+
},
|
| 532 |
+
"metadata": {
|
| 533 |
+
"anyOf": [
|
| 534 |
+
{
|
| 535 |
+
"$ref": "#/$defs/TargetSpecJsonMetadata"
|
| 536 |
+
},
|
| 537 |
+
{
|
| 538 |
+
"type": "null"
|
| 539 |
+
}
|
| 540 |
+
]
|
| 541 |
+
},
|
| 542 |
+
"min-atomic-width": {
|
| 543 |
+
"type": [
|
| 544 |
+
"integer",
|
| 545 |
+
"null"
|
| 546 |
+
],
|
| 547 |
+
"format": "uint64",
|
| 548 |
+
"minimum": 0
|
| 549 |
+
},
|
| 550 |
+
"min-global-align": {
|
| 551 |
+
"type": [
|
| 552 |
+
"integer",
|
| 553 |
+
"null"
|
| 554 |
+
],
|
| 555 |
+
"format": "uint64",
|
| 556 |
+
"minimum": 0
|
| 557 |
+
},
|
| 558 |
+
"need-explicit-cpu": {
|
| 559 |
+
"type": [
|
| 560 |
+
"boolean",
|
| 561 |
+
"null"
|
| 562 |
+
]
|
| 563 |
+
},
|
| 564 |
+
"no-builtins": {
|
| 565 |
+
"type": [
|
| 566 |
+
"boolean",
|
| 567 |
+
"null"
|
| 568 |
+
]
|
| 569 |
+
},
|
| 570 |
+
"no-default-libraries": {
|
| 571 |
+
"type": [
|
| 572 |
+
"boolean",
|
| 573 |
+
"null"
|
| 574 |
+
]
|
| 575 |
+
},
|
| 576 |
+
"obj-is-bitcode": {
|
| 577 |
+
"type": [
|
| 578 |
+
"boolean",
|
| 579 |
+
"null"
|
| 580 |
+
]
|
| 581 |
+
},
|
| 582 |
+
"only-cdylib": {
|
| 583 |
+
"type": [
|
| 584 |
+
"boolean",
|
| 585 |
+
"null"
|
| 586 |
+
]
|
| 587 |
+
},
|
| 588 |
+
"os": {
|
| 589 |
+
"anyOf": [
|
| 590 |
+
{
|
| 591 |
+
"$ref": "#/$defs/Os"
|
| 592 |
+
},
|
| 593 |
+
{
|
| 594 |
+
"type": "null"
|
| 595 |
+
}
|
| 596 |
+
]
|
| 597 |
+
},
|
| 598 |
+
"override-export-symbols": {
|
| 599 |
+
"type": [
|
| 600 |
+
"array",
|
| 601 |
+
"null"
|
| 602 |
+
],
|
| 603 |
+
"items": {
|
| 604 |
+
"type": "string"
|
| 605 |
+
}
|
| 606 |
+
},
|
| 607 |
+
"panic-strategy": {
|
| 608 |
+
"anyOf": [
|
| 609 |
+
{
|
| 610 |
+
"$ref": "#/$defs/PanicStrategy"
|
| 611 |
+
},
|
| 612 |
+
{
|
| 613 |
+
"type": "null"
|
| 614 |
+
}
|
| 615 |
+
]
|
| 616 |
+
},
|
| 617 |
+
"plt-by-default": {
|
| 618 |
+
"type": [
|
| 619 |
+
"boolean",
|
| 620 |
+
"null"
|
| 621 |
+
]
|
| 622 |
+
},
|
| 623 |
+
"position-independent-executables": {
|
| 624 |
+
"type": [
|
| 625 |
+
"boolean",
|
| 626 |
+
"null"
|
| 627 |
+
]
|
| 628 |
+
},
|
| 629 |
+
"post-link-args": {
|
| 630 |
+
"type": [
|
| 631 |
+
"object",
|
| 632 |
+
"null"
|
| 633 |
+
],
|
| 634 |
+
"additionalProperties": {
|
| 635 |
+
"type": "array",
|
| 636 |
+
"items": {
|
| 637 |
+
"type": "string"
|
| 638 |
+
}
|
| 639 |
+
}
|
| 640 |
+
},
|
| 641 |
+
"post-link-objects": {
|
| 642 |
+
"type": [
|
| 643 |
+
"object",
|
| 644 |
+
"null"
|
| 645 |
+
],
|
| 646 |
+
"additionalProperties": {
|
| 647 |
+
"type": "array",
|
| 648 |
+
"items": {
|
| 649 |
+
"type": "string"
|
| 650 |
+
}
|
| 651 |
+
}
|
| 652 |
+
},
|
| 653 |
+
"post-link-objects-fallback": {
|
| 654 |
+
"type": [
|
| 655 |
+
"object",
|
| 656 |
+
"null"
|
| 657 |
+
],
|
| 658 |
+
"additionalProperties": {
|
| 659 |
+
"type": "array",
|
| 660 |
+
"items": {
|
| 661 |
+
"type": "string"
|
| 662 |
+
}
|
| 663 |
+
}
|
| 664 |
+
},
|
| 665 |
+
"pre-link-args": {
|
| 666 |
+
"type": [
|
| 667 |
+
"object",
|
| 668 |
+
"null"
|
| 669 |
+
],
|
| 670 |
+
"additionalProperties": {
|
| 671 |
+
"type": "array",
|
| 672 |
+
"items": {
|
| 673 |
+
"type": "string"
|
| 674 |
+
}
|
| 675 |
+
}
|
| 676 |
+
},
|
| 677 |
+
"pre-link-objects": {
|
| 678 |
+
"type": [
|
| 679 |
+
"object",
|
| 680 |
+
"null"
|
| 681 |
+
],
|
| 682 |
+
"additionalProperties": {
|
| 683 |
+
"type": "array",
|
| 684 |
+
"items": {
|
| 685 |
+
"type": "string"
|
| 686 |
+
}
|
| 687 |
+
}
|
| 688 |
+
},
|
| 689 |
+
"pre-link-objects-fallback": {
|
| 690 |
+
"type": [
|
| 691 |
+
"object",
|
| 692 |
+
"null"
|
| 693 |
+
],
|
| 694 |
+
"additionalProperties": {
|
| 695 |
+
"type": "array",
|
| 696 |
+
"items": {
|
| 697 |
+
"type": "string"
|
| 698 |
+
}
|
| 699 |
+
}
|
| 700 |
+
},
|
| 701 |
+
"relax-elf-relocations": {
|
| 702 |
+
"type": [
|
| 703 |
+
"boolean",
|
| 704 |
+
"null"
|
| 705 |
+
]
|
| 706 |
+
},
|
| 707 |
+
"relocation-model": {
|
| 708 |
+
"anyOf": [
|
| 709 |
+
{
|
| 710 |
+
"$ref": "#/$defs/RelocModel"
|
| 711 |
+
},
|
| 712 |
+
{
|
| 713 |
+
"type": "null"
|
| 714 |
+
}
|
| 715 |
+
]
|
| 716 |
+
},
|
| 717 |
+
"relro-level": {
|
| 718 |
+
"anyOf": [
|
| 719 |
+
{
|
| 720 |
+
"$ref": "#/$defs/RelroLevel"
|
| 721 |
+
},
|
| 722 |
+
{
|
| 723 |
+
"type": "null"
|
| 724 |
+
}
|
| 725 |
+
]
|
| 726 |
+
},
|
| 727 |
+
"requires-lto": {
|
| 728 |
+
"type": [
|
| 729 |
+
"boolean",
|
| 730 |
+
"null"
|
| 731 |
+
]
|
| 732 |
+
},
|
| 733 |
+
"requires-uwtable": {
|
| 734 |
+
"type": [
|
| 735 |
+
"boolean",
|
| 736 |
+
"null"
|
| 737 |
+
]
|
| 738 |
+
},
|
| 739 |
+
"rustc-abi": {
|
| 740 |
+
"anyOf": [
|
| 741 |
+
{
|
| 742 |
+
"$ref": "#/$defs/RustcAbi"
|
| 743 |
+
},
|
| 744 |
+
{
|
| 745 |
+
"type": "null"
|
| 746 |
+
}
|
| 747 |
+
]
|
| 748 |
+
},
|
| 749 |
+
"simd-types-indirect": {
|
| 750 |
+
"type": [
|
| 751 |
+
"boolean",
|
| 752 |
+
"null"
|
| 753 |
+
]
|
| 754 |
+
},
|
| 755 |
+
"singlethread": {
|
| 756 |
+
"type": [
|
| 757 |
+
"boolean",
|
| 758 |
+
"null"
|
| 759 |
+
]
|
| 760 |
+
},
|
| 761 |
+
"small-data-threshold-support": {
|
| 762 |
+
"anyOf": [
|
| 763 |
+
{
|
| 764 |
+
"$ref": "#/$defs/SmallDataThresholdSupport"
|
| 765 |
+
},
|
| 766 |
+
{
|
| 767 |
+
"type": "null"
|
| 768 |
+
}
|
| 769 |
+
]
|
| 770 |
+
},
|
| 771 |
+
"split-debuginfo": {
|
| 772 |
+
"anyOf": [
|
| 773 |
+
{
|
| 774 |
+
"$ref": "#/$defs/SplitDebuginfo"
|
| 775 |
+
},
|
| 776 |
+
{
|
| 777 |
+
"type": "null"
|
| 778 |
+
}
|
| 779 |
+
]
|
| 780 |
+
},
|
| 781 |
+
"stack-probes": {
|
| 782 |
+
"anyOf": [
|
| 783 |
+
{
|
| 784 |
+
"$ref": "#/$defs/StackProbeType"
|
| 785 |
+
},
|
| 786 |
+
{
|
| 787 |
+
"type": "null"
|
| 788 |
+
}
|
| 789 |
+
]
|
| 790 |
+
},
|
| 791 |
+
"static-initializer-must-be-acyclic": {
|
| 792 |
+
"type": [
|
| 793 |
+
"boolean",
|
| 794 |
+
"null"
|
| 795 |
+
]
|
| 796 |
+
},
|
| 797 |
+
"static-position-independent-executables": {
|
| 798 |
+
"type": [
|
| 799 |
+
"boolean",
|
| 800 |
+
"null"
|
| 801 |
+
]
|
| 802 |
+
},
|
| 803 |
+
"staticlib-prefix": {
|
| 804 |
+
"type": [
|
| 805 |
+
"string",
|
| 806 |
+
"null"
|
| 807 |
+
]
|
| 808 |
+
},
|
| 809 |
+
"staticlib-suffix": {
|
| 810 |
+
"type": [
|
| 811 |
+
"string",
|
| 812 |
+
"null"
|
| 813 |
+
]
|
| 814 |
+
},
|
| 815 |
+
"supported-sanitizers": {
|
| 816 |
+
"type": [
|
| 817 |
+
"array",
|
| 818 |
+
"null"
|
| 819 |
+
],
|
| 820 |
+
"items": {
|
| 821 |
+
"$ref": "#/$defs/SanitizerSet"
|
| 822 |
+
}
|
| 823 |
+
},
|
| 824 |
+
"supported-split-debuginfo": {
|
| 825 |
+
"type": [
|
| 826 |
+
"array",
|
| 827 |
+
"null"
|
| 828 |
+
],
|
| 829 |
+
"items": {
|
| 830 |
+
"$ref": "#/$defs/SplitDebuginfo"
|
| 831 |
+
}
|
| 832 |
+
},
|
| 833 |
+
"supports-stack-protector": {
|
| 834 |
+
"type": [
|
| 835 |
+
"boolean",
|
| 836 |
+
"null"
|
| 837 |
+
]
|
| 838 |
+
},
|
| 839 |
+
"supports-xray": {
|
| 840 |
+
"type": [
|
| 841 |
+
"boolean",
|
| 842 |
+
"null"
|
| 843 |
+
]
|
| 844 |
+
},
|
| 845 |
+
"target-c-int-width": {
|
| 846 |
+
"type": [
|
| 847 |
+
"integer",
|
| 848 |
+
"null"
|
| 849 |
+
],
|
| 850 |
+
"format": "uint16",
|
| 851 |
+
"maximum": 65535,
|
| 852 |
+
"minimum": 0
|
| 853 |
+
},
|
| 854 |
+
"target-endian": {
|
| 855 |
+
"anyOf": [
|
| 856 |
+
{
|
| 857 |
+
"$ref": "#/$defs/Endian"
|
| 858 |
+
},
|
| 859 |
+
{
|
| 860 |
+
"type": "null"
|
| 861 |
+
}
|
| 862 |
+
]
|
| 863 |
+
},
|
| 864 |
+
"target-family": {
|
| 865 |
+
"anyOf": [
|
| 866 |
+
{
|
| 867 |
+
"$ref": "#/$defs/TargetFamiliesJson"
|
| 868 |
+
},
|
| 869 |
+
{
|
| 870 |
+
"type": "null"
|
| 871 |
+
}
|
| 872 |
+
]
|
| 873 |
+
},
|
| 874 |
+
"target-mcount": {
|
| 875 |
+
"type": [
|
| 876 |
+
"string",
|
| 877 |
+
"null"
|
| 878 |
+
]
|
| 879 |
+
},
|
| 880 |
+
"target-pointer-width": {
|
| 881 |
+
"type": "integer",
|
| 882 |
+
"format": "uint16",
|
| 883 |
+
"maximum": 65535,
|
| 884 |
+
"minimum": 0
|
| 885 |
+
},
|
| 886 |
+
"tls-model": {
|
| 887 |
+
"anyOf": [
|
| 888 |
+
{
|
| 889 |
+
"$ref": "#/$defs/TlsModel"
|
| 890 |
+
},
|
| 891 |
+
{
|
| 892 |
+
"type": "null"
|
| 893 |
+
}
|
| 894 |
+
]
|
| 895 |
+
},
|
| 896 |
+
"trap-unreachable": {
|
| 897 |
+
"type": [
|
| 898 |
+
"boolean",
|
| 899 |
+
"null"
|
| 900 |
+
]
|
| 901 |
+
},
|
| 902 |
+
"use-ctors-section": {
|
| 903 |
+
"type": [
|
| 904 |
+
"boolean",
|
| 905 |
+
"null"
|
| 906 |
+
]
|
| 907 |
+
},
|
| 908 |
+
"vendor": {
|
| 909 |
+
"type": [
|
| 910 |
+
"string",
|
| 911 |
+
"null"
|
| 912 |
+
]
|
| 913 |
+
}
|
| 914 |
+
},
|
| 915 |
+
"additionalProperties": false,
|
| 916 |
+
"required": [
|
| 917 |
+
"llvm-target",
|
| 918 |
+
"target-pointer-width",
|
| 919 |
+
"data-layout",
|
| 920 |
+
"arch"
|
| 921 |
+
],
|
| 922 |
+
"$defs": {
|
| 923 |
+
"Abi": {
|
| 924 |
+
"type": "string"
|
| 925 |
+
},
|
| 926 |
+
"Arch": {
|
| 927 |
+
"type": "string"
|
| 928 |
+
},
|
| 929 |
+
"BinaryFormat": {
|
| 930 |
+
"type": "string",
|
| 931 |
+
"enum": [
|
| 932 |
+
"coff",
|
| 933 |
+
"elf",
|
| 934 |
+
"mach-o",
|
| 935 |
+
"wasm",
|
| 936 |
+
"xcoff"
|
| 937 |
+
]
|
| 938 |
+
},
|
| 939 |
+
"CodeModel": {
|
| 940 |
+
"type": "string",
|
| 941 |
+
"enum": [
|
| 942 |
+
"tiny",
|
| 943 |
+
"small",
|
| 944 |
+
"kernel",
|
| 945 |
+
"medium",
|
| 946 |
+
"large"
|
| 947 |
+
]
|
| 948 |
+
},
|
| 949 |
+
"DebuginfoKind": {
|
| 950 |
+
"description": "Which kind of debuginfo does the target use?\n\nUseful in determining whether a target supports Split DWARF (a target with\n`DebuginfoKind::Dwarf` and supporting `SplitDebuginfo::Unpacked` for example).",
|
| 951 |
+
"oneOf": [
|
| 952 |
+
{
|
| 953 |
+
"description": "DWARF debuginfo (such as that used on `x86_64_unknown_linux_gnu`).",
|
| 954 |
+
"type": "string",
|
| 955 |
+
"const": "dwarf"
|
| 956 |
+
},
|
| 957 |
+
{
|
| 958 |
+
"description": "DWARF debuginfo in dSYM files (such as on Apple platforms).",
|
| 959 |
+
"type": "string",
|
| 960 |
+
"const": "dwarf-dsym"
|
| 961 |
+
},
|
| 962 |
+
{
|
| 963 |
+
"description": "Program database files (such as on Windows).",
|
| 964 |
+
"type": "string",
|
| 965 |
+
"const": "pdb"
|
| 966 |
+
}
|
| 967 |
+
]
|
| 968 |
+
},
|
| 969 |
+
"Endian": {
|
| 970 |
+
"type": "string",
|
| 971 |
+
"enum": [
|
| 972 |
+
"big",
|
| 973 |
+
"little"
|
| 974 |
+
]
|
| 975 |
+
},
|
| 976 |
+
"Env": {
|
| 977 |
+
"type": "string"
|
| 978 |
+
},
|
| 979 |
+
"ExternAbi": {
|
| 980 |
+
"type": "string",
|
| 981 |
+
"enum": [
|
| 982 |
+
"C",
|
| 983 |
+
"C-unwind",
|
| 984 |
+
"Rust",
|
| 985 |
+
"aapcs",
|
| 986 |
+
"aapcs-unwind",
|
| 987 |
+
"avr-interrupt",
|
| 988 |
+
"avr-non-blocking-interrupt",
|
| 989 |
+
"cdecl",
|
| 990 |
+
"cdecl-unwind",
|
| 991 |
+
"cmse-nonsecure-call",
|
| 992 |
+
"cmse-nonsecure-entry",
|
| 993 |
+
"custom",
|
| 994 |
+
"efiapi",
|
| 995 |
+
"fastcall",
|
| 996 |
+
"fastcall-unwind",
|
| 997 |
+
"gpu-kernel",
|
| 998 |
+
"msp430-interrupt",
|
| 999 |
+
"ptx-kernel",
|
| 1000 |
+
"riscv-interrupt-m",
|
| 1001 |
+
"riscv-interrupt-s",
|
| 1002 |
+
"rust-call",
|
| 1003 |
+
"rust-cold",
|
| 1004 |
+
"rust-invalid",
|
| 1005 |
+
"rust-preserve-none",
|
| 1006 |
+
"stdcall",
|
| 1007 |
+
"stdcall-unwind",
|
| 1008 |
+
"system",
|
| 1009 |
+
"system-unwind",
|
| 1010 |
+
"sysv64",
|
| 1011 |
+
"sysv64-unwind",
|
| 1012 |
+
"thiscall",
|
| 1013 |
+
"thiscall-unwind",
|
| 1014 |
+
"unadjusted",
|
| 1015 |
+
"vectorcall",
|
| 1016 |
+
"vectorcall-unwind",
|
| 1017 |
+
"win64",
|
| 1018 |
+
"win64-unwind",
|
| 1019 |
+
"x86-interrupt"
|
| 1020 |
+
]
|
| 1021 |
+
},
|
| 1022 |
+
"FloatAbi": {
|
| 1023 |
+
"description": "The float ABI setting to be configured in the LLVM target machine.",
|
| 1024 |
+
"type": "string",
|
| 1025 |
+
"enum": [
|
| 1026 |
+
"soft",
|
| 1027 |
+
"hard"
|
| 1028 |
+
]
|
| 1029 |
+
},
|
| 1030 |
+
"FramePointer": {
|
| 1031 |
+
"oneOf": [
|
| 1032 |
+
{
|
| 1033 |
+
"description": "Forces the machine code generator to always preserve the frame pointers.",
|
| 1034 |
+
"type": "string",
|
| 1035 |
+
"const": "always"
|
| 1036 |
+
},
|
| 1037 |
+
{
|
| 1038 |
+
"description": "Forces the machine code generator to preserve the frame pointers except for the leaf\nfunctions (i.e. those that don't call other functions).",
|
| 1039 |
+
"type": "string",
|
| 1040 |
+
"const": "non-leaf"
|
| 1041 |
+
},
|
| 1042 |
+
{
|
| 1043 |
+
"description": "Allows the machine code generator to omit the frame pointers.\n\nThis option does not guarantee that the frame pointers will be omitted.",
|
| 1044 |
+
"type": "string",
|
| 1045 |
+
"const": "may-omit"
|
| 1046 |
+
}
|
| 1047 |
+
]
|
| 1048 |
+
},
|
| 1049 |
+
"LinkSelfContainedComponents": {
|
| 1050 |
+
"type": "string",
|
| 1051 |
+
"enum": [
|
| 1052 |
+
"crto",
|
| 1053 |
+
"libc",
|
| 1054 |
+
"unwind",
|
| 1055 |
+
"linker",
|
| 1056 |
+
"sanitizers",
|
| 1057 |
+
"mingw"
|
| 1058 |
+
]
|
| 1059 |
+
},
|
| 1060 |
+
"LinkSelfContainedComponentsWrapper": {
|
| 1061 |
+
"type": "object",
|
| 1062 |
+
"properties": {
|
| 1063 |
+
"components": {
|
| 1064 |
+
"type": "array",
|
| 1065 |
+
"items": {
|
| 1066 |
+
"$ref": "#/$defs/LinkSelfContainedComponents"
|
| 1067 |
+
}
|
| 1068 |
+
}
|
| 1069 |
+
},
|
| 1070 |
+
"required": [
|
| 1071 |
+
"components"
|
| 1072 |
+
]
|
| 1073 |
+
},
|
| 1074 |
+
"LinkSelfContainedDefault": {
|
| 1075 |
+
"type": "string",
|
| 1076 |
+
"enum": [
|
| 1077 |
+
"false",
|
| 1078 |
+
"true",
|
| 1079 |
+
"wasm",
|
| 1080 |
+
"musl",
|
| 1081 |
+
"mingw"
|
| 1082 |
+
]
|
| 1083 |
+
},
|
| 1084 |
+
"LinkerFlavor": {
|
| 1085 |
+
"type": "string",
|
| 1086 |
+
"enum": [
|
| 1087 |
+
"gnu",
|
| 1088 |
+
"gnu-lld",
|
| 1089 |
+
"gnu-cc",
|
| 1090 |
+
"gnu-lld-cc",
|
| 1091 |
+
"darwin",
|
| 1092 |
+
"darwin-lld",
|
| 1093 |
+
"darwin-cc",
|
| 1094 |
+
"darwin-lld-cc",
|
| 1095 |
+
"wasm-lld",
|
| 1096 |
+
"wasm-lld-cc",
|
| 1097 |
+
"unix",
|
| 1098 |
+
"unix-cc",
|
| 1099 |
+
"msvc-lld",
|
| 1100 |
+
"msvc",
|
| 1101 |
+
"em-cc",
|
| 1102 |
+
"bpf",
|
| 1103 |
+
"llbc",
|
| 1104 |
+
"ptx",
|
| 1105 |
+
"gcc",
|
| 1106 |
+
"ld",
|
| 1107 |
+
"ld.lld",
|
| 1108 |
+
"ld64.lld",
|
| 1109 |
+
"lld-link",
|
| 1110 |
+
"wasm-ld",
|
| 1111 |
+
"em"
|
| 1112 |
+
]
|
| 1113 |
+
},
|
| 1114 |
+
"LldFlavor": {
|
| 1115 |
+
"type": "string",
|
| 1116 |
+
"enum": [
|
| 1117 |
+
"wasm",
|
| 1118 |
+
"darwin",
|
| 1119 |
+
"gnu",
|
| 1120 |
+
"link"
|
| 1121 |
+
]
|
| 1122 |
+
},
|
| 1123 |
+
"MergeFunctions": {
|
| 1124 |
+
"type": "string",
|
| 1125 |
+
"enum": [
|
| 1126 |
+
"disabled",
|
| 1127 |
+
"trampolines",
|
| 1128 |
+
"aliases"
|
| 1129 |
+
]
|
| 1130 |
+
},
|
| 1131 |
+
"Os": {
|
| 1132 |
+
"type": "string"
|
| 1133 |
+
},
|
| 1134 |
+
"PanicStrategy": {
|
| 1135 |
+
"type": "string",
|
| 1136 |
+
"enum": [
|
| 1137 |
+
"unwind",
|
| 1138 |
+
"abort",
|
| 1139 |
+
"immediate-abort"
|
| 1140 |
+
]
|
| 1141 |
+
},
|
| 1142 |
+
"RelocModel": {
|
| 1143 |
+
"type": "string",
|
| 1144 |
+
"enum": [
|
| 1145 |
+
"static",
|
| 1146 |
+
"pic",
|
| 1147 |
+
"pie",
|
| 1148 |
+
"dynamic-no-pic",
|
| 1149 |
+
"ropi",
|
| 1150 |
+
"rwpi",
|
| 1151 |
+
"ropi-rwpi"
|
| 1152 |
+
]
|
| 1153 |
+
},
|
| 1154 |
+
"RelroLevel": {
|
| 1155 |
+
"type": "string",
|
| 1156 |
+
"enum": [
|
| 1157 |
+
"full",
|
| 1158 |
+
"partial",
|
| 1159 |
+
"off",
|
| 1160 |
+
"none"
|
| 1161 |
+
]
|
| 1162 |
+
},
|
| 1163 |
+
"RustcAbi": {
|
| 1164 |
+
"description": "The Rustc-specific variant of the ABI used for this target.",
|
| 1165 |
+
"oneOf": [
|
| 1166 |
+
{
|
| 1167 |
+
"description": "On x86-32 only: make use of SSE and SSE2 for ABI purposes.",
|
| 1168 |
+
"type": "string",
|
| 1169 |
+
"const": "x86-sse2"
|
| 1170 |
+
},
|
| 1171 |
+
{
|
| 1172 |
+
"description": "On x86-32/64 and S390x: do not use any FPU or SIMD registers for the ABI.",
|
| 1173 |
+
"type": "string",
|
| 1174 |
+
"const": "softfloat"
|
| 1175 |
+
}
|
| 1176 |
+
]
|
| 1177 |
+
},
|
| 1178 |
+
"SanitizerSet": {
|
| 1179 |
+
"type": "string",
|
| 1180 |
+
"enum": [
|
| 1181 |
+
"address",
|
| 1182 |
+
"leak",
|
| 1183 |
+
"memory",
|
| 1184 |
+
"thread",
|
| 1185 |
+
"hwaddress",
|
| 1186 |
+
"cfi",
|
| 1187 |
+
"memtag",
|
| 1188 |
+
"shadow-call-stack",
|
| 1189 |
+
"kcfi",
|
| 1190 |
+
"kernel-address",
|
| 1191 |
+
"safestack",
|
| 1192 |
+
"dataflow",
|
| 1193 |
+
"realtime"
|
| 1194 |
+
]
|
| 1195 |
+
},
|
| 1196 |
+
"SmallDataThresholdSupport": {
|
| 1197 |
+
"type": "string",
|
| 1198 |
+
"pattern": "^none|default-for-arch|llvm-module-flag=.+|llvm-arg=.+$"
|
| 1199 |
+
},
|
| 1200 |
+
"SplitDebuginfo": {
|
| 1201 |
+
"oneOf": [
|
| 1202 |
+
{
|
| 1203 |
+
"description": "Split debug-information is disabled, meaning that on supported platforms\nyou can find all debug information in the executable itself. This is\nonly supported for ELF effectively.\n\n* Windows - not supported\n* macOS - don't run `dsymutil`\n* ELF - `.debug_*` sections",
|
| 1204 |
+
"type": "string",
|
| 1205 |
+
"const": "off"
|
| 1206 |
+
},
|
| 1207 |
+
{
|
| 1208 |
+
"description": "Split debug-information can be found in a \"packed\" location separate\nfrom the final artifact. This is supported on all platforms.\n\n* Windows - `*.pdb`\n* macOS - `*.dSYM` (run `dsymutil`)\n* ELF - `*.dwp` (run `thorin`)",
|
| 1209 |
+
"type": "string",
|
| 1210 |
+
"const": "packed"
|
| 1211 |
+
},
|
| 1212 |
+
{
|
| 1213 |
+
"description": "Split debug-information can be found in individual object files on the\nfilesystem. The main executable may point to the object files.\n\n* Windows - not supported\n* macOS - supported, scattered object files\n* ELF - supported, scattered `*.dwo` or `*.o` files (see `SplitDwarfKind`)",
|
| 1214 |
+
"type": "string",
|
| 1215 |
+
"const": "unpacked"
|
| 1216 |
+
}
|
| 1217 |
+
]
|
| 1218 |
+
},
|
| 1219 |
+
"StackProbeType": {
|
| 1220 |
+
"oneOf": [
|
| 1221 |
+
{
|
| 1222 |
+
"description": "Don't emit any stack probes.",
|
| 1223 |
+
"type": "object",
|
| 1224 |
+
"properties": {
|
| 1225 |
+
"kind": {
|
| 1226 |
+
"type": "string",
|
| 1227 |
+
"const": "none"
|
| 1228 |
+
}
|
| 1229 |
+
},
|
| 1230 |
+
"required": [
|
| 1231 |
+
"kind"
|
| 1232 |
+
]
|
| 1233 |
+
},
|
| 1234 |
+
{
|
| 1235 |
+
"description": "It is harmless to use this option even on targets that do not have backend support for\nstack probes as the failure mode is the same as if no stack-probe option was specified in\nthe first place.",
|
| 1236 |
+
"type": "object",
|
| 1237 |
+
"properties": {
|
| 1238 |
+
"kind": {
|
| 1239 |
+
"type": "string",
|
| 1240 |
+
"const": "inline"
|
| 1241 |
+
}
|
| 1242 |
+
},
|
| 1243 |
+
"required": [
|
| 1244 |
+
"kind"
|
| 1245 |
+
]
|
| 1246 |
+
},
|
| 1247 |
+
{
|
| 1248 |
+
"description": "Call `__rust_probestack` whenever stack needs to be probed.",
|
| 1249 |
+
"type": "object",
|
| 1250 |
+
"properties": {
|
| 1251 |
+
"kind": {
|
| 1252 |
+
"type": "string",
|
| 1253 |
+
"const": "call"
|
| 1254 |
+
}
|
| 1255 |
+
},
|
| 1256 |
+
"required": [
|
| 1257 |
+
"kind"
|
| 1258 |
+
]
|
| 1259 |
+
},
|
| 1260 |
+
{
|
| 1261 |
+
"description": "Use inline option for LLVM versions later than specified in `min_llvm_version_for_inline`\nand call `__rust_probestack` otherwise.",
|
| 1262 |
+
"type": "object",
|
| 1263 |
+
"properties": {
|
| 1264 |
+
"kind": {
|
| 1265 |
+
"type": "string",
|
| 1266 |
+
"const": "inline-or-call"
|
| 1267 |
+
},
|
| 1268 |
+
"min-llvm-version-for-inline": {
|
| 1269 |
+
"type": "array",
|
| 1270 |
+
"maxItems": 3,
|
| 1271 |
+
"minItems": 3,
|
| 1272 |
+
"prefixItems": [
|
| 1273 |
+
{
|
| 1274 |
+
"type": "integer",
|
| 1275 |
+
"format": "uint32",
|
| 1276 |
+
"minimum": 0
|
| 1277 |
+
},
|
| 1278 |
+
{
|
| 1279 |
+
"type": "integer",
|
| 1280 |
+
"format": "uint32",
|
| 1281 |
+
"minimum": 0
|
| 1282 |
+
},
|
| 1283 |
+
{
|
| 1284 |
+
"type": "integer",
|
| 1285 |
+
"format": "uint32",
|
| 1286 |
+
"minimum": 0
|
| 1287 |
+
}
|
| 1288 |
+
]
|
| 1289 |
+
}
|
| 1290 |
+
},
|
| 1291 |
+
"required": [
|
| 1292 |
+
"kind",
|
| 1293 |
+
"min-llvm-version-for-inline"
|
| 1294 |
+
]
|
| 1295 |
+
}
|
| 1296 |
+
]
|
| 1297 |
+
},
|
| 1298 |
+
"SymbolVisibility": {
|
| 1299 |
+
"type": "string",
|
| 1300 |
+
"enum": [
|
| 1301 |
+
"hidden",
|
| 1302 |
+
"protected",
|
| 1303 |
+
"interposable"
|
| 1304 |
+
]
|
| 1305 |
+
},
|
| 1306 |
+
"TargetFamiliesJson": {
|
| 1307 |
+
"anyOf": [
|
| 1308 |
+
{
|
| 1309 |
+
"type": "array",
|
| 1310 |
+
"items": {
|
| 1311 |
+
"type": "string"
|
| 1312 |
+
}
|
| 1313 |
+
},
|
| 1314 |
+
{
|
| 1315 |
+
"type": "string"
|
| 1316 |
+
}
|
| 1317 |
+
]
|
| 1318 |
+
},
|
| 1319 |
+
"TargetSpecJsonMetadata": {
|
| 1320 |
+
"type": "object",
|
| 1321 |
+
"properties": {
|
| 1322 |
+
"description": {
|
| 1323 |
+
"type": [
|
| 1324 |
+
"string",
|
| 1325 |
+
"null"
|
| 1326 |
+
]
|
| 1327 |
+
},
|
| 1328 |
+
"host_tools": {
|
| 1329 |
+
"type": [
|
| 1330 |
+
"boolean",
|
| 1331 |
+
"null"
|
| 1332 |
+
]
|
| 1333 |
+
},
|
| 1334 |
+
"std": {
|
| 1335 |
+
"type": [
|
| 1336 |
+
"boolean",
|
| 1337 |
+
"null"
|
| 1338 |
+
]
|
| 1339 |
+
},
|
| 1340 |
+
"tier": {
|
| 1341 |
+
"type": [
|
| 1342 |
+
"integer",
|
| 1343 |
+
"null"
|
| 1344 |
+
],
|
| 1345 |
+
"format": "uint64",
|
| 1346 |
+
"minimum": 0
|
| 1347 |
+
}
|
| 1348 |
+
}
|
| 1349 |
+
},
|
| 1350 |
+
"TlsModel": {
|
| 1351 |
+
"type": "string",
|
| 1352 |
+
"enum": [
|
| 1353 |
+
"global-dynamic",
|
| 1354 |
+
"local-dynamic",
|
| 1355 |
+
"initial-exec",
|
| 1356 |
+
"local-exec",
|
| 1357 |
+
"emulated"
|
| 1358 |
+
]
|
| 1359 |
+
}
|
| 1360 |
+
}
|
| 1361 |
+
}
|
rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-add.1
ADDED
|
@@ -0,0 +1,369 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
'\" t
|
| 2 |
+
.TH "CARGO\-ADD" "1"
|
| 3 |
+
.nh
|
| 4 |
+
.ad l
|
| 5 |
+
.ss \n[.ss] 0
|
| 6 |
+
.SH "NAME"
|
| 7 |
+
cargo\-add \[em] Add dependencies to a Cargo.toml manifest file
|
| 8 |
+
.SH "SYNOPSIS"
|
| 9 |
+
\fBcargo add\fR [\fIoptions\fR] \fIcrate\fR\[u2026]
|
| 10 |
+
.br
|
| 11 |
+
\fBcargo add\fR [\fIoptions\fR] \fB\-\-path\fR \fIpath\fR
|
| 12 |
+
.br
|
| 13 |
+
\fBcargo add\fR [\fIoptions\fR] \fB\-\-git\fR \fIurl\fR [\fIcrate\fR\[u2026]]
|
| 14 |
+
.SH "DESCRIPTION"
|
| 15 |
+
This command can add or modify dependencies.
|
| 16 |
+
.sp
|
| 17 |
+
The source for the dependency can be specified with:
|
| 18 |
+
.sp
|
| 19 |
+
.RS 4
|
| 20 |
+
\h'-04'\(bu\h'+03'\fIcrate\fR\fB@\fR\fIversion\fR: Fetch from a registry with a version constraint of \[lq]\fIversion\fR\[rq]
|
| 21 |
+
.RE
|
| 22 |
+
.sp
|
| 23 |
+
.RS 4
|
| 24 |
+
\h'-04'\(bu\h'+03'\fB\-\-path\fR \fIpath\fR: Fetch from the specified \fIpath\fR
|
| 25 |
+
.RE
|
| 26 |
+
.sp
|
| 27 |
+
.RS 4
|
| 28 |
+
\h'-04'\(bu\h'+03'\fB\-\-git\fR \fIurl\fR: Pull from a git repo at \fIurl\fR
|
| 29 |
+
.RE
|
| 30 |
+
.sp
|
| 31 |
+
If no source is specified, then a best effort will be made to select one, including:
|
| 32 |
+
.sp
|
| 33 |
+
.RS 4
|
| 34 |
+
\h'-04'\(bu\h'+03'Existing dependencies in other tables (like \fBdev\-dependencies\fR)
|
| 35 |
+
.RE
|
| 36 |
+
.sp
|
| 37 |
+
.RS 4
|
| 38 |
+
\h'-04'\(bu\h'+03'Workspace members
|
| 39 |
+
.RE
|
| 40 |
+
.sp
|
| 41 |
+
.RS 4
|
| 42 |
+
\h'-04'\(bu\h'+03'Latest release in the registry
|
| 43 |
+
.RE
|
| 44 |
+
.sp
|
| 45 |
+
When you add a package that is already present, the existing entry will be updated with the flags specified.
|
| 46 |
+
.sp
|
| 47 |
+
Upon successful invocation, the enabled (\fB+\fR) and disabled (\fB\-\fR) \fIfeatures\fR <https://doc.rust\-lang.org/cargo/reference/features.html> of the specified
|
| 48 |
+
dependency will be listed in the command\[cq]s output.
|
| 49 |
+
.SH "OPTIONS"
|
| 50 |
+
.SS "Source options"
|
| 51 |
+
.sp
|
| 52 |
+
\fB\-\-git\fR \fIurl\fR
|
| 53 |
+
.RS 4
|
| 54 |
+
\fIGit URL to add the specified crate from\fR <https://doc.rust\-lang.org/cargo/reference/specifying\-dependencies.html#specifying\-dependencies\-from\-git\-repositories>\&.
|
| 55 |
+
.RE
|
| 56 |
+
.sp
|
| 57 |
+
\fB\-\-branch\fR \fIbranch\fR
|
| 58 |
+
.RS 4
|
| 59 |
+
Branch to use when adding from git.
|
| 60 |
+
.RE
|
| 61 |
+
.sp
|
| 62 |
+
\fB\-\-tag\fR \fItag\fR
|
| 63 |
+
.RS 4
|
| 64 |
+
Tag to use when adding from git.
|
| 65 |
+
.RE
|
| 66 |
+
.sp
|
| 67 |
+
\fB\-\-rev\fR \fIsha\fR
|
| 68 |
+
.RS 4
|
| 69 |
+
Specific commit to use when adding from git.
|
| 70 |
+
.RE
|
| 71 |
+
.sp
|
| 72 |
+
\fB\-\-path\fR \fIpath\fR
|
| 73 |
+
.RS 4
|
| 74 |
+
\fIFilesystem path\fR <https://doc.rust\-lang.org/cargo/reference/specifying\-dependencies.html#specifying\-path\-dependencies> to local crate to add.
|
| 75 |
+
.RE
|
| 76 |
+
.sp
|
| 77 |
+
\fB\-\-base\fR \fIbase\fR
|
| 78 |
+
.RS 4
|
| 79 |
+
The \fIpath base\fR <https://doc.rust\-lang.org/cargo/reference/unstable.html#path\-bases> to use when adding a local crate.
|
| 80 |
+
.sp
|
| 81 |
+
\fIUnstable (nightly\-only)\fR <https://doc.rust\-lang.org/cargo/reference/unstable.html#path\-bases>
|
| 82 |
+
.RE
|
| 83 |
+
.sp
|
| 84 |
+
\fB\-\-registry\fR \fIregistry\fR
|
| 85 |
+
.RS 4
|
| 86 |
+
Name of the registry to use. Registry names are defined in \fICargo config
|
| 87 |
+
files\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&. If not specified, the default registry is used,
|
| 88 |
+
which is defined by the \fBregistry.default\fR config key which defaults to
|
| 89 |
+
\fBcrates\-io\fR\&.
|
| 90 |
+
.RE
|
| 91 |
+
.SS "Section options"
|
| 92 |
+
.sp
|
| 93 |
+
\fB\-\-dev\fR
|
| 94 |
+
.RS 4
|
| 95 |
+
Add as a \fIdevelopment dependency\fR <https://doc.rust\-lang.org/cargo/reference/specifying\-dependencies.html#development\-dependencies>\&.
|
| 96 |
+
.RE
|
| 97 |
+
.sp
|
| 98 |
+
\fB\-\-build\fR
|
| 99 |
+
.RS 4
|
| 100 |
+
Add as a \fIbuild dependency\fR <https://doc.rust\-lang.org/cargo/reference/specifying\-dependencies.html#build\-dependencies>\&.
|
| 101 |
+
.RE
|
| 102 |
+
.sp
|
| 103 |
+
\fB\-\-target\fR \fItarget\fR
|
| 104 |
+
.RS 4
|
| 105 |
+
Add as a dependency to the \fIgiven target platform\fR <https://doc.rust\-lang.org/cargo/reference/specifying\-dependencies.html#platform\-specific\-dependencies>\&.
|
| 106 |
+
.sp
|
| 107 |
+
To avoid unexpected shell expansions, you may use quotes around each target, e.g., \fB\-\-target 'cfg(unix)'\fR\&.
|
| 108 |
+
.RE
|
| 109 |
+
.SS "Dependency options"
|
| 110 |
+
.sp
|
| 111 |
+
\fB\-\-dry\-run\fR
|
| 112 |
+
.RS 4
|
| 113 |
+
Don\[cq]t actually write the manifest
|
| 114 |
+
.RE
|
| 115 |
+
.sp
|
| 116 |
+
\fB\-\-rename\fR \fIname\fR
|
| 117 |
+
.RS 4
|
| 118 |
+
\fIRename\fR <https://doc.rust\-lang.org/cargo/reference/specifying\-dependencies.html#renaming\-dependencies\-in\-cargotoml> the dependency.
|
| 119 |
+
.RE
|
| 120 |
+
.sp
|
| 121 |
+
\fB\-\-optional\fR
|
| 122 |
+
.RS 4
|
| 123 |
+
Mark the dependency as \fIoptional\fR <https://doc.rust\-lang.org/cargo/reference/features.html#optional\-dependencies>\&.
|
| 124 |
+
.RE
|
| 125 |
+
.sp
|
| 126 |
+
\fB\-\-no\-optional\fR
|
| 127 |
+
.RS 4
|
| 128 |
+
Mark the dependency as \fIrequired\fR <https://doc.rust\-lang.org/cargo/reference/features.html#optional\-dependencies>\&.
|
| 129 |
+
.RE
|
| 130 |
+
.sp
|
| 131 |
+
\fB\-\-public\fR
|
| 132 |
+
.RS 4
|
| 133 |
+
Mark the dependency as public.
|
| 134 |
+
.sp
|
| 135 |
+
The dependency can be referenced in your library\[cq]s public API.
|
| 136 |
+
.sp
|
| 137 |
+
\fIUnstable (nightly\-only)\fR <https://doc.rust\-lang.org/cargo/reference/unstable.html#public\-dependency>
|
| 138 |
+
.RE
|
| 139 |
+
.sp
|
| 140 |
+
\fB\-\-no\-public\fR
|
| 141 |
+
.RS 4
|
| 142 |
+
Mark the dependency as private.
|
| 143 |
+
.sp
|
| 144 |
+
While you can use the crate in your implementation, it cannot be referenced in your public API.
|
| 145 |
+
.sp
|
| 146 |
+
\fIUnstable (nightly\-only)\fR <https://doc.rust\-lang.org/cargo/reference/unstable.html#public\-dependency>
|
| 147 |
+
.RE
|
| 148 |
+
.sp
|
| 149 |
+
\fB\-\-no\-default\-features\fR
|
| 150 |
+
.RS 4
|
| 151 |
+
Disable the \fIdefault features\fR <https://doc.rust\-lang.org/cargo/reference/features.html#dependency\-features>\&.
|
| 152 |
+
.RE
|
| 153 |
+
.sp
|
| 154 |
+
\fB\-\-default\-features\fR
|
| 155 |
+
.RS 4
|
| 156 |
+
Re\-enable the \fIdefault features\fR <https://doc.rust\-lang.org/cargo/reference/features.html#dependency\-features>\&.
|
| 157 |
+
.RE
|
| 158 |
+
.sp
|
| 159 |
+
\fB\-F\fR \fIfeatures\fR,
|
| 160 |
+
\fB\-\-features\fR \fIfeatures\fR
|
| 161 |
+
.RS 4
|
| 162 |
+
Space or comma separated list of \fIfeatures to
|
| 163 |
+
activate\fR <https://doc.rust\-lang.org/cargo/reference/features.html#dependency\-features>\&. When adding multiple
|
| 164 |
+
crates, the features for a specific crate may be enabled with
|
| 165 |
+
\fBpackage\-name/feature\-name\fR syntax. This flag may be specified multiple times,
|
| 166 |
+
which enables all specified features.
|
| 167 |
+
.RE
|
| 168 |
+
.SS "Display Options"
|
| 169 |
+
.sp
|
| 170 |
+
\fB\-v\fR,
|
| 171 |
+
\fB\-\-verbose\fR
|
| 172 |
+
.RS 4
|
| 173 |
+
Use verbose output. May be specified twice for \[lq]very verbose\[rq] output which
|
| 174 |
+
includes extra output such as dependency warnings and build script output.
|
| 175 |
+
May also be specified with the \fBterm.verbose\fR
|
| 176 |
+
\fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 177 |
+
.RE
|
| 178 |
+
.sp
|
| 179 |
+
\fB\-q\fR,
|
| 180 |
+
\fB\-\-quiet\fR
|
| 181 |
+
.RS 4
|
| 182 |
+
Do not print cargo log messages.
|
| 183 |
+
May also be specified with the \fBterm.quiet\fR
|
| 184 |
+
\fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 185 |
+
.RE
|
| 186 |
+
.sp
|
| 187 |
+
\fB\-\-color\fR \fIwhen\fR
|
| 188 |
+
.RS 4
|
| 189 |
+
Control when colored output is used. Valid values:
|
| 190 |
+
.sp
|
| 191 |
+
.RS 4
|
| 192 |
+
\h'-04'\(bu\h'+03'\fBauto\fR (default): Automatically detect if color support is available on the
|
| 193 |
+
terminal.
|
| 194 |
+
.RE
|
| 195 |
+
.sp
|
| 196 |
+
.RS 4
|
| 197 |
+
\h'-04'\(bu\h'+03'\fBalways\fR: Always display colors.
|
| 198 |
+
.RE
|
| 199 |
+
.sp
|
| 200 |
+
.RS 4
|
| 201 |
+
\h'-04'\(bu\h'+03'\fBnever\fR: Never display colors.
|
| 202 |
+
.RE
|
| 203 |
+
.sp
|
| 204 |
+
May also be specified with the \fBterm.color\fR
|
| 205 |
+
\fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 206 |
+
.RE
|
| 207 |
+
.SS "Manifest Options"
|
| 208 |
+
.sp
|
| 209 |
+
\fB\-\-manifest\-path\fR \fIpath\fR
|
| 210 |
+
.RS 4
|
| 211 |
+
Path to the \fBCargo.toml\fR file. By default, Cargo searches for the
|
| 212 |
+
\fBCargo.toml\fR file in the current directory or any parent directory.
|
| 213 |
+
.RE
|
| 214 |
+
.sp
|
| 215 |
+
\fB\-p\fR \fIspec\fR,
|
| 216 |
+
\fB\-\-package\fR \fIspec\fR
|
| 217 |
+
.RS 4
|
| 218 |
+
Add dependencies to only the specified package.
|
| 219 |
+
.RE
|
| 220 |
+
.sp
|
| 221 |
+
\fB\-\-ignore\-rust\-version\fR
|
| 222 |
+
.RS 4
|
| 223 |
+
Ignore \fBrust\-version\fR specification in packages.
|
| 224 |
+
.RE
|
| 225 |
+
.sp
|
| 226 |
+
\fB\-\-locked\fR
|
| 227 |
+
.RS 4
|
| 228 |
+
Asserts that the exact same dependencies and versions are used as when the
|
| 229 |
+
existing \fBCargo.lock\fR file was originally generated. Cargo will exit with an
|
| 230 |
+
error when either of the following scenarios arises:
|
| 231 |
+
.sp
|
| 232 |
+
.RS 4
|
| 233 |
+
\h'-04'\(bu\h'+03'The lock file is missing.
|
| 234 |
+
.RE
|
| 235 |
+
.sp
|
| 236 |
+
.RS 4
|
| 237 |
+
\h'-04'\(bu\h'+03'Cargo attempted to change the lock file due to a different dependency resolution.
|
| 238 |
+
.RE
|
| 239 |
+
.sp
|
| 240 |
+
It may be used in environments where deterministic builds are desired,
|
| 241 |
+
such as in CI pipelines.
|
| 242 |
+
.RE
|
| 243 |
+
.sp
|
| 244 |
+
\fB\-\-offline\fR
|
| 245 |
+
.RS 4
|
| 246 |
+
Prevents Cargo from accessing the network for any reason. Without this
|
| 247 |
+
flag, Cargo will stop with an error if it needs to access the network and
|
| 248 |
+
the network is not available. With this flag, Cargo will attempt to
|
| 249 |
+
proceed without the network if possible.
|
| 250 |
+
.sp
|
| 251 |
+
Beware that this may result in different dependency resolution than online
|
| 252 |
+
mode. Cargo will restrict itself to crates that are downloaded locally, even
|
| 253 |
+
if there might be a newer version as indicated in the local copy of the index.
|
| 254 |
+
See the \fBcargo\-fetch\fR(1) command to download dependencies before going
|
| 255 |
+
offline.
|
| 256 |
+
.sp
|
| 257 |
+
May also be specified with the \fBnet.offline\fR \fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 258 |
+
.RE
|
| 259 |
+
.sp
|
| 260 |
+
\fB\-\-frozen\fR
|
| 261 |
+
.RS 4
|
| 262 |
+
Equivalent to specifying both \fB\-\-locked\fR and \fB\-\-offline\fR\&.
|
| 263 |
+
.RE
|
| 264 |
+
.SS "Common Options"
|
| 265 |
+
.sp
|
| 266 |
+
\fB+\fR\fItoolchain\fR
|
| 267 |
+
.RS 4
|
| 268 |
+
If Cargo has been installed with rustup, and the first argument to \fBcargo\fR
|
| 269 |
+
begins with \fB+\fR, it will be interpreted as a rustup toolchain name (such
|
| 270 |
+
as \fB+stable\fR or \fB+nightly\fR).
|
| 271 |
+
See the \fIrustup documentation\fR <https://rust\-lang.github.io/rustup/overrides.html>
|
| 272 |
+
for more information about how toolchain overrides work.
|
| 273 |
+
.RE
|
| 274 |
+
.sp
|
| 275 |
+
\fB\-\-config\fR \fIKEY=VALUE\fR or \fIPATH\fR
|
| 276 |
+
.RS 4
|
| 277 |
+
Overrides a Cargo configuration value. The argument should be in TOML syntax of \fBKEY=VALUE\fR,
|
| 278 |
+
or provided as a path to an extra configuration file. This flag may be specified multiple times.
|
| 279 |
+
See the \fIcommand\-line overrides section\fR <https://doc.rust\-lang.org/cargo/reference/config.html#command\-line\-overrides> for more information.
|
| 280 |
+
.RE
|
| 281 |
+
.sp
|
| 282 |
+
\fB\-C\fR \fIPATH\fR
|
| 283 |
+
.RS 4
|
| 284 |
+
Changes the current working directory before executing any specified operations. This affects
|
| 285 |
+
things like where cargo looks by default for the project manifest (\fBCargo.toml\fR), as well as
|
| 286 |
+
the directories searched for discovering \fB\&.cargo/config.toml\fR, for example. This option must
|
| 287 |
+
appear before the command name, for example \fBcargo \-C path/to/my\-project build\fR\&.
|
| 288 |
+
.sp
|
| 289 |
+
This option is only available on the \fInightly
|
| 290 |
+
channel\fR <https://doc.rust\-lang.org/book/appendix\-07\-nightly\-rust.html> and
|
| 291 |
+
requires the \fB\-Z unstable\-options\fR flag to enable (see
|
| 292 |
+
\fI#10098\fR <https://github.com/rust\-lang/cargo/issues/10098>).
|
| 293 |
+
.RE
|
| 294 |
+
.sp
|
| 295 |
+
\fB\-h\fR,
|
| 296 |
+
\fB\-\-help\fR
|
| 297 |
+
.RS 4
|
| 298 |
+
Prints help information.
|
| 299 |
+
.RE
|
| 300 |
+
.sp
|
| 301 |
+
\fB\-Z\fR \fIflag\fR
|
| 302 |
+
.RS 4
|
| 303 |
+
Unstable (nightly\-only) flags to Cargo. Run \fBcargo \-Z help\fR for details.
|
| 304 |
+
.RE
|
| 305 |
+
.SH "ENVIRONMENT"
|
| 306 |
+
See \fIthe reference\fR <https://doc.rust\-lang.org/cargo/reference/environment\-variables.html> for
|
| 307 |
+
details on environment variables that Cargo reads.
|
| 308 |
+
.SH "EXIT STATUS"
|
| 309 |
+
.sp
|
| 310 |
+
.RS 4
|
| 311 |
+
\h'-04'\(bu\h'+03'\fB0\fR: Cargo succeeded.
|
| 312 |
+
.RE
|
| 313 |
+
.sp
|
| 314 |
+
.RS 4
|
| 315 |
+
\h'-04'\(bu\h'+03'\fB101\fR: Cargo failed to complete.
|
| 316 |
+
.RE
|
| 317 |
+
.SH "EXAMPLES"
|
| 318 |
+
.sp
|
| 319 |
+
.RS 4
|
| 320 |
+
\h'-04' 1.\h'+01'Add \fBregex\fR as a dependency
|
| 321 |
+
.sp
|
| 322 |
+
.RS 4
|
| 323 |
+
.nf
|
| 324 |
+
cargo add regex
|
| 325 |
+
.fi
|
| 326 |
+
.RE
|
| 327 |
+
.RE
|
| 328 |
+
.sp
|
| 329 |
+
.RS 4
|
| 330 |
+
\h'-04' 2.\h'+01'Add \fBtrybuild\fR as a dev\-dependency
|
| 331 |
+
.sp
|
| 332 |
+
.RS 4
|
| 333 |
+
.nf
|
| 334 |
+
cargo add \-\-dev trybuild
|
| 335 |
+
.fi
|
| 336 |
+
.RE
|
| 337 |
+
.RE
|
| 338 |
+
.sp
|
| 339 |
+
.RS 4
|
| 340 |
+
\h'-04' 3.\h'+01'Add an older version of \fBnom\fR as a dependency
|
| 341 |
+
.sp
|
| 342 |
+
.RS 4
|
| 343 |
+
.nf
|
| 344 |
+
cargo add nom@5
|
| 345 |
+
.fi
|
| 346 |
+
.RE
|
| 347 |
+
.RE
|
| 348 |
+
.sp
|
| 349 |
+
.RS 4
|
| 350 |
+
\h'-04' 4.\h'+01'Add support for serializing data structures to json with \fBderive\fRs
|
| 351 |
+
.sp
|
| 352 |
+
.RS 4
|
| 353 |
+
.nf
|
| 354 |
+
cargo add serde serde_json \-F serde/derive
|
| 355 |
+
.fi
|
| 356 |
+
.RE
|
| 357 |
+
.RE
|
| 358 |
+
.sp
|
| 359 |
+
.RS 4
|
| 360 |
+
\h'-04' 5.\h'+01'Add \fBwindows\fR as a platform specific dependency on \fBcfg(windows)\fR
|
| 361 |
+
.sp
|
| 362 |
+
.RS 4
|
| 363 |
+
.nf
|
| 364 |
+
cargo add windows \-\-target 'cfg(windows)'
|
| 365 |
+
.fi
|
| 366 |
+
.RE
|
| 367 |
+
.RE
|
| 368 |
+
.SH "SEE ALSO"
|
| 369 |
+
\fBcargo\fR(1), \fBcargo\-remove\fR(1)
|
rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-bench.1
ADDED
|
@@ -0,0 +1,562 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
'\" t
|
| 2 |
+
.TH "CARGO\-BENCH" "1"
|
| 3 |
+
.nh
|
| 4 |
+
.ad l
|
| 5 |
+
.ss \n[.ss] 0
|
| 6 |
+
.SH "NAME"
|
| 7 |
+
cargo\-bench \[em] Execute benchmarks of a package
|
| 8 |
+
.SH "SYNOPSIS"
|
| 9 |
+
\fBcargo bench\fR [\fIoptions\fR] [\fIbenchname\fR] [\fB\-\-\fR \fIbench\-options\fR]
|
| 10 |
+
.SH "DESCRIPTION"
|
| 11 |
+
Compile and execute benchmarks.
|
| 12 |
+
.sp
|
| 13 |
+
The benchmark filtering argument \fIbenchname\fR and all the arguments following
|
| 14 |
+
the two dashes (\fB\-\-\fR) are passed to the benchmark binaries and thus to
|
| 15 |
+
\fIlibtest\fR (rustc\[cq]s built in unit\-test and micro\-benchmarking framework). If
|
| 16 |
+
you are passing arguments to both Cargo and the binary, the ones after \fB\-\-\fR go
|
| 17 |
+
to the binary, the ones before go to Cargo. For details about libtest\[cq]s
|
| 18 |
+
arguments see the output of \fBcargo bench \-\- \-\-help\fR and check out the rustc
|
| 19 |
+
book\[cq]s chapter on how tests work at
|
| 20 |
+
<https://doc.rust\-lang.org/rustc/tests/index.html>\&.
|
| 21 |
+
.sp
|
| 22 |
+
As an example, this will run only the benchmark named \fBfoo\fR (and skip other
|
| 23 |
+
similarly named benchmarks like \fBfoobar\fR):
|
| 24 |
+
.sp
|
| 25 |
+
.RS 4
|
| 26 |
+
.nf
|
| 27 |
+
cargo bench \-\- foo \-\-exact
|
| 28 |
+
.fi
|
| 29 |
+
.RE
|
| 30 |
+
.sp
|
| 31 |
+
Benchmarks are built with the \fB\-\-test\fR option to \fBrustc\fR which creates a
|
| 32 |
+
special executable by linking your code with libtest. The executable
|
| 33 |
+
automatically runs all functions annotated with the \fB#[bench]\fR attribute.
|
| 34 |
+
Cargo passes the \fB\-\-bench\fR flag to the test harness to tell it to run
|
| 35 |
+
only benchmarks, regardless of whether the harness is libtest or a custom harness.
|
| 36 |
+
.sp
|
| 37 |
+
The libtest harness may be disabled by setting \fBharness = false\fR in the target
|
| 38 |
+
manifest settings, in which case your code will need to provide its own \fBmain\fR
|
| 39 |
+
function to handle running benchmarks.
|
| 40 |
+
.RS 3
|
| 41 |
+
.ll -5
|
| 42 |
+
.sp
|
| 43 |
+
\fBNote\fR: The
|
| 44 |
+
\fI\f(BI#[bench]\fI attribute\fR <https://doc.rust\-lang.org/nightly/unstable\-book/library\-features/test.html>
|
| 45 |
+
is currently unstable and only available on the
|
| 46 |
+
\fInightly channel\fR <https://doc.rust\-lang.org/book/appendix\-07\-nightly\-rust.html>\&.
|
| 47 |
+
There are some packages available on
|
| 48 |
+
\fIcrates.io\fR <https://crates.io/keywords/benchmark> that may help with
|
| 49 |
+
running benchmarks on the stable channel, such as
|
| 50 |
+
\fICriterion\fR <https://crates.io/crates/criterion>\&.
|
| 51 |
+
.br
|
| 52 |
+
.RE
|
| 53 |
+
.ll
|
| 54 |
+
.sp
|
| 55 |
+
By default, \fBcargo bench\fR uses the \fI\f(BIbench\fI profile\fR <https://doc.rust\-lang.org/cargo/reference/profiles.html#bench>, which enables
|
| 56 |
+
optimizations and disables debugging information. If you need to debug a
|
| 57 |
+
benchmark, you can use the \fB\-\-profile=dev\fR command\-line option to switch to
|
| 58 |
+
the dev profile. You can then run the debug\-enabled benchmark within a
|
| 59 |
+
debugger.
|
| 60 |
+
.SS "Working directory of benchmarks"
|
| 61 |
+
The working directory of every benchmark is set to the root directory of the
|
| 62 |
+
package the benchmark belongs to.
|
| 63 |
+
Setting the working directory of benchmarks to the package\[cq]s root directory
|
| 64 |
+
makes it possible for benchmarks to reliably access the package\[cq]s files using
|
| 65 |
+
relative paths, regardless from where \fBcargo bench\fR was executed from.
|
| 66 |
+
.SH "OPTIONS"
|
| 67 |
+
.SS "Benchmark Options"
|
| 68 |
+
.sp
|
| 69 |
+
\fB\-\-no\-run\fR
|
| 70 |
+
.RS 4
|
| 71 |
+
Compile, but don\[cq]t run benchmarks.
|
| 72 |
+
.RE
|
| 73 |
+
.sp
|
| 74 |
+
\fB\-\-no\-fail\-fast\fR
|
| 75 |
+
.RS 4
|
| 76 |
+
Run all benchmarks regardless of failure. Without this flag, Cargo will exit
|
| 77 |
+
after the first executable fails. The Rust test harness will run all benchmarks
|
| 78 |
+
within the executable to completion, this flag only applies to the executable
|
| 79 |
+
as a whole.
|
| 80 |
+
.RE
|
| 81 |
+
.SS "Package Selection"
|
| 82 |
+
By default, when no package selection options are given, the packages selected
|
| 83 |
+
depend on the selected manifest file (based on the current working directory if
|
| 84 |
+
\fB\-\-manifest\-path\fR is not given). If the manifest is the root of a workspace then
|
| 85 |
+
the workspaces default members are selected, otherwise only the package defined
|
| 86 |
+
by the manifest will be selected.
|
| 87 |
+
.sp
|
| 88 |
+
The default members of a workspace can be set explicitly with the
|
| 89 |
+
\fBworkspace.default\-members\fR key in the root manifest. If this is not set, a
|
| 90 |
+
virtual workspace will include all workspace members (equivalent to passing
|
| 91 |
+
\fB\-\-workspace\fR), and a non\-virtual workspace will include only the root crate itself.
|
| 92 |
+
.sp
|
| 93 |
+
\fB\-p\fR \fIspec\fR\[u2026],
|
| 94 |
+
\fB\-\-package\fR \fIspec\fR\[u2026]
|
| 95 |
+
.RS 4
|
| 96 |
+
Benchmark only the specified packages. See \fBcargo\-pkgid\fR(1) for the
|
| 97 |
+
SPEC format. This flag may be specified multiple times and supports common Unix
|
| 98 |
+
glob patterns like \fB*\fR, \fB?\fR and \fB[]\fR\&. However, to avoid your shell accidentally
|
| 99 |
+
expanding glob patterns before Cargo handles them, you must use single quotes or
|
| 100 |
+
double quotes around each pattern.
|
| 101 |
+
.RE
|
| 102 |
+
.sp
|
| 103 |
+
\fB\-\-workspace\fR
|
| 104 |
+
.RS 4
|
| 105 |
+
Benchmark all members in the workspace.
|
| 106 |
+
.RE
|
| 107 |
+
.sp
|
| 108 |
+
\fB\-\-all\fR
|
| 109 |
+
.RS 4
|
| 110 |
+
Deprecated alias for \fB\-\-workspace\fR\&.
|
| 111 |
+
.RE
|
| 112 |
+
.sp
|
| 113 |
+
\fB\-\-exclude\fR \fISPEC\fR\[u2026]
|
| 114 |
+
.RS 4
|
| 115 |
+
Exclude the specified packages. Must be used in conjunction with the
|
| 116 |
+
\fB\-\-workspace\fR flag. This flag may be specified multiple times and supports
|
| 117 |
+
common Unix glob patterns like \fB*\fR, \fB?\fR and \fB[]\fR\&. However, to avoid your shell
|
| 118 |
+
accidentally expanding glob patterns before Cargo handles them, you must use
|
| 119 |
+
single quotes or double quotes around each pattern.
|
| 120 |
+
.RE
|
| 121 |
+
.SS "Target Selection"
|
| 122 |
+
When no target selection options are given, \fBcargo bench\fR will build the
|
| 123 |
+
following targets of the selected packages:
|
| 124 |
+
.sp
|
| 125 |
+
.RS 4
|
| 126 |
+
\h'-04'\(bu\h'+03'lib \[em] used to link with binaries and benchmarks
|
| 127 |
+
.RE
|
| 128 |
+
.sp
|
| 129 |
+
.RS 4
|
| 130 |
+
\h'-04'\(bu\h'+03'bins (only if benchmark targets are built and required features are
|
| 131 |
+
available)
|
| 132 |
+
.RE
|
| 133 |
+
.sp
|
| 134 |
+
.RS 4
|
| 135 |
+
\h'-04'\(bu\h'+03'lib as a benchmark
|
| 136 |
+
.RE
|
| 137 |
+
.sp
|
| 138 |
+
.RS 4
|
| 139 |
+
\h'-04'\(bu\h'+03'bins as benchmarks
|
| 140 |
+
.RE
|
| 141 |
+
.sp
|
| 142 |
+
.RS 4
|
| 143 |
+
\h'-04'\(bu\h'+03'benchmark targets
|
| 144 |
+
.RE
|
| 145 |
+
.sp
|
| 146 |
+
The default behavior can be changed by setting the \fBbench\fR flag for the target
|
| 147 |
+
in the manifest settings. Setting examples to \fBbench = true\fR will build and
|
| 148 |
+
run the example as a benchmark, replacing the example\[cq]s \fBmain\fR function with
|
| 149 |
+
the libtest harness.
|
| 150 |
+
.sp
|
| 151 |
+
Setting targets to \fBbench = false\fR will stop them from being benchmarked by
|
| 152 |
+
default. Target selection options that take a target by name (such as
|
| 153 |
+
\fB\-\-example foo\fR) ignore the \fBbench\fR flag and will always benchmark the given
|
| 154 |
+
target.
|
| 155 |
+
.sp
|
| 156 |
+
See \fIConfiguring a target\fR <https://doc.rust\-lang.org/cargo/reference/cargo\-targets.html#configuring\-a\-target>
|
| 157 |
+
for more information on per\-target settings.
|
| 158 |
+
.sp
|
| 159 |
+
Binary targets are automatically built if there is an integration test or
|
| 160 |
+
benchmark being selected to benchmark. This allows an integration
|
| 161 |
+
test to execute the binary to exercise and test its behavior.
|
| 162 |
+
The \fBCARGO_BIN_EXE_<name>\fR
|
| 163 |
+
\fIenvironment variable\fR <https://doc.rust\-lang.org/cargo/reference/environment\-variables.html#environment\-variables\-cargo\-sets\-for\-crates>
|
| 164 |
+
is set when the integration test is built and run so that it can use the
|
| 165 |
+
\fI\f(BIenv\fI macro\fR <https://doc.rust\-lang.org/std/macro.env.html> or the
|
| 166 |
+
\fI\f(BIvar\fI function\fR <https://doc.rust\-lang.org/std/env/fn.var.html> to locate the
|
| 167 |
+
executable.
|
| 168 |
+
.sp
|
| 169 |
+
Passing target selection flags will benchmark only the specified
|
| 170 |
+
targets.
|
| 171 |
+
.sp
|
| 172 |
+
Note that \fB\-\-bin\fR, \fB\-\-example\fR, \fB\-\-test\fR and \fB\-\-bench\fR flags also
|
| 173 |
+
support common Unix glob patterns like \fB*\fR, \fB?\fR and \fB[]\fR\&. However, to avoid your
|
| 174 |
+
shell accidentally expanding glob patterns before Cargo handles them, you must
|
| 175 |
+
use single quotes or double quotes around each glob pattern.
|
| 176 |
+
.sp
|
| 177 |
+
\fB\-\-lib\fR
|
| 178 |
+
.RS 4
|
| 179 |
+
Benchmark the package\[cq]s library.
|
| 180 |
+
.RE
|
| 181 |
+
.sp
|
| 182 |
+
\fB\-\-bin\fR \fIname\fR\[u2026]
|
| 183 |
+
.RS 4
|
| 184 |
+
Benchmark the specified binary. This flag may be specified multiple times
|
| 185 |
+
and supports common Unix glob patterns.
|
| 186 |
+
.RE
|
| 187 |
+
.sp
|
| 188 |
+
\fB\-\-bins\fR
|
| 189 |
+
.RS 4
|
| 190 |
+
Benchmark all binary targets.
|
| 191 |
+
.RE
|
| 192 |
+
.sp
|
| 193 |
+
\fB\-\-example\fR \fIname\fR\[u2026]
|
| 194 |
+
.RS 4
|
| 195 |
+
Benchmark the specified example. This flag may be specified multiple times
|
| 196 |
+
and supports common Unix glob patterns.
|
| 197 |
+
.RE
|
| 198 |
+
.sp
|
| 199 |
+
\fB\-\-examples\fR
|
| 200 |
+
.RS 4
|
| 201 |
+
Benchmark all example targets.
|
| 202 |
+
.RE
|
| 203 |
+
.sp
|
| 204 |
+
\fB\-\-test\fR \fIname\fR\[u2026]
|
| 205 |
+
.RS 4
|
| 206 |
+
Benchmark the specified integration test. This flag may be specified
|
| 207 |
+
multiple times and supports common Unix glob patterns.
|
| 208 |
+
.RE
|
| 209 |
+
.sp
|
| 210 |
+
\fB\-\-tests\fR
|
| 211 |
+
.RS 4
|
| 212 |
+
Benchmark all targets that have the \fBtest = true\fR manifest
|
| 213 |
+
flag set. By default this includes the library and binaries built as
|
| 214 |
+
unittests, and integration tests. Be aware that this will also build any
|
| 215 |
+
required dependencies, so the lib target may be built twice (once as a
|
| 216 |
+
unittest, and once as a dependency for binaries, integration tests, etc.).
|
| 217 |
+
Targets may be enabled or disabled by setting the \fBtest\fR flag in the
|
| 218 |
+
manifest settings for the target.
|
| 219 |
+
.RE
|
| 220 |
+
.sp
|
| 221 |
+
\fB\-\-bench\fR \fIname\fR\[u2026]
|
| 222 |
+
.RS 4
|
| 223 |
+
Benchmark the specified benchmark. This flag may be specified multiple
|
| 224 |
+
times and supports common Unix glob patterns.
|
| 225 |
+
.RE
|
| 226 |
+
.sp
|
| 227 |
+
\fB\-\-benches\fR
|
| 228 |
+
.RS 4
|
| 229 |
+
Benchmark all targets that have the \fBbench = true\fR
|
| 230 |
+
manifest flag set. By default this includes the library and binaries built
|
| 231 |
+
as benchmarks, and bench targets. Be aware that this will also build any
|
| 232 |
+
required dependencies, so the lib target may be built twice (once as a
|
| 233 |
+
benchmark, and once as a dependency for binaries, benchmarks, etc.).
|
| 234 |
+
Targets may be enabled or disabled by setting the \fBbench\fR flag in the
|
| 235 |
+
manifest settings for the target.
|
| 236 |
+
.RE
|
| 237 |
+
.sp
|
| 238 |
+
\fB\-\-all\-targets\fR
|
| 239 |
+
.RS 4
|
| 240 |
+
Benchmark all targets. This is equivalent to specifying \fB\-\-lib \-\-bins \-\-tests \-\-benches \-\-examples\fR\&.
|
| 241 |
+
.RE
|
| 242 |
+
.SS "Feature Selection"
|
| 243 |
+
The feature flags allow you to control which features are enabled. When no
|
| 244 |
+
feature options are given, the \fBdefault\fR feature is activated for every
|
| 245 |
+
selected package.
|
| 246 |
+
.sp
|
| 247 |
+
See \fIthe features documentation\fR <https://doc.rust\-lang.org/cargo/reference/features.html#command\-line\-feature\-options>
|
| 248 |
+
for more details.
|
| 249 |
+
.sp
|
| 250 |
+
\fB\-F\fR \fIfeatures\fR,
|
| 251 |
+
\fB\-\-features\fR \fIfeatures\fR
|
| 252 |
+
.RS 4
|
| 253 |
+
Space or comma separated list of features to activate. Features of workspace
|
| 254 |
+
members may be enabled with \fBpackage\-name/feature\-name\fR syntax. This flag may
|
| 255 |
+
be specified multiple times, which enables all specified features.
|
| 256 |
+
.RE
|
| 257 |
+
.sp
|
| 258 |
+
\fB\-\-all\-features\fR
|
| 259 |
+
.RS 4
|
| 260 |
+
Activate all available features of all selected packages.
|
| 261 |
+
.RE
|
| 262 |
+
.sp
|
| 263 |
+
\fB\-\-no\-default\-features\fR
|
| 264 |
+
.RS 4
|
| 265 |
+
Do not activate the \fBdefault\fR feature of the selected packages.
|
| 266 |
+
.RE
|
| 267 |
+
.SS "Compilation Options"
|
| 268 |
+
.sp
|
| 269 |
+
\fB\-\-target\fR \fItriple\fR
|
| 270 |
+
.RS 4
|
| 271 |
+
Benchmark for the specified target architecture. Flag may be specified multiple times. The default is the host architecture. The general format of the triple is
|
| 272 |
+
\fB<arch><sub>\-<vendor>\-<sys>\-<abi>\fR\&.
|
| 273 |
+
.sp
|
| 274 |
+
Possible values:
|
| 275 |
+
.sp
|
| 276 |
+
.RS 4
|
| 277 |
+
\h'-04'\(bu\h'+03'Any supported target in \fBrustc \-\-print target\-list\fR\&.
|
| 278 |
+
.RE
|
| 279 |
+
.sp
|
| 280 |
+
.RS 4
|
| 281 |
+
\h'-04'\(bu\h'+03'\fB"host\-tuple"\fR, which will internally be substituted by the host\[cq]s target. This can be particularly useful if you\[cq]re cross\-compiling some crates, and don\[cq]t want to specify your host\[cq]s machine as a target (for instance, an \fBxtask\fR in a shared project that may be worked on by many hosts).
|
| 282 |
+
.RE
|
| 283 |
+
.sp
|
| 284 |
+
.RS 4
|
| 285 |
+
\h'-04'\(bu\h'+03'A path to a custom target specification. See \fICustom Target Lookup Path\fR <https://doc.rust\-lang.org/rustc/targets/custom.html#custom\-target\-lookup\-path> for more information.
|
| 286 |
+
.RE
|
| 287 |
+
.sp
|
| 288 |
+
This may also be specified with the \fBbuild.target\fR \fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 289 |
+
.sp
|
| 290 |
+
Note that specifying this flag makes Cargo run in a different mode where the
|
| 291 |
+
target artifacts are placed in a separate directory. See the
|
| 292 |
+
\fIbuild cache\fR <https://doc.rust\-lang.org/cargo/reference/build\-cache.html> documentation for more details.
|
| 293 |
+
.RE
|
| 294 |
+
.sp
|
| 295 |
+
\fB\-\-profile\fR \fIname\fR
|
| 296 |
+
.RS 4
|
| 297 |
+
Benchmark with the given profile.
|
| 298 |
+
See \fIthe reference\fR <https://doc.rust\-lang.org/cargo/reference/profiles.html> for more details on profiles.
|
| 299 |
+
.RE
|
| 300 |
+
.sp
|
| 301 |
+
\fB\-\-timings\fR
|
| 302 |
+
.RS 4
|
| 303 |
+
Output information how long each compilation takes, and track concurrency
|
| 304 |
+
information over time.
|
| 305 |
+
.sp
|
| 306 |
+
A file \fBcargo\-timing.html\fR will be written to the \fBtarget/cargo\-timings\fR
|
| 307 |
+
directory at the end of the build. An additional report with a timestamp
|
| 308 |
+
in its filename is also written if you want to look at a previous run.
|
| 309 |
+
These reports are suitable for human consumption only, and do not provide
|
| 310 |
+
machine\-readable timing data.
|
| 311 |
+
.RE
|
| 312 |
+
.SS "Output Options"
|
| 313 |
+
.sp
|
| 314 |
+
\fB\-\-target\-dir\fR \fIdirectory\fR
|
| 315 |
+
.RS 4
|
| 316 |
+
Directory for all generated artifacts and intermediate files. May also be
|
| 317 |
+
specified with the \fBCARGO_TARGET_DIR\fR environment variable, or the
|
| 318 |
+
\fBbuild.target\-dir\fR \fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 319 |
+
Defaults to \fBtarget\fR in the root of the workspace.
|
| 320 |
+
.RE
|
| 321 |
+
.SS "Display Options"
|
| 322 |
+
By default the Rust test harness hides output from benchmark execution to keep
|
| 323 |
+
results readable. Benchmark output can be recovered (e.g., for debugging) by
|
| 324 |
+
passing \fB\-\-no\-capture\fR to the benchmark binaries:
|
| 325 |
+
.sp
|
| 326 |
+
.RS 4
|
| 327 |
+
.nf
|
| 328 |
+
cargo bench \-\- \-\-no\-capture
|
| 329 |
+
.fi
|
| 330 |
+
.RE
|
| 331 |
+
.sp
|
| 332 |
+
\fB\-v\fR,
|
| 333 |
+
\fB\-\-verbose\fR
|
| 334 |
+
.RS 4
|
| 335 |
+
Use verbose output. May be specified twice for \[lq]very verbose\[rq] output which
|
| 336 |
+
includes extra output such as dependency warnings and build script output.
|
| 337 |
+
May also be specified with the \fBterm.verbose\fR
|
| 338 |
+
\fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 339 |
+
.RE
|
| 340 |
+
.sp
|
| 341 |
+
\fB\-q\fR,
|
| 342 |
+
\fB\-\-quiet\fR
|
| 343 |
+
.RS 4
|
| 344 |
+
Do not print cargo log messages.
|
| 345 |
+
May also be specified with the \fBterm.quiet\fR
|
| 346 |
+
\fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 347 |
+
.RE
|
| 348 |
+
.sp
|
| 349 |
+
\fB\-\-color\fR \fIwhen\fR
|
| 350 |
+
.RS 4
|
| 351 |
+
Control when colored output is used. Valid values:
|
| 352 |
+
.sp
|
| 353 |
+
.RS 4
|
| 354 |
+
\h'-04'\(bu\h'+03'\fBauto\fR (default): Automatically detect if color support is available on the
|
| 355 |
+
terminal.
|
| 356 |
+
.RE
|
| 357 |
+
.sp
|
| 358 |
+
.RS 4
|
| 359 |
+
\h'-04'\(bu\h'+03'\fBalways\fR: Always display colors.
|
| 360 |
+
.RE
|
| 361 |
+
.sp
|
| 362 |
+
.RS 4
|
| 363 |
+
\h'-04'\(bu\h'+03'\fBnever\fR: Never display colors.
|
| 364 |
+
.RE
|
| 365 |
+
.sp
|
| 366 |
+
May also be specified with the \fBterm.color\fR
|
| 367 |
+
\fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 368 |
+
.RE
|
| 369 |
+
.sp
|
| 370 |
+
\fB\-\-message\-format\fR \fIfmt\fR
|
| 371 |
+
.RS 4
|
| 372 |
+
The output format for diagnostic messages. Can be specified multiple times
|
| 373 |
+
and consists of comma\-separated values. Valid values:
|
| 374 |
+
.sp
|
| 375 |
+
.RS 4
|
| 376 |
+
\h'-04'\(bu\h'+03'\fBhuman\fR (default): Display in a human\-readable text format. Conflicts with
|
| 377 |
+
\fBshort\fR and \fBjson\fR\&.
|
| 378 |
+
.RE
|
| 379 |
+
.sp
|
| 380 |
+
.RS 4
|
| 381 |
+
\h'-04'\(bu\h'+03'\fBshort\fR: Emit shorter, human\-readable text messages. Conflicts with \fBhuman\fR
|
| 382 |
+
and \fBjson\fR\&.
|
| 383 |
+
.RE
|
| 384 |
+
.sp
|
| 385 |
+
.RS 4
|
| 386 |
+
\h'-04'\(bu\h'+03'\fBjson\fR: Emit JSON messages to stdout. See
|
| 387 |
+
\fIthe reference\fR <https://doc.rust\-lang.org/cargo/reference/external\-tools.html#json\-messages>
|
| 388 |
+
for more details. Conflicts with \fBhuman\fR and \fBshort\fR\&.
|
| 389 |
+
.RE
|
| 390 |
+
.sp
|
| 391 |
+
.RS 4
|
| 392 |
+
\h'-04'\(bu\h'+03'\fBjson\-diagnostic\-short\fR: Ensure the \fBrendered\fR field of JSON messages contains
|
| 393 |
+
the \[lq]short\[rq] rendering from rustc. Cannot be used with \fBhuman\fR or \fBshort\fR\&.
|
| 394 |
+
.RE
|
| 395 |
+
.sp
|
| 396 |
+
.RS 4
|
| 397 |
+
\h'-04'\(bu\h'+03'\fBjson\-diagnostic\-rendered\-ansi\fR: Ensure the \fBrendered\fR field of JSON messages
|
| 398 |
+
contains embedded ANSI color codes for respecting rustc\[cq]s default color
|
| 399 |
+
scheme. Cannot be used with \fBhuman\fR or \fBshort\fR\&.
|
| 400 |
+
.RE
|
| 401 |
+
.sp
|
| 402 |
+
.RS 4
|
| 403 |
+
\h'-04'\(bu\h'+03'\fBjson\-render\-diagnostics\fR: Instruct Cargo to not include rustc diagnostics
|
| 404 |
+
in JSON messages printed, but instead Cargo itself should render the
|
| 405 |
+
JSON diagnostics coming from rustc. Cargo\[cq]s own JSON diagnostics and others
|
| 406 |
+
coming from rustc are still emitted. Cannot be used with \fBhuman\fR or \fBshort\fR\&.
|
| 407 |
+
.RE
|
| 408 |
+
.RE
|
| 409 |
+
.SS "Manifest Options"
|
| 410 |
+
.sp
|
| 411 |
+
\fB\-\-manifest\-path\fR \fIpath\fR
|
| 412 |
+
.RS 4
|
| 413 |
+
Path to the \fBCargo.toml\fR file. By default, Cargo searches for the
|
| 414 |
+
\fBCargo.toml\fR file in the current directory or any parent directory.
|
| 415 |
+
.RE
|
| 416 |
+
.sp
|
| 417 |
+
\fB\-\-ignore\-rust\-version\fR
|
| 418 |
+
.RS 4
|
| 419 |
+
Ignore \fBrust\-version\fR specification in packages.
|
| 420 |
+
.RE
|
| 421 |
+
.sp
|
| 422 |
+
\fB\-\-locked\fR
|
| 423 |
+
.RS 4
|
| 424 |
+
Asserts that the exact same dependencies and versions are used as when the
|
| 425 |
+
existing \fBCargo.lock\fR file was originally generated. Cargo will exit with an
|
| 426 |
+
error when either of the following scenarios arises:
|
| 427 |
+
.sp
|
| 428 |
+
.RS 4
|
| 429 |
+
\h'-04'\(bu\h'+03'The lock file is missing.
|
| 430 |
+
.RE
|
| 431 |
+
.sp
|
| 432 |
+
.RS 4
|
| 433 |
+
\h'-04'\(bu\h'+03'Cargo attempted to change the lock file due to a different dependency resolution.
|
| 434 |
+
.RE
|
| 435 |
+
.sp
|
| 436 |
+
It may be used in environments where deterministic builds are desired,
|
| 437 |
+
such as in CI pipelines.
|
| 438 |
+
.RE
|
| 439 |
+
.sp
|
| 440 |
+
\fB\-\-offline\fR
|
| 441 |
+
.RS 4
|
| 442 |
+
Prevents Cargo from accessing the network for any reason. Without this
|
| 443 |
+
flag, Cargo will stop with an error if it needs to access the network and
|
| 444 |
+
the network is not available. With this flag, Cargo will attempt to
|
| 445 |
+
proceed without the network if possible.
|
| 446 |
+
.sp
|
| 447 |
+
Beware that this may result in different dependency resolution than online
|
| 448 |
+
mode. Cargo will restrict itself to crates that are downloaded locally, even
|
| 449 |
+
if there might be a newer version as indicated in the local copy of the index.
|
| 450 |
+
See the \fBcargo\-fetch\fR(1) command to download dependencies before going
|
| 451 |
+
offline.
|
| 452 |
+
.sp
|
| 453 |
+
May also be specified with the \fBnet.offline\fR \fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 454 |
+
.RE
|
| 455 |
+
.sp
|
| 456 |
+
\fB\-\-frozen\fR
|
| 457 |
+
.RS 4
|
| 458 |
+
Equivalent to specifying both \fB\-\-locked\fR and \fB\-\-offline\fR\&.
|
| 459 |
+
.RE
|
| 460 |
+
.SS "Common Options"
|
| 461 |
+
.sp
|
| 462 |
+
\fB+\fR\fItoolchain\fR
|
| 463 |
+
.RS 4
|
| 464 |
+
If Cargo has been installed with rustup, and the first argument to \fBcargo\fR
|
| 465 |
+
begins with \fB+\fR, it will be interpreted as a rustup toolchain name (such
|
| 466 |
+
as \fB+stable\fR or \fB+nightly\fR).
|
| 467 |
+
See the \fIrustup documentation\fR <https://rust\-lang.github.io/rustup/overrides.html>
|
| 468 |
+
for more information about how toolchain overrides work.
|
| 469 |
+
.RE
|
| 470 |
+
.sp
|
| 471 |
+
\fB\-\-config\fR \fIKEY=VALUE\fR or \fIPATH\fR
|
| 472 |
+
.RS 4
|
| 473 |
+
Overrides a Cargo configuration value. The argument should be in TOML syntax of \fBKEY=VALUE\fR,
|
| 474 |
+
or provided as a path to an extra configuration file. This flag may be specified multiple times.
|
| 475 |
+
See the \fIcommand\-line overrides section\fR <https://doc.rust\-lang.org/cargo/reference/config.html#command\-line\-overrides> for more information.
|
| 476 |
+
.RE
|
| 477 |
+
.sp
|
| 478 |
+
\fB\-C\fR \fIPATH\fR
|
| 479 |
+
.RS 4
|
| 480 |
+
Changes the current working directory before executing any specified operations. This affects
|
| 481 |
+
things like where cargo looks by default for the project manifest (\fBCargo.toml\fR), as well as
|
| 482 |
+
the directories searched for discovering \fB\&.cargo/config.toml\fR, for example. This option must
|
| 483 |
+
appear before the command name, for example \fBcargo \-C path/to/my\-project build\fR\&.
|
| 484 |
+
.sp
|
| 485 |
+
This option is only available on the \fInightly
|
| 486 |
+
channel\fR <https://doc.rust\-lang.org/book/appendix\-07\-nightly\-rust.html> and
|
| 487 |
+
requires the \fB\-Z unstable\-options\fR flag to enable (see
|
| 488 |
+
\fI#10098\fR <https://github.com/rust\-lang/cargo/issues/10098>).
|
| 489 |
+
.RE
|
| 490 |
+
.sp
|
| 491 |
+
\fB\-h\fR,
|
| 492 |
+
\fB\-\-help\fR
|
| 493 |
+
.RS 4
|
| 494 |
+
Prints help information.
|
| 495 |
+
.RE
|
| 496 |
+
.sp
|
| 497 |
+
\fB\-Z\fR \fIflag\fR
|
| 498 |
+
.RS 4
|
| 499 |
+
Unstable (nightly\-only) flags to Cargo. Run \fBcargo \-Z help\fR for details.
|
| 500 |
+
.RE
|
| 501 |
+
.SS "Miscellaneous Options"
|
| 502 |
+
The \fB\-\-jobs\fR argument affects the building of the benchmark executable but
|
| 503 |
+
does not affect how many threads are used when running the benchmarks. The
|
| 504 |
+
Rust test harness runs benchmarks serially in a single thread.
|
| 505 |
+
.sp
|
| 506 |
+
\fB\-j\fR \fIN\fR,
|
| 507 |
+
\fB\-\-jobs\fR \fIN\fR
|
| 508 |
+
.RS 4
|
| 509 |
+
Number of parallel jobs to run. May also be specified with the
|
| 510 |
+
\fBbuild.jobs\fR \fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&. Defaults to
|
| 511 |
+
the number of logical CPUs. If negative, it sets the maximum number of
|
| 512 |
+
parallel jobs to the number of logical CPUs plus provided value. If
|
| 513 |
+
a string \fBdefault\fR is provided, it sets the value back to defaults.
|
| 514 |
+
Should not be 0.
|
| 515 |
+
.RE
|
| 516 |
+
.sp
|
| 517 |
+
While \fBcargo bench\fR involves compilation, it does not provide a \fB\-\-keep\-going\fR
|
| 518 |
+
flag. Use \fB\-\-no\-fail\-fast\fR to run as many benchmarks as possible without
|
| 519 |
+
stopping at the first failure. To \[lq]compile\[rq] as many benchmarks as possible, use
|
| 520 |
+
\fB\-\-benches\fR to build benchmark binaries separately. For example:
|
| 521 |
+
.sp
|
| 522 |
+
.RS 4
|
| 523 |
+
.nf
|
| 524 |
+
cargo build \-\-benches \-\-release \-\-keep\-going
|
| 525 |
+
cargo bench \-\-no\-fail\-fast
|
| 526 |
+
.fi
|
| 527 |
+
.RE
|
| 528 |
+
.SH "ENVIRONMENT"
|
| 529 |
+
See \fIthe reference\fR <https://doc.rust\-lang.org/cargo/reference/environment\-variables.html> for
|
| 530 |
+
details on environment variables that Cargo reads.
|
| 531 |
+
.SH "EXIT STATUS"
|
| 532 |
+
.sp
|
| 533 |
+
.RS 4
|
| 534 |
+
\h'-04'\(bu\h'+03'\fB0\fR: Cargo succeeded.
|
| 535 |
+
.RE
|
| 536 |
+
.sp
|
| 537 |
+
.RS 4
|
| 538 |
+
\h'-04'\(bu\h'+03'\fB101\fR: Cargo failed to complete.
|
| 539 |
+
.RE
|
| 540 |
+
.SH "EXAMPLES"
|
| 541 |
+
.sp
|
| 542 |
+
.RS 4
|
| 543 |
+
\h'-04' 1.\h'+01'Build and execute all the benchmarks of the current package:
|
| 544 |
+
.sp
|
| 545 |
+
.RS 4
|
| 546 |
+
.nf
|
| 547 |
+
cargo bench
|
| 548 |
+
.fi
|
| 549 |
+
.RE
|
| 550 |
+
.RE
|
| 551 |
+
.sp
|
| 552 |
+
.RS 4
|
| 553 |
+
\h'-04' 2.\h'+01'Run only a specific benchmark within a specific benchmark target:
|
| 554 |
+
.sp
|
| 555 |
+
.RS 4
|
| 556 |
+
.nf
|
| 557 |
+
cargo bench \-\-bench bench_name \-\- modname::some_benchmark
|
| 558 |
+
.fi
|
| 559 |
+
.RE
|
| 560 |
+
.RE
|
| 561 |
+
.SH "SEE ALSO"
|
| 562 |
+
\fBcargo\fR(1), \fBcargo\-test\fR(1)
|
rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-build.1
ADDED
|
@@ -0,0 +1,474 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
'\" t
|
| 2 |
+
.TH "CARGO\-BUILD" "1"
|
| 3 |
+
.nh
|
| 4 |
+
.ad l
|
| 5 |
+
.ss \n[.ss] 0
|
| 6 |
+
.SH "NAME"
|
| 7 |
+
cargo\-build \[em] Compile the current package
|
| 8 |
+
.SH "SYNOPSIS"
|
| 9 |
+
\fBcargo build\fR [\fIoptions\fR]
|
| 10 |
+
.SH "DESCRIPTION"
|
| 11 |
+
Compile local packages and all of their dependencies.
|
| 12 |
+
.SH "OPTIONS"
|
| 13 |
+
.SS "Package Selection"
|
| 14 |
+
By default, when no package selection options are given, the packages selected
|
| 15 |
+
depend on the selected manifest file (based on the current working directory if
|
| 16 |
+
\fB\-\-manifest\-path\fR is not given). If the manifest is the root of a workspace then
|
| 17 |
+
the workspaces default members are selected, otherwise only the package defined
|
| 18 |
+
by the manifest will be selected.
|
| 19 |
+
.sp
|
| 20 |
+
The default members of a workspace can be set explicitly with the
|
| 21 |
+
\fBworkspace.default\-members\fR key in the root manifest. If this is not set, a
|
| 22 |
+
virtual workspace will include all workspace members (equivalent to passing
|
| 23 |
+
\fB\-\-workspace\fR), and a non\-virtual workspace will include only the root crate itself.
|
| 24 |
+
.sp
|
| 25 |
+
\fB\-p\fR \fIspec\fR\[u2026],
|
| 26 |
+
\fB\-\-package\fR \fIspec\fR\[u2026]
|
| 27 |
+
.RS 4
|
| 28 |
+
Build only the specified packages. See \fBcargo\-pkgid\fR(1) for the
|
| 29 |
+
SPEC format. This flag may be specified multiple times and supports common Unix
|
| 30 |
+
glob patterns like \fB*\fR, \fB?\fR and \fB[]\fR\&. However, to avoid your shell accidentally
|
| 31 |
+
expanding glob patterns before Cargo handles them, you must use single quotes or
|
| 32 |
+
double quotes around each pattern.
|
| 33 |
+
.RE
|
| 34 |
+
.sp
|
| 35 |
+
\fB\-\-workspace\fR
|
| 36 |
+
.RS 4
|
| 37 |
+
Build all members in the workspace.
|
| 38 |
+
.RE
|
| 39 |
+
.sp
|
| 40 |
+
\fB\-\-all\fR
|
| 41 |
+
.RS 4
|
| 42 |
+
Deprecated alias for \fB\-\-workspace\fR\&.
|
| 43 |
+
.RE
|
| 44 |
+
.sp
|
| 45 |
+
\fB\-\-exclude\fR \fISPEC\fR\[u2026]
|
| 46 |
+
.RS 4
|
| 47 |
+
Exclude the specified packages. Must be used in conjunction with the
|
| 48 |
+
\fB\-\-workspace\fR flag. This flag may be specified multiple times and supports
|
| 49 |
+
common Unix glob patterns like \fB*\fR, \fB?\fR and \fB[]\fR\&. However, to avoid your shell
|
| 50 |
+
accidentally expanding glob patterns before Cargo handles them, you must use
|
| 51 |
+
single quotes or double quotes around each pattern.
|
| 52 |
+
.RE
|
| 53 |
+
.SS "Target Selection"
|
| 54 |
+
When no target selection options are given, \fBcargo build\fR will build all
|
| 55 |
+
binary and library targets of the selected packages. Binaries are skipped if
|
| 56 |
+
they have \fBrequired\-features\fR that are missing.
|
| 57 |
+
.sp
|
| 58 |
+
Binary targets are automatically built if there is an integration test or
|
| 59 |
+
benchmark being selected to build. This allows an integration
|
| 60 |
+
test to execute the binary to exercise and test its behavior.
|
| 61 |
+
The \fBCARGO_BIN_EXE_<name>\fR
|
| 62 |
+
\fIenvironment variable\fR <https://doc.rust\-lang.org/cargo/reference/environment\-variables.html#environment\-variables\-cargo\-sets\-for\-crates>
|
| 63 |
+
is set when the integration test is built and run so that it can use the
|
| 64 |
+
\fI\f(BIenv\fI macro\fR <https://doc.rust\-lang.org/std/macro.env.html> or the
|
| 65 |
+
\fI\f(BIvar\fI function\fR <https://doc.rust\-lang.org/std/env/fn.var.html> to locate the
|
| 66 |
+
executable.
|
| 67 |
+
.sp
|
| 68 |
+
Passing target selection flags will build only the specified
|
| 69 |
+
targets.
|
| 70 |
+
.sp
|
| 71 |
+
Note that \fB\-\-bin\fR, \fB\-\-example\fR, \fB\-\-test\fR and \fB\-\-bench\fR flags also
|
| 72 |
+
support common Unix glob patterns like \fB*\fR, \fB?\fR and \fB[]\fR\&. However, to avoid your
|
| 73 |
+
shell accidentally expanding glob patterns before Cargo handles them, you must
|
| 74 |
+
use single quotes or double quotes around each glob pattern.
|
| 75 |
+
.sp
|
| 76 |
+
\fB\-\-lib\fR
|
| 77 |
+
.RS 4
|
| 78 |
+
Build the package\[cq]s library.
|
| 79 |
+
.RE
|
| 80 |
+
.sp
|
| 81 |
+
\fB\-\-bin\fR \fIname\fR\[u2026]
|
| 82 |
+
.RS 4
|
| 83 |
+
Build the specified binary. This flag may be specified multiple times
|
| 84 |
+
and supports common Unix glob patterns.
|
| 85 |
+
.RE
|
| 86 |
+
.sp
|
| 87 |
+
\fB\-\-bins\fR
|
| 88 |
+
.RS 4
|
| 89 |
+
Build all binary targets.
|
| 90 |
+
.RE
|
| 91 |
+
.sp
|
| 92 |
+
\fB\-\-example\fR \fIname\fR\[u2026]
|
| 93 |
+
.RS 4
|
| 94 |
+
Build the specified example. This flag may be specified multiple times
|
| 95 |
+
and supports common Unix glob patterns.
|
| 96 |
+
.RE
|
| 97 |
+
.sp
|
| 98 |
+
\fB\-\-examples\fR
|
| 99 |
+
.RS 4
|
| 100 |
+
Build all example targets.
|
| 101 |
+
.RE
|
| 102 |
+
.sp
|
| 103 |
+
\fB\-\-test\fR \fIname\fR\[u2026]
|
| 104 |
+
.RS 4
|
| 105 |
+
Build the specified integration test. This flag may be specified
|
| 106 |
+
multiple times and supports common Unix glob patterns.
|
| 107 |
+
.RE
|
| 108 |
+
.sp
|
| 109 |
+
\fB\-\-tests\fR
|
| 110 |
+
.RS 4
|
| 111 |
+
Build all targets that have the \fBtest = true\fR manifest
|
| 112 |
+
flag set. By default this includes the library and binaries built as
|
| 113 |
+
unittests, and integration tests. Be aware that this will also build any
|
| 114 |
+
required dependencies, so the lib target may be built twice (once as a
|
| 115 |
+
unittest, and once as a dependency for binaries, integration tests, etc.).
|
| 116 |
+
Targets may be enabled or disabled by setting the \fBtest\fR flag in the
|
| 117 |
+
manifest settings for the target.
|
| 118 |
+
.RE
|
| 119 |
+
.sp
|
| 120 |
+
\fB\-\-bench\fR \fIname\fR\[u2026]
|
| 121 |
+
.RS 4
|
| 122 |
+
Build the specified benchmark. This flag may be specified multiple
|
| 123 |
+
times and supports common Unix glob patterns.
|
| 124 |
+
.RE
|
| 125 |
+
.sp
|
| 126 |
+
\fB\-\-benches\fR
|
| 127 |
+
.RS 4
|
| 128 |
+
Build all targets that have the \fBbench = true\fR
|
| 129 |
+
manifest flag set. By default this includes the library and binaries built
|
| 130 |
+
as benchmarks, and bench targets. Be aware that this will also build any
|
| 131 |
+
required dependencies, so the lib target may be built twice (once as a
|
| 132 |
+
benchmark, and once as a dependency for binaries, benchmarks, etc.).
|
| 133 |
+
Targets may be enabled or disabled by setting the \fBbench\fR flag in the
|
| 134 |
+
manifest settings for the target.
|
| 135 |
+
.RE
|
| 136 |
+
.sp
|
| 137 |
+
\fB\-\-all\-targets\fR
|
| 138 |
+
.RS 4
|
| 139 |
+
Build all targets. This is equivalent to specifying \fB\-\-lib \-\-bins \-\-tests \-\-benches \-\-examples\fR\&.
|
| 140 |
+
.RE
|
| 141 |
+
.SS "Feature Selection"
|
| 142 |
+
The feature flags allow you to control which features are enabled. When no
|
| 143 |
+
feature options are given, the \fBdefault\fR feature is activated for every
|
| 144 |
+
selected package.
|
| 145 |
+
.sp
|
| 146 |
+
See \fIthe features documentation\fR <https://doc.rust\-lang.org/cargo/reference/features.html#command\-line\-feature\-options>
|
| 147 |
+
for more details.
|
| 148 |
+
.sp
|
| 149 |
+
\fB\-F\fR \fIfeatures\fR,
|
| 150 |
+
\fB\-\-features\fR \fIfeatures\fR
|
| 151 |
+
.RS 4
|
| 152 |
+
Space or comma separated list of features to activate. Features of workspace
|
| 153 |
+
members may be enabled with \fBpackage\-name/feature\-name\fR syntax. This flag may
|
| 154 |
+
be specified multiple times, which enables all specified features.
|
| 155 |
+
.RE
|
| 156 |
+
.sp
|
| 157 |
+
\fB\-\-all\-features\fR
|
| 158 |
+
.RS 4
|
| 159 |
+
Activate all available features of all selected packages.
|
| 160 |
+
.RE
|
| 161 |
+
.sp
|
| 162 |
+
\fB\-\-no\-default\-features\fR
|
| 163 |
+
.RS 4
|
| 164 |
+
Do not activate the \fBdefault\fR feature of the selected packages.
|
| 165 |
+
.RE
|
| 166 |
+
.SS "Compilation Options"
|
| 167 |
+
.sp
|
| 168 |
+
\fB\-\-target\fR \fItriple\fR
|
| 169 |
+
.RS 4
|
| 170 |
+
Build for the specified target architecture. Flag may be specified multiple times. The default is the host architecture. The general format of the triple is
|
| 171 |
+
\fB<arch><sub>\-<vendor>\-<sys>\-<abi>\fR\&.
|
| 172 |
+
.sp
|
| 173 |
+
Possible values:
|
| 174 |
+
.sp
|
| 175 |
+
.RS 4
|
| 176 |
+
\h'-04'\(bu\h'+03'Any supported target in \fBrustc \-\-print target\-list\fR\&.
|
| 177 |
+
.RE
|
| 178 |
+
.sp
|
| 179 |
+
.RS 4
|
| 180 |
+
\h'-04'\(bu\h'+03'\fB"host\-tuple"\fR, which will internally be substituted by the host\[cq]s target. This can be particularly useful if you\[cq]re cross\-compiling some crates, and don\[cq]t want to specify your host\[cq]s machine as a target (for instance, an \fBxtask\fR in a shared project that may be worked on by many hosts).
|
| 181 |
+
.RE
|
| 182 |
+
.sp
|
| 183 |
+
.RS 4
|
| 184 |
+
\h'-04'\(bu\h'+03'A path to a custom target specification. See \fICustom Target Lookup Path\fR <https://doc.rust\-lang.org/rustc/targets/custom.html#custom\-target\-lookup\-path> for more information.
|
| 185 |
+
.RE
|
| 186 |
+
.sp
|
| 187 |
+
This may also be specified with the \fBbuild.target\fR \fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 188 |
+
.sp
|
| 189 |
+
Note that specifying this flag makes Cargo run in a different mode where the
|
| 190 |
+
target artifacts are placed in a separate directory. See the
|
| 191 |
+
\fIbuild cache\fR <https://doc.rust\-lang.org/cargo/reference/build\-cache.html> documentation for more details.
|
| 192 |
+
.RE
|
| 193 |
+
.sp
|
| 194 |
+
\fB\-r\fR,
|
| 195 |
+
\fB\-\-release\fR
|
| 196 |
+
.RS 4
|
| 197 |
+
Build optimized artifacts with the \fBrelease\fR profile.
|
| 198 |
+
See also the \fB\-\-profile\fR option for choosing a specific profile by name.
|
| 199 |
+
.RE
|
| 200 |
+
.sp
|
| 201 |
+
\fB\-\-profile\fR \fIname\fR
|
| 202 |
+
.RS 4
|
| 203 |
+
Build with the given profile.
|
| 204 |
+
See \fIthe reference\fR <https://doc.rust\-lang.org/cargo/reference/profiles.html> for more details on profiles.
|
| 205 |
+
.RE
|
| 206 |
+
.sp
|
| 207 |
+
\fB\-\-timings\fR
|
| 208 |
+
.RS 4
|
| 209 |
+
Output information how long each compilation takes, and track concurrency
|
| 210 |
+
information over time.
|
| 211 |
+
.sp
|
| 212 |
+
A file \fBcargo\-timing.html\fR will be written to the \fBtarget/cargo\-timings\fR
|
| 213 |
+
directory at the end of the build. An additional report with a timestamp
|
| 214 |
+
in its filename is also written if you want to look at a previous run.
|
| 215 |
+
These reports are suitable for human consumption only, and do not provide
|
| 216 |
+
machine\-readable timing data.
|
| 217 |
+
.RE
|
| 218 |
+
.SS "Output Options"
|
| 219 |
+
.sp
|
| 220 |
+
\fB\-\-target\-dir\fR \fIdirectory\fR
|
| 221 |
+
.RS 4
|
| 222 |
+
Directory for all generated artifacts and intermediate files. May also be
|
| 223 |
+
specified with the \fBCARGO_TARGET_DIR\fR environment variable, or the
|
| 224 |
+
\fBbuild.target\-dir\fR \fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 225 |
+
Defaults to \fBtarget\fR in the root of the workspace.
|
| 226 |
+
.RE
|
| 227 |
+
.sp
|
| 228 |
+
\fB\-\-artifact\-dir\fR \fIdirectory\fR
|
| 229 |
+
.RS 4
|
| 230 |
+
Copy final artifacts to this directory.
|
| 231 |
+
.sp
|
| 232 |
+
This option is unstable and available only on the
|
| 233 |
+
\fInightly channel\fR <https://doc.rust\-lang.org/book/appendix\-07\-nightly\-rust.html>
|
| 234 |
+
and requires the \fB\-Z unstable\-options\fR flag to enable.
|
| 235 |
+
See <https://github.com/rust\-lang/cargo/issues/6790> for more information.
|
| 236 |
+
.RE
|
| 237 |
+
.SS "Display Options"
|
| 238 |
+
.sp
|
| 239 |
+
\fB\-v\fR,
|
| 240 |
+
\fB\-\-verbose\fR
|
| 241 |
+
.RS 4
|
| 242 |
+
Use verbose output. May be specified twice for \[lq]very verbose\[rq] output which
|
| 243 |
+
includes extra output such as dependency warnings and build script output.
|
| 244 |
+
May also be specified with the \fBterm.verbose\fR
|
| 245 |
+
\fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 246 |
+
.RE
|
| 247 |
+
.sp
|
| 248 |
+
\fB\-q\fR,
|
| 249 |
+
\fB\-\-quiet\fR
|
| 250 |
+
.RS 4
|
| 251 |
+
Do not print cargo log messages.
|
| 252 |
+
May also be specified with the \fBterm.quiet\fR
|
| 253 |
+
\fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 254 |
+
.RE
|
| 255 |
+
.sp
|
| 256 |
+
\fB\-\-color\fR \fIwhen\fR
|
| 257 |
+
.RS 4
|
| 258 |
+
Control when colored output is used. Valid values:
|
| 259 |
+
.sp
|
| 260 |
+
.RS 4
|
| 261 |
+
\h'-04'\(bu\h'+03'\fBauto\fR (default): Automatically detect if color support is available on the
|
| 262 |
+
terminal.
|
| 263 |
+
.RE
|
| 264 |
+
.sp
|
| 265 |
+
.RS 4
|
| 266 |
+
\h'-04'\(bu\h'+03'\fBalways\fR: Always display colors.
|
| 267 |
+
.RE
|
| 268 |
+
.sp
|
| 269 |
+
.RS 4
|
| 270 |
+
\h'-04'\(bu\h'+03'\fBnever\fR: Never display colors.
|
| 271 |
+
.RE
|
| 272 |
+
.sp
|
| 273 |
+
May also be specified with the \fBterm.color\fR
|
| 274 |
+
\fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 275 |
+
.RE
|
| 276 |
+
.sp
|
| 277 |
+
\fB\-\-message\-format\fR \fIfmt\fR
|
| 278 |
+
.RS 4
|
| 279 |
+
The output format for diagnostic messages. Can be specified multiple times
|
| 280 |
+
and consists of comma\-separated values. Valid values:
|
| 281 |
+
.sp
|
| 282 |
+
.RS 4
|
| 283 |
+
\h'-04'\(bu\h'+03'\fBhuman\fR (default): Display in a human\-readable text format. Conflicts with
|
| 284 |
+
\fBshort\fR and \fBjson\fR\&.
|
| 285 |
+
.RE
|
| 286 |
+
.sp
|
| 287 |
+
.RS 4
|
| 288 |
+
\h'-04'\(bu\h'+03'\fBshort\fR: Emit shorter, human\-readable text messages. Conflicts with \fBhuman\fR
|
| 289 |
+
and \fBjson\fR\&.
|
| 290 |
+
.RE
|
| 291 |
+
.sp
|
| 292 |
+
.RS 4
|
| 293 |
+
\h'-04'\(bu\h'+03'\fBjson\fR: Emit JSON messages to stdout. See
|
| 294 |
+
\fIthe reference\fR <https://doc.rust\-lang.org/cargo/reference/external\-tools.html#json\-messages>
|
| 295 |
+
for more details. Conflicts with \fBhuman\fR and \fBshort\fR\&.
|
| 296 |
+
.RE
|
| 297 |
+
.sp
|
| 298 |
+
.RS 4
|
| 299 |
+
\h'-04'\(bu\h'+03'\fBjson\-diagnostic\-short\fR: Ensure the \fBrendered\fR field of JSON messages contains
|
| 300 |
+
the \[lq]short\[rq] rendering from rustc. Cannot be used with \fBhuman\fR or \fBshort\fR\&.
|
| 301 |
+
.RE
|
| 302 |
+
.sp
|
| 303 |
+
.RS 4
|
| 304 |
+
\h'-04'\(bu\h'+03'\fBjson\-diagnostic\-rendered\-ansi\fR: Ensure the \fBrendered\fR field of JSON messages
|
| 305 |
+
contains embedded ANSI color codes for respecting rustc\[cq]s default color
|
| 306 |
+
scheme. Cannot be used with \fBhuman\fR or \fBshort\fR\&.
|
| 307 |
+
.RE
|
| 308 |
+
.sp
|
| 309 |
+
.RS 4
|
| 310 |
+
\h'-04'\(bu\h'+03'\fBjson\-render\-diagnostics\fR: Instruct Cargo to not include rustc diagnostics
|
| 311 |
+
in JSON messages printed, but instead Cargo itself should render the
|
| 312 |
+
JSON diagnostics coming from rustc. Cargo\[cq]s own JSON diagnostics and others
|
| 313 |
+
coming from rustc are still emitted. Cannot be used with \fBhuman\fR or \fBshort\fR\&.
|
| 314 |
+
.RE
|
| 315 |
+
.RE
|
| 316 |
+
.SS "Manifest Options"
|
| 317 |
+
.sp
|
| 318 |
+
\fB\-\-manifest\-path\fR \fIpath\fR
|
| 319 |
+
.RS 4
|
| 320 |
+
Path to the \fBCargo.toml\fR file. By default, Cargo searches for the
|
| 321 |
+
\fBCargo.toml\fR file in the current directory or any parent directory.
|
| 322 |
+
.RE
|
| 323 |
+
.sp
|
| 324 |
+
\fB\-\-ignore\-rust\-version\fR
|
| 325 |
+
.RS 4
|
| 326 |
+
Ignore \fBrust\-version\fR specification in packages.
|
| 327 |
+
.RE
|
| 328 |
+
.sp
|
| 329 |
+
\fB\-\-locked\fR
|
| 330 |
+
.RS 4
|
| 331 |
+
Asserts that the exact same dependencies and versions are used as when the
|
| 332 |
+
existing \fBCargo.lock\fR file was originally generated. Cargo will exit with an
|
| 333 |
+
error when either of the following scenarios arises:
|
| 334 |
+
.sp
|
| 335 |
+
.RS 4
|
| 336 |
+
\h'-04'\(bu\h'+03'The lock file is missing.
|
| 337 |
+
.RE
|
| 338 |
+
.sp
|
| 339 |
+
.RS 4
|
| 340 |
+
\h'-04'\(bu\h'+03'Cargo attempted to change the lock file due to a different dependency resolution.
|
| 341 |
+
.RE
|
| 342 |
+
.sp
|
| 343 |
+
It may be used in environments where deterministic builds are desired,
|
| 344 |
+
such as in CI pipelines.
|
| 345 |
+
.RE
|
| 346 |
+
.sp
|
| 347 |
+
\fB\-\-offline\fR
|
| 348 |
+
.RS 4
|
| 349 |
+
Prevents Cargo from accessing the network for any reason. Without this
|
| 350 |
+
flag, Cargo will stop with an error if it needs to access the network and
|
| 351 |
+
the network is not available. With this flag, Cargo will attempt to
|
| 352 |
+
proceed without the network if possible.
|
| 353 |
+
.sp
|
| 354 |
+
Beware that this may result in different dependency resolution than online
|
| 355 |
+
mode. Cargo will restrict itself to crates that are downloaded locally, even
|
| 356 |
+
if there might be a newer version as indicated in the local copy of the index.
|
| 357 |
+
See the \fBcargo\-fetch\fR(1) command to download dependencies before going
|
| 358 |
+
offline.
|
| 359 |
+
.sp
|
| 360 |
+
May also be specified with the \fBnet.offline\fR \fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 361 |
+
.RE
|
| 362 |
+
.sp
|
| 363 |
+
\fB\-\-frozen\fR
|
| 364 |
+
.RS 4
|
| 365 |
+
Equivalent to specifying both \fB\-\-locked\fR and \fB\-\-offline\fR\&.
|
| 366 |
+
.RE
|
| 367 |
+
.SS "Common Options"
|
| 368 |
+
.sp
|
| 369 |
+
\fB+\fR\fItoolchain\fR
|
| 370 |
+
.RS 4
|
| 371 |
+
If Cargo has been installed with rustup, and the first argument to \fBcargo\fR
|
| 372 |
+
begins with \fB+\fR, it will be interpreted as a rustup toolchain name (such
|
| 373 |
+
as \fB+stable\fR or \fB+nightly\fR).
|
| 374 |
+
See the \fIrustup documentation\fR <https://rust\-lang.github.io/rustup/overrides.html>
|
| 375 |
+
for more information about how toolchain overrides work.
|
| 376 |
+
.RE
|
| 377 |
+
.sp
|
| 378 |
+
\fB\-\-config\fR \fIKEY=VALUE\fR or \fIPATH\fR
|
| 379 |
+
.RS 4
|
| 380 |
+
Overrides a Cargo configuration value. The argument should be in TOML syntax of \fBKEY=VALUE\fR,
|
| 381 |
+
or provided as a path to an extra configuration file. This flag may be specified multiple times.
|
| 382 |
+
See the \fIcommand\-line overrides section\fR <https://doc.rust\-lang.org/cargo/reference/config.html#command\-line\-overrides> for more information.
|
| 383 |
+
.RE
|
| 384 |
+
.sp
|
| 385 |
+
\fB\-C\fR \fIPATH\fR
|
| 386 |
+
.RS 4
|
| 387 |
+
Changes the current working directory before executing any specified operations. This affects
|
| 388 |
+
things like where cargo looks by default for the project manifest (\fBCargo.toml\fR), as well as
|
| 389 |
+
the directories searched for discovering \fB\&.cargo/config.toml\fR, for example. This option must
|
| 390 |
+
appear before the command name, for example \fBcargo \-C path/to/my\-project build\fR\&.
|
| 391 |
+
.sp
|
| 392 |
+
This option is only available on the \fInightly
|
| 393 |
+
channel\fR <https://doc.rust\-lang.org/book/appendix\-07\-nightly\-rust.html> and
|
| 394 |
+
requires the \fB\-Z unstable\-options\fR flag to enable (see
|
| 395 |
+
\fI#10098\fR <https://github.com/rust\-lang/cargo/issues/10098>).
|
| 396 |
+
.RE
|
| 397 |
+
.sp
|
| 398 |
+
\fB\-h\fR,
|
| 399 |
+
\fB\-\-help\fR
|
| 400 |
+
.RS 4
|
| 401 |
+
Prints help information.
|
| 402 |
+
.RE
|
| 403 |
+
.sp
|
| 404 |
+
\fB\-Z\fR \fIflag\fR
|
| 405 |
+
.RS 4
|
| 406 |
+
Unstable (nightly\-only) flags to Cargo. Run \fBcargo \-Z help\fR for details.
|
| 407 |
+
.RE
|
| 408 |
+
.SS "Miscellaneous Options"
|
| 409 |
+
.sp
|
| 410 |
+
\fB\-j\fR \fIN\fR,
|
| 411 |
+
\fB\-\-jobs\fR \fIN\fR
|
| 412 |
+
.RS 4
|
| 413 |
+
Number of parallel jobs to run. May also be specified with the
|
| 414 |
+
\fBbuild.jobs\fR \fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&. Defaults to
|
| 415 |
+
the number of logical CPUs. If negative, it sets the maximum number of
|
| 416 |
+
parallel jobs to the number of logical CPUs plus provided value. If
|
| 417 |
+
a string \fBdefault\fR is provided, it sets the value back to defaults.
|
| 418 |
+
Should not be 0.
|
| 419 |
+
.RE
|
| 420 |
+
.sp
|
| 421 |
+
\fB\-\-keep\-going\fR
|
| 422 |
+
.RS 4
|
| 423 |
+
Build as many crates in the dependency graph as possible, rather than aborting
|
| 424 |
+
the build on the first one that fails to build.
|
| 425 |
+
.sp
|
| 426 |
+
For example if the current package depends on dependencies \fBfails\fR and \fBworks\fR,
|
| 427 |
+
one of which fails to build, \fBcargo build \-j1\fR may or may not build the
|
| 428 |
+
one that succeeds (depending on which one of the two builds Cargo picked to run
|
| 429 |
+
first), whereas \fBcargo build \-j1 \-\-keep\-going\fR would definitely run both
|
| 430 |
+
builds, even if the one run first fails.
|
| 431 |
+
.RE
|
| 432 |
+
.sp
|
| 433 |
+
\fB\-\-future\-incompat\-report\fR
|
| 434 |
+
.RS 4
|
| 435 |
+
Displays a future\-incompat report for any future\-incompatible warnings
|
| 436 |
+
produced during execution of this command
|
| 437 |
+
.sp
|
| 438 |
+
See \fBcargo\-report\fR(1)
|
| 439 |
+
.RE
|
| 440 |
+
.SH "ENVIRONMENT"
|
| 441 |
+
See \fIthe reference\fR <https://doc.rust\-lang.org/cargo/reference/environment\-variables.html> for
|
| 442 |
+
details on environment variables that Cargo reads.
|
| 443 |
+
.SH "EXIT STATUS"
|
| 444 |
+
.sp
|
| 445 |
+
.RS 4
|
| 446 |
+
\h'-04'\(bu\h'+03'\fB0\fR: Cargo succeeded.
|
| 447 |
+
.RE
|
| 448 |
+
.sp
|
| 449 |
+
.RS 4
|
| 450 |
+
\h'-04'\(bu\h'+03'\fB101\fR: Cargo failed to complete.
|
| 451 |
+
.RE
|
| 452 |
+
.SH "EXAMPLES"
|
| 453 |
+
.sp
|
| 454 |
+
.RS 4
|
| 455 |
+
\h'-04' 1.\h'+01'Build the local package and all of its dependencies:
|
| 456 |
+
.sp
|
| 457 |
+
.RS 4
|
| 458 |
+
.nf
|
| 459 |
+
cargo build
|
| 460 |
+
.fi
|
| 461 |
+
.RE
|
| 462 |
+
.RE
|
| 463 |
+
.sp
|
| 464 |
+
.RS 4
|
| 465 |
+
\h'-04' 2.\h'+01'Build with optimizations:
|
| 466 |
+
.sp
|
| 467 |
+
.RS 4
|
| 468 |
+
.nf
|
| 469 |
+
cargo build \-\-release
|
| 470 |
+
.fi
|
| 471 |
+
.RE
|
| 472 |
+
.RE
|
| 473 |
+
.SH "SEE ALSO"
|
| 474 |
+
\fBcargo\fR(1), \fBcargo\-rustc\fR(1)
|
rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-check.1
ADDED
|
@@ -0,0 +1,465 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
'\" t
|
| 2 |
+
.TH "CARGO\-CHECK" "1"
|
| 3 |
+
.nh
|
| 4 |
+
.ad l
|
| 5 |
+
.ss \n[.ss] 0
|
| 6 |
+
.SH "NAME"
|
| 7 |
+
cargo\-check \[em] Check the current package
|
| 8 |
+
.SH "SYNOPSIS"
|
| 9 |
+
\fBcargo check\fR [\fIoptions\fR]
|
| 10 |
+
.SH "DESCRIPTION"
|
| 11 |
+
Check a local package and all of its dependencies for errors. This will
|
| 12 |
+
essentially compile the packages without performing the final step of code
|
| 13 |
+
generation, which is faster than running \fBcargo build\fR\&. The compiler will save
|
| 14 |
+
metadata files to disk so that future runs will reuse them if the source has
|
| 15 |
+
not been modified. Some diagnostics and errors are only emitted during code
|
| 16 |
+
generation, so they inherently won\[cq]t be reported with \fBcargo check\fR\&.
|
| 17 |
+
.SH "OPTIONS"
|
| 18 |
+
.SS "Package Selection"
|
| 19 |
+
By default, when no package selection options are given, the packages selected
|
| 20 |
+
depend on the selected manifest file (based on the current working directory if
|
| 21 |
+
\fB\-\-manifest\-path\fR is not given). If the manifest is the root of a workspace then
|
| 22 |
+
the workspaces default members are selected, otherwise only the package defined
|
| 23 |
+
by the manifest will be selected.
|
| 24 |
+
.sp
|
| 25 |
+
The default members of a workspace can be set explicitly with the
|
| 26 |
+
\fBworkspace.default\-members\fR key in the root manifest. If this is not set, a
|
| 27 |
+
virtual workspace will include all workspace members (equivalent to passing
|
| 28 |
+
\fB\-\-workspace\fR), and a non\-virtual workspace will include only the root crate itself.
|
| 29 |
+
.sp
|
| 30 |
+
\fB\-p\fR \fIspec\fR\[u2026],
|
| 31 |
+
\fB\-\-package\fR \fIspec\fR\[u2026]
|
| 32 |
+
.RS 4
|
| 33 |
+
Check only the specified packages. See \fBcargo\-pkgid\fR(1) for the
|
| 34 |
+
SPEC format. This flag may be specified multiple times and supports common Unix
|
| 35 |
+
glob patterns like \fB*\fR, \fB?\fR and \fB[]\fR\&. However, to avoid your shell accidentally
|
| 36 |
+
expanding glob patterns before Cargo handles them, you must use single quotes or
|
| 37 |
+
double quotes around each pattern.
|
| 38 |
+
.RE
|
| 39 |
+
.sp
|
| 40 |
+
\fB\-\-workspace\fR
|
| 41 |
+
.RS 4
|
| 42 |
+
Check all members in the workspace.
|
| 43 |
+
.RE
|
| 44 |
+
.sp
|
| 45 |
+
\fB\-\-all\fR
|
| 46 |
+
.RS 4
|
| 47 |
+
Deprecated alias for \fB\-\-workspace\fR\&.
|
| 48 |
+
.RE
|
| 49 |
+
.sp
|
| 50 |
+
\fB\-\-exclude\fR \fISPEC\fR\[u2026]
|
| 51 |
+
.RS 4
|
| 52 |
+
Exclude the specified packages. Must be used in conjunction with the
|
| 53 |
+
\fB\-\-workspace\fR flag. This flag may be specified multiple times and supports
|
| 54 |
+
common Unix glob patterns like \fB*\fR, \fB?\fR and \fB[]\fR\&. However, to avoid your shell
|
| 55 |
+
accidentally expanding glob patterns before Cargo handles them, you must use
|
| 56 |
+
single quotes or double quotes around each pattern.
|
| 57 |
+
.RE
|
| 58 |
+
.SS "Target Selection"
|
| 59 |
+
When no target selection options are given, \fBcargo check\fR will check all
|
| 60 |
+
binary and library targets of the selected packages. Binaries are skipped if
|
| 61 |
+
they have \fBrequired\-features\fR that are missing.
|
| 62 |
+
.sp
|
| 63 |
+
Passing target selection flags will check only the specified
|
| 64 |
+
targets.
|
| 65 |
+
.sp
|
| 66 |
+
Note that \fB\-\-bin\fR, \fB\-\-example\fR, \fB\-\-test\fR and \fB\-\-bench\fR flags also
|
| 67 |
+
support common Unix glob patterns like \fB*\fR, \fB?\fR and \fB[]\fR\&. However, to avoid your
|
| 68 |
+
shell accidentally expanding glob patterns before Cargo handles them, you must
|
| 69 |
+
use single quotes or double quotes around each glob pattern.
|
| 70 |
+
.sp
|
| 71 |
+
\fB\-\-lib\fR
|
| 72 |
+
.RS 4
|
| 73 |
+
Check the package\[cq]s library.
|
| 74 |
+
.RE
|
| 75 |
+
.sp
|
| 76 |
+
\fB\-\-bin\fR \fIname\fR\[u2026]
|
| 77 |
+
.RS 4
|
| 78 |
+
Check the specified binary. This flag may be specified multiple times
|
| 79 |
+
and supports common Unix glob patterns.
|
| 80 |
+
.RE
|
| 81 |
+
.sp
|
| 82 |
+
\fB\-\-bins\fR
|
| 83 |
+
.RS 4
|
| 84 |
+
Check all binary targets.
|
| 85 |
+
.RE
|
| 86 |
+
.sp
|
| 87 |
+
\fB\-\-example\fR \fIname\fR\[u2026]
|
| 88 |
+
.RS 4
|
| 89 |
+
Check the specified example. This flag may be specified multiple times
|
| 90 |
+
and supports common Unix glob patterns.
|
| 91 |
+
.RE
|
| 92 |
+
.sp
|
| 93 |
+
\fB\-\-examples\fR
|
| 94 |
+
.RS 4
|
| 95 |
+
Check all example targets.
|
| 96 |
+
.RE
|
| 97 |
+
.sp
|
| 98 |
+
\fB\-\-test\fR \fIname\fR\[u2026]
|
| 99 |
+
.RS 4
|
| 100 |
+
Check the specified integration test. This flag may be specified
|
| 101 |
+
multiple times and supports common Unix glob patterns.
|
| 102 |
+
.RE
|
| 103 |
+
.sp
|
| 104 |
+
\fB\-\-tests\fR
|
| 105 |
+
.RS 4
|
| 106 |
+
Check all targets that have the \fBtest = true\fR manifest
|
| 107 |
+
flag set. By default this includes the library and binaries built as
|
| 108 |
+
unittests, and integration tests. Be aware that this will also build any
|
| 109 |
+
required dependencies, so the lib target may be built twice (once as a
|
| 110 |
+
unittest, and once as a dependency for binaries, integration tests, etc.).
|
| 111 |
+
Targets may be enabled or disabled by setting the \fBtest\fR flag in the
|
| 112 |
+
manifest settings for the target.
|
| 113 |
+
.RE
|
| 114 |
+
.sp
|
| 115 |
+
\fB\-\-bench\fR \fIname\fR\[u2026]
|
| 116 |
+
.RS 4
|
| 117 |
+
Check the specified benchmark. This flag may be specified multiple
|
| 118 |
+
times and supports common Unix glob patterns.
|
| 119 |
+
.RE
|
| 120 |
+
.sp
|
| 121 |
+
\fB\-\-benches\fR
|
| 122 |
+
.RS 4
|
| 123 |
+
Check all targets that have the \fBbench = true\fR
|
| 124 |
+
manifest flag set. By default this includes the library and binaries built
|
| 125 |
+
as benchmarks, and bench targets. Be aware that this will also build any
|
| 126 |
+
required dependencies, so the lib target may be built twice (once as a
|
| 127 |
+
benchmark, and once as a dependency for binaries, benchmarks, etc.).
|
| 128 |
+
Targets may be enabled or disabled by setting the \fBbench\fR flag in the
|
| 129 |
+
manifest settings for the target.
|
| 130 |
+
.RE
|
| 131 |
+
.sp
|
| 132 |
+
\fB\-\-all\-targets\fR
|
| 133 |
+
.RS 4
|
| 134 |
+
Check all targets. This is equivalent to specifying \fB\-\-lib \-\-bins \-\-tests \-\-benches \-\-examples\fR\&.
|
| 135 |
+
.RE
|
| 136 |
+
.SS "Feature Selection"
|
| 137 |
+
The feature flags allow you to control which features are enabled. When no
|
| 138 |
+
feature options are given, the \fBdefault\fR feature is activated for every
|
| 139 |
+
selected package.
|
| 140 |
+
.sp
|
| 141 |
+
See \fIthe features documentation\fR <https://doc.rust\-lang.org/cargo/reference/features.html#command\-line\-feature\-options>
|
| 142 |
+
for more details.
|
| 143 |
+
.sp
|
| 144 |
+
\fB\-F\fR \fIfeatures\fR,
|
| 145 |
+
\fB\-\-features\fR \fIfeatures\fR
|
| 146 |
+
.RS 4
|
| 147 |
+
Space or comma separated list of features to activate. Features of workspace
|
| 148 |
+
members may be enabled with \fBpackage\-name/feature\-name\fR syntax. This flag may
|
| 149 |
+
be specified multiple times, which enables all specified features.
|
| 150 |
+
.RE
|
| 151 |
+
.sp
|
| 152 |
+
\fB\-\-all\-features\fR
|
| 153 |
+
.RS 4
|
| 154 |
+
Activate all available features of all selected packages.
|
| 155 |
+
.RE
|
| 156 |
+
.sp
|
| 157 |
+
\fB\-\-no\-default\-features\fR
|
| 158 |
+
.RS 4
|
| 159 |
+
Do not activate the \fBdefault\fR feature of the selected packages.
|
| 160 |
+
.RE
|
| 161 |
+
.SS "Compilation Options"
|
| 162 |
+
.sp
|
| 163 |
+
\fB\-\-target\fR \fItriple\fR
|
| 164 |
+
.RS 4
|
| 165 |
+
Check for the specified target architecture. Flag may be specified multiple times. The default is the host architecture. The general format of the triple is
|
| 166 |
+
\fB<arch><sub>\-<vendor>\-<sys>\-<abi>\fR\&.
|
| 167 |
+
.sp
|
| 168 |
+
Possible values:
|
| 169 |
+
.sp
|
| 170 |
+
.RS 4
|
| 171 |
+
\h'-04'\(bu\h'+03'Any supported target in \fBrustc \-\-print target\-list\fR\&.
|
| 172 |
+
.RE
|
| 173 |
+
.sp
|
| 174 |
+
.RS 4
|
| 175 |
+
\h'-04'\(bu\h'+03'\fB"host\-tuple"\fR, which will internally be substituted by the host\[cq]s target. This can be particularly useful if you\[cq]re cross\-compiling some crates, and don\[cq]t want to specify your host\[cq]s machine as a target (for instance, an \fBxtask\fR in a shared project that may be worked on by many hosts).
|
| 176 |
+
.RE
|
| 177 |
+
.sp
|
| 178 |
+
.RS 4
|
| 179 |
+
\h'-04'\(bu\h'+03'A path to a custom target specification. See \fICustom Target Lookup Path\fR <https://doc.rust\-lang.org/rustc/targets/custom.html#custom\-target\-lookup\-path> for more information.
|
| 180 |
+
.RE
|
| 181 |
+
.sp
|
| 182 |
+
This may also be specified with the \fBbuild.target\fR \fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 183 |
+
.sp
|
| 184 |
+
Note that specifying this flag makes Cargo run in a different mode where the
|
| 185 |
+
target artifacts are placed in a separate directory. See the
|
| 186 |
+
\fIbuild cache\fR <https://doc.rust\-lang.org/cargo/reference/build\-cache.html> documentation for more details.
|
| 187 |
+
.RE
|
| 188 |
+
.sp
|
| 189 |
+
\fB\-r\fR,
|
| 190 |
+
\fB\-\-release\fR
|
| 191 |
+
.RS 4
|
| 192 |
+
Check optimized artifacts with the \fBrelease\fR profile.
|
| 193 |
+
See also the \fB\-\-profile\fR option for choosing a specific profile by name.
|
| 194 |
+
.RE
|
| 195 |
+
.sp
|
| 196 |
+
\fB\-\-profile\fR \fIname\fR
|
| 197 |
+
.RS 4
|
| 198 |
+
Check with the given profile.
|
| 199 |
+
.sp
|
| 200 |
+
As a special case, specifying the \fBtest\fR profile will also enable checking in
|
| 201 |
+
test mode which will enable checking tests and enable the \fBtest\fR cfg option.
|
| 202 |
+
See \fIrustc tests\fR <https://doc.rust\-lang.org/rustc/tests/index.html> for more
|
| 203 |
+
detail.
|
| 204 |
+
.sp
|
| 205 |
+
See \fIthe reference\fR <https://doc.rust\-lang.org/cargo/reference/profiles.html> for more details on profiles.
|
| 206 |
+
.RE
|
| 207 |
+
.sp
|
| 208 |
+
\fB\-\-timings\fR
|
| 209 |
+
.RS 4
|
| 210 |
+
Output information how long each compilation takes, and track concurrency
|
| 211 |
+
information over time.
|
| 212 |
+
.sp
|
| 213 |
+
A file \fBcargo\-timing.html\fR will be written to the \fBtarget/cargo\-timings\fR
|
| 214 |
+
directory at the end of the build. An additional report with a timestamp
|
| 215 |
+
in its filename is also written if you want to look at a previous run.
|
| 216 |
+
These reports are suitable for human consumption only, and do not provide
|
| 217 |
+
machine\-readable timing data.
|
| 218 |
+
.RE
|
| 219 |
+
.SS "Output Options"
|
| 220 |
+
.sp
|
| 221 |
+
\fB\-\-target\-dir\fR \fIdirectory\fR
|
| 222 |
+
.RS 4
|
| 223 |
+
Directory for all generated artifacts and intermediate files. May also be
|
| 224 |
+
specified with the \fBCARGO_TARGET_DIR\fR environment variable, or the
|
| 225 |
+
\fBbuild.target\-dir\fR \fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 226 |
+
Defaults to \fBtarget\fR in the root of the workspace.
|
| 227 |
+
.RE
|
| 228 |
+
.SS "Display Options"
|
| 229 |
+
.sp
|
| 230 |
+
\fB\-v\fR,
|
| 231 |
+
\fB\-\-verbose\fR
|
| 232 |
+
.RS 4
|
| 233 |
+
Use verbose output. May be specified twice for \[lq]very verbose\[rq] output which
|
| 234 |
+
includes extra output such as dependency warnings and build script output.
|
| 235 |
+
May also be specified with the \fBterm.verbose\fR
|
| 236 |
+
\fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 237 |
+
.RE
|
| 238 |
+
.sp
|
| 239 |
+
\fB\-q\fR,
|
| 240 |
+
\fB\-\-quiet\fR
|
| 241 |
+
.RS 4
|
| 242 |
+
Do not print cargo log messages.
|
| 243 |
+
May also be specified with the \fBterm.quiet\fR
|
| 244 |
+
\fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 245 |
+
.RE
|
| 246 |
+
.sp
|
| 247 |
+
\fB\-\-color\fR \fIwhen\fR
|
| 248 |
+
.RS 4
|
| 249 |
+
Control when colored output is used. Valid values:
|
| 250 |
+
.sp
|
| 251 |
+
.RS 4
|
| 252 |
+
\h'-04'\(bu\h'+03'\fBauto\fR (default): Automatically detect if color support is available on the
|
| 253 |
+
terminal.
|
| 254 |
+
.RE
|
| 255 |
+
.sp
|
| 256 |
+
.RS 4
|
| 257 |
+
\h'-04'\(bu\h'+03'\fBalways\fR: Always display colors.
|
| 258 |
+
.RE
|
| 259 |
+
.sp
|
| 260 |
+
.RS 4
|
| 261 |
+
\h'-04'\(bu\h'+03'\fBnever\fR: Never display colors.
|
| 262 |
+
.RE
|
| 263 |
+
.sp
|
| 264 |
+
May also be specified with the \fBterm.color\fR
|
| 265 |
+
\fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 266 |
+
.RE
|
| 267 |
+
.sp
|
| 268 |
+
\fB\-\-message\-format\fR \fIfmt\fR
|
| 269 |
+
.RS 4
|
| 270 |
+
The output format for diagnostic messages. Can be specified multiple times
|
| 271 |
+
and consists of comma\-separated values. Valid values:
|
| 272 |
+
.sp
|
| 273 |
+
.RS 4
|
| 274 |
+
\h'-04'\(bu\h'+03'\fBhuman\fR (default): Display in a human\-readable text format. Conflicts with
|
| 275 |
+
\fBshort\fR and \fBjson\fR\&.
|
| 276 |
+
.RE
|
| 277 |
+
.sp
|
| 278 |
+
.RS 4
|
| 279 |
+
\h'-04'\(bu\h'+03'\fBshort\fR: Emit shorter, human\-readable text messages. Conflicts with \fBhuman\fR
|
| 280 |
+
and \fBjson\fR\&.
|
| 281 |
+
.RE
|
| 282 |
+
.sp
|
| 283 |
+
.RS 4
|
| 284 |
+
\h'-04'\(bu\h'+03'\fBjson\fR: Emit JSON messages to stdout. See
|
| 285 |
+
\fIthe reference\fR <https://doc.rust\-lang.org/cargo/reference/external\-tools.html#json\-messages>
|
| 286 |
+
for more details. Conflicts with \fBhuman\fR and \fBshort\fR\&.
|
| 287 |
+
.RE
|
| 288 |
+
.sp
|
| 289 |
+
.RS 4
|
| 290 |
+
\h'-04'\(bu\h'+03'\fBjson\-diagnostic\-short\fR: Ensure the \fBrendered\fR field of JSON messages contains
|
| 291 |
+
the \[lq]short\[rq] rendering from rustc. Cannot be used with \fBhuman\fR or \fBshort\fR\&.
|
| 292 |
+
.RE
|
| 293 |
+
.sp
|
| 294 |
+
.RS 4
|
| 295 |
+
\h'-04'\(bu\h'+03'\fBjson\-diagnostic\-rendered\-ansi\fR: Ensure the \fBrendered\fR field of JSON messages
|
| 296 |
+
contains embedded ANSI color codes for respecting rustc\[cq]s default color
|
| 297 |
+
scheme. Cannot be used with \fBhuman\fR or \fBshort\fR\&.
|
| 298 |
+
.RE
|
| 299 |
+
.sp
|
| 300 |
+
.RS 4
|
| 301 |
+
\h'-04'\(bu\h'+03'\fBjson\-render\-diagnostics\fR: Instruct Cargo to not include rustc diagnostics
|
| 302 |
+
in JSON messages printed, but instead Cargo itself should render the
|
| 303 |
+
JSON diagnostics coming from rustc. Cargo\[cq]s own JSON diagnostics and others
|
| 304 |
+
coming from rustc are still emitted. Cannot be used with \fBhuman\fR or \fBshort\fR\&.
|
| 305 |
+
.RE
|
| 306 |
+
.RE
|
| 307 |
+
.SS "Manifest Options"
|
| 308 |
+
.sp
|
| 309 |
+
\fB\-\-manifest\-path\fR \fIpath\fR
|
| 310 |
+
.RS 4
|
| 311 |
+
Path to the \fBCargo.toml\fR file. By default, Cargo searches for the
|
| 312 |
+
\fBCargo.toml\fR file in the current directory or any parent directory.
|
| 313 |
+
.RE
|
| 314 |
+
.sp
|
| 315 |
+
\fB\-\-ignore\-rust\-version\fR
|
| 316 |
+
.RS 4
|
| 317 |
+
Ignore \fBrust\-version\fR specification in packages.
|
| 318 |
+
.RE
|
| 319 |
+
.sp
|
| 320 |
+
\fB\-\-locked\fR
|
| 321 |
+
.RS 4
|
| 322 |
+
Asserts that the exact same dependencies and versions are used as when the
|
| 323 |
+
existing \fBCargo.lock\fR file was originally generated. Cargo will exit with an
|
| 324 |
+
error when either of the following scenarios arises:
|
| 325 |
+
.sp
|
| 326 |
+
.RS 4
|
| 327 |
+
\h'-04'\(bu\h'+03'The lock file is missing.
|
| 328 |
+
.RE
|
| 329 |
+
.sp
|
| 330 |
+
.RS 4
|
| 331 |
+
\h'-04'\(bu\h'+03'Cargo attempted to change the lock file due to a different dependency resolution.
|
| 332 |
+
.RE
|
| 333 |
+
.sp
|
| 334 |
+
It may be used in environments where deterministic builds are desired,
|
| 335 |
+
such as in CI pipelines.
|
| 336 |
+
.RE
|
| 337 |
+
.sp
|
| 338 |
+
\fB\-\-offline\fR
|
| 339 |
+
.RS 4
|
| 340 |
+
Prevents Cargo from accessing the network for any reason. Without this
|
| 341 |
+
flag, Cargo will stop with an error if it needs to access the network and
|
| 342 |
+
the network is not available. With this flag, Cargo will attempt to
|
| 343 |
+
proceed without the network if possible.
|
| 344 |
+
.sp
|
| 345 |
+
Beware that this may result in different dependency resolution than online
|
| 346 |
+
mode. Cargo will restrict itself to crates that are downloaded locally, even
|
| 347 |
+
if there might be a newer version as indicated in the local copy of the index.
|
| 348 |
+
See the \fBcargo\-fetch\fR(1) command to download dependencies before going
|
| 349 |
+
offline.
|
| 350 |
+
.sp
|
| 351 |
+
May also be specified with the \fBnet.offline\fR \fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 352 |
+
.RE
|
| 353 |
+
.sp
|
| 354 |
+
\fB\-\-frozen\fR
|
| 355 |
+
.RS 4
|
| 356 |
+
Equivalent to specifying both \fB\-\-locked\fR and \fB\-\-offline\fR\&.
|
| 357 |
+
.RE
|
| 358 |
+
.SS "Common Options"
|
| 359 |
+
.sp
|
| 360 |
+
\fB+\fR\fItoolchain\fR
|
| 361 |
+
.RS 4
|
| 362 |
+
If Cargo has been installed with rustup, and the first argument to \fBcargo\fR
|
| 363 |
+
begins with \fB+\fR, it will be interpreted as a rustup toolchain name (such
|
| 364 |
+
as \fB+stable\fR or \fB+nightly\fR).
|
| 365 |
+
See the \fIrustup documentation\fR <https://rust\-lang.github.io/rustup/overrides.html>
|
| 366 |
+
for more information about how toolchain overrides work.
|
| 367 |
+
.RE
|
| 368 |
+
.sp
|
| 369 |
+
\fB\-\-config\fR \fIKEY=VALUE\fR or \fIPATH\fR
|
| 370 |
+
.RS 4
|
| 371 |
+
Overrides a Cargo configuration value. The argument should be in TOML syntax of \fBKEY=VALUE\fR,
|
| 372 |
+
or provided as a path to an extra configuration file. This flag may be specified multiple times.
|
| 373 |
+
See the \fIcommand\-line overrides section\fR <https://doc.rust\-lang.org/cargo/reference/config.html#command\-line\-overrides> for more information.
|
| 374 |
+
.RE
|
| 375 |
+
.sp
|
| 376 |
+
\fB\-C\fR \fIPATH\fR
|
| 377 |
+
.RS 4
|
| 378 |
+
Changes the current working directory before executing any specified operations. This affects
|
| 379 |
+
things like where cargo looks by default for the project manifest (\fBCargo.toml\fR), as well as
|
| 380 |
+
the directories searched for discovering \fB\&.cargo/config.toml\fR, for example. This option must
|
| 381 |
+
appear before the command name, for example \fBcargo \-C path/to/my\-project build\fR\&.
|
| 382 |
+
.sp
|
| 383 |
+
This option is only available on the \fInightly
|
| 384 |
+
channel\fR <https://doc.rust\-lang.org/book/appendix\-07\-nightly\-rust.html> and
|
| 385 |
+
requires the \fB\-Z unstable\-options\fR flag to enable (see
|
| 386 |
+
\fI#10098\fR <https://github.com/rust\-lang/cargo/issues/10098>).
|
| 387 |
+
.RE
|
| 388 |
+
.sp
|
| 389 |
+
\fB\-h\fR,
|
| 390 |
+
\fB\-\-help\fR
|
| 391 |
+
.RS 4
|
| 392 |
+
Prints help information.
|
| 393 |
+
.RE
|
| 394 |
+
.sp
|
| 395 |
+
\fB\-Z\fR \fIflag\fR
|
| 396 |
+
.RS 4
|
| 397 |
+
Unstable (nightly\-only) flags to Cargo. Run \fBcargo \-Z help\fR for details.
|
| 398 |
+
.RE
|
| 399 |
+
.SS "Miscellaneous Options"
|
| 400 |
+
.sp
|
| 401 |
+
\fB\-j\fR \fIN\fR,
|
| 402 |
+
\fB\-\-jobs\fR \fIN\fR
|
| 403 |
+
.RS 4
|
| 404 |
+
Number of parallel jobs to run. May also be specified with the
|
| 405 |
+
\fBbuild.jobs\fR \fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&. Defaults to
|
| 406 |
+
the number of logical CPUs. If negative, it sets the maximum number of
|
| 407 |
+
parallel jobs to the number of logical CPUs plus provided value. If
|
| 408 |
+
a string \fBdefault\fR is provided, it sets the value back to defaults.
|
| 409 |
+
Should not be 0.
|
| 410 |
+
.RE
|
| 411 |
+
.sp
|
| 412 |
+
\fB\-\-keep\-going\fR
|
| 413 |
+
.RS 4
|
| 414 |
+
Build as many crates in the dependency graph as possible, rather than aborting
|
| 415 |
+
the build on the first one that fails to build.
|
| 416 |
+
.sp
|
| 417 |
+
For example if the current package depends on dependencies \fBfails\fR and \fBworks\fR,
|
| 418 |
+
one of which fails to build, \fBcargo check \-j1\fR may or may not build the
|
| 419 |
+
one that succeeds (depending on which one of the two builds Cargo picked to run
|
| 420 |
+
first), whereas \fBcargo check \-j1 \-\-keep\-going\fR would definitely run both
|
| 421 |
+
builds, even if the one run first fails.
|
| 422 |
+
.RE
|
| 423 |
+
.sp
|
| 424 |
+
\fB\-\-future\-incompat\-report\fR
|
| 425 |
+
.RS 4
|
| 426 |
+
Displays a future\-incompat report for any future\-incompatible warnings
|
| 427 |
+
produced during execution of this command
|
| 428 |
+
.sp
|
| 429 |
+
See \fBcargo\-report\fR(1)
|
| 430 |
+
.RE
|
| 431 |
+
.SH "ENVIRONMENT"
|
| 432 |
+
See \fIthe reference\fR <https://doc.rust\-lang.org/cargo/reference/environment\-variables.html> for
|
| 433 |
+
details on environment variables that Cargo reads.
|
| 434 |
+
.SH "EXIT STATUS"
|
| 435 |
+
.sp
|
| 436 |
+
.RS 4
|
| 437 |
+
\h'-04'\(bu\h'+03'\fB0\fR: Cargo succeeded.
|
| 438 |
+
.RE
|
| 439 |
+
.sp
|
| 440 |
+
.RS 4
|
| 441 |
+
\h'-04'\(bu\h'+03'\fB101\fR: Cargo failed to complete.
|
| 442 |
+
.RE
|
| 443 |
+
.SH "EXAMPLES"
|
| 444 |
+
.sp
|
| 445 |
+
.RS 4
|
| 446 |
+
\h'-04' 1.\h'+01'Check the local package for errors:
|
| 447 |
+
.sp
|
| 448 |
+
.RS 4
|
| 449 |
+
.nf
|
| 450 |
+
cargo check
|
| 451 |
+
.fi
|
| 452 |
+
.RE
|
| 453 |
+
.RE
|
| 454 |
+
.sp
|
| 455 |
+
.RS 4
|
| 456 |
+
\h'-04' 2.\h'+01'Check all targets, including unit tests:
|
| 457 |
+
.sp
|
| 458 |
+
.RS 4
|
| 459 |
+
.nf
|
| 460 |
+
cargo check \-\-all\-targets \-\-profile=test
|
| 461 |
+
.fi
|
| 462 |
+
.RE
|
| 463 |
+
.RE
|
| 464 |
+
.SH "SEE ALSO"
|
| 465 |
+
\fBcargo\fR(1), \fBcargo\-build\fR(1)
|
rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-clean.1
ADDED
|
@@ -0,0 +1,248 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
'\" t
|
| 2 |
+
.TH "CARGO\-CLEAN" "1"
|
| 3 |
+
.nh
|
| 4 |
+
.ad l
|
| 5 |
+
.ss \n[.ss] 0
|
| 6 |
+
.SH "NAME"
|
| 7 |
+
cargo\-clean \[em] Remove generated artifacts
|
| 8 |
+
.SH "SYNOPSIS"
|
| 9 |
+
\fBcargo clean\fR [\fIoptions\fR]
|
| 10 |
+
.SH "DESCRIPTION"
|
| 11 |
+
Remove artifacts from the target directory that Cargo has generated in the
|
| 12 |
+
past.
|
| 13 |
+
.sp
|
| 14 |
+
With no options, \fBcargo clean\fR will delete the entire target directory.
|
| 15 |
+
.SH "OPTIONS"
|
| 16 |
+
.SS "Package Selection"
|
| 17 |
+
When no packages are selected, all packages and all dependencies in the
|
| 18 |
+
workspace are cleaned.
|
| 19 |
+
.sp
|
| 20 |
+
\fB\-p\fR \fIspec\fR\[u2026],
|
| 21 |
+
\fB\-\-package\fR \fIspec\fR\[u2026]
|
| 22 |
+
.RS 4
|
| 23 |
+
Clean only the specified packages. This flag may be specified
|
| 24 |
+
multiple times. See \fBcargo\-pkgid\fR(1) for the SPEC format.
|
| 25 |
+
.RE
|
| 26 |
+
.sp
|
| 27 |
+
\fB\-\-workspace\fR
|
| 28 |
+
.RS 4
|
| 29 |
+
Clean artifacts of the workspace members.
|
| 30 |
+
.RE
|
| 31 |
+
.SS "Clean Options"
|
| 32 |
+
.sp
|
| 33 |
+
\fB\-\-dry\-run\fR
|
| 34 |
+
.RS 4
|
| 35 |
+
Displays a summary of what would be deleted without deleting anything.
|
| 36 |
+
Use with \fB\-\-verbose\fR to display the actual files that would be deleted.
|
| 37 |
+
.RE
|
| 38 |
+
.sp
|
| 39 |
+
\fB\-\-doc\fR
|
| 40 |
+
.RS 4
|
| 41 |
+
This option will cause \fBcargo clean\fR to remove only the \fBdoc\fR directory in
|
| 42 |
+
the target directory.
|
| 43 |
+
.RE
|
| 44 |
+
.sp
|
| 45 |
+
\fB\-\-release\fR
|
| 46 |
+
.RS 4
|
| 47 |
+
Remove all artifacts in the \fBrelease\fR directory.
|
| 48 |
+
.RE
|
| 49 |
+
.sp
|
| 50 |
+
\fB\-\-profile\fR \fIname\fR
|
| 51 |
+
.RS 4
|
| 52 |
+
Remove all artifacts in the directory with the given profile name.
|
| 53 |
+
.RE
|
| 54 |
+
.sp
|
| 55 |
+
\fB\-\-target\-dir\fR \fIdirectory\fR
|
| 56 |
+
.RS 4
|
| 57 |
+
Directory for all generated artifacts and intermediate files. May also be
|
| 58 |
+
specified with the \fBCARGO_TARGET_DIR\fR environment variable, or the
|
| 59 |
+
\fBbuild.target\-dir\fR \fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 60 |
+
Defaults to \fBtarget\fR in the root of the workspace.
|
| 61 |
+
.RE
|
| 62 |
+
.sp
|
| 63 |
+
\fB\-\-target\fR \fItriple\fR
|
| 64 |
+
.RS 4
|
| 65 |
+
Clean for the specified target architecture. Flag may be specified multiple times. The default is the host architecture. The general format of the triple is
|
| 66 |
+
\fB<arch><sub>\-<vendor>\-<sys>\-<abi>\fR\&.
|
| 67 |
+
.sp
|
| 68 |
+
Possible values:
|
| 69 |
+
.sp
|
| 70 |
+
.RS 4
|
| 71 |
+
\h'-04'\(bu\h'+03'Any supported target in \fBrustc \-\-print target\-list\fR\&.
|
| 72 |
+
.RE
|
| 73 |
+
.sp
|
| 74 |
+
.RS 4
|
| 75 |
+
\h'-04'\(bu\h'+03'\fB"host\-tuple"\fR, which will internally be substituted by the host\[cq]s target. This can be particularly useful if you\[cq]re cross\-compiling some crates, and don\[cq]t want to specify your host\[cq]s machine as a target (for instance, an \fBxtask\fR in a shared project that may be worked on by many hosts).
|
| 76 |
+
.RE
|
| 77 |
+
.sp
|
| 78 |
+
.RS 4
|
| 79 |
+
\h'-04'\(bu\h'+03'A path to a custom target specification. See \fICustom Target Lookup Path\fR <https://doc.rust\-lang.org/rustc/targets/custom.html#custom\-target\-lookup\-path> for more information.
|
| 80 |
+
.RE
|
| 81 |
+
.sp
|
| 82 |
+
This may also be specified with the \fBbuild.target\fR \fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 83 |
+
.sp
|
| 84 |
+
Note that specifying this flag makes Cargo run in a different mode where the
|
| 85 |
+
target artifacts are placed in a separate directory. See the
|
| 86 |
+
\fIbuild cache\fR <https://doc.rust\-lang.org/cargo/reference/build\-cache.html> documentation for more details.
|
| 87 |
+
.RE
|
| 88 |
+
.SS "Display Options"
|
| 89 |
+
.sp
|
| 90 |
+
\fB\-v\fR,
|
| 91 |
+
\fB\-\-verbose\fR
|
| 92 |
+
.RS 4
|
| 93 |
+
Use verbose output. May be specified twice for \[lq]very verbose\[rq] output which
|
| 94 |
+
includes extra output such as dependency warnings and build script output.
|
| 95 |
+
May also be specified with the \fBterm.verbose\fR
|
| 96 |
+
\fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 97 |
+
.RE
|
| 98 |
+
.sp
|
| 99 |
+
\fB\-q\fR,
|
| 100 |
+
\fB\-\-quiet\fR
|
| 101 |
+
.RS 4
|
| 102 |
+
Do not print cargo log messages.
|
| 103 |
+
May also be specified with the \fBterm.quiet\fR
|
| 104 |
+
\fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 105 |
+
.RE
|
| 106 |
+
.sp
|
| 107 |
+
\fB\-\-color\fR \fIwhen\fR
|
| 108 |
+
.RS 4
|
| 109 |
+
Control when colored output is used. Valid values:
|
| 110 |
+
.sp
|
| 111 |
+
.RS 4
|
| 112 |
+
\h'-04'\(bu\h'+03'\fBauto\fR (default): Automatically detect if color support is available on the
|
| 113 |
+
terminal.
|
| 114 |
+
.RE
|
| 115 |
+
.sp
|
| 116 |
+
.RS 4
|
| 117 |
+
\h'-04'\(bu\h'+03'\fBalways\fR: Always display colors.
|
| 118 |
+
.RE
|
| 119 |
+
.sp
|
| 120 |
+
.RS 4
|
| 121 |
+
\h'-04'\(bu\h'+03'\fBnever\fR: Never display colors.
|
| 122 |
+
.RE
|
| 123 |
+
.sp
|
| 124 |
+
May also be specified with the \fBterm.color\fR
|
| 125 |
+
\fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 126 |
+
.RE
|
| 127 |
+
.SS "Manifest Options"
|
| 128 |
+
.sp
|
| 129 |
+
\fB\-\-manifest\-path\fR \fIpath\fR
|
| 130 |
+
.RS 4
|
| 131 |
+
Path to the \fBCargo.toml\fR file. By default, Cargo searches for the
|
| 132 |
+
\fBCargo.toml\fR file in the current directory or any parent directory.
|
| 133 |
+
.RE
|
| 134 |
+
.sp
|
| 135 |
+
\fB\-\-locked\fR
|
| 136 |
+
.RS 4
|
| 137 |
+
Asserts that the exact same dependencies and versions are used as when the
|
| 138 |
+
existing \fBCargo.lock\fR file was originally generated. Cargo will exit with an
|
| 139 |
+
error when either of the following scenarios arises:
|
| 140 |
+
.sp
|
| 141 |
+
.RS 4
|
| 142 |
+
\h'-04'\(bu\h'+03'The lock file is missing.
|
| 143 |
+
.RE
|
| 144 |
+
.sp
|
| 145 |
+
.RS 4
|
| 146 |
+
\h'-04'\(bu\h'+03'Cargo attempted to change the lock file due to a different dependency resolution.
|
| 147 |
+
.RE
|
| 148 |
+
.sp
|
| 149 |
+
It may be used in environments where deterministic builds are desired,
|
| 150 |
+
such as in CI pipelines.
|
| 151 |
+
.RE
|
| 152 |
+
.sp
|
| 153 |
+
\fB\-\-offline\fR
|
| 154 |
+
.RS 4
|
| 155 |
+
Prevents Cargo from accessing the network for any reason. Without this
|
| 156 |
+
flag, Cargo will stop with an error if it needs to access the network and
|
| 157 |
+
the network is not available. With this flag, Cargo will attempt to
|
| 158 |
+
proceed without the network if possible.
|
| 159 |
+
.sp
|
| 160 |
+
Beware that this may result in different dependency resolution than online
|
| 161 |
+
mode. Cargo will restrict itself to crates that are downloaded locally, even
|
| 162 |
+
if there might be a newer version as indicated in the local copy of the index.
|
| 163 |
+
See the \fBcargo\-fetch\fR(1) command to download dependencies before going
|
| 164 |
+
offline.
|
| 165 |
+
.sp
|
| 166 |
+
May also be specified with the \fBnet.offline\fR \fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 167 |
+
.RE
|
| 168 |
+
.sp
|
| 169 |
+
\fB\-\-frozen\fR
|
| 170 |
+
.RS 4
|
| 171 |
+
Equivalent to specifying both \fB\-\-locked\fR and \fB\-\-offline\fR\&.
|
| 172 |
+
.RE
|
| 173 |
+
.SS "Common Options"
|
| 174 |
+
.sp
|
| 175 |
+
\fB+\fR\fItoolchain\fR
|
| 176 |
+
.RS 4
|
| 177 |
+
If Cargo has been installed with rustup, and the first argument to \fBcargo\fR
|
| 178 |
+
begins with \fB+\fR, it will be interpreted as a rustup toolchain name (such
|
| 179 |
+
as \fB+stable\fR or \fB+nightly\fR).
|
| 180 |
+
See the \fIrustup documentation\fR <https://rust\-lang.github.io/rustup/overrides.html>
|
| 181 |
+
for more information about how toolchain overrides work.
|
| 182 |
+
.RE
|
| 183 |
+
.sp
|
| 184 |
+
\fB\-\-config\fR \fIKEY=VALUE\fR or \fIPATH\fR
|
| 185 |
+
.RS 4
|
| 186 |
+
Overrides a Cargo configuration value. The argument should be in TOML syntax of \fBKEY=VALUE\fR,
|
| 187 |
+
or provided as a path to an extra configuration file. This flag may be specified multiple times.
|
| 188 |
+
See the \fIcommand\-line overrides section\fR <https://doc.rust\-lang.org/cargo/reference/config.html#command\-line\-overrides> for more information.
|
| 189 |
+
.RE
|
| 190 |
+
.sp
|
| 191 |
+
\fB\-C\fR \fIPATH\fR
|
| 192 |
+
.RS 4
|
| 193 |
+
Changes the current working directory before executing any specified operations. This affects
|
| 194 |
+
things like where cargo looks by default for the project manifest (\fBCargo.toml\fR), as well as
|
| 195 |
+
the directories searched for discovering \fB\&.cargo/config.toml\fR, for example. This option must
|
| 196 |
+
appear before the command name, for example \fBcargo \-C path/to/my\-project build\fR\&.
|
| 197 |
+
.sp
|
| 198 |
+
This option is only available on the \fInightly
|
| 199 |
+
channel\fR <https://doc.rust\-lang.org/book/appendix\-07\-nightly\-rust.html> and
|
| 200 |
+
requires the \fB\-Z unstable\-options\fR flag to enable (see
|
| 201 |
+
\fI#10098\fR <https://github.com/rust\-lang/cargo/issues/10098>).
|
| 202 |
+
.RE
|
| 203 |
+
.sp
|
| 204 |
+
\fB\-h\fR,
|
| 205 |
+
\fB\-\-help\fR
|
| 206 |
+
.RS 4
|
| 207 |
+
Prints help information.
|
| 208 |
+
.RE
|
| 209 |
+
.sp
|
| 210 |
+
\fB\-Z\fR \fIflag\fR
|
| 211 |
+
.RS 4
|
| 212 |
+
Unstable (nightly\-only) flags to Cargo. Run \fBcargo \-Z help\fR for details.
|
| 213 |
+
.RE
|
| 214 |
+
.SH "ENVIRONMENT"
|
| 215 |
+
See \fIthe reference\fR <https://doc.rust\-lang.org/cargo/reference/environment\-variables.html> for
|
| 216 |
+
details on environment variables that Cargo reads.
|
| 217 |
+
.SH "EXIT STATUS"
|
| 218 |
+
.sp
|
| 219 |
+
.RS 4
|
| 220 |
+
\h'-04'\(bu\h'+03'\fB0\fR: Cargo succeeded.
|
| 221 |
+
.RE
|
| 222 |
+
.sp
|
| 223 |
+
.RS 4
|
| 224 |
+
\h'-04'\(bu\h'+03'\fB101\fR: Cargo failed to complete.
|
| 225 |
+
.RE
|
| 226 |
+
.SH "EXAMPLES"
|
| 227 |
+
.sp
|
| 228 |
+
.RS 4
|
| 229 |
+
\h'-04' 1.\h'+01'Remove the entire target directory:
|
| 230 |
+
.sp
|
| 231 |
+
.RS 4
|
| 232 |
+
.nf
|
| 233 |
+
cargo clean
|
| 234 |
+
.fi
|
| 235 |
+
.RE
|
| 236 |
+
.RE
|
| 237 |
+
.sp
|
| 238 |
+
.RS 4
|
| 239 |
+
\h'-04' 2.\h'+01'Remove only the release artifacts:
|
| 240 |
+
.sp
|
| 241 |
+
.RS 4
|
| 242 |
+
.nf
|
| 243 |
+
cargo clean \-\-release
|
| 244 |
+
.fi
|
| 245 |
+
.RE
|
| 246 |
+
.RE
|
| 247 |
+
.SH "SEE ALSO"
|
| 248 |
+
\fBcargo\fR(1), \fBcargo\-build\fR(1)
|
rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-doc.1
ADDED
|
@@ -0,0 +1,417 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
'\" t
|
| 2 |
+
.TH "CARGO\-DOC" "1"
|
| 3 |
+
.nh
|
| 4 |
+
.ad l
|
| 5 |
+
.ss \n[.ss] 0
|
| 6 |
+
.SH "NAME"
|
| 7 |
+
cargo\-doc \[em] Build a package\[cq]s documentation
|
| 8 |
+
.SH "SYNOPSIS"
|
| 9 |
+
\fBcargo doc\fR [\fIoptions\fR]
|
| 10 |
+
.SH "DESCRIPTION"
|
| 11 |
+
Build the documentation for the local package and all dependencies. The output
|
| 12 |
+
is placed in \fBtarget/doc\fR in rustdoc\[cq]s usual format.
|
| 13 |
+
.sp
|
| 14 |
+
\fBNote:\fR Documentation generation is cumulative: existing doc files in the target directory are preserved across different \fBcargo doc\fR invocations. To remove existing generated docs, pass \fB\-\-doc\fR to \fBcargo\-clean\fR(1).
|
| 15 |
+
.SH "OPTIONS"
|
| 16 |
+
.SS "Documentation Options"
|
| 17 |
+
.sp
|
| 18 |
+
\fB\-\-open\fR
|
| 19 |
+
.RS 4
|
| 20 |
+
Open the docs in a browser after building them. This will use your default
|
| 21 |
+
browser unless you define another one in the \fBBROWSER\fR environment variable
|
| 22 |
+
or use the \fI\f(BIdoc.browser\fI\fR <https://doc.rust\-lang.org/cargo/reference/config.html#docbrowser> configuration
|
| 23 |
+
option.
|
| 24 |
+
.RE
|
| 25 |
+
.sp
|
| 26 |
+
\fB\-\-no\-deps\fR
|
| 27 |
+
.RS 4
|
| 28 |
+
Do not build documentation for dependencies.
|
| 29 |
+
.RE
|
| 30 |
+
.sp
|
| 31 |
+
\fB\-\-document\-private\-items\fR
|
| 32 |
+
.RS 4
|
| 33 |
+
Include non\-public items in the documentation. This will be enabled by default if documenting a binary target.
|
| 34 |
+
.RE
|
| 35 |
+
.SS "Package Selection"
|
| 36 |
+
By default, when no package selection options are given, the packages selected
|
| 37 |
+
depend on the selected manifest file (based on the current working directory if
|
| 38 |
+
\fB\-\-manifest\-path\fR is not given). If the manifest is the root of a workspace then
|
| 39 |
+
the workspaces default members are selected, otherwise only the package defined
|
| 40 |
+
by the manifest will be selected.
|
| 41 |
+
.sp
|
| 42 |
+
The default members of a workspace can be set explicitly with the
|
| 43 |
+
\fBworkspace.default\-members\fR key in the root manifest. If this is not set, a
|
| 44 |
+
virtual workspace will include all workspace members (equivalent to passing
|
| 45 |
+
\fB\-\-workspace\fR), and a non\-virtual workspace will include only the root crate itself.
|
| 46 |
+
.sp
|
| 47 |
+
\fB\-p\fR \fIspec\fR\[u2026],
|
| 48 |
+
\fB\-\-package\fR \fIspec\fR\[u2026]
|
| 49 |
+
.RS 4
|
| 50 |
+
Document only the specified packages. See \fBcargo\-pkgid\fR(1) for the
|
| 51 |
+
SPEC format. This flag may be specified multiple times and supports common Unix
|
| 52 |
+
glob patterns like \fB*\fR, \fB?\fR and \fB[]\fR\&. However, to avoid your shell accidentally
|
| 53 |
+
expanding glob patterns before Cargo handles them, you must use single quotes or
|
| 54 |
+
double quotes around each pattern.
|
| 55 |
+
.RE
|
| 56 |
+
.sp
|
| 57 |
+
\fB\-\-workspace\fR
|
| 58 |
+
.RS 4
|
| 59 |
+
Document all members in the workspace.
|
| 60 |
+
.RE
|
| 61 |
+
.sp
|
| 62 |
+
\fB\-\-all\fR
|
| 63 |
+
.RS 4
|
| 64 |
+
Deprecated alias for \fB\-\-workspace\fR\&.
|
| 65 |
+
.RE
|
| 66 |
+
.sp
|
| 67 |
+
\fB\-\-exclude\fR \fISPEC\fR\[u2026]
|
| 68 |
+
.RS 4
|
| 69 |
+
Exclude the specified packages. Must be used in conjunction with the
|
| 70 |
+
\fB\-\-workspace\fR flag. This flag may be specified multiple times and supports
|
| 71 |
+
common Unix glob patterns like \fB*\fR, \fB?\fR and \fB[]\fR\&. However, to avoid your shell
|
| 72 |
+
accidentally expanding glob patterns before Cargo handles them, you must use
|
| 73 |
+
single quotes or double quotes around each pattern.
|
| 74 |
+
.RE
|
| 75 |
+
.SS "Target Selection"
|
| 76 |
+
When no target selection options are given, \fBcargo doc\fR will document all
|
| 77 |
+
binary and library targets of the selected package. The binary will be skipped
|
| 78 |
+
if its name is the same as the lib target. Binaries are skipped if they have
|
| 79 |
+
\fBrequired\-features\fR that are missing.
|
| 80 |
+
.sp
|
| 81 |
+
The default behavior can be changed by setting \fBdoc = false\fR for the target in
|
| 82 |
+
the manifest settings. Using target selection options will ignore the \fBdoc\fR
|
| 83 |
+
flag and will always document the given target.
|
| 84 |
+
.sp
|
| 85 |
+
\fB\-\-lib\fR
|
| 86 |
+
.RS 4
|
| 87 |
+
Document the package\[cq]s library.
|
| 88 |
+
.RE
|
| 89 |
+
.sp
|
| 90 |
+
\fB\-\-bin\fR \fIname\fR\[u2026]
|
| 91 |
+
.RS 4
|
| 92 |
+
Document the specified binary. This flag may be specified multiple times
|
| 93 |
+
and supports common Unix glob patterns.
|
| 94 |
+
.RE
|
| 95 |
+
.sp
|
| 96 |
+
\fB\-\-bins\fR
|
| 97 |
+
.RS 4
|
| 98 |
+
Document all binary targets.
|
| 99 |
+
.RE
|
| 100 |
+
.sp
|
| 101 |
+
\fB\-\-example\fR \fIname\fR\[u2026]
|
| 102 |
+
.RS 4
|
| 103 |
+
Document the specified example. This flag may be specified multiple times
|
| 104 |
+
and supports common Unix glob patterns.
|
| 105 |
+
.RE
|
| 106 |
+
.sp
|
| 107 |
+
\fB\-\-examples\fR
|
| 108 |
+
.RS 4
|
| 109 |
+
Document all example targets.
|
| 110 |
+
.RE
|
| 111 |
+
.SS "Feature Selection"
|
| 112 |
+
The feature flags allow you to control which features are enabled. When no
|
| 113 |
+
feature options are given, the \fBdefault\fR feature is activated for every
|
| 114 |
+
selected package.
|
| 115 |
+
.sp
|
| 116 |
+
See \fIthe features documentation\fR <https://doc.rust\-lang.org/cargo/reference/features.html#command\-line\-feature\-options>
|
| 117 |
+
for more details.
|
| 118 |
+
.sp
|
| 119 |
+
\fB\-F\fR \fIfeatures\fR,
|
| 120 |
+
\fB\-\-features\fR \fIfeatures\fR
|
| 121 |
+
.RS 4
|
| 122 |
+
Space or comma separated list of features to activate. Features of workspace
|
| 123 |
+
members may be enabled with \fBpackage\-name/feature\-name\fR syntax. This flag may
|
| 124 |
+
be specified multiple times, which enables all specified features.
|
| 125 |
+
.RE
|
| 126 |
+
.sp
|
| 127 |
+
\fB\-\-all\-features\fR
|
| 128 |
+
.RS 4
|
| 129 |
+
Activate all available features of all selected packages.
|
| 130 |
+
.RE
|
| 131 |
+
.sp
|
| 132 |
+
\fB\-\-no\-default\-features\fR
|
| 133 |
+
.RS 4
|
| 134 |
+
Do not activate the \fBdefault\fR feature of the selected packages.
|
| 135 |
+
.RE
|
| 136 |
+
.SS "Compilation Options"
|
| 137 |
+
.sp
|
| 138 |
+
\fB\-\-target\fR \fItriple\fR
|
| 139 |
+
.RS 4
|
| 140 |
+
Document for the specified target architecture. Flag may be specified multiple times. The default is the host architecture. The general format of the triple is
|
| 141 |
+
\fB<arch><sub>\-<vendor>\-<sys>\-<abi>\fR\&.
|
| 142 |
+
.sp
|
| 143 |
+
Possible values:
|
| 144 |
+
.sp
|
| 145 |
+
.RS 4
|
| 146 |
+
\h'-04'\(bu\h'+03'Any supported target in \fBrustc \-\-print target\-list\fR\&.
|
| 147 |
+
.RE
|
| 148 |
+
.sp
|
| 149 |
+
.RS 4
|
| 150 |
+
\h'-04'\(bu\h'+03'\fB"host\-tuple"\fR, which will internally be substituted by the host\[cq]s target. This can be particularly useful if you\[cq]re cross\-compiling some crates, and don\[cq]t want to specify your host\[cq]s machine as a target (for instance, an \fBxtask\fR in a shared project that may be worked on by many hosts).
|
| 151 |
+
.RE
|
| 152 |
+
.sp
|
| 153 |
+
.RS 4
|
| 154 |
+
\h'-04'\(bu\h'+03'A path to a custom target specification. See \fICustom Target Lookup Path\fR <https://doc.rust\-lang.org/rustc/targets/custom.html#custom\-target\-lookup\-path> for more information.
|
| 155 |
+
.RE
|
| 156 |
+
.sp
|
| 157 |
+
This may also be specified with the \fBbuild.target\fR \fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 158 |
+
.sp
|
| 159 |
+
Note that specifying this flag makes Cargo run in a different mode where the
|
| 160 |
+
target artifacts are placed in a separate directory. See the
|
| 161 |
+
\fIbuild cache\fR <https://doc.rust\-lang.org/cargo/reference/build\-cache.html> documentation for more details.
|
| 162 |
+
.RE
|
| 163 |
+
.sp
|
| 164 |
+
\fB\-r\fR,
|
| 165 |
+
\fB\-\-release\fR
|
| 166 |
+
.RS 4
|
| 167 |
+
Document optimized artifacts with the \fBrelease\fR profile.
|
| 168 |
+
See also the \fB\-\-profile\fR option for choosing a specific profile by name.
|
| 169 |
+
.RE
|
| 170 |
+
.sp
|
| 171 |
+
\fB\-\-profile\fR \fIname\fR
|
| 172 |
+
.RS 4
|
| 173 |
+
Document with the given profile.
|
| 174 |
+
See \fIthe reference\fR <https://doc.rust\-lang.org/cargo/reference/profiles.html> for more details on profiles.
|
| 175 |
+
.RE
|
| 176 |
+
.sp
|
| 177 |
+
\fB\-\-timings\fR
|
| 178 |
+
.RS 4
|
| 179 |
+
Output information how long each compilation takes, and track concurrency
|
| 180 |
+
information over time.
|
| 181 |
+
.sp
|
| 182 |
+
A file \fBcargo\-timing.html\fR will be written to the \fBtarget/cargo\-timings\fR
|
| 183 |
+
directory at the end of the build. An additional report with a timestamp
|
| 184 |
+
in its filename is also written if you want to look at a previous run.
|
| 185 |
+
These reports are suitable for human consumption only, and do not provide
|
| 186 |
+
machine\-readable timing data.
|
| 187 |
+
.RE
|
| 188 |
+
.SS "Output Options"
|
| 189 |
+
.sp
|
| 190 |
+
\fB\-\-target\-dir\fR \fIdirectory\fR
|
| 191 |
+
.RS 4
|
| 192 |
+
Directory for all generated artifacts and intermediate files. May also be
|
| 193 |
+
specified with the \fBCARGO_TARGET_DIR\fR environment variable, or the
|
| 194 |
+
\fBbuild.target\-dir\fR \fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 195 |
+
Defaults to \fBtarget\fR in the root of the workspace.
|
| 196 |
+
.RE
|
| 197 |
+
.SS "Display Options"
|
| 198 |
+
.sp
|
| 199 |
+
\fB\-v\fR,
|
| 200 |
+
\fB\-\-verbose\fR
|
| 201 |
+
.RS 4
|
| 202 |
+
Use verbose output. May be specified twice for \[lq]very verbose\[rq] output which
|
| 203 |
+
includes extra output such as dependency warnings and build script output.
|
| 204 |
+
May also be specified with the \fBterm.verbose\fR
|
| 205 |
+
\fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 206 |
+
.RE
|
| 207 |
+
.sp
|
| 208 |
+
\fB\-q\fR,
|
| 209 |
+
\fB\-\-quiet\fR
|
| 210 |
+
.RS 4
|
| 211 |
+
Do not print cargo log messages.
|
| 212 |
+
May also be specified with the \fBterm.quiet\fR
|
| 213 |
+
\fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 214 |
+
.RE
|
| 215 |
+
.sp
|
| 216 |
+
\fB\-\-color\fR \fIwhen\fR
|
| 217 |
+
.RS 4
|
| 218 |
+
Control when colored output is used. Valid values:
|
| 219 |
+
.sp
|
| 220 |
+
.RS 4
|
| 221 |
+
\h'-04'\(bu\h'+03'\fBauto\fR (default): Automatically detect if color support is available on the
|
| 222 |
+
terminal.
|
| 223 |
+
.RE
|
| 224 |
+
.sp
|
| 225 |
+
.RS 4
|
| 226 |
+
\h'-04'\(bu\h'+03'\fBalways\fR: Always display colors.
|
| 227 |
+
.RE
|
| 228 |
+
.sp
|
| 229 |
+
.RS 4
|
| 230 |
+
\h'-04'\(bu\h'+03'\fBnever\fR: Never display colors.
|
| 231 |
+
.RE
|
| 232 |
+
.sp
|
| 233 |
+
May also be specified with the \fBterm.color\fR
|
| 234 |
+
\fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 235 |
+
.RE
|
| 236 |
+
.sp
|
| 237 |
+
\fB\-\-message\-format\fR \fIfmt\fR
|
| 238 |
+
.RS 4
|
| 239 |
+
The output format for diagnostic messages. Can be specified multiple times
|
| 240 |
+
and consists of comma\-separated values. Valid values:
|
| 241 |
+
.sp
|
| 242 |
+
.RS 4
|
| 243 |
+
\h'-04'\(bu\h'+03'\fBhuman\fR (default): Display in a human\-readable text format. Conflicts with
|
| 244 |
+
\fBshort\fR and \fBjson\fR\&.
|
| 245 |
+
.RE
|
| 246 |
+
.sp
|
| 247 |
+
.RS 4
|
| 248 |
+
\h'-04'\(bu\h'+03'\fBshort\fR: Emit shorter, human\-readable text messages. Conflicts with \fBhuman\fR
|
| 249 |
+
and \fBjson\fR\&.
|
| 250 |
+
.RE
|
| 251 |
+
.sp
|
| 252 |
+
.RS 4
|
| 253 |
+
\h'-04'\(bu\h'+03'\fBjson\fR: Emit JSON messages to stdout. See
|
| 254 |
+
\fIthe reference\fR <https://doc.rust\-lang.org/cargo/reference/external\-tools.html#json\-messages>
|
| 255 |
+
for more details. Conflicts with \fBhuman\fR and \fBshort\fR\&.
|
| 256 |
+
.RE
|
| 257 |
+
.sp
|
| 258 |
+
.RS 4
|
| 259 |
+
\h'-04'\(bu\h'+03'\fBjson\-diagnostic\-short\fR: Ensure the \fBrendered\fR field of JSON messages contains
|
| 260 |
+
the \[lq]short\[rq] rendering from rustc. Cannot be used with \fBhuman\fR or \fBshort\fR\&.
|
| 261 |
+
.RE
|
| 262 |
+
.sp
|
| 263 |
+
.RS 4
|
| 264 |
+
\h'-04'\(bu\h'+03'\fBjson\-diagnostic\-rendered\-ansi\fR: Ensure the \fBrendered\fR field of JSON messages
|
| 265 |
+
contains embedded ANSI color codes for respecting rustc\[cq]s default color
|
| 266 |
+
scheme. Cannot be used with \fBhuman\fR or \fBshort\fR\&.
|
| 267 |
+
.RE
|
| 268 |
+
.sp
|
| 269 |
+
.RS 4
|
| 270 |
+
\h'-04'\(bu\h'+03'\fBjson\-render\-diagnostics\fR: Instruct Cargo to not include rustc diagnostics
|
| 271 |
+
in JSON messages printed, but instead Cargo itself should render the
|
| 272 |
+
JSON diagnostics coming from rustc. Cargo\[cq]s own JSON diagnostics and others
|
| 273 |
+
coming from rustc are still emitted. Cannot be used with \fBhuman\fR or \fBshort\fR\&.
|
| 274 |
+
.RE
|
| 275 |
+
.RE
|
| 276 |
+
.SS "Manifest Options"
|
| 277 |
+
.sp
|
| 278 |
+
\fB\-\-manifest\-path\fR \fIpath\fR
|
| 279 |
+
.RS 4
|
| 280 |
+
Path to the \fBCargo.toml\fR file. By default, Cargo searches for the
|
| 281 |
+
\fBCargo.toml\fR file in the current directory or any parent directory.
|
| 282 |
+
.RE
|
| 283 |
+
.sp
|
| 284 |
+
\fB\-\-ignore\-rust\-version\fR
|
| 285 |
+
.RS 4
|
| 286 |
+
Ignore \fBrust\-version\fR specification in packages.
|
| 287 |
+
.RE
|
| 288 |
+
.sp
|
| 289 |
+
\fB\-\-locked\fR
|
| 290 |
+
.RS 4
|
| 291 |
+
Asserts that the exact same dependencies and versions are used as when the
|
| 292 |
+
existing \fBCargo.lock\fR file was originally generated. Cargo will exit with an
|
| 293 |
+
error when either of the following scenarios arises:
|
| 294 |
+
.sp
|
| 295 |
+
.RS 4
|
| 296 |
+
\h'-04'\(bu\h'+03'The lock file is missing.
|
| 297 |
+
.RE
|
| 298 |
+
.sp
|
| 299 |
+
.RS 4
|
| 300 |
+
\h'-04'\(bu\h'+03'Cargo attempted to change the lock file due to a different dependency resolution.
|
| 301 |
+
.RE
|
| 302 |
+
.sp
|
| 303 |
+
It may be used in environments where deterministic builds are desired,
|
| 304 |
+
such as in CI pipelines.
|
| 305 |
+
.RE
|
| 306 |
+
.sp
|
| 307 |
+
\fB\-\-offline\fR
|
| 308 |
+
.RS 4
|
| 309 |
+
Prevents Cargo from accessing the network for any reason. Without this
|
| 310 |
+
flag, Cargo will stop with an error if it needs to access the network and
|
| 311 |
+
the network is not available. With this flag, Cargo will attempt to
|
| 312 |
+
proceed without the network if possible.
|
| 313 |
+
.sp
|
| 314 |
+
Beware that this may result in different dependency resolution than online
|
| 315 |
+
mode. Cargo will restrict itself to crates that are downloaded locally, even
|
| 316 |
+
if there might be a newer version as indicated in the local copy of the index.
|
| 317 |
+
See the \fBcargo\-fetch\fR(1) command to download dependencies before going
|
| 318 |
+
offline.
|
| 319 |
+
.sp
|
| 320 |
+
May also be specified with the \fBnet.offline\fR \fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 321 |
+
.RE
|
| 322 |
+
.sp
|
| 323 |
+
\fB\-\-frozen\fR
|
| 324 |
+
.RS 4
|
| 325 |
+
Equivalent to specifying both \fB\-\-locked\fR and \fB\-\-offline\fR\&.
|
| 326 |
+
.RE
|
| 327 |
+
.SS "Common Options"
|
| 328 |
+
.sp
|
| 329 |
+
\fB+\fR\fItoolchain\fR
|
| 330 |
+
.RS 4
|
| 331 |
+
If Cargo has been installed with rustup, and the first argument to \fBcargo\fR
|
| 332 |
+
begins with \fB+\fR, it will be interpreted as a rustup toolchain name (such
|
| 333 |
+
as \fB+stable\fR or \fB+nightly\fR).
|
| 334 |
+
See the \fIrustup documentation\fR <https://rust\-lang.github.io/rustup/overrides.html>
|
| 335 |
+
for more information about how toolchain overrides work.
|
| 336 |
+
.RE
|
| 337 |
+
.sp
|
| 338 |
+
\fB\-\-config\fR \fIKEY=VALUE\fR or \fIPATH\fR
|
| 339 |
+
.RS 4
|
| 340 |
+
Overrides a Cargo configuration value. The argument should be in TOML syntax of \fBKEY=VALUE\fR,
|
| 341 |
+
or provided as a path to an extra configuration file. This flag may be specified multiple times.
|
| 342 |
+
See the \fIcommand\-line overrides section\fR <https://doc.rust\-lang.org/cargo/reference/config.html#command\-line\-overrides> for more information.
|
| 343 |
+
.RE
|
| 344 |
+
.sp
|
| 345 |
+
\fB\-C\fR \fIPATH\fR
|
| 346 |
+
.RS 4
|
| 347 |
+
Changes the current working directory before executing any specified operations. This affects
|
| 348 |
+
things like where cargo looks by default for the project manifest (\fBCargo.toml\fR), as well as
|
| 349 |
+
the directories searched for discovering \fB\&.cargo/config.toml\fR, for example. This option must
|
| 350 |
+
appear before the command name, for example \fBcargo \-C path/to/my\-project build\fR\&.
|
| 351 |
+
.sp
|
| 352 |
+
This option is only available on the \fInightly
|
| 353 |
+
channel\fR <https://doc.rust\-lang.org/book/appendix\-07\-nightly\-rust.html> and
|
| 354 |
+
requires the \fB\-Z unstable\-options\fR flag to enable (see
|
| 355 |
+
\fI#10098\fR <https://github.com/rust\-lang/cargo/issues/10098>).
|
| 356 |
+
.RE
|
| 357 |
+
.sp
|
| 358 |
+
\fB\-h\fR,
|
| 359 |
+
\fB\-\-help\fR
|
| 360 |
+
.RS 4
|
| 361 |
+
Prints help information.
|
| 362 |
+
.RE
|
| 363 |
+
.sp
|
| 364 |
+
\fB\-Z\fR \fIflag\fR
|
| 365 |
+
.RS 4
|
| 366 |
+
Unstable (nightly\-only) flags to Cargo. Run \fBcargo \-Z help\fR for details.
|
| 367 |
+
.RE
|
| 368 |
+
.SS "Miscellaneous Options"
|
| 369 |
+
.sp
|
| 370 |
+
\fB\-j\fR \fIN\fR,
|
| 371 |
+
\fB\-\-jobs\fR \fIN\fR
|
| 372 |
+
.RS 4
|
| 373 |
+
Number of parallel jobs to run. May also be specified with the
|
| 374 |
+
\fBbuild.jobs\fR \fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&. Defaults to
|
| 375 |
+
the number of logical CPUs. If negative, it sets the maximum number of
|
| 376 |
+
parallel jobs to the number of logical CPUs plus provided value. If
|
| 377 |
+
a string \fBdefault\fR is provided, it sets the value back to defaults.
|
| 378 |
+
Should not be 0.
|
| 379 |
+
.RE
|
| 380 |
+
.sp
|
| 381 |
+
\fB\-\-keep\-going\fR
|
| 382 |
+
.RS 4
|
| 383 |
+
Build as many crates in the dependency graph as possible, rather than aborting
|
| 384 |
+
the build on the first one that fails to build.
|
| 385 |
+
.sp
|
| 386 |
+
For example if the current package depends on dependencies \fBfails\fR and \fBworks\fR,
|
| 387 |
+
one of which fails to build, \fBcargo doc \-j1\fR may or may not build the
|
| 388 |
+
one that succeeds (depending on which one of the two builds Cargo picked to run
|
| 389 |
+
first), whereas \fBcargo doc \-j1 \-\-keep\-going\fR would definitely run both
|
| 390 |
+
builds, even if the one run first fails.
|
| 391 |
+
.RE
|
| 392 |
+
.SH "ENVIRONMENT"
|
| 393 |
+
See \fIthe reference\fR <https://doc.rust\-lang.org/cargo/reference/environment\-variables.html> for
|
| 394 |
+
details on environment variables that Cargo reads.
|
| 395 |
+
.SH "EXIT STATUS"
|
| 396 |
+
.sp
|
| 397 |
+
.RS 4
|
| 398 |
+
\h'-04'\(bu\h'+03'\fB0\fR: Cargo succeeded.
|
| 399 |
+
.RE
|
| 400 |
+
.sp
|
| 401 |
+
.RS 4
|
| 402 |
+
\h'-04'\(bu\h'+03'\fB101\fR: Cargo failed to complete.
|
| 403 |
+
.RE
|
| 404 |
+
.SH "EXAMPLES"
|
| 405 |
+
.sp
|
| 406 |
+
.RS 4
|
| 407 |
+
\h'-04' 1.\h'+01'Build the local package documentation and its dependencies and output to
|
| 408 |
+
\fBtarget/doc\fR\&.
|
| 409 |
+
.sp
|
| 410 |
+
.RS 4
|
| 411 |
+
.nf
|
| 412 |
+
cargo doc
|
| 413 |
+
.fi
|
| 414 |
+
.RE
|
| 415 |
+
.RE
|
| 416 |
+
.SH "SEE ALSO"
|
| 417 |
+
\fBcargo\fR(1), \fBcargo\-rustdoc\fR(1), \fBrustdoc\fR(1)
|
rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-fetch.1
ADDED
|
@@ -0,0 +1,199 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
'\" t
|
| 2 |
+
.TH "CARGO\-FETCH" "1"
|
| 3 |
+
.nh
|
| 4 |
+
.ad l
|
| 5 |
+
.ss \n[.ss] 0
|
| 6 |
+
.SH "NAME"
|
| 7 |
+
cargo\-fetch \[em] Fetch dependencies of a package from the network
|
| 8 |
+
.SH "SYNOPSIS"
|
| 9 |
+
\fBcargo fetch\fR [\fIoptions\fR]
|
| 10 |
+
.SH "DESCRIPTION"
|
| 11 |
+
If a \fBCargo.lock\fR file is available, this command will ensure that all of the
|
| 12 |
+
git dependencies and/or registry dependencies are downloaded and locally
|
| 13 |
+
available. Subsequent Cargo commands will be able to run offline after a \fBcargo fetch\fR unless the lock file changes.
|
| 14 |
+
.sp
|
| 15 |
+
If the lock file is not available, then this command will generate the lock
|
| 16 |
+
file before fetching the dependencies.
|
| 17 |
+
.sp
|
| 18 |
+
If \fB\-\-target\fR is not specified, then all target dependencies are fetched.
|
| 19 |
+
.sp
|
| 20 |
+
See also the \fIcargo\-prefetch\fR <https://crates.io/crates/cargo\-prefetch>
|
| 21 |
+
plugin which adds a command to download popular crates. This may be useful if
|
| 22 |
+
you plan to use Cargo without a network with the \fB\-\-offline\fR flag.
|
| 23 |
+
.SH "OPTIONS"
|
| 24 |
+
.SS "Fetch options"
|
| 25 |
+
.sp
|
| 26 |
+
\fB\-\-target\fR \fItriple\fR
|
| 27 |
+
.RS 4
|
| 28 |
+
Fetch for the specified target architecture. Flag may be specified multiple times. The default is all architectures. The general format of the triple is
|
| 29 |
+
\fB<arch><sub>\-<vendor>\-<sys>\-<abi>\fR\&.
|
| 30 |
+
.sp
|
| 31 |
+
Possible values:
|
| 32 |
+
.sp
|
| 33 |
+
.RS 4
|
| 34 |
+
\h'-04'\(bu\h'+03'Any supported target in \fBrustc \-\-print target\-list\fR\&.
|
| 35 |
+
.RE
|
| 36 |
+
.sp
|
| 37 |
+
.RS 4
|
| 38 |
+
\h'-04'\(bu\h'+03'\fB"host\-tuple"\fR, which will internally be substituted by the host\[cq]s target. This can be particularly useful if you\[cq]re cross\-compiling some crates, and don\[cq]t want to specify your host\[cq]s machine as a target (for instance, an \fBxtask\fR in a shared project that may be worked on by many hosts).
|
| 39 |
+
.RE
|
| 40 |
+
.sp
|
| 41 |
+
.RS 4
|
| 42 |
+
\h'-04'\(bu\h'+03'A path to a custom target specification. See \fICustom Target Lookup Path\fR <https://doc.rust\-lang.org/rustc/targets/custom.html#custom\-target\-lookup\-path> for more information.
|
| 43 |
+
.RE
|
| 44 |
+
.sp
|
| 45 |
+
This may also be specified with the \fBbuild.target\fR \fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 46 |
+
.sp
|
| 47 |
+
Note that specifying this flag makes Cargo run in a different mode where the
|
| 48 |
+
target artifacts are placed in a separate directory. See the
|
| 49 |
+
\fIbuild cache\fR <https://doc.rust\-lang.org/cargo/reference/build\-cache.html> documentation for more details.
|
| 50 |
+
.RE
|
| 51 |
+
.SS "Display Options"
|
| 52 |
+
.sp
|
| 53 |
+
\fB\-v\fR,
|
| 54 |
+
\fB\-\-verbose\fR
|
| 55 |
+
.RS 4
|
| 56 |
+
Use verbose output. May be specified twice for \[lq]very verbose\[rq] output which
|
| 57 |
+
includes extra output such as dependency warnings and build script output.
|
| 58 |
+
May also be specified with the \fBterm.verbose\fR
|
| 59 |
+
\fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 60 |
+
.RE
|
| 61 |
+
.sp
|
| 62 |
+
\fB\-q\fR,
|
| 63 |
+
\fB\-\-quiet\fR
|
| 64 |
+
.RS 4
|
| 65 |
+
Do not print cargo log messages.
|
| 66 |
+
May also be specified with the \fBterm.quiet\fR
|
| 67 |
+
\fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 68 |
+
.RE
|
| 69 |
+
.sp
|
| 70 |
+
\fB\-\-color\fR \fIwhen\fR
|
| 71 |
+
.RS 4
|
| 72 |
+
Control when colored output is used. Valid values:
|
| 73 |
+
.sp
|
| 74 |
+
.RS 4
|
| 75 |
+
\h'-04'\(bu\h'+03'\fBauto\fR (default): Automatically detect if color support is available on the
|
| 76 |
+
terminal.
|
| 77 |
+
.RE
|
| 78 |
+
.sp
|
| 79 |
+
.RS 4
|
| 80 |
+
\h'-04'\(bu\h'+03'\fBalways\fR: Always display colors.
|
| 81 |
+
.RE
|
| 82 |
+
.sp
|
| 83 |
+
.RS 4
|
| 84 |
+
\h'-04'\(bu\h'+03'\fBnever\fR: Never display colors.
|
| 85 |
+
.RE
|
| 86 |
+
.sp
|
| 87 |
+
May also be specified with the \fBterm.color\fR
|
| 88 |
+
\fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 89 |
+
.RE
|
| 90 |
+
.SS "Manifest Options"
|
| 91 |
+
.sp
|
| 92 |
+
\fB\-\-manifest\-path\fR \fIpath\fR
|
| 93 |
+
.RS 4
|
| 94 |
+
Path to the \fBCargo.toml\fR file. By default, Cargo searches for the
|
| 95 |
+
\fBCargo.toml\fR file in the current directory or any parent directory.
|
| 96 |
+
.RE
|
| 97 |
+
.sp
|
| 98 |
+
\fB\-\-locked\fR
|
| 99 |
+
.RS 4
|
| 100 |
+
Asserts that the exact same dependencies and versions are used as when the
|
| 101 |
+
existing \fBCargo.lock\fR file was originally generated. Cargo will exit with an
|
| 102 |
+
error when either of the following scenarios arises:
|
| 103 |
+
.sp
|
| 104 |
+
.RS 4
|
| 105 |
+
\h'-04'\(bu\h'+03'The lock file is missing.
|
| 106 |
+
.RE
|
| 107 |
+
.sp
|
| 108 |
+
.RS 4
|
| 109 |
+
\h'-04'\(bu\h'+03'Cargo attempted to change the lock file due to a different dependency resolution.
|
| 110 |
+
.RE
|
| 111 |
+
.sp
|
| 112 |
+
It may be used in environments where deterministic builds are desired,
|
| 113 |
+
such as in CI pipelines.
|
| 114 |
+
.RE
|
| 115 |
+
.sp
|
| 116 |
+
\fB\-\-offline\fR
|
| 117 |
+
.RS 4
|
| 118 |
+
Prevents Cargo from accessing the network for any reason. Without this
|
| 119 |
+
flag, Cargo will stop with an error if it needs to access the network and
|
| 120 |
+
the network is not available. With this flag, Cargo will attempt to
|
| 121 |
+
proceed without the network if possible.
|
| 122 |
+
.sp
|
| 123 |
+
Beware that this may result in different dependency resolution than online
|
| 124 |
+
mode. Cargo will restrict itself to crates that are downloaded locally, even
|
| 125 |
+
if there might be a newer version as indicated in the local copy of the index.
|
| 126 |
+
.sp
|
| 127 |
+
May also be specified with the \fBnet.offline\fR \fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 128 |
+
.RE
|
| 129 |
+
.sp
|
| 130 |
+
\fB\-\-frozen\fR
|
| 131 |
+
.RS 4
|
| 132 |
+
Equivalent to specifying both \fB\-\-locked\fR and \fB\-\-offline\fR\&.
|
| 133 |
+
.RE
|
| 134 |
+
.SS "Common Options"
|
| 135 |
+
.sp
|
| 136 |
+
\fB+\fR\fItoolchain\fR
|
| 137 |
+
.RS 4
|
| 138 |
+
If Cargo has been installed with rustup, and the first argument to \fBcargo\fR
|
| 139 |
+
begins with \fB+\fR, it will be interpreted as a rustup toolchain name (such
|
| 140 |
+
as \fB+stable\fR or \fB+nightly\fR).
|
| 141 |
+
See the \fIrustup documentation\fR <https://rust\-lang.github.io/rustup/overrides.html>
|
| 142 |
+
for more information about how toolchain overrides work.
|
| 143 |
+
.RE
|
| 144 |
+
.sp
|
| 145 |
+
\fB\-\-config\fR \fIKEY=VALUE\fR or \fIPATH\fR
|
| 146 |
+
.RS 4
|
| 147 |
+
Overrides a Cargo configuration value. The argument should be in TOML syntax of \fBKEY=VALUE\fR,
|
| 148 |
+
or provided as a path to an extra configuration file. This flag may be specified multiple times.
|
| 149 |
+
See the \fIcommand\-line overrides section\fR <https://doc.rust\-lang.org/cargo/reference/config.html#command\-line\-overrides> for more information.
|
| 150 |
+
.RE
|
| 151 |
+
.sp
|
| 152 |
+
\fB\-C\fR \fIPATH\fR
|
| 153 |
+
.RS 4
|
| 154 |
+
Changes the current working directory before executing any specified operations. This affects
|
| 155 |
+
things like where cargo looks by default for the project manifest (\fBCargo.toml\fR), as well as
|
| 156 |
+
the directories searched for discovering \fB\&.cargo/config.toml\fR, for example. This option must
|
| 157 |
+
appear before the command name, for example \fBcargo \-C path/to/my\-project build\fR\&.
|
| 158 |
+
.sp
|
| 159 |
+
This option is only available on the \fInightly
|
| 160 |
+
channel\fR <https://doc.rust\-lang.org/book/appendix\-07\-nightly\-rust.html> and
|
| 161 |
+
requires the \fB\-Z unstable\-options\fR flag to enable (see
|
| 162 |
+
\fI#10098\fR <https://github.com/rust\-lang/cargo/issues/10098>).
|
| 163 |
+
.RE
|
| 164 |
+
.sp
|
| 165 |
+
\fB\-h\fR,
|
| 166 |
+
\fB\-\-help\fR
|
| 167 |
+
.RS 4
|
| 168 |
+
Prints help information.
|
| 169 |
+
.RE
|
| 170 |
+
.sp
|
| 171 |
+
\fB\-Z\fR \fIflag\fR
|
| 172 |
+
.RS 4
|
| 173 |
+
Unstable (nightly\-only) flags to Cargo. Run \fBcargo \-Z help\fR for details.
|
| 174 |
+
.RE
|
| 175 |
+
.SH "ENVIRONMENT"
|
| 176 |
+
See \fIthe reference\fR <https://doc.rust\-lang.org/cargo/reference/environment\-variables.html> for
|
| 177 |
+
details on environment variables that Cargo reads.
|
| 178 |
+
.SH "EXIT STATUS"
|
| 179 |
+
.sp
|
| 180 |
+
.RS 4
|
| 181 |
+
\h'-04'\(bu\h'+03'\fB0\fR: Cargo succeeded.
|
| 182 |
+
.RE
|
| 183 |
+
.sp
|
| 184 |
+
.RS 4
|
| 185 |
+
\h'-04'\(bu\h'+03'\fB101\fR: Cargo failed to complete.
|
| 186 |
+
.RE
|
| 187 |
+
.SH "EXAMPLES"
|
| 188 |
+
.sp
|
| 189 |
+
.RS 4
|
| 190 |
+
\h'-04' 1.\h'+01'Fetch all dependencies:
|
| 191 |
+
.sp
|
| 192 |
+
.RS 4
|
| 193 |
+
.nf
|
| 194 |
+
cargo fetch
|
| 195 |
+
.fi
|
| 196 |
+
.RE
|
| 197 |
+
.RE
|
| 198 |
+
.SH "SEE ALSO"
|
| 199 |
+
\fBcargo\fR(1), \fBcargo\-update\fR(1), \fBcargo\-generate\-lockfile\fR(1)
|
rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-fix.1
ADDED
|
@@ -0,0 +1,562 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
'\" t
|
| 2 |
+
.TH "CARGO\-FIX" "1"
|
| 3 |
+
.nh
|
| 4 |
+
.ad l
|
| 5 |
+
.ss \n[.ss] 0
|
| 6 |
+
.SH "NAME"
|
| 7 |
+
cargo\-fix \[em] Automatically fix lint warnings reported by rustc
|
| 8 |
+
.SH "SYNOPSIS"
|
| 9 |
+
\fBcargo fix\fR [\fIoptions\fR]
|
| 10 |
+
.SH "DESCRIPTION"
|
| 11 |
+
This Cargo subcommand will automatically take rustc\[cq]s suggestions from
|
| 12 |
+
diagnostics like warnings and apply them to your source code. This is intended
|
| 13 |
+
to help automate tasks that rustc itself already knows how to tell you to fix!
|
| 14 |
+
.sp
|
| 15 |
+
Executing \fBcargo fix\fR will under the hood execute \fBcargo\-check\fR(1). Any warnings
|
| 16 |
+
applicable to your crate will be automatically fixed (if possible) and all
|
| 17 |
+
remaining warnings will be displayed when the check process is finished. For
|
| 18 |
+
example if you\[cq]d like to apply all fixes to the current package, you can run:
|
| 19 |
+
.sp
|
| 20 |
+
.RS 4
|
| 21 |
+
.nf
|
| 22 |
+
cargo fix
|
| 23 |
+
.fi
|
| 24 |
+
.RE
|
| 25 |
+
.sp
|
| 26 |
+
which behaves the same as \fBcargo check \-\-all\-targets\fR\&.
|
| 27 |
+
.sp
|
| 28 |
+
\fBcargo fix\fR is only capable of fixing code that is normally compiled with
|
| 29 |
+
\fBcargo check\fR\&. If code is conditionally enabled with optional features, you
|
| 30 |
+
will need to enable those features for that code to be analyzed:
|
| 31 |
+
.sp
|
| 32 |
+
.RS 4
|
| 33 |
+
.nf
|
| 34 |
+
cargo fix \-\-features foo
|
| 35 |
+
.fi
|
| 36 |
+
.RE
|
| 37 |
+
.sp
|
| 38 |
+
Similarly, other \fBcfg\fR expressions like platform\-specific code will need to
|
| 39 |
+
pass \fB\-\-target\fR to fix code for the given target.
|
| 40 |
+
.sp
|
| 41 |
+
.RS 4
|
| 42 |
+
.nf
|
| 43 |
+
cargo fix \-\-target x86_64\-pc\-windows\-gnu
|
| 44 |
+
.fi
|
| 45 |
+
.RE
|
| 46 |
+
.sp
|
| 47 |
+
If you encounter any problems with \fBcargo fix\fR or otherwise have any questions
|
| 48 |
+
or feature requests please don\[cq]t hesitate to file an issue at
|
| 49 |
+
<https://github.com/rust\-lang/cargo>\&.
|
| 50 |
+
.SS "Edition migration"
|
| 51 |
+
The \fBcargo fix\fR subcommand can also be used to migrate a package from one
|
| 52 |
+
\fIedition\fR <https://doc.rust\-lang.org/edition\-guide/editions/transitioning\-an\-existing\-project\-to\-a\-new\-edition.html> to the next. The general procedure is:
|
| 53 |
+
.sp
|
| 54 |
+
.RS 4
|
| 55 |
+
\h'-04' 1.\h'+01'Run \fBcargo fix \-\-edition\fR\&. Consider also using the \fB\-\-all\-features\fR flag if
|
| 56 |
+
your project has multiple features. You may also want to run \fBcargo fix \-\-edition\fR multiple times with different \fB\-\-target\fR flags if your project
|
| 57 |
+
has platform\-specific code gated by \fBcfg\fR attributes.
|
| 58 |
+
.RE
|
| 59 |
+
.sp
|
| 60 |
+
.RS 4
|
| 61 |
+
\h'-04' 2.\h'+01'Modify \fBCargo.toml\fR to set the \fIedition field\fR <https://doc.rust\-lang.org/cargo/reference/manifest.html#the\-edition\-field> to the new edition.
|
| 62 |
+
.RE
|
| 63 |
+
.sp
|
| 64 |
+
.RS 4
|
| 65 |
+
\h'-04' 3.\h'+01'Run your project tests to verify that everything still works. If new
|
| 66 |
+
warnings are issued, you may want to consider running \fBcargo fix\fR again
|
| 67 |
+
(without the \fB\-\-edition\fR flag) to apply any suggestions given by the
|
| 68 |
+
compiler.
|
| 69 |
+
.RE
|
| 70 |
+
.sp
|
| 71 |
+
And hopefully that\[cq]s it! Just keep in mind of the caveats mentioned above that
|
| 72 |
+
\fBcargo fix\fR cannot update code for inactive features or \fBcfg\fR expressions.
|
| 73 |
+
Also, in some rare cases the compiler is unable to automatically migrate all
|
| 74 |
+
code to the new edition, and this may require manual changes after building
|
| 75 |
+
with the new edition.
|
| 76 |
+
.SH "OPTIONS"
|
| 77 |
+
.SS "Fix options"
|
| 78 |
+
.sp
|
| 79 |
+
\fB\-\-broken\-code\fR
|
| 80 |
+
.RS 4
|
| 81 |
+
Fix code even if it already has compiler errors. This is useful if \fBcargo fix\fR
|
| 82 |
+
fails to apply the changes. It will apply the changes and leave the broken
|
| 83 |
+
code in the working directory for you to inspect and manually fix.
|
| 84 |
+
.RE
|
| 85 |
+
.sp
|
| 86 |
+
\fB\-\-edition\fR
|
| 87 |
+
.RS 4
|
| 88 |
+
Apply changes that will update the code to the next edition. This will not
|
| 89 |
+
update the edition in the \fBCargo.toml\fR manifest, which must be updated
|
| 90 |
+
manually after \fBcargo fix \-\-edition\fR has finished.
|
| 91 |
+
.RE
|
| 92 |
+
.sp
|
| 93 |
+
\fB\-\-edition\-idioms\fR
|
| 94 |
+
.RS 4
|
| 95 |
+
Apply suggestions that will update code to the preferred style for the current
|
| 96 |
+
edition.
|
| 97 |
+
.RE
|
| 98 |
+
.sp
|
| 99 |
+
\fB\-\-allow\-no\-vcs\fR
|
| 100 |
+
.RS 4
|
| 101 |
+
Fix code even if a VCS was not detected.
|
| 102 |
+
.RE
|
| 103 |
+
.sp
|
| 104 |
+
\fB\-\-allow\-dirty\fR
|
| 105 |
+
.RS 4
|
| 106 |
+
Fix code even if the working directory has changes (including staged changes).
|
| 107 |
+
.RE
|
| 108 |
+
.sp
|
| 109 |
+
\fB\-\-allow\-staged\fR
|
| 110 |
+
.RS 4
|
| 111 |
+
Fix code even if the working directory has staged changes.
|
| 112 |
+
.RE
|
| 113 |
+
.SS "Package Selection"
|
| 114 |
+
By default, when no package selection options are given, the packages selected
|
| 115 |
+
depend on the selected manifest file (based on the current working directory if
|
| 116 |
+
\fB\-\-manifest\-path\fR is not given). If the manifest is the root of a workspace then
|
| 117 |
+
the workspaces default members are selected, otherwise only the package defined
|
| 118 |
+
by the manifest will be selected.
|
| 119 |
+
.sp
|
| 120 |
+
The default members of a workspace can be set explicitly with the
|
| 121 |
+
\fBworkspace.default\-members\fR key in the root manifest. If this is not set, a
|
| 122 |
+
virtual workspace will include all workspace members (equivalent to passing
|
| 123 |
+
\fB\-\-workspace\fR), and a non\-virtual workspace will include only the root crate itself.
|
| 124 |
+
.sp
|
| 125 |
+
\fB\-p\fR \fIspec\fR\[u2026],
|
| 126 |
+
\fB\-\-package\fR \fIspec\fR\[u2026]
|
| 127 |
+
.RS 4
|
| 128 |
+
Fix only the specified packages. See \fBcargo\-pkgid\fR(1) for the
|
| 129 |
+
SPEC format. This flag may be specified multiple times and supports common Unix
|
| 130 |
+
glob patterns like \fB*\fR, \fB?\fR and \fB[]\fR\&. However, to avoid your shell accidentally
|
| 131 |
+
expanding glob patterns before Cargo handles them, you must use single quotes or
|
| 132 |
+
double quotes around each pattern.
|
| 133 |
+
.RE
|
| 134 |
+
.sp
|
| 135 |
+
\fB\-\-workspace\fR
|
| 136 |
+
.RS 4
|
| 137 |
+
Fix all members in the workspace.
|
| 138 |
+
.RE
|
| 139 |
+
.sp
|
| 140 |
+
\fB\-\-all\fR
|
| 141 |
+
.RS 4
|
| 142 |
+
Deprecated alias for \fB\-\-workspace\fR\&.
|
| 143 |
+
.RE
|
| 144 |
+
.sp
|
| 145 |
+
\fB\-\-exclude\fR \fISPEC\fR\[u2026]
|
| 146 |
+
.RS 4
|
| 147 |
+
Exclude the specified packages. Must be used in conjunction with the
|
| 148 |
+
\fB\-\-workspace\fR flag. This flag may be specified multiple times and supports
|
| 149 |
+
common Unix glob patterns like \fB*\fR, \fB?\fR and \fB[]\fR\&. However, to avoid your shell
|
| 150 |
+
accidentally expanding glob patterns before Cargo handles them, you must use
|
| 151 |
+
single quotes or double quotes around each pattern.
|
| 152 |
+
.RE
|
| 153 |
+
.SS "Target Selection"
|
| 154 |
+
When no target selection options are given, \fBcargo fix\fR will fix all targets
|
| 155 |
+
(\fB\-\-all\-targets\fR implied). Binaries are skipped if they have
|
| 156 |
+
\fBrequired\-features\fR that are missing.
|
| 157 |
+
.sp
|
| 158 |
+
Passing target selection flags will fix only the specified
|
| 159 |
+
targets.
|
| 160 |
+
.sp
|
| 161 |
+
Note that \fB\-\-bin\fR, \fB\-\-example\fR, \fB\-\-test\fR and \fB\-\-bench\fR flags also
|
| 162 |
+
support common Unix glob patterns like \fB*\fR, \fB?\fR and \fB[]\fR\&. However, to avoid your
|
| 163 |
+
shell accidentally expanding glob patterns before Cargo handles them, you must
|
| 164 |
+
use single quotes or double quotes around each glob pattern.
|
| 165 |
+
.sp
|
| 166 |
+
\fB\-\-lib\fR
|
| 167 |
+
.RS 4
|
| 168 |
+
Fix the package\[cq]s library.
|
| 169 |
+
.RE
|
| 170 |
+
.sp
|
| 171 |
+
\fB\-\-bin\fR \fIname\fR\[u2026]
|
| 172 |
+
.RS 4
|
| 173 |
+
Fix the specified binary. This flag may be specified multiple times
|
| 174 |
+
and supports common Unix glob patterns.
|
| 175 |
+
.RE
|
| 176 |
+
.sp
|
| 177 |
+
\fB\-\-bins\fR
|
| 178 |
+
.RS 4
|
| 179 |
+
Fix all binary targets.
|
| 180 |
+
.RE
|
| 181 |
+
.sp
|
| 182 |
+
\fB\-\-example\fR \fIname\fR\[u2026]
|
| 183 |
+
.RS 4
|
| 184 |
+
Fix the specified example. This flag may be specified multiple times
|
| 185 |
+
and supports common Unix glob patterns.
|
| 186 |
+
.RE
|
| 187 |
+
.sp
|
| 188 |
+
\fB\-\-examples\fR
|
| 189 |
+
.RS 4
|
| 190 |
+
Fix all example targets.
|
| 191 |
+
.RE
|
| 192 |
+
.sp
|
| 193 |
+
\fB\-\-test\fR \fIname\fR\[u2026]
|
| 194 |
+
.RS 4
|
| 195 |
+
Fix the specified integration test. This flag may be specified
|
| 196 |
+
multiple times and supports common Unix glob patterns.
|
| 197 |
+
.RE
|
| 198 |
+
.sp
|
| 199 |
+
\fB\-\-tests\fR
|
| 200 |
+
.RS 4
|
| 201 |
+
Fix all targets that have the \fBtest = true\fR manifest
|
| 202 |
+
flag set. By default this includes the library and binaries built as
|
| 203 |
+
unittests, and integration tests. Be aware that this will also build any
|
| 204 |
+
required dependencies, so the lib target may be built twice (once as a
|
| 205 |
+
unittest, and once as a dependency for binaries, integration tests, etc.).
|
| 206 |
+
Targets may be enabled or disabled by setting the \fBtest\fR flag in the
|
| 207 |
+
manifest settings for the target.
|
| 208 |
+
.RE
|
| 209 |
+
.sp
|
| 210 |
+
\fB\-\-bench\fR \fIname\fR\[u2026]
|
| 211 |
+
.RS 4
|
| 212 |
+
Fix the specified benchmark. This flag may be specified multiple
|
| 213 |
+
times and supports common Unix glob patterns.
|
| 214 |
+
.RE
|
| 215 |
+
.sp
|
| 216 |
+
\fB\-\-benches\fR
|
| 217 |
+
.RS 4
|
| 218 |
+
Fix all targets that have the \fBbench = true\fR
|
| 219 |
+
manifest flag set. By default this includes the library and binaries built
|
| 220 |
+
as benchmarks, and bench targets. Be aware that this will also build any
|
| 221 |
+
required dependencies, so the lib target may be built twice (once as a
|
| 222 |
+
benchmark, and once as a dependency for binaries, benchmarks, etc.).
|
| 223 |
+
Targets may be enabled or disabled by setting the \fBbench\fR flag in the
|
| 224 |
+
manifest settings for the target.
|
| 225 |
+
.RE
|
| 226 |
+
.sp
|
| 227 |
+
\fB\-\-all\-targets\fR
|
| 228 |
+
.RS 4
|
| 229 |
+
Fix all targets. This is equivalent to specifying \fB\-\-lib \-\-bins \-\-tests \-\-benches \-\-examples\fR\&.
|
| 230 |
+
.RE
|
| 231 |
+
.SS "Feature Selection"
|
| 232 |
+
The feature flags allow you to control which features are enabled. When no
|
| 233 |
+
feature options are given, the \fBdefault\fR feature is activated for every
|
| 234 |
+
selected package.
|
| 235 |
+
.sp
|
| 236 |
+
See \fIthe features documentation\fR <https://doc.rust\-lang.org/cargo/reference/features.html#command\-line\-feature\-options>
|
| 237 |
+
for more details.
|
| 238 |
+
.sp
|
| 239 |
+
\fB\-F\fR \fIfeatures\fR,
|
| 240 |
+
\fB\-\-features\fR \fIfeatures\fR
|
| 241 |
+
.RS 4
|
| 242 |
+
Space or comma separated list of features to activate. Features of workspace
|
| 243 |
+
members may be enabled with \fBpackage\-name/feature\-name\fR syntax. This flag may
|
| 244 |
+
be specified multiple times, which enables all specified features.
|
| 245 |
+
.RE
|
| 246 |
+
.sp
|
| 247 |
+
\fB\-\-all\-features\fR
|
| 248 |
+
.RS 4
|
| 249 |
+
Activate all available features of all selected packages.
|
| 250 |
+
.RE
|
| 251 |
+
.sp
|
| 252 |
+
\fB\-\-no\-default\-features\fR
|
| 253 |
+
.RS 4
|
| 254 |
+
Do not activate the \fBdefault\fR feature of the selected packages.
|
| 255 |
+
.RE
|
| 256 |
+
.SS "Compilation Options"
|
| 257 |
+
.sp
|
| 258 |
+
\fB\-\-target\fR \fItriple\fR
|
| 259 |
+
.RS 4
|
| 260 |
+
Fix for the specified target architecture. Flag may be specified multiple times. The default is the host architecture. The general format of the triple is
|
| 261 |
+
\fB<arch><sub>\-<vendor>\-<sys>\-<abi>\fR\&.
|
| 262 |
+
.sp
|
| 263 |
+
Possible values:
|
| 264 |
+
.sp
|
| 265 |
+
.RS 4
|
| 266 |
+
\h'-04'\(bu\h'+03'Any supported target in \fBrustc \-\-print target\-list\fR\&.
|
| 267 |
+
.RE
|
| 268 |
+
.sp
|
| 269 |
+
.RS 4
|
| 270 |
+
\h'-04'\(bu\h'+03'\fB"host\-tuple"\fR, which will internally be substituted by the host\[cq]s target. This can be particularly useful if you\[cq]re cross\-compiling some crates, and don\[cq]t want to specify your host\[cq]s machine as a target (for instance, an \fBxtask\fR in a shared project that may be worked on by many hosts).
|
| 271 |
+
.RE
|
| 272 |
+
.sp
|
| 273 |
+
.RS 4
|
| 274 |
+
\h'-04'\(bu\h'+03'A path to a custom target specification. See \fICustom Target Lookup Path\fR <https://doc.rust\-lang.org/rustc/targets/custom.html#custom\-target\-lookup\-path> for more information.
|
| 275 |
+
.RE
|
| 276 |
+
.sp
|
| 277 |
+
This may also be specified with the \fBbuild.target\fR \fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 278 |
+
.sp
|
| 279 |
+
Note that specifying this flag makes Cargo run in a different mode where the
|
| 280 |
+
target artifacts are placed in a separate directory. See the
|
| 281 |
+
\fIbuild cache\fR <https://doc.rust\-lang.org/cargo/reference/build\-cache.html> documentation for more details.
|
| 282 |
+
.RE
|
| 283 |
+
.sp
|
| 284 |
+
\fB\-r\fR,
|
| 285 |
+
\fB\-\-release\fR
|
| 286 |
+
.RS 4
|
| 287 |
+
Fix optimized artifacts with the \fBrelease\fR profile.
|
| 288 |
+
See also the \fB\-\-profile\fR option for choosing a specific profile by name.
|
| 289 |
+
.RE
|
| 290 |
+
.sp
|
| 291 |
+
\fB\-\-profile\fR \fIname\fR
|
| 292 |
+
.RS 4
|
| 293 |
+
Fix with the given profile.
|
| 294 |
+
.sp
|
| 295 |
+
As a special case, specifying the \fBtest\fR profile will also enable checking in
|
| 296 |
+
test mode which will enable checking tests and enable the \fBtest\fR cfg option.
|
| 297 |
+
See \fIrustc tests\fR <https://doc.rust\-lang.org/rustc/tests/index.html> for more
|
| 298 |
+
detail.
|
| 299 |
+
.sp
|
| 300 |
+
See \fIthe reference\fR <https://doc.rust\-lang.org/cargo/reference/profiles.html> for more details on profiles.
|
| 301 |
+
.RE
|
| 302 |
+
.sp
|
| 303 |
+
\fB\-\-timings\fR
|
| 304 |
+
.RS 4
|
| 305 |
+
Output information how long each compilation takes, and track concurrency
|
| 306 |
+
information over time.
|
| 307 |
+
.sp
|
| 308 |
+
A file \fBcargo\-timing.html\fR will be written to the \fBtarget/cargo\-timings\fR
|
| 309 |
+
directory at the end of the build. An additional report with a timestamp
|
| 310 |
+
in its filename is also written if you want to look at a previous run.
|
| 311 |
+
These reports are suitable for human consumption only, and do not provide
|
| 312 |
+
machine\-readable timing data.
|
| 313 |
+
.RE
|
| 314 |
+
.SS "Output Options"
|
| 315 |
+
.sp
|
| 316 |
+
\fB\-\-target\-dir\fR \fIdirectory\fR
|
| 317 |
+
.RS 4
|
| 318 |
+
Directory for all generated artifacts and intermediate files. May also be
|
| 319 |
+
specified with the \fBCARGO_TARGET_DIR\fR environment variable, or the
|
| 320 |
+
\fBbuild.target\-dir\fR \fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 321 |
+
Defaults to \fBtarget\fR in the root of the workspace.
|
| 322 |
+
.RE
|
| 323 |
+
.SS "Display Options"
|
| 324 |
+
.sp
|
| 325 |
+
\fB\-v\fR,
|
| 326 |
+
\fB\-\-verbose\fR
|
| 327 |
+
.RS 4
|
| 328 |
+
Use verbose output. May be specified twice for \[lq]very verbose\[rq] output which
|
| 329 |
+
includes extra output such as dependency warnings and build script output.
|
| 330 |
+
May also be specified with the \fBterm.verbose\fR
|
| 331 |
+
\fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 332 |
+
.RE
|
| 333 |
+
.sp
|
| 334 |
+
\fB\-q\fR,
|
| 335 |
+
\fB\-\-quiet\fR
|
| 336 |
+
.RS 4
|
| 337 |
+
Do not print cargo log messages.
|
| 338 |
+
May also be specified with the \fBterm.quiet\fR
|
| 339 |
+
\fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 340 |
+
.RE
|
| 341 |
+
.sp
|
| 342 |
+
\fB\-\-color\fR \fIwhen\fR
|
| 343 |
+
.RS 4
|
| 344 |
+
Control when colored output is used. Valid values:
|
| 345 |
+
.sp
|
| 346 |
+
.RS 4
|
| 347 |
+
\h'-04'\(bu\h'+03'\fBauto\fR (default): Automatically detect if color support is available on the
|
| 348 |
+
terminal.
|
| 349 |
+
.RE
|
| 350 |
+
.sp
|
| 351 |
+
.RS 4
|
| 352 |
+
\h'-04'\(bu\h'+03'\fBalways\fR: Always display colors.
|
| 353 |
+
.RE
|
| 354 |
+
.sp
|
| 355 |
+
.RS 4
|
| 356 |
+
\h'-04'\(bu\h'+03'\fBnever\fR: Never display colors.
|
| 357 |
+
.RE
|
| 358 |
+
.sp
|
| 359 |
+
May also be specified with the \fBterm.color\fR
|
| 360 |
+
\fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 361 |
+
.RE
|
| 362 |
+
.sp
|
| 363 |
+
\fB\-\-message\-format\fR \fIfmt\fR
|
| 364 |
+
.RS 4
|
| 365 |
+
The output format for diagnostic messages. Can be specified multiple times
|
| 366 |
+
and consists of comma\-separated values. Valid values:
|
| 367 |
+
.sp
|
| 368 |
+
.RS 4
|
| 369 |
+
\h'-04'\(bu\h'+03'\fBhuman\fR (default): Display in a human\-readable text format. Conflicts with
|
| 370 |
+
\fBshort\fR and \fBjson\fR\&.
|
| 371 |
+
.RE
|
| 372 |
+
.sp
|
| 373 |
+
.RS 4
|
| 374 |
+
\h'-04'\(bu\h'+03'\fBshort\fR: Emit shorter, human\-readable text messages. Conflicts with \fBhuman\fR
|
| 375 |
+
and \fBjson\fR\&.
|
| 376 |
+
.RE
|
| 377 |
+
.sp
|
| 378 |
+
.RS 4
|
| 379 |
+
\h'-04'\(bu\h'+03'\fBjson\fR: Emit JSON messages to stdout. See
|
| 380 |
+
\fIthe reference\fR <https://doc.rust\-lang.org/cargo/reference/external\-tools.html#json\-messages>
|
| 381 |
+
for more details. Conflicts with \fBhuman\fR and \fBshort\fR\&.
|
| 382 |
+
.RE
|
| 383 |
+
.sp
|
| 384 |
+
.RS 4
|
| 385 |
+
\h'-04'\(bu\h'+03'\fBjson\-diagnostic\-short\fR: Ensure the \fBrendered\fR field of JSON messages contains
|
| 386 |
+
the \[lq]short\[rq] rendering from rustc. Cannot be used with \fBhuman\fR or \fBshort\fR\&.
|
| 387 |
+
.RE
|
| 388 |
+
.sp
|
| 389 |
+
.RS 4
|
| 390 |
+
\h'-04'\(bu\h'+03'\fBjson\-diagnostic\-rendered\-ansi\fR: Ensure the \fBrendered\fR field of JSON messages
|
| 391 |
+
contains embedded ANSI color codes for respecting rustc\[cq]s default color
|
| 392 |
+
scheme. Cannot be used with \fBhuman\fR or \fBshort\fR\&.
|
| 393 |
+
.RE
|
| 394 |
+
.sp
|
| 395 |
+
.RS 4
|
| 396 |
+
\h'-04'\(bu\h'+03'\fBjson\-render\-diagnostics\fR: Instruct Cargo to not include rustc diagnostics
|
| 397 |
+
in JSON messages printed, but instead Cargo itself should render the
|
| 398 |
+
JSON diagnostics coming from rustc. Cargo\[cq]s own JSON diagnostics and others
|
| 399 |
+
coming from rustc are still emitted. Cannot be used with \fBhuman\fR or \fBshort\fR\&.
|
| 400 |
+
.RE
|
| 401 |
+
.RE
|
| 402 |
+
.SS "Manifest Options"
|
| 403 |
+
.sp
|
| 404 |
+
\fB\-\-manifest\-path\fR \fIpath\fR
|
| 405 |
+
.RS 4
|
| 406 |
+
Path to the \fBCargo.toml\fR file. By default, Cargo searches for the
|
| 407 |
+
\fBCargo.toml\fR file in the current directory or any parent directory.
|
| 408 |
+
.RE
|
| 409 |
+
.sp
|
| 410 |
+
\fB\-\-ignore\-rust\-version\fR
|
| 411 |
+
.RS 4
|
| 412 |
+
Ignore \fBrust\-version\fR specification in packages.
|
| 413 |
+
.RE
|
| 414 |
+
.sp
|
| 415 |
+
\fB\-\-locked\fR
|
| 416 |
+
.RS 4
|
| 417 |
+
Asserts that the exact same dependencies and versions are used as when the
|
| 418 |
+
existing \fBCargo.lock\fR file was originally generated. Cargo will exit with an
|
| 419 |
+
error when either of the following scenarios arises:
|
| 420 |
+
.sp
|
| 421 |
+
.RS 4
|
| 422 |
+
\h'-04'\(bu\h'+03'The lock file is missing.
|
| 423 |
+
.RE
|
| 424 |
+
.sp
|
| 425 |
+
.RS 4
|
| 426 |
+
\h'-04'\(bu\h'+03'Cargo attempted to change the lock file due to a different dependency resolution.
|
| 427 |
+
.RE
|
| 428 |
+
.sp
|
| 429 |
+
It may be used in environments where deterministic builds are desired,
|
| 430 |
+
such as in CI pipelines.
|
| 431 |
+
.RE
|
| 432 |
+
.sp
|
| 433 |
+
\fB\-\-offline\fR
|
| 434 |
+
.RS 4
|
| 435 |
+
Prevents Cargo from accessing the network for any reason. Without this
|
| 436 |
+
flag, Cargo will stop with an error if it needs to access the network and
|
| 437 |
+
the network is not available. With this flag, Cargo will attempt to
|
| 438 |
+
proceed without the network if possible.
|
| 439 |
+
.sp
|
| 440 |
+
Beware that this may result in different dependency resolution than online
|
| 441 |
+
mode. Cargo will restrict itself to crates that are downloaded locally, even
|
| 442 |
+
if there might be a newer version as indicated in the local copy of the index.
|
| 443 |
+
See the \fBcargo\-fetch\fR(1) command to download dependencies before going
|
| 444 |
+
offline.
|
| 445 |
+
.sp
|
| 446 |
+
May also be specified with the \fBnet.offline\fR \fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 447 |
+
.RE
|
| 448 |
+
.sp
|
| 449 |
+
\fB\-\-frozen\fR
|
| 450 |
+
.RS 4
|
| 451 |
+
Equivalent to specifying both \fB\-\-locked\fR and \fB\-\-offline\fR\&.
|
| 452 |
+
.RE
|
| 453 |
+
.SS "Common Options"
|
| 454 |
+
.sp
|
| 455 |
+
\fB+\fR\fItoolchain\fR
|
| 456 |
+
.RS 4
|
| 457 |
+
If Cargo has been installed with rustup, and the first argument to \fBcargo\fR
|
| 458 |
+
begins with \fB+\fR, it will be interpreted as a rustup toolchain name (such
|
| 459 |
+
as \fB+stable\fR or \fB+nightly\fR).
|
| 460 |
+
See the \fIrustup documentation\fR <https://rust\-lang.github.io/rustup/overrides.html>
|
| 461 |
+
for more information about how toolchain overrides work.
|
| 462 |
+
.RE
|
| 463 |
+
.sp
|
| 464 |
+
\fB\-\-config\fR \fIKEY=VALUE\fR or \fIPATH\fR
|
| 465 |
+
.RS 4
|
| 466 |
+
Overrides a Cargo configuration value. The argument should be in TOML syntax of \fBKEY=VALUE\fR,
|
| 467 |
+
or provided as a path to an extra configuration file. This flag may be specified multiple times.
|
| 468 |
+
See the \fIcommand\-line overrides section\fR <https://doc.rust\-lang.org/cargo/reference/config.html#command\-line\-overrides> for more information.
|
| 469 |
+
.RE
|
| 470 |
+
.sp
|
| 471 |
+
\fB\-C\fR \fIPATH\fR
|
| 472 |
+
.RS 4
|
| 473 |
+
Changes the current working directory before executing any specified operations. This affects
|
| 474 |
+
things like where cargo looks by default for the project manifest (\fBCargo.toml\fR), as well as
|
| 475 |
+
the directories searched for discovering \fB\&.cargo/config.toml\fR, for example. This option must
|
| 476 |
+
appear before the command name, for example \fBcargo \-C path/to/my\-project build\fR\&.
|
| 477 |
+
.sp
|
| 478 |
+
This option is only available on the \fInightly
|
| 479 |
+
channel\fR <https://doc.rust\-lang.org/book/appendix\-07\-nightly\-rust.html> and
|
| 480 |
+
requires the \fB\-Z unstable\-options\fR flag to enable (see
|
| 481 |
+
\fI#10098\fR <https://github.com/rust\-lang/cargo/issues/10098>).
|
| 482 |
+
.RE
|
| 483 |
+
.sp
|
| 484 |
+
\fB\-h\fR,
|
| 485 |
+
\fB\-\-help\fR
|
| 486 |
+
.RS 4
|
| 487 |
+
Prints help information.
|
| 488 |
+
.RE
|
| 489 |
+
.sp
|
| 490 |
+
\fB\-Z\fR \fIflag\fR
|
| 491 |
+
.RS 4
|
| 492 |
+
Unstable (nightly\-only) flags to Cargo. Run \fBcargo \-Z help\fR for details.
|
| 493 |
+
.RE
|
| 494 |
+
.SS "Miscellaneous Options"
|
| 495 |
+
.sp
|
| 496 |
+
\fB\-j\fR \fIN\fR,
|
| 497 |
+
\fB\-\-jobs\fR \fIN\fR
|
| 498 |
+
.RS 4
|
| 499 |
+
Number of parallel jobs to run. May also be specified with the
|
| 500 |
+
\fBbuild.jobs\fR \fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&. Defaults to
|
| 501 |
+
the number of logical CPUs. If negative, it sets the maximum number of
|
| 502 |
+
parallel jobs to the number of logical CPUs plus provided value. If
|
| 503 |
+
a string \fBdefault\fR is provided, it sets the value back to defaults.
|
| 504 |
+
Should not be 0.
|
| 505 |
+
.RE
|
| 506 |
+
.sp
|
| 507 |
+
\fB\-\-keep\-going\fR
|
| 508 |
+
.RS 4
|
| 509 |
+
Build as many crates in the dependency graph as possible, rather than aborting
|
| 510 |
+
the build on the first one that fails to build.
|
| 511 |
+
.sp
|
| 512 |
+
For example if the current package depends on dependencies \fBfails\fR and \fBworks\fR,
|
| 513 |
+
one of which fails to build, \fBcargo fix \-j1\fR may or may not build the
|
| 514 |
+
one that succeeds (depending on which one of the two builds Cargo picked to run
|
| 515 |
+
first), whereas \fBcargo fix \-j1 \-\-keep\-going\fR would definitely run both
|
| 516 |
+
builds, even if the one run first fails.
|
| 517 |
+
.RE
|
| 518 |
+
.SH "ENVIRONMENT"
|
| 519 |
+
See \fIthe reference\fR <https://doc.rust\-lang.org/cargo/reference/environment\-variables.html> for
|
| 520 |
+
details on environment variables that Cargo reads.
|
| 521 |
+
.SH "EXIT STATUS"
|
| 522 |
+
.sp
|
| 523 |
+
.RS 4
|
| 524 |
+
\h'-04'\(bu\h'+03'\fB0\fR: Cargo succeeded.
|
| 525 |
+
.RE
|
| 526 |
+
.sp
|
| 527 |
+
.RS 4
|
| 528 |
+
\h'-04'\(bu\h'+03'\fB101\fR: Cargo failed to complete.
|
| 529 |
+
.RE
|
| 530 |
+
.SH "EXAMPLES"
|
| 531 |
+
.sp
|
| 532 |
+
.RS 4
|
| 533 |
+
\h'-04' 1.\h'+01'Apply compiler suggestions to the local package:
|
| 534 |
+
.sp
|
| 535 |
+
.RS 4
|
| 536 |
+
.nf
|
| 537 |
+
cargo fix
|
| 538 |
+
.fi
|
| 539 |
+
.RE
|
| 540 |
+
.RE
|
| 541 |
+
.sp
|
| 542 |
+
.RS 4
|
| 543 |
+
\h'-04' 2.\h'+01'Update a package to prepare it for the next edition:
|
| 544 |
+
.sp
|
| 545 |
+
.RS 4
|
| 546 |
+
.nf
|
| 547 |
+
cargo fix \-\-edition
|
| 548 |
+
.fi
|
| 549 |
+
.RE
|
| 550 |
+
.RE
|
| 551 |
+
.sp
|
| 552 |
+
.RS 4
|
| 553 |
+
\h'-04' 3.\h'+01'Apply suggested idioms for the current edition:
|
| 554 |
+
.sp
|
| 555 |
+
.RS 4
|
| 556 |
+
.nf
|
| 557 |
+
cargo fix \-\-edition\-idioms
|
| 558 |
+
.fi
|
| 559 |
+
.RE
|
| 560 |
+
.RE
|
| 561 |
+
.SH "SEE ALSO"
|
| 562 |
+
\fBcargo\fR(1), \fBcargo\-check\fR(1)
|
rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-generate-lockfile.1
ADDED
|
@@ -0,0 +1,192 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
'\" t
|
| 2 |
+
.TH "CARGO\-GENERATE\-LOCKFILE" "1"
|
| 3 |
+
.nh
|
| 4 |
+
.ad l
|
| 5 |
+
.ss \n[.ss] 0
|
| 6 |
+
.SH "NAME"
|
| 7 |
+
cargo\-generate\-lockfile \[em] Generate the lockfile for a package
|
| 8 |
+
.SH "SYNOPSIS"
|
| 9 |
+
\fBcargo generate\-lockfile\fR [\fIoptions\fR]
|
| 10 |
+
.SH "DESCRIPTION"
|
| 11 |
+
This command will create the \fBCargo.lock\fR lockfile for the current package or
|
| 12 |
+
workspace. If the lockfile already exists, it will be rebuilt with the latest
|
| 13 |
+
available version of every package.
|
| 14 |
+
.sp
|
| 15 |
+
See also \fBcargo\-update\fR(1) which is also capable of creating a \fBCargo.lock\fR
|
| 16 |
+
lockfile and has more options for controlling update behavior.
|
| 17 |
+
.SH "OPTIONS"
|
| 18 |
+
.SS "Display Options"
|
| 19 |
+
.sp
|
| 20 |
+
\fB\-v\fR,
|
| 21 |
+
\fB\-\-verbose\fR
|
| 22 |
+
.RS 4
|
| 23 |
+
Use verbose output. May be specified twice for \[lq]very verbose\[rq] output which
|
| 24 |
+
includes extra output such as dependency warnings and build script output.
|
| 25 |
+
May also be specified with the \fBterm.verbose\fR
|
| 26 |
+
\fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 27 |
+
.RE
|
| 28 |
+
.sp
|
| 29 |
+
\fB\-q\fR,
|
| 30 |
+
\fB\-\-quiet\fR
|
| 31 |
+
.RS 4
|
| 32 |
+
Do not print cargo log messages.
|
| 33 |
+
May also be specified with the \fBterm.quiet\fR
|
| 34 |
+
\fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 35 |
+
.RE
|
| 36 |
+
.sp
|
| 37 |
+
\fB\-\-color\fR \fIwhen\fR
|
| 38 |
+
.RS 4
|
| 39 |
+
Control when colored output is used. Valid values:
|
| 40 |
+
.sp
|
| 41 |
+
.RS 4
|
| 42 |
+
\h'-04'\(bu\h'+03'\fBauto\fR (default): Automatically detect if color support is available on the
|
| 43 |
+
terminal.
|
| 44 |
+
.RE
|
| 45 |
+
.sp
|
| 46 |
+
.RS 4
|
| 47 |
+
\h'-04'\(bu\h'+03'\fBalways\fR: Always display colors.
|
| 48 |
+
.RE
|
| 49 |
+
.sp
|
| 50 |
+
.RS 4
|
| 51 |
+
\h'-04'\(bu\h'+03'\fBnever\fR: Never display colors.
|
| 52 |
+
.RE
|
| 53 |
+
.sp
|
| 54 |
+
May also be specified with the \fBterm.color\fR
|
| 55 |
+
\fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 56 |
+
.RE
|
| 57 |
+
.SS "Manifest Options"
|
| 58 |
+
.sp
|
| 59 |
+
\fB\-\-manifest\-path\fR \fIpath\fR
|
| 60 |
+
.RS 4
|
| 61 |
+
Path to the \fBCargo.toml\fR file. By default, Cargo searches for the
|
| 62 |
+
\fBCargo.toml\fR file in the current directory or any parent directory.
|
| 63 |
+
.RE
|
| 64 |
+
.sp
|
| 65 |
+
\fB\-\-ignore\-rust\-version\fR
|
| 66 |
+
.RS 4
|
| 67 |
+
Ignore \fBrust\-version\fR specification in packages.
|
| 68 |
+
.RE
|
| 69 |
+
.sp
|
| 70 |
+
\fB\-\-publish\-time\fR \fIyyyy\-mm\-ddThh:mm:ssZ\fR
|
| 71 |
+
.RS 4
|
| 72 |
+
Latest publish time allowed for registry packages (Unstable)
|
| 73 |
+
.sp
|
| 74 |
+
This is a best\-effort filter on allowed packages, including:
|
| 75 |
+
.sp
|
| 76 |
+
.RS 4
|
| 77 |
+
\h'-04'\(bu\h'+03'packages from unsupported registries are always accepted
|
| 78 |
+
.RE
|
| 79 |
+
.sp
|
| 80 |
+
.RS 4
|
| 81 |
+
\h'-04'\(bu\h'+03'only the current yank state is respected, not the state as of \fB\-\-publish\-time\fR
|
| 82 |
+
.RE
|
| 83 |
+
.sp
|
| 84 |
+
.RS 4
|
| 85 |
+
\h'-04'\(bu\h'+03'precision of the publish time
|
| 86 |
+
.RE
|
| 87 |
+
.RE
|
| 88 |
+
.sp
|
| 89 |
+
\fB\-\-locked\fR
|
| 90 |
+
.RS 4
|
| 91 |
+
Asserts that the exact same dependencies and versions are used as when the
|
| 92 |
+
existing \fBCargo.lock\fR file was originally generated. Cargo will exit with an
|
| 93 |
+
error when either of the following scenarios arises:
|
| 94 |
+
.sp
|
| 95 |
+
.RS 4
|
| 96 |
+
\h'-04'\(bu\h'+03'The lock file is missing.
|
| 97 |
+
.RE
|
| 98 |
+
.sp
|
| 99 |
+
.RS 4
|
| 100 |
+
\h'-04'\(bu\h'+03'Cargo attempted to change the lock file due to a different dependency resolution.
|
| 101 |
+
.RE
|
| 102 |
+
.sp
|
| 103 |
+
It may be used in environments where deterministic builds are desired,
|
| 104 |
+
such as in CI pipelines.
|
| 105 |
+
.RE
|
| 106 |
+
.sp
|
| 107 |
+
\fB\-\-offline\fR
|
| 108 |
+
.RS 4
|
| 109 |
+
Prevents Cargo from accessing the network for any reason. Without this
|
| 110 |
+
flag, Cargo will stop with an error if it needs to access the network and
|
| 111 |
+
the network is not available. With this flag, Cargo will attempt to
|
| 112 |
+
proceed without the network if possible.
|
| 113 |
+
.sp
|
| 114 |
+
Beware that this may result in different dependency resolution than online
|
| 115 |
+
mode. Cargo will restrict itself to crates that are downloaded locally, even
|
| 116 |
+
if there might be a newer version as indicated in the local copy of the index.
|
| 117 |
+
See the \fBcargo\-fetch\fR(1) command to download dependencies before going
|
| 118 |
+
offline.
|
| 119 |
+
.sp
|
| 120 |
+
May also be specified with the \fBnet.offline\fR \fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 121 |
+
.RE
|
| 122 |
+
.sp
|
| 123 |
+
\fB\-\-frozen\fR
|
| 124 |
+
.RS 4
|
| 125 |
+
Equivalent to specifying both \fB\-\-locked\fR and \fB\-\-offline\fR\&.
|
| 126 |
+
.RE
|
| 127 |
+
.SS "Common Options"
|
| 128 |
+
.sp
|
| 129 |
+
\fB+\fR\fItoolchain\fR
|
| 130 |
+
.RS 4
|
| 131 |
+
If Cargo has been installed with rustup, and the first argument to \fBcargo\fR
|
| 132 |
+
begins with \fB+\fR, it will be interpreted as a rustup toolchain name (such
|
| 133 |
+
as \fB+stable\fR or \fB+nightly\fR).
|
| 134 |
+
See the \fIrustup documentation\fR <https://rust\-lang.github.io/rustup/overrides.html>
|
| 135 |
+
for more information about how toolchain overrides work.
|
| 136 |
+
.RE
|
| 137 |
+
.sp
|
| 138 |
+
\fB\-\-config\fR \fIKEY=VALUE\fR or \fIPATH\fR
|
| 139 |
+
.RS 4
|
| 140 |
+
Overrides a Cargo configuration value. The argument should be in TOML syntax of \fBKEY=VALUE\fR,
|
| 141 |
+
or provided as a path to an extra configuration file. This flag may be specified multiple times.
|
| 142 |
+
See the \fIcommand\-line overrides section\fR <https://doc.rust\-lang.org/cargo/reference/config.html#command\-line\-overrides> for more information.
|
| 143 |
+
.RE
|
| 144 |
+
.sp
|
| 145 |
+
\fB\-C\fR \fIPATH\fR
|
| 146 |
+
.RS 4
|
| 147 |
+
Changes the current working directory before executing any specified operations. This affects
|
| 148 |
+
things like where cargo looks by default for the project manifest (\fBCargo.toml\fR), as well as
|
| 149 |
+
the directories searched for discovering \fB\&.cargo/config.toml\fR, for example. This option must
|
| 150 |
+
appear before the command name, for example \fBcargo \-C path/to/my\-project build\fR\&.
|
| 151 |
+
.sp
|
| 152 |
+
This option is only available on the \fInightly
|
| 153 |
+
channel\fR <https://doc.rust\-lang.org/book/appendix\-07\-nightly\-rust.html> and
|
| 154 |
+
requires the \fB\-Z unstable\-options\fR flag to enable (see
|
| 155 |
+
\fI#10098\fR <https://github.com/rust\-lang/cargo/issues/10098>).
|
| 156 |
+
.RE
|
| 157 |
+
.sp
|
| 158 |
+
\fB\-h\fR,
|
| 159 |
+
\fB\-\-help\fR
|
| 160 |
+
.RS 4
|
| 161 |
+
Prints help information.
|
| 162 |
+
.RE
|
| 163 |
+
.sp
|
| 164 |
+
\fB\-Z\fR \fIflag\fR
|
| 165 |
+
.RS 4
|
| 166 |
+
Unstable (nightly\-only) flags to Cargo. Run \fBcargo \-Z help\fR for details.
|
| 167 |
+
.RE
|
| 168 |
+
.SH "ENVIRONMENT"
|
| 169 |
+
See \fIthe reference\fR <https://doc.rust\-lang.org/cargo/reference/environment\-variables.html> for
|
| 170 |
+
details on environment variables that Cargo reads.
|
| 171 |
+
.SH "EXIT STATUS"
|
| 172 |
+
.sp
|
| 173 |
+
.RS 4
|
| 174 |
+
\h'-04'\(bu\h'+03'\fB0\fR: Cargo succeeded.
|
| 175 |
+
.RE
|
| 176 |
+
.sp
|
| 177 |
+
.RS 4
|
| 178 |
+
\h'-04'\(bu\h'+03'\fB101\fR: Cargo failed to complete.
|
| 179 |
+
.RE
|
| 180 |
+
.SH "EXAMPLES"
|
| 181 |
+
.sp
|
| 182 |
+
.RS 4
|
| 183 |
+
\h'-04' 1.\h'+01'Create or update the lockfile for the current package or workspace:
|
| 184 |
+
.sp
|
| 185 |
+
.RS 4
|
| 186 |
+
.nf
|
| 187 |
+
cargo generate\-lockfile
|
| 188 |
+
.fi
|
| 189 |
+
.RE
|
| 190 |
+
.RE
|
| 191 |
+
.SH "SEE ALSO"
|
| 192 |
+
\fBcargo\fR(1), \fBcargo\-update\fR(1)
|
rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-help.1
ADDED
|
@@ -0,0 +1,167 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
'\" t
|
| 2 |
+
.TH "CARGO\-HELP" "1"
|
| 3 |
+
.nh
|
| 4 |
+
.ad l
|
| 5 |
+
.ss \n[.ss] 0
|
| 6 |
+
.SH "NAME"
|
| 7 |
+
cargo\-help \[em] Get help for a Cargo command
|
| 8 |
+
.SH "SYNOPSIS"
|
| 9 |
+
\fBcargo help\fR [\fIsubcommand\fR]
|
| 10 |
+
.SH "DESCRIPTION"
|
| 11 |
+
Prints a help message for the given command.
|
| 12 |
+
.SH "OPTIONS"
|
| 13 |
+
.SS "Display Options"
|
| 14 |
+
.sp
|
| 15 |
+
\fB\-v\fR,
|
| 16 |
+
\fB\-\-verbose\fR
|
| 17 |
+
.RS 4
|
| 18 |
+
Use verbose output. May be specified twice for \[lq]very verbose\[rq] output which
|
| 19 |
+
includes extra output such as dependency warnings and build script output.
|
| 20 |
+
May also be specified with the \fBterm.verbose\fR
|
| 21 |
+
\fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 22 |
+
.RE
|
| 23 |
+
.sp
|
| 24 |
+
\fB\-q\fR,
|
| 25 |
+
\fB\-\-quiet\fR
|
| 26 |
+
.RS 4
|
| 27 |
+
Do not print cargo log messages.
|
| 28 |
+
May also be specified with the \fBterm.quiet\fR
|
| 29 |
+
\fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 30 |
+
.RE
|
| 31 |
+
.sp
|
| 32 |
+
\fB\-\-color\fR \fIwhen\fR
|
| 33 |
+
.RS 4
|
| 34 |
+
Control when colored output is used. Valid values:
|
| 35 |
+
.sp
|
| 36 |
+
.RS 4
|
| 37 |
+
\h'-04'\(bu\h'+03'\fBauto\fR (default): Automatically detect if color support is available on the
|
| 38 |
+
terminal.
|
| 39 |
+
.RE
|
| 40 |
+
.sp
|
| 41 |
+
.RS 4
|
| 42 |
+
\h'-04'\(bu\h'+03'\fBalways\fR: Always display colors.
|
| 43 |
+
.RE
|
| 44 |
+
.sp
|
| 45 |
+
.RS 4
|
| 46 |
+
\h'-04'\(bu\h'+03'\fBnever\fR: Never display colors.
|
| 47 |
+
.RE
|
| 48 |
+
.sp
|
| 49 |
+
May also be specified with the \fBterm.color\fR
|
| 50 |
+
\fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 51 |
+
.RE
|
| 52 |
+
.SS "Manifest Options"
|
| 53 |
+
.sp
|
| 54 |
+
\fB\-\-locked\fR
|
| 55 |
+
.RS 4
|
| 56 |
+
Asserts that the exact same dependencies and versions are used as when the
|
| 57 |
+
existing \fBCargo.lock\fR file was originally generated. Cargo will exit with an
|
| 58 |
+
error when either of the following scenarios arises:
|
| 59 |
+
.sp
|
| 60 |
+
.RS 4
|
| 61 |
+
\h'-04'\(bu\h'+03'The lock file is missing.
|
| 62 |
+
.RE
|
| 63 |
+
.sp
|
| 64 |
+
.RS 4
|
| 65 |
+
\h'-04'\(bu\h'+03'Cargo attempted to change the lock file due to a different dependency resolution.
|
| 66 |
+
.RE
|
| 67 |
+
.sp
|
| 68 |
+
It may be used in environments where deterministic builds are desired,
|
| 69 |
+
such as in CI pipelines.
|
| 70 |
+
.RE
|
| 71 |
+
.sp
|
| 72 |
+
\fB\-\-offline\fR
|
| 73 |
+
.RS 4
|
| 74 |
+
Prevents Cargo from accessing the network for any reason. Without this
|
| 75 |
+
flag, Cargo will stop with an error if it needs to access the network and
|
| 76 |
+
the network is not available. With this flag, Cargo will attempt to
|
| 77 |
+
proceed without the network if possible.
|
| 78 |
+
.sp
|
| 79 |
+
Beware that this may result in different dependency resolution than online
|
| 80 |
+
mode. Cargo will restrict itself to crates that are downloaded locally, even
|
| 81 |
+
if there might be a newer version as indicated in the local copy of the index.
|
| 82 |
+
See the \fBcargo\-fetch\fR(1) command to download dependencies before going
|
| 83 |
+
offline.
|
| 84 |
+
.sp
|
| 85 |
+
May also be specified with the \fBnet.offline\fR \fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 86 |
+
.RE
|
| 87 |
+
.sp
|
| 88 |
+
\fB\-\-frozen\fR
|
| 89 |
+
.RS 4
|
| 90 |
+
Equivalent to specifying both \fB\-\-locked\fR and \fB\-\-offline\fR\&.
|
| 91 |
+
.RE
|
| 92 |
+
.SS "Common Options"
|
| 93 |
+
.sp
|
| 94 |
+
\fB+\fR\fItoolchain\fR
|
| 95 |
+
.RS 4
|
| 96 |
+
If Cargo has been installed with rustup, and the first argument to \fBcargo\fR
|
| 97 |
+
begins with \fB+\fR, it will be interpreted as a rustup toolchain name (such
|
| 98 |
+
as \fB+stable\fR or \fB+nightly\fR).
|
| 99 |
+
See the \fIrustup documentation\fR <https://rust\-lang.github.io/rustup/overrides.html>
|
| 100 |
+
for more information about how toolchain overrides work.
|
| 101 |
+
.RE
|
| 102 |
+
.sp
|
| 103 |
+
\fB\-\-config\fR \fIKEY=VALUE\fR or \fIPATH\fR
|
| 104 |
+
.RS 4
|
| 105 |
+
Overrides a Cargo configuration value. The argument should be in TOML syntax of \fBKEY=VALUE\fR,
|
| 106 |
+
or provided as a path to an extra configuration file. This flag may be specified multiple times.
|
| 107 |
+
See the \fIcommand\-line overrides section\fR <https://doc.rust\-lang.org/cargo/reference/config.html#command\-line\-overrides> for more information.
|
| 108 |
+
.RE
|
| 109 |
+
.sp
|
| 110 |
+
\fB\-C\fR \fIPATH\fR
|
| 111 |
+
.RS 4
|
| 112 |
+
Changes the current working directory before executing any specified operations. This affects
|
| 113 |
+
things like where cargo looks by default for the project manifest (\fBCargo.toml\fR), as well as
|
| 114 |
+
the directories searched for discovering \fB\&.cargo/config.toml\fR, for example. This option must
|
| 115 |
+
appear before the command name, for example \fBcargo \-C path/to/my\-project build\fR\&.
|
| 116 |
+
.sp
|
| 117 |
+
This option is only available on the \fInightly
|
| 118 |
+
channel\fR <https://doc.rust\-lang.org/book/appendix\-07\-nightly\-rust.html> and
|
| 119 |
+
requires the \fB\-Z unstable\-options\fR flag to enable (see
|
| 120 |
+
\fI#10098\fR <https://github.com/rust\-lang/cargo/issues/10098>).
|
| 121 |
+
.RE
|
| 122 |
+
.sp
|
| 123 |
+
\fB\-h\fR,
|
| 124 |
+
\fB\-\-help\fR
|
| 125 |
+
.RS 4
|
| 126 |
+
Prints help information.
|
| 127 |
+
.RE
|
| 128 |
+
.sp
|
| 129 |
+
\fB\-Z\fR \fIflag\fR
|
| 130 |
+
.RS 4
|
| 131 |
+
Unstable (nightly\-only) flags to Cargo. Run \fBcargo \-Z help\fR for details.
|
| 132 |
+
.RE
|
| 133 |
+
.SH "ENVIRONMENT"
|
| 134 |
+
See \fIthe reference\fR <https://doc.rust\-lang.org/cargo/reference/environment\-variables.html> for
|
| 135 |
+
details on environment variables that Cargo reads.
|
| 136 |
+
.SH "EXIT STATUS"
|
| 137 |
+
.sp
|
| 138 |
+
.RS 4
|
| 139 |
+
\h'-04'\(bu\h'+03'\fB0\fR: Cargo succeeded.
|
| 140 |
+
.RE
|
| 141 |
+
.sp
|
| 142 |
+
.RS 4
|
| 143 |
+
\h'-04'\(bu\h'+03'\fB101\fR: Cargo failed to complete.
|
| 144 |
+
.RE
|
| 145 |
+
.SH "EXAMPLES"
|
| 146 |
+
.sp
|
| 147 |
+
.RS 4
|
| 148 |
+
\h'-04' 1.\h'+01'Get help for a command:
|
| 149 |
+
.sp
|
| 150 |
+
.RS 4
|
| 151 |
+
.nf
|
| 152 |
+
cargo help build
|
| 153 |
+
.fi
|
| 154 |
+
.RE
|
| 155 |
+
.RE
|
| 156 |
+
.sp
|
| 157 |
+
.RS 4
|
| 158 |
+
\h'-04' 2.\h'+01'Help is also available with the \fB\-\-help\fR flag:
|
| 159 |
+
.sp
|
| 160 |
+
.RS 4
|
| 161 |
+
.nf
|
| 162 |
+
cargo build \-\-help
|
| 163 |
+
.fi
|
| 164 |
+
.RE
|
| 165 |
+
.RE
|
| 166 |
+
.SH "SEE ALSO"
|
| 167 |
+
\fBcargo\fR(1)
|
rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-info.1
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
'\" t
|
| 2 |
+
.TH "CARGO\-INFO" "1"
|
| 3 |
+
.nh
|
| 4 |
+
.ad l
|
| 5 |
+
.ss \n[.ss] 0
|
| 6 |
+
.SH "NAME"
|
| 7 |
+
cargo\-info \[em] Display information about a package.
|
| 8 |
+
.SH "SYNOPSIS"
|
| 9 |
+
\fBcargo info\fR [\fIoptions\fR] \fIspec\fR
|
| 10 |
+
.SH "DESCRIPTION"
|
| 11 |
+
This command displays information about a package. It fetches data from the package\[cq]s Cargo.toml file
|
| 12 |
+
and presents it in a human\-readable format.
|
| 13 |
+
.SH "OPTIONS"
|
| 14 |
+
.SS "Info Options"
|
| 15 |
+
.sp
|
| 16 |
+
\fIspec\fR
|
| 17 |
+
.RS 4
|
| 18 |
+
Fetch information about the specified package. The \fIspec\fR can be a package ID, see \fBcargo\-pkgid\fR(1) for the SPEC
|
| 19 |
+
format.
|
| 20 |
+
If the specified package is part of the current workspace, information from the local Cargo.toml file will be displayed.
|
| 21 |
+
If the \fBCargo.lock\fR file does not exist, it will be created. If no version is specified, the appropriate version will be
|
| 22 |
+
selected based on the Minimum Supported Rust Version (MSRV).
|
| 23 |
+
.RE
|
| 24 |
+
.sp
|
| 25 |
+
\fB\-\-index\fR \fIindex\fR
|
| 26 |
+
.RS 4
|
| 27 |
+
The URL of the registry index to use.
|
| 28 |
+
.RE
|
| 29 |
+
.sp
|
| 30 |
+
\fB\-\-registry\fR \fIregistry\fR
|
| 31 |
+
.RS 4
|
| 32 |
+
Name of the registry to use. Registry names are defined in \fICargo config
|
| 33 |
+
files\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&. If not specified, the default registry is used,
|
| 34 |
+
which is defined by the \fBregistry.default\fR config key which defaults to
|
| 35 |
+
\fBcrates\-io\fR\&.
|
| 36 |
+
.RE
|
| 37 |
+
.SS "Display Options"
|
| 38 |
+
.sp
|
| 39 |
+
\fB\-v\fR,
|
| 40 |
+
\fB\-\-verbose\fR
|
| 41 |
+
.RS 4
|
| 42 |
+
Use verbose output. May be specified twice for \[lq]very verbose\[rq] output which
|
| 43 |
+
includes extra output such as dependency warnings and build script output.
|
| 44 |
+
May also be specified with the \fBterm.verbose\fR
|
| 45 |
+
\fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 46 |
+
.RE
|
| 47 |
+
.sp
|
| 48 |
+
\fB\-q\fR,
|
| 49 |
+
\fB\-\-quiet\fR
|
| 50 |
+
.RS 4
|
| 51 |
+
Do not print cargo log messages.
|
| 52 |
+
May also be specified with the \fBterm.quiet\fR
|
| 53 |
+
\fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 54 |
+
.RE
|
| 55 |
+
.sp
|
| 56 |
+
\fB\-\-color\fR \fIwhen\fR
|
| 57 |
+
.RS 4
|
| 58 |
+
Control when colored output is used. Valid values:
|
| 59 |
+
.sp
|
| 60 |
+
.RS 4
|
| 61 |
+
\h'-04'\(bu\h'+03'\fBauto\fR (default): Automatically detect if color support is available on the
|
| 62 |
+
terminal.
|
| 63 |
+
.RE
|
| 64 |
+
.sp
|
| 65 |
+
.RS 4
|
| 66 |
+
\h'-04'\(bu\h'+03'\fBalways\fR: Always display colors.
|
| 67 |
+
.RE
|
| 68 |
+
.sp
|
| 69 |
+
.RS 4
|
| 70 |
+
\h'-04'\(bu\h'+03'\fBnever\fR: Never display colors.
|
| 71 |
+
.RE
|
| 72 |
+
.sp
|
| 73 |
+
May also be specified with the \fBterm.color\fR
|
| 74 |
+
\fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 75 |
+
.RE
|
| 76 |
+
.SS "Manifest Options"
|
| 77 |
+
.sp
|
| 78 |
+
\fB\-\-locked\fR
|
| 79 |
+
.RS 4
|
| 80 |
+
Asserts that the exact same dependencies and versions are used as when the
|
| 81 |
+
existing \fBCargo.lock\fR file was originally generated. Cargo will exit with an
|
| 82 |
+
error when either of the following scenarios arises:
|
| 83 |
+
.sp
|
| 84 |
+
.RS 4
|
| 85 |
+
\h'-04'\(bu\h'+03'The lock file is missing.
|
| 86 |
+
.RE
|
| 87 |
+
.sp
|
| 88 |
+
.RS 4
|
| 89 |
+
\h'-04'\(bu\h'+03'Cargo attempted to change the lock file due to a different dependency resolution.
|
| 90 |
+
.RE
|
| 91 |
+
.sp
|
| 92 |
+
It may be used in environments where deterministic builds are desired,
|
| 93 |
+
such as in CI pipelines.
|
| 94 |
+
.RE
|
| 95 |
+
.sp
|
| 96 |
+
\fB\-\-offline\fR
|
| 97 |
+
.RS 4
|
| 98 |
+
Prevents Cargo from accessing the network for any reason. Without this
|
| 99 |
+
flag, Cargo will stop with an error if it needs to access the network and
|
| 100 |
+
the network is not available. With this flag, Cargo will attempt to
|
| 101 |
+
proceed without the network if possible.
|
| 102 |
+
.sp
|
| 103 |
+
Beware that this may result in different dependency resolution than online
|
| 104 |
+
mode. Cargo will restrict itself to crates that are downloaded locally, even
|
| 105 |
+
if there might be a newer version as indicated in the local copy of the index.
|
| 106 |
+
See the \fBcargo\-fetch\fR(1) command to download dependencies before going
|
| 107 |
+
offline.
|
| 108 |
+
.sp
|
| 109 |
+
May also be specified with the \fBnet.offline\fR \fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 110 |
+
.RE
|
| 111 |
+
.sp
|
| 112 |
+
\fB\-\-frozen\fR
|
| 113 |
+
.RS 4
|
| 114 |
+
Equivalent to specifying both \fB\-\-locked\fR and \fB\-\-offline\fR\&.
|
| 115 |
+
.RE
|
| 116 |
+
.SS "Common Options"
|
| 117 |
+
.sp
|
| 118 |
+
\fB+\fR\fItoolchain\fR
|
| 119 |
+
.RS 4
|
| 120 |
+
If Cargo has been installed with rustup, and the first argument to \fBcargo\fR
|
| 121 |
+
begins with \fB+\fR, it will be interpreted as a rustup toolchain name (such
|
| 122 |
+
as \fB+stable\fR or \fB+nightly\fR).
|
| 123 |
+
See the \fIrustup documentation\fR <https://rust\-lang.github.io/rustup/overrides.html>
|
| 124 |
+
for more information about how toolchain overrides work.
|
| 125 |
+
.RE
|
| 126 |
+
.sp
|
| 127 |
+
\fB\-\-config\fR \fIKEY=VALUE\fR or \fIPATH\fR
|
| 128 |
+
.RS 4
|
| 129 |
+
Overrides a Cargo configuration value. The argument should be in TOML syntax of \fBKEY=VALUE\fR,
|
| 130 |
+
or provided as a path to an extra configuration file. This flag may be specified multiple times.
|
| 131 |
+
See the \fIcommand\-line overrides section\fR <https://doc.rust\-lang.org/cargo/reference/config.html#command\-line\-overrides> for more information.
|
| 132 |
+
.RE
|
| 133 |
+
.sp
|
| 134 |
+
\fB\-C\fR \fIPATH\fR
|
| 135 |
+
.RS 4
|
| 136 |
+
Changes the current working directory before executing any specified operations. This affects
|
| 137 |
+
things like where cargo looks by default for the project manifest (\fBCargo.toml\fR), as well as
|
| 138 |
+
the directories searched for discovering \fB\&.cargo/config.toml\fR, for example. This option must
|
| 139 |
+
appear before the command name, for example \fBcargo \-C path/to/my\-project build\fR\&.
|
| 140 |
+
.sp
|
| 141 |
+
This option is only available on the \fInightly
|
| 142 |
+
channel\fR <https://doc.rust\-lang.org/book/appendix\-07\-nightly\-rust.html> and
|
| 143 |
+
requires the \fB\-Z unstable\-options\fR flag to enable (see
|
| 144 |
+
\fI#10098\fR <https://github.com/rust\-lang/cargo/issues/10098>).
|
| 145 |
+
.RE
|
| 146 |
+
.sp
|
| 147 |
+
\fB\-h\fR,
|
| 148 |
+
\fB\-\-help\fR
|
| 149 |
+
.RS 4
|
| 150 |
+
Prints help information.
|
| 151 |
+
.RE
|
| 152 |
+
.sp
|
| 153 |
+
\fB\-Z\fR \fIflag\fR
|
| 154 |
+
.RS 4
|
| 155 |
+
Unstable (nightly\-only) flags to Cargo. Run \fBcargo \-Z help\fR for details.
|
| 156 |
+
.RE
|
| 157 |
+
.SH "ENVIRONMENT"
|
| 158 |
+
See \fIthe reference\fR <https://doc.rust\-lang.org/cargo/reference/environment\-variables.html> for
|
| 159 |
+
details on environment variables that Cargo reads.
|
| 160 |
+
.SH "EXIT STATUS"
|
| 161 |
+
.sp
|
| 162 |
+
.RS 4
|
| 163 |
+
\h'-04'\(bu\h'+03'\fB0\fR: Cargo succeeded.
|
| 164 |
+
.RE
|
| 165 |
+
.sp
|
| 166 |
+
.RS 4
|
| 167 |
+
\h'-04'\(bu\h'+03'\fB101\fR: Cargo failed to complete.
|
| 168 |
+
.RE
|
| 169 |
+
.SH "EXAMPLES"
|
| 170 |
+
.sp
|
| 171 |
+
.RS 4
|
| 172 |
+
\h'-04' 1.\h'+01'Inspect the \fBserde\fR package from crates.io:
|
| 173 |
+
.sp
|
| 174 |
+
.RS 4
|
| 175 |
+
.nf
|
| 176 |
+
cargo info serde
|
| 177 |
+
.fi
|
| 178 |
+
.RE
|
| 179 |
+
.RE
|
| 180 |
+
.sp
|
| 181 |
+
.RS 4
|
| 182 |
+
\h'-04' 2.\h'+01'Inspect the \fBserde\fR package with version \fB1.0.0\fR:
|
| 183 |
+
.sp
|
| 184 |
+
.RS 4
|
| 185 |
+
.nf
|
| 186 |
+
cargo info serde@1.0.0
|
| 187 |
+
.fi
|
| 188 |
+
.RE
|
| 189 |
+
.RE
|
| 190 |
+
.sp
|
| 191 |
+
.RS 4
|
| 192 |
+
\h'-04' 3.\h'+01'Inspect the \fBserde\fR package form the local registry:
|
| 193 |
+
.sp
|
| 194 |
+
.RS 4
|
| 195 |
+
.nf
|
| 196 |
+
cargo info serde \-\-registry my\-registry
|
| 197 |
+
.fi
|
| 198 |
+
.RE
|
| 199 |
+
.RE
|
| 200 |
+
.SH "SEE ALSO"
|
| 201 |
+
\fBcargo\fR(1), \fBcargo\-search\fR(1)
|
rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-init.1
ADDED
|
@@ -0,0 +1,171 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
'\" t
|
| 2 |
+
.TH "CARGO\-INIT" "1"
|
| 3 |
+
.nh
|
| 4 |
+
.ad l
|
| 5 |
+
.ss \n[.ss] 0
|
| 6 |
+
.SH "NAME"
|
| 7 |
+
cargo\-init \[em] Create a new Cargo package in an existing directory
|
| 8 |
+
.SH "SYNOPSIS"
|
| 9 |
+
\fBcargo init\fR [\fIoptions\fR] [\fIpath\fR]
|
| 10 |
+
.SH "DESCRIPTION"
|
| 11 |
+
This command will create a new Cargo manifest in the current directory. Give a
|
| 12 |
+
path as an argument to create in the given directory.
|
| 13 |
+
.sp
|
| 14 |
+
If there are typically\-named Rust source files already in the directory, those
|
| 15 |
+
will be used. If not, then a sample \fBsrc/main.rs\fR file will be created, or
|
| 16 |
+
\fBsrc/lib.rs\fR if \fB\-\-lib\fR is passed.
|
| 17 |
+
.sp
|
| 18 |
+
If the directory is not already in a VCS repository, then a new repository
|
| 19 |
+
is created (see \fB\-\-vcs\fR below).
|
| 20 |
+
.sp
|
| 21 |
+
See \fBcargo\-new\fR(1) for a similar command which will create a new package in
|
| 22 |
+
a new directory.
|
| 23 |
+
.SH "OPTIONS"
|
| 24 |
+
.SS "Init Options"
|
| 25 |
+
.sp
|
| 26 |
+
\fB\-\-bin\fR
|
| 27 |
+
.RS 4
|
| 28 |
+
Create a package with a binary target (\fBsrc/main.rs\fR).
|
| 29 |
+
This is the default behavior.
|
| 30 |
+
.RE
|
| 31 |
+
.sp
|
| 32 |
+
\fB\-\-lib\fR
|
| 33 |
+
.RS 4
|
| 34 |
+
Create a package with a library target (\fBsrc/lib.rs\fR).
|
| 35 |
+
.RE
|
| 36 |
+
.sp
|
| 37 |
+
\fB\-\-edition\fR \fIedition\fR
|
| 38 |
+
.RS 4
|
| 39 |
+
Specify the Rust edition to use. Default is 2024.
|
| 40 |
+
Possible values: 2015, 2018, 2021, 2024
|
| 41 |
+
.RE
|
| 42 |
+
.sp
|
| 43 |
+
\fB\-\-name\fR \fIname\fR
|
| 44 |
+
.RS 4
|
| 45 |
+
Set the package name. Defaults to the directory name.
|
| 46 |
+
.RE
|
| 47 |
+
.sp
|
| 48 |
+
\fB\-\-vcs\fR \fIvcs\fR
|
| 49 |
+
.RS 4
|
| 50 |
+
Initialize a new VCS repository for the given version control system (git,
|
| 51 |
+
hg, pijul, or fossil) or do not initialize any version control at all
|
| 52 |
+
(none). If not specified, defaults to \fBgit\fR or the configuration value
|
| 53 |
+
\fBcargo\-new.vcs\fR, or \fBnone\fR if already inside a VCS repository.
|
| 54 |
+
.RE
|
| 55 |
+
.sp
|
| 56 |
+
\fB\-\-registry\fR \fIregistry\fR
|
| 57 |
+
.RS 4
|
| 58 |
+
This sets the \fBpublish\fR field in \fBCargo.toml\fR to the given registry name
|
| 59 |
+
which will restrict publishing only to that registry.
|
| 60 |
+
.sp
|
| 61 |
+
Registry names are defined in \fICargo config files\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 62 |
+
If not specified, the default registry defined by the \fBregistry.default\fR
|
| 63 |
+
config key is used. If the default registry is not set and \fB\-\-registry\fR is not
|
| 64 |
+
used, the \fBpublish\fR field will not be set which means that publishing will not
|
| 65 |
+
be restricted.
|
| 66 |
+
.RE
|
| 67 |
+
.SS "Display Options"
|
| 68 |
+
.sp
|
| 69 |
+
\fB\-v\fR,
|
| 70 |
+
\fB\-\-verbose\fR
|
| 71 |
+
.RS 4
|
| 72 |
+
Use verbose output. May be specified twice for \[lq]very verbose\[rq] output which
|
| 73 |
+
includes extra output such as dependency warnings and build script output.
|
| 74 |
+
May also be specified with the \fBterm.verbose\fR
|
| 75 |
+
\fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 76 |
+
.RE
|
| 77 |
+
.sp
|
| 78 |
+
\fB\-q\fR,
|
| 79 |
+
\fB\-\-quiet\fR
|
| 80 |
+
.RS 4
|
| 81 |
+
Do not print cargo log messages.
|
| 82 |
+
May also be specified with the \fBterm.quiet\fR
|
| 83 |
+
\fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 84 |
+
.RE
|
| 85 |
+
.sp
|
| 86 |
+
\fB\-\-color\fR \fIwhen\fR
|
| 87 |
+
.RS 4
|
| 88 |
+
Control when colored output is used. Valid values:
|
| 89 |
+
.sp
|
| 90 |
+
.RS 4
|
| 91 |
+
\h'-04'\(bu\h'+03'\fBauto\fR (default): Automatically detect if color support is available on the
|
| 92 |
+
terminal.
|
| 93 |
+
.RE
|
| 94 |
+
.sp
|
| 95 |
+
.RS 4
|
| 96 |
+
\h'-04'\(bu\h'+03'\fBalways\fR: Always display colors.
|
| 97 |
+
.RE
|
| 98 |
+
.sp
|
| 99 |
+
.RS 4
|
| 100 |
+
\h'-04'\(bu\h'+03'\fBnever\fR: Never display colors.
|
| 101 |
+
.RE
|
| 102 |
+
.sp
|
| 103 |
+
May also be specified with the \fBterm.color\fR
|
| 104 |
+
\fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 105 |
+
.RE
|
| 106 |
+
.SS "Common Options"
|
| 107 |
+
.sp
|
| 108 |
+
\fB+\fR\fItoolchain\fR
|
| 109 |
+
.RS 4
|
| 110 |
+
If Cargo has been installed with rustup, and the first argument to \fBcargo\fR
|
| 111 |
+
begins with \fB+\fR, it will be interpreted as a rustup toolchain name (such
|
| 112 |
+
as \fB+stable\fR or \fB+nightly\fR).
|
| 113 |
+
See the \fIrustup documentation\fR <https://rust\-lang.github.io/rustup/overrides.html>
|
| 114 |
+
for more information about how toolchain overrides work.
|
| 115 |
+
.RE
|
| 116 |
+
.sp
|
| 117 |
+
\fB\-\-config\fR \fIKEY=VALUE\fR or \fIPATH\fR
|
| 118 |
+
.RS 4
|
| 119 |
+
Overrides a Cargo configuration value. The argument should be in TOML syntax of \fBKEY=VALUE\fR,
|
| 120 |
+
or provided as a path to an extra configuration file. This flag may be specified multiple times.
|
| 121 |
+
See the \fIcommand\-line overrides section\fR <https://doc.rust\-lang.org/cargo/reference/config.html#command\-line\-overrides> for more information.
|
| 122 |
+
.RE
|
| 123 |
+
.sp
|
| 124 |
+
\fB\-C\fR \fIPATH\fR
|
| 125 |
+
.RS 4
|
| 126 |
+
Changes the current working directory before executing any specified operations. This affects
|
| 127 |
+
things like where cargo looks by default for the project manifest (\fBCargo.toml\fR), as well as
|
| 128 |
+
the directories searched for discovering \fB\&.cargo/config.toml\fR, for example. This option must
|
| 129 |
+
appear before the command name, for example \fBcargo \-C path/to/my\-project build\fR\&.
|
| 130 |
+
.sp
|
| 131 |
+
This option is only available on the \fInightly
|
| 132 |
+
channel\fR <https://doc.rust\-lang.org/book/appendix\-07\-nightly\-rust.html> and
|
| 133 |
+
requires the \fB\-Z unstable\-options\fR flag to enable (see
|
| 134 |
+
\fI#10098\fR <https://github.com/rust\-lang/cargo/issues/10098>).
|
| 135 |
+
.RE
|
| 136 |
+
.sp
|
| 137 |
+
\fB\-h\fR,
|
| 138 |
+
\fB\-\-help\fR
|
| 139 |
+
.RS 4
|
| 140 |
+
Prints help information.
|
| 141 |
+
.RE
|
| 142 |
+
.sp
|
| 143 |
+
\fB\-Z\fR \fIflag\fR
|
| 144 |
+
.RS 4
|
| 145 |
+
Unstable (nightly\-only) flags to Cargo. Run \fBcargo \-Z help\fR for details.
|
| 146 |
+
.RE
|
| 147 |
+
.SH "ENVIRONMENT"
|
| 148 |
+
See \fIthe reference\fR <https://doc.rust\-lang.org/cargo/reference/environment\-variables.html> for
|
| 149 |
+
details on environment variables that Cargo reads.
|
| 150 |
+
.SH "EXIT STATUS"
|
| 151 |
+
.sp
|
| 152 |
+
.RS 4
|
| 153 |
+
\h'-04'\(bu\h'+03'\fB0\fR: Cargo succeeded.
|
| 154 |
+
.RE
|
| 155 |
+
.sp
|
| 156 |
+
.RS 4
|
| 157 |
+
\h'-04'\(bu\h'+03'\fB101\fR: Cargo failed to complete.
|
| 158 |
+
.RE
|
| 159 |
+
.SH "EXAMPLES"
|
| 160 |
+
.sp
|
| 161 |
+
.RS 4
|
| 162 |
+
\h'-04' 1.\h'+01'Create a binary Cargo package in the current directory:
|
| 163 |
+
.sp
|
| 164 |
+
.RS 4
|
| 165 |
+
.nf
|
| 166 |
+
cargo init
|
| 167 |
+
.fi
|
| 168 |
+
.RE
|
| 169 |
+
.RE
|
| 170 |
+
.SH "SEE ALSO"
|
| 171 |
+
\fBcargo\fR(1), \fBcargo\-new\fR(1)
|
rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-install.1
ADDED
|
@@ -0,0 +1,538 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
'\" t
|
| 2 |
+
.TH "CARGO\-INSTALL" "1"
|
| 3 |
+
.nh
|
| 4 |
+
.ad l
|
| 5 |
+
.ss \n[.ss] 0
|
| 6 |
+
.SH "NAME"
|
| 7 |
+
cargo\-install \[em] Build and install a Rust binary
|
| 8 |
+
.SH "SYNOPSIS"
|
| 9 |
+
\fBcargo install\fR [\fIoptions\fR] \fIcrate\fR[@\fIversion\fR]\[u2026]
|
| 10 |
+
.br
|
| 11 |
+
\fBcargo install\fR [\fIoptions\fR] \fB\-\-path\fR \fIpath\fR
|
| 12 |
+
.br
|
| 13 |
+
\fBcargo install\fR [\fIoptions\fR] \fB\-\-git\fR \fIurl\fR [\fIcrate\fR\[u2026]]
|
| 14 |
+
.br
|
| 15 |
+
\fBcargo install\fR [\fIoptions\fR] \fB\-\-list\fR
|
| 16 |
+
.SH "DESCRIPTION"
|
| 17 |
+
This command manages Cargo\[cq]s local set of installed binary crates. Only
|
| 18 |
+
packages which have executable \fB[[bin]]\fR or \fB[[example]]\fR targets can be
|
| 19 |
+
installed, and all executables are installed into the installation root\[cq]s
|
| 20 |
+
\fBbin\fR folder. By default only binaries, not examples, are installed.
|
| 21 |
+
.sp
|
| 22 |
+
The installation root is determined, in order of precedence:
|
| 23 |
+
.sp
|
| 24 |
+
.RS 4
|
| 25 |
+
\h'-04'\(bu\h'+03'\fB\-\-root\fR option
|
| 26 |
+
.RE
|
| 27 |
+
.sp
|
| 28 |
+
.RS 4
|
| 29 |
+
\h'-04'\(bu\h'+03'\fBCARGO_INSTALL_ROOT\fR environment variable
|
| 30 |
+
.RE
|
| 31 |
+
.sp
|
| 32 |
+
.RS 4
|
| 33 |
+
\h'-04'\(bu\h'+03'\fBinstall.root\fR Cargo \fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>
|
| 34 |
+
.RE
|
| 35 |
+
.sp
|
| 36 |
+
.RS 4
|
| 37 |
+
\h'-04'\(bu\h'+03'\fBCARGO_HOME\fR environment variable
|
| 38 |
+
.RE
|
| 39 |
+
.sp
|
| 40 |
+
.RS 4
|
| 41 |
+
\h'-04'\(bu\h'+03'\fB$HOME/.cargo\fR
|
| 42 |
+
.RE
|
| 43 |
+
.sp
|
| 44 |
+
There are multiple sources from which a crate can be installed. The default
|
| 45 |
+
source location is crates.io but the \fB\-\-git\fR, \fB\-\-path\fR, and \fB\-\-registry\fR flags
|
| 46 |
+
can change this source. If the source contains more than one package (such as
|
| 47 |
+
crates.io or a git repository with multiple crates) the \fIcrate\fR argument is
|
| 48 |
+
required to indicate which crate should be installed.
|
| 49 |
+
.sp
|
| 50 |
+
Crates from crates.io can optionally specify the version they wish to install
|
| 51 |
+
via the \fB\-\-version\fR flags, and similarly packages from git repositories can
|
| 52 |
+
optionally specify the branch, tag, or revision that should be installed. If a
|
| 53 |
+
crate has multiple binaries, the \fB\-\-bin\fR argument can selectively install only
|
| 54 |
+
one of them, and if you\[cq]d rather install examples the \fB\-\-example\fR argument can
|
| 55 |
+
be used as well.
|
| 56 |
+
.sp
|
| 57 |
+
If the package is already installed, Cargo will reinstall it if the installed
|
| 58 |
+
version does not appear to be up\-to\-date. If any of the following values
|
| 59 |
+
change, then Cargo will reinstall the package:
|
| 60 |
+
.sp
|
| 61 |
+
.RS 4
|
| 62 |
+
\h'-04'\(bu\h'+03'The package version and source.
|
| 63 |
+
.RE
|
| 64 |
+
.sp
|
| 65 |
+
.RS 4
|
| 66 |
+
\h'-04'\(bu\h'+03'The set of binary names installed.
|
| 67 |
+
.RE
|
| 68 |
+
.sp
|
| 69 |
+
.RS 4
|
| 70 |
+
\h'-04'\(bu\h'+03'The chosen features.
|
| 71 |
+
.RE
|
| 72 |
+
.sp
|
| 73 |
+
.RS 4
|
| 74 |
+
\h'-04'\(bu\h'+03'The profile (\fB\-\-profile\fR).
|
| 75 |
+
.RE
|
| 76 |
+
.sp
|
| 77 |
+
.RS 4
|
| 78 |
+
\h'-04'\(bu\h'+03'The target (\fB\-\-target\fR).
|
| 79 |
+
.RE
|
| 80 |
+
.sp
|
| 81 |
+
Installing with \fB\-\-path\fR will always build and install, unless there are
|
| 82 |
+
conflicting binaries from another package. The \fB\-\-force\fR flag may be used to
|
| 83 |
+
force Cargo to always reinstall the package.
|
| 84 |
+
.sp
|
| 85 |
+
If the source is crates.io or \fB\-\-git\fR then by default the crate will be built
|
| 86 |
+
in a temporary target directory. To avoid this, the target directory can be
|
| 87 |
+
specified by setting the \fBCARGO_TARGET_DIR\fR environment variable to a relative
|
| 88 |
+
path. In particular, this can be useful for caching build artifacts on
|
| 89 |
+
continuous integration systems.
|
| 90 |
+
.SS "Dealing with the Lockfile"
|
| 91 |
+
By default, the \fBCargo.lock\fR file that is included with the package will be
|
| 92 |
+
ignored. This means that Cargo will recompute which versions of dependencies
|
| 93 |
+
to use, possibly using newer versions that have been released since the
|
| 94 |
+
package was published. The \fB\-\-locked\fR flag can be used to force Cargo to use
|
| 95 |
+
the packaged \fBCargo.lock\fR file if it is available. This may be useful for
|
| 96 |
+
ensuring reproducible builds, to use the exact same set of dependencies that
|
| 97 |
+
were available when the package was published. It may also be useful if a
|
| 98 |
+
newer version of a dependency is published that no longer builds on your
|
| 99 |
+
system, or has other problems. The downside to using \fB\-\-locked\fR is that you
|
| 100 |
+
will not receive any fixes or updates to any dependency. Note that Cargo did
|
| 101 |
+
not start publishing \fBCargo.lock\fR files until version 1.37, which means
|
| 102 |
+
packages published with prior versions will not have a \fBCargo.lock\fR file
|
| 103 |
+
available.
|
| 104 |
+
.SS "Configuration Discovery"
|
| 105 |
+
This command operates on system or user level, not project level.
|
| 106 |
+
This means that the local \fIconfiguration discovery\fR <https://doc.rust\-lang.org/cargo/reference/config.html#hierarchical\-structure> is ignored.
|
| 107 |
+
Instead, the configuration discovery begins at \fB$CARGO_HOME/config.toml\fR\&.
|
| 108 |
+
If the package is installed with \fB\-\-path $PATH\fR, the local configuration
|
| 109 |
+
will be used, beginning discovery at \fB$PATH/.cargo/config.toml\fR\&.
|
| 110 |
+
.SH "OPTIONS"
|
| 111 |
+
.SS "Install Options"
|
| 112 |
+
.sp
|
| 113 |
+
\fB\-\-vers\fR \fIversion\fR,
|
| 114 |
+
\fB\-\-version\fR \fIversion\fR
|
| 115 |
+
.RS 4
|
| 116 |
+
Specify a version to install. This may be a \fIversion
|
| 117 |
+
requirement\fR <https://doc.rust\-lang.org/cargo/reference/specifying\-dependencies.html>, like \fB~1.2\fR, to have Cargo
|
| 118 |
+
select the newest version from the given requirement. If the version does not
|
| 119 |
+
have a requirement operator (such as \fB^\fR or \fB~\fR), then it must be in the form
|
| 120 |
+
\fIMAJOR.MINOR.PATCH\fR, and will install exactly that version; it is \fInot\fR
|
| 121 |
+
treated as a caret requirement like Cargo dependencies are.
|
| 122 |
+
.RE
|
| 123 |
+
.sp
|
| 124 |
+
\fB\-\-git\fR \fIurl\fR
|
| 125 |
+
.RS 4
|
| 126 |
+
Git URL to install the specified crate from.
|
| 127 |
+
.RE
|
| 128 |
+
.sp
|
| 129 |
+
\fB\-\-branch\fR \fIbranch\fR
|
| 130 |
+
.RS 4
|
| 131 |
+
Branch to use when installing from git.
|
| 132 |
+
.RE
|
| 133 |
+
.sp
|
| 134 |
+
\fB\-\-tag\fR \fItag\fR
|
| 135 |
+
.RS 4
|
| 136 |
+
Tag to use when installing from git.
|
| 137 |
+
.RE
|
| 138 |
+
.sp
|
| 139 |
+
\fB\-\-rev\fR \fIsha\fR
|
| 140 |
+
.RS 4
|
| 141 |
+
Specific commit to use when installing from git.
|
| 142 |
+
.RE
|
| 143 |
+
.sp
|
| 144 |
+
\fB\-\-path\fR \fIpath\fR
|
| 145 |
+
.RS 4
|
| 146 |
+
Filesystem path to local crate to install from.
|
| 147 |
+
.RE
|
| 148 |
+
.sp
|
| 149 |
+
\fB\-\-list\fR
|
| 150 |
+
.RS 4
|
| 151 |
+
List all installed packages and their versions.
|
| 152 |
+
.RE
|
| 153 |
+
.sp
|
| 154 |
+
\fB\-n\fR,
|
| 155 |
+
\fB\-\-dry\-run\fR
|
| 156 |
+
.RS 4
|
| 157 |
+
(unstable) Perform all checks without installing.
|
| 158 |
+
.RE
|
| 159 |
+
.sp
|
| 160 |
+
\fB\-f\fR,
|
| 161 |
+
\fB\-\-force\fR
|
| 162 |
+
.RS 4
|
| 163 |
+
Force overwriting existing crates or binaries. This can be used if a package
|
| 164 |
+
has installed a binary with the same name as another package. This is also
|
| 165 |
+
useful if something has changed on the system that you want to rebuild with,
|
| 166 |
+
such as a newer version of \fBrustc\fR\&.
|
| 167 |
+
.RE
|
| 168 |
+
.sp
|
| 169 |
+
\fB\-\-no\-track\fR
|
| 170 |
+
.RS 4
|
| 171 |
+
By default, Cargo keeps track of the installed packages with a metadata file
|
| 172 |
+
stored in the installation root directory. This flag tells Cargo not to use or
|
| 173 |
+
create that file. With this flag, Cargo will refuse to overwrite any existing
|
| 174 |
+
files unless the \fB\-\-force\fR flag is used. This also disables Cargo\[cq]s ability to
|
| 175 |
+
protect against multiple concurrent invocations of Cargo installing at the
|
| 176 |
+
same time.
|
| 177 |
+
.RE
|
| 178 |
+
.sp
|
| 179 |
+
\fB\-\-bin\fR \fIname\fR\[u2026]
|
| 180 |
+
.RS 4
|
| 181 |
+
Install only the specified binary.
|
| 182 |
+
.RE
|
| 183 |
+
.sp
|
| 184 |
+
\fB\-\-bins\fR
|
| 185 |
+
.RS 4
|
| 186 |
+
Install all binaries. This is the default behavior.
|
| 187 |
+
.RE
|
| 188 |
+
.sp
|
| 189 |
+
\fB\-\-example\fR \fIname\fR\[u2026]
|
| 190 |
+
.RS 4
|
| 191 |
+
Install only the specified example.
|
| 192 |
+
.RE
|
| 193 |
+
.sp
|
| 194 |
+
\fB\-\-examples\fR
|
| 195 |
+
.RS 4
|
| 196 |
+
Install all examples.
|
| 197 |
+
.RE
|
| 198 |
+
.sp
|
| 199 |
+
\fB\-\-root\fR \fIdir\fR
|
| 200 |
+
.RS 4
|
| 201 |
+
Directory to install packages into.
|
| 202 |
+
.RE
|
| 203 |
+
.sp
|
| 204 |
+
\fB\-\-registry\fR \fIregistry\fR
|
| 205 |
+
.RS 4
|
| 206 |
+
Name of the registry to use. Registry names are defined in \fICargo config
|
| 207 |
+
files\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&. If not specified, the default registry is used,
|
| 208 |
+
which is defined by the \fBregistry.default\fR config key which defaults to
|
| 209 |
+
\fBcrates\-io\fR\&.
|
| 210 |
+
.RE
|
| 211 |
+
.sp
|
| 212 |
+
\fB\-\-index\fR \fIindex\fR
|
| 213 |
+
.RS 4
|
| 214 |
+
The URL of the registry index to use.
|
| 215 |
+
.RE
|
| 216 |
+
.SS "Feature Selection"
|
| 217 |
+
The feature flags allow you to control which features are enabled. When no
|
| 218 |
+
feature options are given, the \fBdefault\fR feature is activated for every
|
| 219 |
+
selected package.
|
| 220 |
+
.sp
|
| 221 |
+
See \fIthe features documentation\fR <https://doc.rust\-lang.org/cargo/reference/features.html#command\-line\-feature\-options>
|
| 222 |
+
for more details.
|
| 223 |
+
.sp
|
| 224 |
+
\fB\-F\fR \fIfeatures\fR,
|
| 225 |
+
\fB\-\-features\fR \fIfeatures\fR
|
| 226 |
+
.RS 4
|
| 227 |
+
Space or comma separated list of features to activate. Features of workspace
|
| 228 |
+
members may be enabled with \fBpackage\-name/feature\-name\fR syntax. This flag may
|
| 229 |
+
be specified multiple times, which enables all specified features.
|
| 230 |
+
.RE
|
| 231 |
+
.sp
|
| 232 |
+
\fB\-\-all\-features\fR
|
| 233 |
+
.RS 4
|
| 234 |
+
Activate all available features of all selected packages.
|
| 235 |
+
.RE
|
| 236 |
+
.sp
|
| 237 |
+
\fB\-\-no\-default\-features\fR
|
| 238 |
+
.RS 4
|
| 239 |
+
Do not activate the \fBdefault\fR feature of the selected packages.
|
| 240 |
+
.RE
|
| 241 |
+
.SS "Compilation Options"
|
| 242 |
+
.sp
|
| 243 |
+
\fB\-\-target\fR \fItriple\fR
|
| 244 |
+
.RS 4
|
| 245 |
+
Install for the specified target architecture. The default is the host architecture. The general format of the triple is
|
| 246 |
+
\fB<arch><sub>\-<vendor>\-<sys>\-<abi>\fR\&.
|
| 247 |
+
.sp
|
| 248 |
+
Possible values:
|
| 249 |
+
.sp
|
| 250 |
+
.RS 4
|
| 251 |
+
\h'-04'\(bu\h'+03'Any supported target in \fBrustc \-\-print target\-list\fR\&.
|
| 252 |
+
.RE
|
| 253 |
+
.sp
|
| 254 |
+
.RS 4
|
| 255 |
+
\h'-04'\(bu\h'+03'\fB"host\-tuple"\fR, which will internally be substituted by the host\[cq]s target. This can be particularly useful if you\[cq]re cross\-compiling some crates, and don\[cq]t want to specify your host\[cq]s machine as a target (for instance, an \fBxtask\fR in a shared project that may be worked on by many hosts).
|
| 256 |
+
.RE
|
| 257 |
+
.sp
|
| 258 |
+
.RS 4
|
| 259 |
+
\h'-04'\(bu\h'+03'A path to a custom target specification. See \fICustom Target Lookup Path\fR <https://doc.rust\-lang.org/rustc/targets/custom.html#custom\-target\-lookup\-path> for more information.
|
| 260 |
+
.RE
|
| 261 |
+
.sp
|
| 262 |
+
This may also be specified with the \fBbuild.target\fR \fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 263 |
+
.sp
|
| 264 |
+
Note that specifying this flag makes Cargo run in a different mode where the
|
| 265 |
+
target artifacts are placed in a separate directory. See the
|
| 266 |
+
\fIbuild cache\fR <https://doc.rust\-lang.org/cargo/reference/build\-cache.html> documentation for more details.
|
| 267 |
+
.RE
|
| 268 |
+
.sp
|
| 269 |
+
\fB\-\-target\-dir\fR \fIdirectory\fR
|
| 270 |
+
.RS 4
|
| 271 |
+
Directory for all generated artifacts and intermediate files. May also be
|
| 272 |
+
specified with the \fBCARGO_TARGET_DIR\fR environment variable, or the
|
| 273 |
+
\fBbuild.target\-dir\fR \fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 274 |
+
Defaults to a new temporary folder located in the
|
| 275 |
+
temporary directory of the platform.
|
| 276 |
+
.sp
|
| 277 |
+
When using \fB\-\-path\fR, by default it will use \fBtarget\fR directory in the workspace
|
| 278 |
+
of the local crate unless \fB\-\-target\-dir\fR
|
| 279 |
+
is specified.
|
| 280 |
+
.RE
|
| 281 |
+
.sp
|
| 282 |
+
\fB\-\-debug\fR
|
| 283 |
+
.RS 4
|
| 284 |
+
Build with the \fBdev\fR profile instead of the \fBrelease\fR profile.
|
| 285 |
+
See also the \fB\-\-profile\fR option for choosing a specific profile by name.
|
| 286 |
+
.RE
|
| 287 |
+
.sp
|
| 288 |
+
\fB\-\-profile\fR \fIname\fR
|
| 289 |
+
.RS 4
|
| 290 |
+
Install with the given profile.
|
| 291 |
+
See \fIthe reference\fR <https://doc.rust\-lang.org/cargo/reference/profiles.html> for more details on profiles.
|
| 292 |
+
.RE
|
| 293 |
+
.sp
|
| 294 |
+
\fB\-\-timings\fR
|
| 295 |
+
.RS 4
|
| 296 |
+
Output information how long each compilation takes, and track concurrency
|
| 297 |
+
information over time.
|
| 298 |
+
.sp
|
| 299 |
+
A file \fBcargo\-timing.html\fR will be written to the \fBtarget/cargo\-timings\fR
|
| 300 |
+
directory at the end of the build. An additional report with a timestamp
|
| 301 |
+
in its filename is also written if you want to look at a previous run.
|
| 302 |
+
These reports are suitable for human consumption only, and do not provide
|
| 303 |
+
machine\-readable timing data.
|
| 304 |
+
.RE
|
| 305 |
+
.SS "Manifest Options"
|
| 306 |
+
.sp
|
| 307 |
+
\fB\-\-ignore\-rust\-version\fR
|
| 308 |
+
.RS 4
|
| 309 |
+
Ignore \fBrust\-version\fR specification in packages.
|
| 310 |
+
.RE
|
| 311 |
+
.sp
|
| 312 |
+
\fB\-\-locked\fR
|
| 313 |
+
.RS 4
|
| 314 |
+
Asserts that the exact same dependencies and versions are used as when the
|
| 315 |
+
existing \fBCargo.lock\fR file was originally generated. Cargo will exit with an
|
| 316 |
+
error when either of the following scenarios arises:
|
| 317 |
+
.sp
|
| 318 |
+
.RS 4
|
| 319 |
+
\h'-04'\(bu\h'+03'The lock file is missing.
|
| 320 |
+
.RE
|
| 321 |
+
.sp
|
| 322 |
+
.RS 4
|
| 323 |
+
\h'-04'\(bu\h'+03'Cargo attempted to change the lock file due to a different dependency resolution.
|
| 324 |
+
.RE
|
| 325 |
+
.sp
|
| 326 |
+
It may be used in environments where deterministic builds are desired,
|
| 327 |
+
such as in CI pipelines.
|
| 328 |
+
.RE
|
| 329 |
+
.sp
|
| 330 |
+
\fB\-\-offline\fR
|
| 331 |
+
.RS 4
|
| 332 |
+
Prevents Cargo from accessing the network for any reason. Without this
|
| 333 |
+
flag, Cargo will stop with an error if it needs to access the network and
|
| 334 |
+
the network is not available. With this flag, Cargo will attempt to
|
| 335 |
+
proceed without the network if possible.
|
| 336 |
+
.sp
|
| 337 |
+
Beware that this may result in different dependency resolution than online
|
| 338 |
+
mode. Cargo will restrict itself to crates that are downloaded locally, even
|
| 339 |
+
if there might be a newer version as indicated in the local copy of the index.
|
| 340 |
+
See the \fBcargo\-fetch\fR(1) command to download dependencies before going
|
| 341 |
+
offline.
|
| 342 |
+
.sp
|
| 343 |
+
May also be specified with the \fBnet.offline\fR \fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 344 |
+
.RE
|
| 345 |
+
.sp
|
| 346 |
+
\fB\-\-frozen\fR
|
| 347 |
+
.RS 4
|
| 348 |
+
Equivalent to specifying both \fB\-\-locked\fR and \fB\-\-offline\fR\&.
|
| 349 |
+
.RE
|
| 350 |
+
.SS "Miscellaneous Options"
|
| 351 |
+
.sp
|
| 352 |
+
\fB\-j\fR \fIN\fR,
|
| 353 |
+
\fB\-\-jobs\fR \fIN\fR
|
| 354 |
+
.RS 4
|
| 355 |
+
Number of parallel jobs to run. May also be specified with the
|
| 356 |
+
\fBbuild.jobs\fR \fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&. Defaults to
|
| 357 |
+
the number of logical CPUs. If negative, it sets the maximum number of
|
| 358 |
+
parallel jobs to the number of logical CPUs plus provided value. If
|
| 359 |
+
a string \fBdefault\fR is provided, it sets the value back to defaults.
|
| 360 |
+
Should not be 0.
|
| 361 |
+
.RE
|
| 362 |
+
.sp
|
| 363 |
+
\fB\-\-keep\-going\fR
|
| 364 |
+
.RS 4
|
| 365 |
+
Build as many crates in the dependency graph as possible, rather than aborting
|
| 366 |
+
the build on the first one that fails to build.
|
| 367 |
+
.sp
|
| 368 |
+
For example if the current package depends on dependencies \fBfails\fR and \fBworks\fR,
|
| 369 |
+
one of which fails to build, \fBcargo install \-j1\fR may or may not build the
|
| 370 |
+
one that succeeds (depending on which one of the two builds Cargo picked to run
|
| 371 |
+
first), whereas \fBcargo install \-j1 \-\-keep\-going\fR would definitely run both
|
| 372 |
+
builds, even if the one run first fails.
|
| 373 |
+
.RE
|
| 374 |
+
.SS "Display Options"
|
| 375 |
+
.sp
|
| 376 |
+
\fB\-v\fR,
|
| 377 |
+
\fB\-\-verbose\fR
|
| 378 |
+
.RS 4
|
| 379 |
+
Use verbose output. May be specified twice for \[lq]very verbose\[rq] output which
|
| 380 |
+
includes extra output such as dependency warnings and build script output.
|
| 381 |
+
May also be specified with the \fBterm.verbose\fR
|
| 382 |
+
\fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 383 |
+
.RE
|
| 384 |
+
.sp
|
| 385 |
+
\fB\-q\fR,
|
| 386 |
+
\fB\-\-quiet\fR
|
| 387 |
+
.RS 4
|
| 388 |
+
Do not print cargo log messages.
|
| 389 |
+
May also be specified with the \fBterm.quiet\fR
|
| 390 |
+
\fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 391 |
+
.RE
|
| 392 |
+
.sp
|
| 393 |
+
\fB\-\-color\fR \fIwhen\fR
|
| 394 |
+
.RS 4
|
| 395 |
+
Control when colored output is used. Valid values:
|
| 396 |
+
.sp
|
| 397 |
+
.RS 4
|
| 398 |
+
\h'-04'\(bu\h'+03'\fBauto\fR (default): Automatically detect if color support is available on the
|
| 399 |
+
terminal.
|
| 400 |
+
.RE
|
| 401 |
+
.sp
|
| 402 |
+
.RS 4
|
| 403 |
+
\h'-04'\(bu\h'+03'\fBalways\fR: Always display colors.
|
| 404 |
+
.RE
|
| 405 |
+
.sp
|
| 406 |
+
.RS 4
|
| 407 |
+
\h'-04'\(bu\h'+03'\fBnever\fR: Never display colors.
|
| 408 |
+
.RE
|
| 409 |
+
.sp
|
| 410 |
+
May also be specified with the \fBterm.color\fR
|
| 411 |
+
\fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 412 |
+
.RE
|
| 413 |
+
.sp
|
| 414 |
+
\fB\-\-message\-format\fR \fIfmt\fR
|
| 415 |
+
.RS 4
|
| 416 |
+
The output format for diagnostic messages. Can be specified multiple times
|
| 417 |
+
and consists of comma\-separated values. Valid values:
|
| 418 |
+
.sp
|
| 419 |
+
.RS 4
|
| 420 |
+
\h'-04'\(bu\h'+03'\fBhuman\fR (default): Display in a human\-readable text format. Conflicts with
|
| 421 |
+
\fBshort\fR and \fBjson\fR\&.
|
| 422 |
+
.RE
|
| 423 |
+
.sp
|
| 424 |
+
.RS 4
|
| 425 |
+
\h'-04'\(bu\h'+03'\fBshort\fR: Emit shorter, human\-readable text messages. Conflicts with \fBhuman\fR
|
| 426 |
+
and \fBjson\fR\&.
|
| 427 |
+
.RE
|
| 428 |
+
.sp
|
| 429 |
+
.RS 4
|
| 430 |
+
\h'-04'\(bu\h'+03'\fBjson\fR: Emit JSON messages to stdout. See
|
| 431 |
+
\fIthe reference\fR <https://doc.rust\-lang.org/cargo/reference/external\-tools.html#json\-messages>
|
| 432 |
+
for more details. Conflicts with \fBhuman\fR and \fBshort\fR\&.
|
| 433 |
+
.RE
|
| 434 |
+
.sp
|
| 435 |
+
.RS 4
|
| 436 |
+
\h'-04'\(bu\h'+03'\fBjson\-diagnostic\-short\fR: Ensure the \fBrendered\fR field of JSON messages contains
|
| 437 |
+
the \[lq]short\[rq] rendering from rustc. Cannot be used with \fBhuman\fR or \fBshort\fR\&.
|
| 438 |
+
.RE
|
| 439 |
+
.sp
|
| 440 |
+
.RS 4
|
| 441 |
+
\h'-04'\(bu\h'+03'\fBjson\-diagnostic\-rendered\-ansi\fR: Ensure the \fBrendered\fR field of JSON messages
|
| 442 |
+
contains embedded ANSI color codes for respecting rustc\[cq]s default color
|
| 443 |
+
scheme. Cannot be used with \fBhuman\fR or \fBshort\fR\&.
|
| 444 |
+
.RE
|
| 445 |
+
.sp
|
| 446 |
+
.RS 4
|
| 447 |
+
\h'-04'\(bu\h'+03'\fBjson\-render\-diagnostics\fR: Instruct Cargo to not include rustc diagnostics
|
| 448 |
+
in JSON messages printed, but instead Cargo itself should render the
|
| 449 |
+
JSON diagnostics coming from rustc. Cargo\[cq]s own JSON diagnostics and others
|
| 450 |
+
coming from rustc are still emitted. Cannot be used with \fBhuman\fR or \fBshort\fR\&.
|
| 451 |
+
.RE
|
| 452 |
+
.RE
|
| 453 |
+
.SS "Common Options"
|
| 454 |
+
.sp
|
| 455 |
+
\fB+\fR\fItoolchain\fR
|
| 456 |
+
.RS 4
|
| 457 |
+
If Cargo has been installed with rustup, and the first argument to \fBcargo\fR
|
| 458 |
+
begins with \fB+\fR, it will be interpreted as a rustup toolchain name (such
|
| 459 |
+
as \fB+stable\fR or \fB+nightly\fR).
|
| 460 |
+
See the \fIrustup documentation\fR <https://rust\-lang.github.io/rustup/overrides.html>
|
| 461 |
+
for more information about how toolchain overrides work.
|
| 462 |
+
.RE
|
| 463 |
+
.sp
|
| 464 |
+
\fB\-\-config\fR \fIKEY=VALUE\fR or \fIPATH\fR
|
| 465 |
+
.RS 4
|
| 466 |
+
Overrides a Cargo configuration value. The argument should be in TOML syntax of \fBKEY=VALUE\fR,
|
| 467 |
+
or provided as a path to an extra configuration file. This flag may be specified multiple times.
|
| 468 |
+
See the \fIcommand\-line overrides section\fR <https://doc.rust\-lang.org/cargo/reference/config.html#command\-line\-overrides> for more information.
|
| 469 |
+
.RE
|
| 470 |
+
.sp
|
| 471 |
+
\fB\-C\fR \fIPATH\fR
|
| 472 |
+
.RS 4
|
| 473 |
+
Changes the current working directory before executing any specified operations. This affects
|
| 474 |
+
things like where cargo looks by default for the project manifest (\fBCargo.toml\fR), as well as
|
| 475 |
+
the directories searched for discovering \fB\&.cargo/config.toml\fR, for example. This option must
|
| 476 |
+
appear before the command name, for example \fBcargo \-C path/to/my\-project build\fR\&.
|
| 477 |
+
.sp
|
| 478 |
+
This option is only available on the \fInightly
|
| 479 |
+
channel\fR <https://doc.rust\-lang.org/book/appendix\-07\-nightly\-rust.html> and
|
| 480 |
+
requires the \fB\-Z unstable\-options\fR flag to enable (see
|
| 481 |
+
\fI#10098\fR <https://github.com/rust\-lang/cargo/issues/10098>).
|
| 482 |
+
.RE
|
| 483 |
+
.sp
|
| 484 |
+
\fB\-h\fR,
|
| 485 |
+
\fB\-\-help\fR
|
| 486 |
+
.RS 4
|
| 487 |
+
Prints help information.
|
| 488 |
+
.RE
|
| 489 |
+
.sp
|
| 490 |
+
\fB\-Z\fR \fIflag\fR
|
| 491 |
+
.RS 4
|
| 492 |
+
Unstable (nightly\-only) flags to Cargo. Run \fBcargo \-Z help\fR for details.
|
| 493 |
+
.RE
|
| 494 |
+
.SH "ENVIRONMENT"
|
| 495 |
+
See \fIthe reference\fR <https://doc.rust\-lang.org/cargo/reference/environment\-variables.html> for
|
| 496 |
+
details on environment variables that Cargo reads.
|
| 497 |
+
.SH "EXIT STATUS"
|
| 498 |
+
.sp
|
| 499 |
+
.RS 4
|
| 500 |
+
\h'-04'\(bu\h'+03'\fB0\fR: Cargo succeeded.
|
| 501 |
+
.RE
|
| 502 |
+
.sp
|
| 503 |
+
.RS 4
|
| 504 |
+
\h'-04'\(bu\h'+03'\fB101\fR: Cargo failed to complete.
|
| 505 |
+
.RE
|
| 506 |
+
.SH "EXAMPLES"
|
| 507 |
+
.sp
|
| 508 |
+
.RS 4
|
| 509 |
+
\h'-04' 1.\h'+01'Install or upgrade a package from crates.io:
|
| 510 |
+
.sp
|
| 511 |
+
.RS 4
|
| 512 |
+
.nf
|
| 513 |
+
cargo install ripgrep
|
| 514 |
+
.fi
|
| 515 |
+
.RE
|
| 516 |
+
.RE
|
| 517 |
+
.sp
|
| 518 |
+
.RS 4
|
| 519 |
+
\h'-04' 2.\h'+01'Install or reinstall the package in the current directory:
|
| 520 |
+
.sp
|
| 521 |
+
.RS 4
|
| 522 |
+
.nf
|
| 523 |
+
cargo install \-\-path .
|
| 524 |
+
.fi
|
| 525 |
+
.RE
|
| 526 |
+
.RE
|
| 527 |
+
.sp
|
| 528 |
+
.RS 4
|
| 529 |
+
\h'-04' 3.\h'+01'View the list of installed packages:
|
| 530 |
+
.sp
|
| 531 |
+
.RS 4
|
| 532 |
+
.nf
|
| 533 |
+
cargo install \-\-list
|
| 534 |
+
.fi
|
| 535 |
+
.RE
|
| 536 |
+
.RE
|
| 537 |
+
.SH "SEE ALSO"
|
| 538 |
+
\fBcargo\fR(1), \fBcargo\-uninstall\fR(1), \fBcargo\-search\fR(1), \fBcargo\-publish\fR(1)
|
rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-locate-project.1
ADDED
|
@@ -0,0 +1,150 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
'\" t
|
| 2 |
+
.TH "CARGO\-LOCATE\-PROJECT" "1"
|
| 3 |
+
.nh
|
| 4 |
+
.ad l
|
| 5 |
+
.ss \n[.ss] 0
|
| 6 |
+
.SH "NAME"
|
| 7 |
+
cargo\-locate\-project \[em] Print a JSON representation of a Cargo.toml file\[cq]s location
|
| 8 |
+
.SH "SYNOPSIS"
|
| 9 |
+
\fBcargo locate\-project\fR [\fIoptions\fR]
|
| 10 |
+
.SH "DESCRIPTION"
|
| 11 |
+
This command will print a JSON object to stdout with the full path to the manifest. The
|
| 12 |
+
manifest is found by searching upward for a file named \fBCargo.toml\fR starting from the current
|
| 13 |
+
working directory.
|
| 14 |
+
.sp
|
| 15 |
+
If the project happens to be a part of a workspace, the manifest of the project, rather than
|
| 16 |
+
the workspace root, is output. This can be overridden by the \fB\-\-workspace\fR flag. The root
|
| 17 |
+
workspace is found by traversing further upward or by using the field \fBpackage.workspace\fR after
|
| 18 |
+
locating the manifest of a workspace member.
|
| 19 |
+
.SH "OPTIONS"
|
| 20 |
+
.sp
|
| 21 |
+
\fB\-\-workspace\fR
|
| 22 |
+
.RS 4
|
| 23 |
+
Locate the \fBCargo.toml\fR at the root of the workspace, as opposed to the current
|
| 24 |
+
workspace member.
|
| 25 |
+
.RE
|
| 26 |
+
.SS "Display Options"
|
| 27 |
+
.sp
|
| 28 |
+
\fB\-\-message\-format\fR \fIfmt\fR
|
| 29 |
+
.RS 4
|
| 30 |
+
The representation in which to print the project location. Valid values:
|
| 31 |
+
.sp
|
| 32 |
+
.RS 4
|
| 33 |
+
\h'-04'\(bu\h'+03'\fBjson\fR (default): JSON object with the path under the key \[lq]root\[rq]\&.
|
| 34 |
+
.RE
|
| 35 |
+
.sp
|
| 36 |
+
.RS 4
|
| 37 |
+
\h'-04'\(bu\h'+03'\fBplain\fR: Just the path.
|
| 38 |
+
.RE
|
| 39 |
+
.RE
|
| 40 |
+
.sp
|
| 41 |
+
\fB\-v\fR,
|
| 42 |
+
\fB\-\-verbose\fR
|
| 43 |
+
.RS 4
|
| 44 |
+
Use verbose output. May be specified twice for \[lq]very verbose\[rq] output which
|
| 45 |
+
includes extra output such as dependency warnings and build script output.
|
| 46 |
+
May also be specified with the \fBterm.verbose\fR
|
| 47 |
+
\fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 48 |
+
.RE
|
| 49 |
+
.sp
|
| 50 |
+
\fB\-q\fR,
|
| 51 |
+
\fB\-\-quiet\fR
|
| 52 |
+
.RS 4
|
| 53 |
+
Do not print cargo log messages.
|
| 54 |
+
May also be specified with the \fBterm.quiet\fR
|
| 55 |
+
\fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 56 |
+
.RE
|
| 57 |
+
.sp
|
| 58 |
+
\fB\-\-color\fR \fIwhen\fR
|
| 59 |
+
.RS 4
|
| 60 |
+
Control when colored output is used. Valid values:
|
| 61 |
+
.sp
|
| 62 |
+
.RS 4
|
| 63 |
+
\h'-04'\(bu\h'+03'\fBauto\fR (default): Automatically detect if color support is available on the
|
| 64 |
+
terminal.
|
| 65 |
+
.RE
|
| 66 |
+
.sp
|
| 67 |
+
.RS 4
|
| 68 |
+
\h'-04'\(bu\h'+03'\fBalways\fR: Always display colors.
|
| 69 |
+
.RE
|
| 70 |
+
.sp
|
| 71 |
+
.RS 4
|
| 72 |
+
\h'-04'\(bu\h'+03'\fBnever\fR: Never display colors.
|
| 73 |
+
.RE
|
| 74 |
+
.sp
|
| 75 |
+
May also be specified with the \fBterm.color\fR
|
| 76 |
+
\fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 77 |
+
.RE
|
| 78 |
+
.SS "Manifest Options"
|
| 79 |
+
.sp
|
| 80 |
+
\fB\-\-manifest\-path\fR \fIpath\fR
|
| 81 |
+
.RS 4
|
| 82 |
+
Path to the \fBCargo.toml\fR file. By default, Cargo searches for the
|
| 83 |
+
\fBCargo.toml\fR file in the current directory or any parent directory.
|
| 84 |
+
.RE
|
| 85 |
+
.SS "Common Options"
|
| 86 |
+
.sp
|
| 87 |
+
\fB+\fR\fItoolchain\fR
|
| 88 |
+
.RS 4
|
| 89 |
+
If Cargo has been installed with rustup, and the first argument to \fBcargo\fR
|
| 90 |
+
begins with \fB+\fR, it will be interpreted as a rustup toolchain name (such
|
| 91 |
+
as \fB+stable\fR or \fB+nightly\fR).
|
| 92 |
+
See the \fIrustup documentation\fR <https://rust\-lang.github.io/rustup/overrides.html>
|
| 93 |
+
for more information about how toolchain overrides work.
|
| 94 |
+
.RE
|
| 95 |
+
.sp
|
| 96 |
+
\fB\-\-config\fR \fIKEY=VALUE\fR or \fIPATH\fR
|
| 97 |
+
.RS 4
|
| 98 |
+
Overrides a Cargo configuration value. The argument should be in TOML syntax of \fBKEY=VALUE\fR,
|
| 99 |
+
or provided as a path to an extra configuration file. This flag may be specified multiple times.
|
| 100 |
+
See the \fIcommand\-line overrides section\fR <https://doc.rust\-lang.org/cargo/reference/config.html#command\-line\-overrides> for more information.
|
| 101 |
+
.RE
|
| 102 |
+
.sp
|
| 103 |
+
\fB\-C\fR \fIPATH\fR
|
| 104 |
+
.RS 4
|
| 105 |
+
Changes the current working directory before executing any specified operations. This affects
|
| 106 |
+
things like where cargo looks by default for the project manifest (\fBCargo.toml\fR), as well as
|
| 107 |
+
the directories searched for discovering \fB\&.cargo/config.toml\fR, for example. This option must
|
| 108 |
+
appear before the command name, for example \fBcargo \-C path/to/my\-project build\fR\&.
|
| 109 |
+
.sp
|
| 110 |
+
This option is only available on the \fInightly
|
| 111 |
+
channel\fR <https://doc.rust\-lang.org/book/appendix\-07\-nightly\-rust.html> and
|
| 112 |
+
requires the \fB\-Z unstable\-options\fR flag to enable (see
|
| 113 |
+
\fI#10098\fR <https://github.com/rust\-lang/cargo/issues/10098>).
|
| 114 |
+
.RE
|
| 115 |
+
.sp
|
| 116 |
+
\fB\-h\fR,
|
| 117 |
+
\fB\-\-help\fR
|
| 118 |
+
.RS 4
|
| 119 |
+
Prints help information.
|
| 120 |
+
.RE
|
| 121 |
+
.sp
|
| 122 |
+
\fB\-Z\fR \fIflag\fR
|
| 123 |
+
.RS 4
|
| 124 |
+
Unstable (nightly\-only) flags to Cargo. Run \fBcargo \-Z help\fR for details.
|
| 125 |
+
.RE
|
| 126 |
+
.SH "ENVIRONMENT"
|
| 127 |
+
See \fIthe reference\fR <https://doc.rust\-lang.org/cargo/reference/environment\-variables.html> for
|
| 128 |
+
details on environment variables that Cargo reads.
|
| 129 |
+
.SH "EXIT STATUS"
|
| 130 |
+
.sp
|
| 131 |
+
.RS 4
|
| 132 |
+
\h'-04'\(bu\h'+03'\fB0\fR: Cargo succeeded.
|
| 133 |
+
.RE
|
| 134 |
+
.sp
|
| 135 |
+
.RS 4
|
| 136 |
+
\h'-04'\(bu\h'+03'\fB101\fR: Cargo failed to complete.
|
| 137 |
+
.RE
|
| 138 |
+
.SH "EXAMPLES"
|
| 139 |
+
.sp
|
| 140 |
+
.RS 4
|
| 141 |
+
\h'-04' 1.\h'+01'Display the path to the manifest based on the current directory:
|
| 142 |
+
.sp
|
| 143 |
+
.RS 4
|
| 144 |
+
.nf
|
| 145 |
+
cargo locate\-project
|
| 146 |
+
.fi
|
| 147 |
+
.RE
|
| 148 |
+
.RE
|
| 149 |
+
.SH "SEE ALSO"
|
| 150 |
+
\fBcargo\fR(1), \fBcargo\-metadata\fR(1)
|
rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-login.1
ADDED
|
@@ -0,0 +1,154 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
'\" t
|
| 2 |
+
.TH "CARGO\-LOGIN" "1"
|
| 3 |
+
.nh
|
| 4 |
+
.ad l
|
| 5 |
+
.ss \n[.ss] 0
|
| 6 |
+
.SH "NAME"
|
| 7 |
+
cargo\-login \[em] Log in to a registry
|
| 8 |
+
.SH "SYNOPSIS"
|
| 9 |
+
\fBcargo login\fR [\fIoptions\fR] [\fB\-\-\fR \fIargs\fR]
|
| 10 |
+
.SH "DESCRIPTION"
|
| 11 |
+
This command will run a credential provider to save a token so that commands
|
| 12 |
+
that require authentication, such as \fBcargo\-publish\fR(1), will be
|
| 13 |
+
automatically authenticated.
|
| 14 |
+
.sp
|
| 15 |
+
All the arguments following the two dashes (\fB\-\-\fR) are passed to the credential provider.
|
| 16 |
+
.sp
|
| 17 |
+
For the default \fBcargo:token\fR credential provider, the token is saved
|
| 18 |
+
in \fB$CARGO_HOME/credentials.toml\fR\&. \fBCARGO_HOME\fR defaults to \fB\&.cargo\fR
|
| 19 |
+
in your home directory.
|
| 20 |
+
.sp
|
| 21 |
+
If a registry has a credential\-provider specified, it will be used. Otherwise,
|
| 22 |
+
the providers from the config value \fBregistry.global\-credential\-providers\fR will
|
| 23 |
+
be attempted, starting from the end of the list.
|
| 24 |
+
.sp
|
| 25 |
+
The \fItoken\fR will be read from stdin.
|
| 26 |
+
.sp
|
| 27 |
+
The API token for crates.io may be retrieved from <https://crates.io/me>\&.
|
| 28 |
+
.sp
|
| 29 |
+
Take care to keep the token secret, it should not be shared with anyone else.
|
| 30 |
+
.SH "OPTIONS"
|
| 31 |
+
.SS "Login Options"
|
| 32 |
+
.sp
|
| 33 |
+
\fB\-\-registry\fR \fIregistry\fR
|
| 34 |
+
.RS 4
|
| 35 |
+
Name of the registry to use. Registry names are defined in \fICargo config
|
| 36 |
+
files\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&. If not specified, the default registry is used,
|
| 37 |
+
which is defined by the \fBregistry.default\fR config key which defaults to
|
| 38 |
+
\fBcrates\-io\fR\&.
|
| 39 |
+
.RE
|
| 40 |
+
.SS "Display Options"
|
| 41 |
+
.sp
|
| 42 |
+
\fB\-v\fR,
|
| 43 |
+
\fB\-\-verbose\fR
|
| 44 |
+
.RS 4
|
| 45 |
+
Use verbose output. May be specified twice for \[lq]very verbose\[rq] output which
|
| 46 |
+
includes extra output such as dependency warnings and build script output.
|
| 47 |
+
May also be specified with the \fBterm.verbose\fR
|
| 48 |
+
\fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 49 |
+
.RE
|
| 50 |
+
.sp
|
| 51 |
+
\fB\-q\fR,
|
| 52 |
+
\fB\-\-quiet\fR
|
| 53 |
+
.RS 4
|
| 54 |
+
Do not print cargo log messages.
|
| 55 |
+
May also be specified with the \fBterm.quiet\fR
|
| 56 |
+
\fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 57 |
+
.RE
|
| 58 |
+
.sp
|
| 59 |
+
\fB\-\-color\fR \fIwhen\fR
|
| 60 |
+
.RS 4
|
| 61 |
+
Control when colored output is used. Valid values:
|
| 62 |
+
.sp
|
| 63 |
+
.RS 4
|
| 64 |
+
\h'-04'\(bu\h'+03'\fBauto\fR (default): Automatically detect if color support is available on the
|
| 65 |
+
terminal.
|
| 66 |
+
.RE
|
| 67 |
+
.sp
|
| 68 |
+
.RS 4
|
| 69 |
+
\h'-04'\(bu\h'+03'\fBalways\fR: Always display colors.
|
| 70 |
+
.RE
|
| 71 |
+
.sp
|
| 72 |
+
.RS 4
|
| 73 |
+
\h'-04'\(bu\h'+03'\fBnever\fR: Never display colors.
|
| 74 |
+
.RE
|
| 75 |
+
.sp
|
| 76 |
+
May also be specified with the \fBterm.color\fR
|
| 77 |
+
\fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 78 |
+
.RE
|
| 79 |
+
.SS "Common Options"
|
| 80 |
+
.sp
|
| 81 |
+
\fB+\fR\fItoolchain\fR
|
| 82 |
+
.RS 4
|
| 83 |
+
If Cargo has been installed with rustup, and the first argument to \fBcargo\fR
|
| 84 |
+
begins with \fB+\fR, it will be interpreted as a rustup toolchain name (such
|
| 85 |
+
as \fB+stable\fR or \fB+nightly\fR).
|
| 86 |
+
See the \fIrustup documentation\fR <https://rust\-lang.github.io/rustup/overrides.html>
|
| 87 |
+
for more information about how toolchain overrides work.
|
| 88 |
+
.RE
|
| 89 |
+
.sp
|
| 90 |
+
\fB\-\-config\fR \fIKEY=VALUE\fR or \fIPATH\fR
|
| 91 |
+
.RS 4
|
| 92 |
+
Overrides a Cargo configuration value. The argument should be in TOML syntax of \fBKEY=VALUE\fR,
|
| 93 |
+
or provided as a path to an extra configuration file. This flag may be specified multiple times.
|
| 94 |
+
See the \fIcommand\-line overrides section\fR <https://doc.rust\-lang.org/cargo/reference/config.html#command\-line\-overrides> for more information.
|
| 95 |
+
.RE
|
| 96 |
+
.sp
|
| 97 |
+
\fB\-C\fR \fIPATH\fR
|
| 98 |
+
.RS 4
|
| 99 |
+
Changes the current working directory before executing any specified operations. This affects
|
| 100 |
+
things like where cargo looks by default for the project manifest (\fBCargo.toml\fR), as well as
|
| 101 |
+
the directories searched for discovering \fB\&.cargo/config.toml\fR, for example. This option must
|
| 102 |
+
appear before the command name, for example \fBcargo \-C path/to/my\-project build\fR\&.
|
| 103 |
+
.sp
|
| 104 |
+
This option is only available on the \fInightly
|
| 105 |
+
channel\fR <https://doc.rust\-lang.org/book/appendix\-07\-nightly\-rust.html> and
|
| 106 |
+
requires the \fB\-Z unstable\-options\fR flag to enable (see
|
| 107 |
+
\fI#10098\fR <https://github.com/rust\-lang/cargo/issues/10098>).
|
| 108 |
+
.RE
|
| 109 |
+
.sp
|
| 110 |
+
\fB\-h\fR,
|
| 111 |
+
\fB\-\-help\fR
|
| 112 |
+
.RS 4
|
| 113 |
+
Prints help information.
|
| 114 |
+
.RE
|
| 115 |
+
.sp
|
| 116 |
+
\fB\-Z\fR \fIflag\fR
|
| 117 |
+
.RS 4
|
| 118 |
+
Unstable (nightly\-only) flags to Cargo. Run \fBcargo \-Z help\fR for details.
|
| 119 |
+
.RE
|
| 120 |
+
.SH "ENVIRONMENT"
|
| 121 |
+
See \fIthe reference\fR <https://doc.rust\-lang.org/cargo/reference/environment\-variables.html> for
|
| 122 |
+
details on environment variables that Cargo reads.
|
| 123 |
+
.SH "EXIT STATUS"
|
| 124 |
+
.sp
|
| 125 |
+
.RS 4
|
| 126 |
+
\h'-04'\(bu\h'+03'\fB0\fR: Cargo succeeded.
|
| 127 |
+
.RE
|
| 128 |
+
.sp
|
| 129 |
+
.RS 4
|
| 130 |
+
\h'-04'\(bu\h'+03'\fB101\fR: Cargo failed to complete.
|
| 131 |
+
.RE
|
| 132 |
+
.SH "EXAMPLES"
|
| 133 |
+
.sp
|
| 134 |
+
.RS 4
|
| 135 |
+
\h'-04' 1.\h'+01'Save the token for the default registry:
|
| 136 |
+
.sp
|
| 137 |
+
.RS 4
|
| 138 |
+
.nf
|
| 139 |
+
cargo login
|
| 140 |
+
.fi
|
| 141 |
+
.RE
|
| 142 |
+
.RE
|
| 143 |
+
.sp
|
| 144 |
+
.RS 4
|
| 145 |
+
\h'-04' 2.\h'+01'Save the token for a specific registry:
|
| 146 |
+
.sp
|
| 147 |
+
.RS 4
|
| 148 |
+
.nf
|
| 149 |
+
cargo login \-\-registry my\-registry
|
| 150 |
+
.fi
|
| 151 |
+
.RE
|
| 152 |
+
.RE
|
| 153 |
+
.SH "SEE ALSO"
|
| 154 |
+
\fBcargo\fR(1), \fBcargo\-logout\fR(1), \fBcargo\-publish\fR(1)
|
rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-logout.1
ADDED
|
@@ -0,0 +1,153 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
'\" t
|
| 2 |
+
.TH "CARGO\-LOGOUT" "1"
|
| 3 |
+
.nh
|
| 4 |
+
.ad l
|
| 5 |
+
.ss \n[.ss] 0
|
| 6 |
+
.SH "NAME"
|
| 7 |
+
cargo\-logout \[em] Remove an API token from the registry locally
|
| 8 |
+
.SH "SYNOPSIS"
|
| 9 |
+
\fBcargo logout\fR [\fIoptions\fR]
|
| 10 |
+
.SH "DESCRIPTION"
|
| 11 |
+
This command will run a credential provider to remove a saved token.
|
| 12 |
+
.sp
|
| 13 |
+
For the default \fBcargo:token\fR credential provider, credentials are stored
|
| 14 |
+
in \fB$CARGO_HOME/credentials.toml\fR where \fB$CARGO_HOME\fR defaults to \fB\&.cargo\fR
|
| 15 |
+
in your home directory.
|
| 16 |
+
.sp
|
| 17 |
+
If a registry has a credential\-provider specified, it will be used. Otherwise,
|
| 18 |
+
the providers from the config value \fBregistry.global\-credential\-providers\fR will
|
| 19 |
+
be attempted, starting from the end of the list.
|
| 20 |
+
.sp
|
| 21 |
+
If \fB\-\-registry\fR is not specified, then the credentials for the default
|
| 22 |
+
registry will be removed (configured by
|
| 23 |
+
\fI\f(BIregistry.default\fI\fR <https://doc.rust\-lang.org/cargo/reference/config.html#registrydefault>, which defaults
|
| 24 |
+
to <https://crates.io/>).
|
| 25 |
+
.sp
|
| 26 |
+
This will not revoke the token on the server. If you need to revoke the token,
|
| 27 |
+
visit the registry website and follow its instructions (see
|
| 28 |
+
<https://crates.io/me> to revoke the token for <https://crates.io/>).
|
| 29 |
+
.SH "OPTIONS"
|
| 30 |
+
.SS "Logout Options"
|
| 31 |
+
.sp
|
| 32 |
+
\fB\-\-registry\fR \fIregistry\fR
|
| 33 |
+
.RS 4
|
| 34 |
+
Name of the registry to use. Registry names are defined in \fICargo config
|
| 35 |
+
files\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&. If not specified, the default registry is used,
|
| 36 |
+
which is defined by the \fBregistry.default\fR config key which defaults to
|
| 37 |
+
\fBcrates\-io\fR\&.
|
| 38 |
+
.RE
|
| 39 |
+
.SS "Display Options"
|
| 40 |
+
.sp
|
| 41 |
+
\fB\-v\fR,
|
| 42 |
+
\fB\-\-verbose\fR
|
| 43 |
+
.RS 4
|
| 44 |
+
Use verbose output. May be specified twice for \[lq]very verbose\[rq] output which
|
| 45 |
+
includes extra output such as dependency warnings and build script output.
|
| 46 |
+
May also be specified with the \fBterm.verbose\fR
|
| 47 |
+
\fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 48 |
+
.RE
|
| 49 |
+
.sp
|
| 50 |
+
\fB\-q\fR,
|
| 51 |
+
\fB\-\-quiet\fR
|
| 52 |
+
.RS 4
|
| 53 |
+
Do not print cargo log messages.
|
| 54 |
+
May also be specified with the \fBterm.quiet\fR
|
| 55 |
+
\fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 56 |
+
.RE
|
| 57 |
+
.sp
|
| 58 |
+
\fB\-\-color\fR \fIwhen\fR
|
| 59 |
+
.RS 4
|
| 60 |
+
Control when colored output is used. Valid values:
|
| 61 |
+
.sp
|
| 62 |
+
.RS 4
|
| 63 |
+
\h'-04'\(bu\h'+03'\fBauto\fR (default): Automatically detect if color support is available on the
|
| 64 |
+
terminal.
|
| 65 |
+
.RE
|
| 66 |
+
.sp
|
| 67 |
+
.RS 4
|
| 68 |
+
\h'-04'\(bu\h'+03'\fBalways\fR: Always display colors.
|
| 69 |
+
.RE
|
| 70 |
+
.sp
|
| 71 |
+
.RS 4
|
| 72 |
+
\h'-04'\(bu\h'+03'\fBnever\fR: Never display colors.
|
| 73 |
+
.RE
|
| 74 |
+
.sp
|
| 75 |
+
May also be specified with the \fBterm.color\fR
|
| 76 |
+
\fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 77 |
+
.RE
|
| 78 |
+
.SS "Common Options"
|
| 79 |
+
.sp
|
| 80 |
+
\fB+\fR\fItoolchain\fR
|
| 81 |
+
.RS 4
|
| 82 |
+
If Cargo has been installed with rustup, and the first argument to \fBcargo\fR
|
| 83 |
+
begins with \fB+\fR, it will be interpreted as a rustup toolchain name (such
|
| 84 |
+
as \fB+stable\fR or \fB+nightly\fR).
|
| 85 |
+
See the \fIrustup documentation\fR <https://rust\-lang.github.io/rustup/overrides.html>
|
| 86 |
+
for more information about how toolchain overrides work.
|
| 87 |
+
.RE
|
| 88 |
+
.sp
|
| 89 |
+
\fB\-\-config\fR \fIKEY=VALUE\fR or \fIPATH\fR
|
| 90 |
+
.RS 4
|
| 91 |
+
Overrides a Cargo configuration value. The argument should be in TOML syntax of \fBKEY=VALUE\fR,
|
| 92 |
+
or provided as a path to an extra configuration file. This flag may be specified multiple times.
|
| 93 |
+
See the \fIcommand\-line overrides section\fR <https://doc.rust\-lang.org/cargo/reference/config.html#command\-line\-overrides> for more information.
|
| 94 |
+
.RE
|
| 95 |
+
.sp
|
| 96 |
+
\fB\-C\fR \fIPATH\fR
|
| 97 |
+
.RS 4
|
| 98 |
+
Changes the current working directory before executing any specified operations. This affects
|
| 99 |
+
things like where cargo looks by default for the project manifest (\fBCargo.toml\fR), as well as
|
| 100 |
+
the directories searched for discovering \fB\&.cargo/config.toml\fR, for example. This option must
|
| 101 |
+
appear before the command name, for example \fBcargo \-C path/to/my\-project build\fR\&.
|
| 102 |
+
.sp
|
| 103 |
+
This option is only available on the \fInightly
|
| 104 |
+
channel\fR <https://doc.rust\-lang.org/book/appendix\-07\-nightly\-rust.html> and
|
| 105 |
+
requires the \fB\-Z unstable\-options\fR flag to enable (see
|
| 106 |
+
\fI#10098\fR <https://github.com/rust\-lang/cargo/issues/10098>).
|
| 107 |
+
.RE
|
| 108 |
+
.sp
|
| 109 |
+
\fB\-h\fR,
|
| 110 |
+
\fB\-\-help\fR
|
| 111 |
+
.RS 4
|
| 112 |
+
Prints help information.
|
| 113 |
+
.RE
|
| 114 |
+
.sp
|
| 115 |
+
\fB\-Z\fR \fIflag\fR
|
| 116 |
+
.RS 4
|
| 117 |
+
Unstable (nightly\-only) flags to Cargo. Run \fBcargo \-Z help\fR for details.
|
| 118 |
+
.RE
|
| 119 |
+
.SH "ENVIRONMENT"
|
| 120 |
+
See \fIthe reference\fR <https://doc.rust\-lang.org/cargo/reference/environment\-variables.html> for
|
| 121 |
+
details on environment variables that Cargo reads.
|
| 122 |
+
.SH "EXIT STATUS"
|
| 123 |
+
.sp
|
| 124 |
+
.RS 4
|
| 125 |
+
\h'-04'\(bu\h'+03'\fB0\fR: Cargo succeeded.
|
| 126 |
+
.RE
|
| 127 |
+
.sp
|
| 128 |
+
.RS 4
|
| 129 |
+
\h'-04'\(bu\h'+03'\fB101\fR: Cargo failed to complete.
|
| 130 |
+
.RE
|
| 131 |
+
.SH "EXAMPLES"
|
| 132 |
+
.sp
|
| 133 |
+
.RS 4
|
| 134 |
+
\h'-04' 1.\h'+01'Remove the default registry token:
|
| 135 |
+
.sp
|
| 136 |
+
.RS 4
|
| 137 |
+
.nf
|
| 138 |
+
cargo logout
|
| 139 |
+
.fi
|
| 140 |
+
.RE
|
| 141 |
+
.RE
|
| 142 |
+
.sp
|
| 143 |
+
.RS 4
|
| 144 |
+
\h'-04' 2.\h'+01'Remove the token for a specific registry:
|
| 145 |
+
.sp
|
| 146 |
+
.RS 4
|
| 147 |
+
.nf
|
| 148 |
+
cargo logout \-\-registry my\-registry
|
| 149 |
+
.fi
|
| 150 |
+
.RE
|
| 151 |
+
.RE
|
| 152 |
+
.SH "SEE ALSO"
|
| 153 |
+
\fBcargo\fR(1), \fBcargo\-login\fR(1)
|
rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-metadata.1
ADDED
|
@@ -0,0 +1,552 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
'\" t
|
| 2 |
+
.TH "CARGO\-METADATA" "1"
|
| 3 |
+
.nh
|
| 4 |
+
.ad l
|
| 5 |
+
.ss \n[.ss] 0
|
| 6 |
+
.SH "NAME"
|
| 7 |
+
cargo\-metadata \[em] Machine\-readable metadata about the current package
|
| 8 |
+
.SH "SYNOPSIS"
|
| 9 |
+
\fBcargo metadata\fR [\fIoptions\fR]
|
| 10 |
+
.SH "DESCRIPTION"
|
| 11 |
+
Output JSON to stdout containing information about the workspace members and
|
| 12 |
+
resolved dependencies of the current package.
|
| 13 |
+
.sp
|
| 14 |
+
The output format is subject to change in future versions of Cargo. It
|
| 15 |
+
is recommended to include the \fB\-\-format\-version\fR flag to future\-proof your code
|
| 16 |
+
and ensure the output is in the format you are expecting. For more on the
|
| 17 |
+
expectations, see \[lq]Compatibility\[rq]\&.
|
| 18 |
+
.sp
|
| 19 |
+
See the \fIcargo_metadata crate\fR <https://crates.io/crates/cargo_metadata>
|
| 20 |
+
for a Rust API for reading the metadata.
|
| 21 |
+
.SH "OUTPUT FORMAT"
|
| 22 |
+
.SS "Compatibility"
|
| 23 |
+
Within the same output format version, the compatibility is maintained, except
|
| 24 |
+
some scenarios. The following is a non\-exhaustive list of changes that are not
|
| 25 |
+
considered as incompatible:
|
| 26 |
+
.sp
|
| 27 |
+
.RS 4
|
| 28 |
+
\h'-04'\(bu\h'+03'\fBAdding new fields\fR \[em] New fields will be added when needed. Reserving this
|
| 29 |
+
helps Cargo evolve without bumping the format version too often.
|
| 30 |
+
.RE
|
| 31 |
+
.sp
|
| 32 |
+
.RS 4
|
| 33 |
+
\h'-04'\(bu\h'+03'\fBAdding new values for enum\-like fields\fR \[em] Same as adding new fields. It
|
| 34 |
+
keeps metadata evolving without stagnation.
|
| 35 |
+
.RE
|
| 36 |
+
.sp
|
| 37 |
+
.RS 4
|
| 38 |
+
\h'-04'\(bu\h'+03'\fBChanging opaque representations\fR \[em] The inner representations of some
|
| 39 |
+
fields are implementation details. For example, fields related to
|
| 40 |
+
\[lq]Source ID\[rq] are treated as opaque identifiers to differentiate packages or
|
| 41 |
+
sources. Consumers shouldn\[cq]t rely on those representations unless specified.
|
| 42 |
+
.RE
|
| 43 |
+
.SS "JSON format"
|
| 44 |
+
The JSON output has the following format:
|
| 45 |
+
.sp
|
| 46 |
+
.RS 4
|
| 47 |
+
.nf
|
| 48 |
+
{
|
| 49 |
+
/* Array of all packages in the workspace.
|
| 50 |
+
It also includes all feature\-enabled dependencies unless \-\-no\-deps is used.
|
| 51 |
+
*/
|
| 52 |
+
"packages": [
|
| 53 |
+
{
|
| 54 |
+
/* The name of the package. */
|
| 55 |
+
"name": "my\-package",
|
| 56 |
+
/* The version of the package. */
|
| 57 |
+
"version": "0.1.0",
|
| 58 |
+
/* The Package ID for referring to the
|
| 59 |
+
package within the document and as the `\-\-package` argument to many commands
|
| 60 |
+
*/
|
| 61 |
+
"id": "file:///path/to/my\-package#0.1.0",
|
| 62 |
+
/* The license value from the manifest, or null. */
|
| 63 |
+
"license": "MIT/Apache\-2.0",
|
| 64 |
+
/* The license\-file value from the manifest, or null. */
|
| 65 |
+
"license_file": "LICENSE",
|
| 66 |
+
/* The description value from the manifest, or null. */
|
| 67 |
+
"description": "Package description.",
|
| 68 |
+
/* The source ID of the package, an "opaque" identifier representing
|
| 69 |
+
where a package is retrieved from. See "Compatibility" above for
|
| 70 |
+
the stability guarantee.
|
| 71 |
+
|
| 72 |
+
This is null for path dependencies and workspace members.
|
| 73 |
+
|
| 74 |
+
For other dependencies, it is a string with the format:
|
| 75 |
+
\- "registry+URL" for registry\-based dependencies.
|
| 76 |
+
Example: "registry+https://github.com/rust\-lang/crates.io\-index"
|
| 77 |
+
\- "git+URL" for git\-based dependencies.
|
| 78 |
+
Example: "git+https://github.com/rust\-lang/cargo?rev=5e85ba14aaa20f8133863373404cb0af69eeef2c#5e85ba14aaa20f8133863373404cb0af69eeef2c"
|
| 79 |
+
\- "sparse+URL" for dependencies from a sparse registry
|
| 80 |
+
Example: "sparse+https://my\-sparse\-registry.org"
|
| 81 |
+
|
| 82 |
+
The value after the `+` is not explicitly defined, and may change
|
| 83 |
+
between versions of Cargo and may not directly correlate to other
|
| 84 |
+
things, such as registry definitions in a config file. New source
|
| 85 |
+
kinds may be added in the future which will have different `+`
|
| 86 |
+
prefixed identifiers.
|
| 87 |
+
*/
|
| 88 |
+
"source": null,
|
| 89 |
+
/* Array of dependencies declared in the package's manifest. */
|
| 90 |
+
"dependencies": [
|
| 91 |
+
{
|
| 92 |
+
/* The name of the dependency. */
|
| 93 |
+
"name": "bitflags",
|
| 94 |
+
/* The source ID of the dependency. May be null, see
|
| 95 |
+
description for the package source.
|
| 96 |
+
*/
|
| 97 |
+
"source": "registry+https://github.com/rust\-lang/crates.io\-index",
|
| 98 |
+
/* The version requirement for the dependency.
|
| 99 |
+
Dependencies without a version requirement have a value of "*".
|
| 100 |
+
*/
|
| 101 |
+
"req": "^1.0",
|
| 102 |
+
/* The dependency kind.
|
| 103 |
+
"dev", "build", or null for a normal dependency.
|
| 104 |
+
*/
|
| 105 |
+
"kind": null,
|
| 106 |
+
/* If the dependency is renamed, this is the new name for
|
| 107 |
+
the dependency as a string. null if it is not renamed.
|
| 108 |
+
*/
|
| 109 |
+
"rename": null,
|
| 110 |
+
/* Boolean of whether or not this is an optional dependency. */
|
| 111 |
+
"optional": false,
|
| 112 |
+
/* Boolean of whether or not default features are enabled. */
|
| 113 |
+
"uses_default_features": true,
|
| 114 |
+
/* Array of features enabled. */
|
| 115 |
+
"features": [],
|
| 116 |
+
/* The target platform for the dependency.
|
| 117 |
+
null if not a target dependency.
|
| 118 |
+
*/
|
| 119 |
+
"target": "cfg(windows)",
|
| 120 |
+
/* The file system path for a local path dependency.
|
| 121 |
+
not present if not a path dependency.
|
| 122 |
+
*/
|
| 123 |
+
"path": "/path/to/dep",
|
| 124 |
+
/* A string of the URL of the registry this dependency is from.
|
| 125 |
+
If not specified or null, the dependency is from the default
|
| 126 |
+
registry (crates.io).
|
| 127 |
+
*/
|
| 128 |
+
"registry": null,
|
| 129 |
+
/* (unstable) Boolean flag of whether or not this is a pulbic
|
| 130 |
+
dependency. This field is only present when
|
| 131 |
+
`\-Zpublic\-dependency` is enabled.
|
| 132 |
+
*/
|
| 133 |
+
"public": false
|
| 134 |
+
}
|
| 135 |
+
],
|
| 136 |
+
/* Array of Cargo targets. */
|
| 137 |
+
"targets": [
|
| 138 |
+
{
|
| 139 |
+
/* Array of target kinds.
|
| 140 |
+
\- lib targets list the `crate\-type` values from the
|
| 141 |
+
manifest such as "lib", "rlib", "dylib",
|
| 142 |
+
"proc\-macro", etc. (default ["lib"])
|
| 143 |
+
\- binary is ["bin"]
|
| 144 |
+
\- example is ["example"]
|
| 145 |
+
\- integration test is ["test"]
|
| 146 |
+
\- benchmark is ["bench"]
|
| 147 |
+
\- build script is ["custom\-build"]
|
| 148 |
+
*/
|
| 149 |
+
"kind": [
|
| 150 |
+
"bin"
|
| 151 |
+
],
|
| 152 |
+
/* Array of crate types.
|
| 153 |
+
\- lib and example libraries list the `crate\-type` values
|
| 154 |
+
from the manifest such as "lib", "rlib", "dylib",
|
| 155 |
+
"proc\-macro", etc. (default ["lib"])
|
| 156 |
+
\- all other target kinds are ["bin"]
|
| 157 |
+
*/
|
| 158 |
+
"crate_types": [
|
| 159 |
+
"bin"
|
| 160 |
+
],
|
| 161 |
+
/* The name of the target.
|
| 162 |
+
For lib targets, dashes will be replaced with underscores.
|
| 163 |
+
*/
|
| 164 |
+
"name": "my\-package",
|
| 165 |
+
/* Absolute path to the root source file of the target. */
|
| 166 |
+
"src_path": "/path/to/my\-package/src/main.rs",
|
| 167 |
+
/* The Rust edition of the target.
|
| 168 |
+
Defaults to the package edition.
|
| 169 |
+
*/
|
| 170 |
+
"edition": "2018",
|
| 171 |
+
/* Array of required features.
|
| 172 |
+
This property is not included if no required features are set.
|
| 173 |
+
*/
|
| 174 |
+
"required\-features": ["feat1"],
|
| 175 |
+
/* Whether the target should be documented by `cargo doc`. */
|
| 176 |
+
"doc": true,
|
| 177 |
+
/* Whether or not this target has doc tests enabled, and
|
| 178 |
+
the target is compatible with doc testing.
|
| 179 |
+
*/
|
| 180 |
+
"doctest": false,
|
| 181 |
+
/* Whether or not this target should be built and run with `\-\-test`
|
| 182 |
+
*/
|
| 183 |
+
"test": true
|
| 184 |
+
}
|
| 185 |
+
],
|
| 186 |
+
/* Set of features defined for the package.
|
| 187 |
+
Each feature maps to an array of features or dependencies it
|
| 188 |
+
enables.
|
| 189 |
+
*/
|
| 190 |
+
"features": {
|
| 191 |
+
"default": [
|
| 192 |
+
"feat1"
|
| 193 |
+
],
|
| 194 |
+
"feat1": [],
|
| 195 |
+
"feat2": []
|
| 196 |
+
},
|
| 197 |
+
/* Absolute path to this package's manifest. */
|
| 198 |
+
"manifest_path": "/path/to/my\-package/Cargo.toml",
|
| 199 |
+
/* Package metadata.
|
| 200 |
+
This is null if no metadata is specified.
|
| 201 |
+
*/
|
| 202 |
+
"metadata": {
|
| 203 |
+
"docs": {
|
| 204 |
+
"rs": {
|
| 205 |
+
"all\-features": true
|
| 206 |
+
}
|
| 207 |
+
}
|
| 208 |
+
},
|
| 209 |
+
/* List of registries to which this package may be published.
|
| 210 |
+
Publishing is unrestricted if null, and forbidden if an empty array. */
|
| 211 |
+
"publish": [
|
| 212 |
+
"crates\-io"
|
| 213 |
+
],
|
| 214 |
+
/* Array of authors from the manifest.
|
| 215 |
+
Empty array if no authors specified.
|
| 216 |
+
*/
|
| 217 |
+
"authors": [
|
| 218 |
+
"Jane Doe <user@example.com>"
|
| 219 |
+
],
|
| 220 |
+
/* Array of categories from the manifest. */
|
| 221 |
+
"categories": [
|
| 222 |
+
"command\-line\-utilities"
|
| 223 |
+
],
|
| 224 |
+
/* Optional string that is the default binary picked by cargo run. */
|
| 225 |
+
"default_run": null,
|
| 226 |
+
/* Optional string that is the minimum supported rust version */
|
| 227 |
+
"rust_version": "1.56",
|
| 228 |
+
/* Array of keywords from the manifest. */
|
| 229 |
+
"keywords": [
|
| 230 |
+
"cli"
|
| 231 |
+
],
|
| 232 |
+
/* The readme value from the manifest or null if not specified. */
|
| 233 |
+
"readme": "README.md",
|
| 234 |
+
/* The repository value from the manifest or null if not specified. */
|
| 235 |
+
"repository": "https://github.com/rust\-lang/cargo",
|
| 236 |
+
/* The homepage value from the manifest or null if not specified. */
|
| 237 |
+
"homepage": "https://rust\-lang.org",
|
| 238 |
+
/* The documentation value from the manifest or null if not specified. */
|
| 239 |
+
"documentation": "https://doc.rust\-lang.org/stable/std",
|
| 240 |
+
/* The default edition of the package.
|
| 241 |
+
Note that individual targets may have different editions.
|
| 242 |
+
*/
|
| 243 |
+
"edition": "2018",
|
| 244 |
+
/* Optional string that is the name of a native library the package
|
| 245 |
+
is linking to.
|
| 246 |
+
*/
|
| 247 |
+
"links": null,
|
| 248 |
+
}
|
| 249 |
+
],
|
| 250 |
+
/* Array of members of the workspace.
|
| 251 |
+
Each entry is the Package ID for the package.
|
| 252 |
+
*/
|
| 253 |
+
"workspace_members": [
|
| 254 |
+
"file:///path/to/my\-package#0.1.0",
|
| 255 |
+
],
|
| 256 |
+
/* Array of default members of the workspace.
|
| 257 |
+
Each entry is the Package ID for the package.
|
| 258 |
+
*/
|
| 259 |
+
"workspace_default_members": [
|
| 260 |
+
"file:///path/to/my\-package#0.1.0",
|
| 261 |
+
],
|
| 262 |
+
// The resolved dependency graph for the entire workspace. The enabled
|
| 263 |
+
// features are based on the enabled features for the "current" package.
|
| 264 |
+
// Inactivated optional dependencies are not listed.
|
| 265 |
+
//
|
| 266 |
+
// This is null if \-\-no\-deps is specified.
|
| 267 |
+
//
|
| 268 |
+
// By default, this includes all dependencies for all target platforms.
|
| 269 |
+
// The `\-\-filter\-platform` flag may be used to narrow to a specific
|
| 270 |
+
// target triple.
|
| 271 |
+
"resolve": {
|
| 272 |
+
/* Array of nodes within the dependency graph.
|
| 273 |
+
Each node is a package.
|
| 274 |
+
*/
|
| 275 |
+
"nodes": [
|
| 276 |
+
{
|
| 277 |
+
/* The Package ID of this node. */
|
| 278 |
+
"id": "file:///path/to/my\-package#0.1.0",
|
| 279 |
+
/* The dependencies of this package, an array of Package IDs. */
|
| 280 |
+
"dependencies": [
|
| 281 |
+
"https://github.com/rust\-lang/crates.io\-index#bitflags@1.0.4"
|
| 282 |
+
],
|
| 283 |
+
/* The dependencies of this package. This is an alternative to
|
| 284 |
+
"dependencies" which contains additional information. In
|
| 285 |
+
particular, this handles renamed dependencies.
|
| 286 |
+
*/
|
| 287 |
+
"deps": [
|
| 288 |
+
{
|
| 289 |
+
/* The name of the dependency's library target.
|
| 290 |
+
If this is a renamed dependency, this is the new
|
| 291 |
+
name.
|
| 292 |
+
*/
|
| 293 |
+
"name": "bitflags",
|
| 294 |
+
/* The Package ID of the dependency. */
|
| 295 |
+
"pkg": "https://github.com/rust\-lang/crates.io\-index#bitflags@1.0.4"
|
| 296 |
+
/* Array of dependency kinds. Added in Cargo 1.40. */
|
| 297 |
+
"dep_kinds": [
|
| 298 |
+
{
|
| 299 |
+
/* The dependency kind.
|
| 300 |
+
"dev", "build", or null for a normal dependency.
|
| 301 |
+
*/
|
| 302 |
+
"kind": null,
|
| 303 |
+
/* The target platform for the dependency.
|
| 304 |
+
null if not a target dependency.
|
| 305 |
+
*/
|
| 306 |
+
"target": "cfg(windows)"
|
| 307 |
+
}
|
| 308 |
+
]
|
| 309 |
+
}
|
| 310 |
+
],
|
| 311 |
+
/* Array of features enabled on this package. */
|
| 312 |
+
"features": [
|
| 313 |
+
"default"
|
| 314 |
+
]
|
| 315 |
+
}
|
| 316 |
+
],
|
| 317 |
+
/* The package in the current working directory (if \-\-manifest\-path is not given).
|
| 318 |
+
This is null if there is a virtual workspace. Otherwise it is
|
| 319 |
+
the Package ID of the package.
|
| 320 |
+
*/
|
| 321 |
+
"root": "file:///path/to/my\-package#0.1.0",
|
| 322 |
+
},
|
| 323 |
+
/* The absolute path to the target directory where Cargo places its output. */
|
| 324 |
+
"target_directory": "/path/to/my\-package/target",
|
| 325 |
+
/* The absolute path to the build directory where Cargo places intermediate build artifacts. (unstable) */
|
| 326 |
+
"build_directory": "/path/to/my\-package/build\-dir",
|
| 327 |
+
/* The version of the schema for this metadata structure.
|
| 328 |
+
This will be changed if incompatible changes are ever made.
|
| 329 |
+
*/
|
| 330 |
+
"version": 1,
|
| 331 |
+
/* The absolute path to the root of the workspace. */
|
| 332 |
+
"workspace_root": "/path/to/my\-package"
|
| 333 |
+
/* Workspace metadata.
|
| 334 |
+
This is null if no metadata is specified. */
|
| 335 |
+
"metadata": {
|
| 336 |
+
"docs": {
|
| 337 |
+
"rs": {
|
| 338 |
+
"all\-features": true
|
| 339 |
+
}
|
| 340 |
+
}
|
| 341 |
+
}
|
| 342 |
+
}
|
| 343 |
+
.fi
|
| 344 |
+
.RE
|
| 345 |
+
.sp
|
| 346 |
+
Notes:
|
| 347 |
+
.sp
|
| 348 |
+
.RS 4
|
| 349 |
+
\h'-04'\(bu\h'+03'For \fB"id"\fR field syntax, see \fIPackage ID Specifications\fR <https://doc.rust\-lang.org/cargo/reference/pkgid\-spec.html> in the reference.
|
| 350 |
+
.RE
|
| 351 |
+
.SH "OPTIONS"
|
| 352 |
+
.SS "Output Options"
|
| 353 |
+
.sp
|
| 354 |
+
\fB\-\-no\-deps\fR
|
| 355 |
+
.RS 4
|
| 356 |
+
Output information only about the workspace members and don\[cq]t fetch
|
| 357 |
+
dependencies.
|
| 358 |
+
.RE
|
| 359 |
+
.sp
|
| 360 |
+
\fB\-\-format\-version\fR \fIversion\fR
|
| 361 |
+
.RS 4
|
| 362 |
+
Specify the version of the output format to use. Currently \fB1\fR is the only
|
| 363 |
+
possible value.
|
| 364 |
+
.RE
|
| 365 |
+
.sp
|
| 366 |
+
\fB\-\-filter\-platform\fR \fItriple\fR
|
| 367 |
+
.RS 4
|
| 368 |
+
This filters the \fBresolve\fR output to only include dependencies for the
|
| 369 |
+
given \fItarget triple\fR <https://doc.rust\-lang.org/cargo/appendix/glossary.html#target>\&.
|
| 370 |
+
A literal \fB"host\-tuple"\fR can be used, which will internally be substituted by the host\[cq]s target.
|
| 371 |
+
Without this flag, the resolve includes all targets.
|
| 372 |
+
.sp
|
| 373 |
+
Note that the dependencies listed in the \[lq]packages\[rq] array still includes all
|
| 374 |
+
dependencies. Each package definition is intended to be an unaltered
|
| 375 |
+
reproduction of the information within \fBCargo.toml\fR\&.
|
| 376 |
+
.RE
|
| 377 |
+
.SS "Feature Selection"
|
| 378 |
+
The feature flags allow you to control which features are enabled. When no
|
| 379 |
+
feature options are given, the \fBdefault\fR feature is activated for every
|
| 380 |
+
selected package.
|
| 381 |
+
.sp
|
| 382 |
+
See \fIthe features documentation\fR <https://doc.rust\-lang.org/cargo/reference/features.html#command\-line\-feature\-options>
|
| 383 |
+
for more details.
|
| 384 |
+
.sp
|
| 385 |
+
\fB\-F\fR \fIfeatures\fR,
|
| 386 |
+
\fB\-\-features\fR \fIfeatures\fR
|
| 387 |
+
.RS 4
|
| 388 |
+
Space or comma separated list of features to activate. Features of workspace
|
| 389 |
+
members may be enabled with \fBpackage\-name/feature\-name\fR syntax. This flag may
|
| 390 |
+
be specified multiple times, which enables all specified features.
|
| 391 |
+
.RE
|
| 392 |
+
.sp
|
| 393 |
+
\fB\-\-all\-features\fR
|
| 394 |
+
.RS 4
|
| 395 |
+
Activate all available features of all selected packages.
|
| 396 |
+
.RE
|
| 397 |
+
.sp
|
| 398 |
+
\fB\-\-no\-default\-features\fR
|
| 399 |
+
.RS 4
|
| 400 |
+
Do not activate the \fBdefault\fR feature of the selected packages.
|
| 401 |
+
.RE
|
| 402 |
+
.SS "Display Options"
|
| 403 |
+
.sp
|
| 404 |
+
\fB\-v\fR,
|
| 405 |
+
\fB\-\-verbose\fR
|
| 406 |
+
.RS 4
|
| 407 |
+
Use verbose output. May be specified twice for \[lq]very verbose\[rq] output which
|
| 408 |
+
includes extra output such as dependency warnings and build script output.
|
| 409 |
+
May also be specified with the \fBterm.verbose\fR
|
| 410 |
+
\fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 411 |
+
.RE
|
| 412 |
+
.sp
|
| 413 |
+
\fB\-q\fR,
|
| 414 |
+
\fB\-\-quiet\fR
|
| 415 |
+
.RS 4
|
| 416 |
+
Do not print cargo log messages.
|
| 417 |
+
May also be specified with the \fBterm.quiet\fR
|
| 418 |
+
\fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 419 |
+
.RE
|
| 420 |
+
.sp
|
| 421 |
+
\fB\-\-color\fR \fIwhen\fR
|
| 422 |
+
.RS 4
|
| 423 |
+
Control when colored output is used. Valid values:
|
| 424 |
+
.sp
|
| 425 |
+
.RS 4
|
| 426 |
+
\h'-04'\(bu\h'+03'\fBauto\fR (default): Automatically detect if color support is available on the
|
| 427 |
+
terminal.
|
| 428 |
+
.RE
|
| 429 |
+
.sp
|
| 430 |
+
.RS 4
|
| 431 |
+
\h'-04'\(bu\h'+03'\fBalways\fR: Always display colors.
|
| 432 |
+
.RE
|
| 433 |
+
.sp
|
| 434 |
+
.RS 4
|
| 435 |
+
\h'-04'\(bu\h'+03'\fBnever\fR: Never display colors.
|
| 436 |
+
.RE
|
| 437 |
+
.sp
|
| 438 |
+
May also be specified with the \fBterm.color\fR
|
| 439 |
+
\fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 440 |
+
.RE
|
| 441 |
+
.SS "Manifest Options"
|
| 442 |
+
.sp
|
| 443 |
+
\fB\-\-manifest\-path\fR \fIpath\fR
|
| 444 |
+
.RS 4
|
| 445 |
+
Path to the \fBCargo.toml\fR file. By default, Cargo searches for the
|
| 446 |
+
\fBCargo.toml\fR file in the current directory or any parent directory.
|
| 447 |
+
.RE
|
| 448 |
+
.sp
|
| 449 |
+
\fB\-\-locked\fR
|
| 450 |
+
.RS 4
|
| 451 |
+
Asserts that the exact same dependencies and versions are used as when the
|
| 452 |
+
existing \fBCargo.lock\fR file was originally generated. Cargo will exit with an
|
| 453 |
+
error when either of the following scenarios arises:
|
| 454 |
+
.sp
|
| 455 |
+
.RS 4
|
| 456 |
+
\h'-04'\(bu\h'+03'The lock file is missing.
|
| 457 |
+
.RE
|
| 458 |
+
.sp
|
| 459 |
+
.RS 4
|
| 460 |
+
\h'-04'\(bu\h'+03'Cargo attempted to change the lock file due to a different dependency resolution.
|
| 461 |
+
.RE
|
| 462 |
+
.sp
|
| 463 |
+
It may be used in environments where deterministic builds are desired,
|
| 464 |
+
such as in CI pipelines.
|
| 465 |
+
.RE
|
| 466 |
+
.sp
|
| 467 |
+
\fB\-\-offline\fR
|
| 468 |
+
.RS 4
|
| 469 |
+
Prevents Cargo from accessing the network for any reason. Without this
|
| 470 |
+
flag, Cargo will stop with an error if it needs to access the network and
|
| 471 |
+
the network is not available. With this flag, Cargo will attempt to
|
| 472 |
+
proceed without the network if possible.
|
| 473 |
+
.sp
|
| 474 |
+
Beware that this may result in different dependency resolution than online
|
| 475 |
+
mode. Cargo will restrict itself to crates that are downloaded locally, even
|
| 476 |
+
if there might be a newer version as indicated in the local copy of the index.
|
| 477 |
+
See the \fBcargo\-fetch\fR(1) command to download dependencies before going
|
| 478 |
+
offline.
|
| 479 |
+
.sp
|
| 480 |
+
May also be specified with the \fBnet.offline\fR \fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 481 |
+
.RE
|
| 482 |
+
.sp
|
| 483 |
+
\fB\-\-frozen\fR
|
| 484 |
+
.RS 4
|
| 485 |
+
Equivalent to specifying both \fB\-\-locked\fR and \fB\-\-offline\fR\&.
|
| 486 |
+
.RE
|
| 487 |
+
.SS "Common Options"
|
| 488 |
+
.sp
|
| 489 |
+
\fB+\fR\fItoolchain\fR
|
| 490 |
+
.RS 4
|
| 491 |
+
If Cargo has been installed with rustup, and the first argument to \fBcargo\fR
|
| 492 |
+
begins with \fB+\fR, it will be interpreted as a rustup toolchain name (such
|
| 493 |
+
as \fB+stable\fR or \fB+nightly\fR).
|
| 494 |
+
See the \fIrustup documentation\fR <https://rust\-lang.github.io/rustup/overrides.html>
|
| 495 |
+
for more information about how toolchain overrides work.
|
| 496 |
+
.RE
|
| 497 |
+
.sp
|
| 498 |
+
\fB\-\-config\fR \fIKEY=VALUE\fR or \fIPATH\fR
|
| 499 |
+
.RS 4
|
| 500 |
+
Overrides a Cargo configuration value. The argument should be in TOML syntax of \fBKEY=VALUE\fR,
|
| 501 |
+
or provided as a path to an extra configuration file. This flag may be specified multiple times.
|
| 502 |
+
See the \fIcommand\-line overrides section\fR <https://doc.rust\-lang.org/cargo/reference/config.html#command\-line\-overrides> for more information.
|
| 503 |
+
.RE
|
| 504 |
+
.sp
|
| 505 |
+
\fB\-C\fR \fIPATH\fR
|
| 506 |
+
.RS 4
|
| 507 |
+
Changes the current working directory before executing any specified operations. This affects
|
| 508 |
+
things like where cargo looks by default for the project manifest (\fBCargo.toml\fR), as well as
|
| 509 |
+
the directories searched for discovering \fB\&.cargo/config.toml\fR, for example. This option must
|
| 510 |
+
appear before the command name, for example \fBcargo \-C path/to/my\-project build\fR\&.
|
| 511 |
+
.sp
|
| 512 |
+
This option is only available on the \fInightly
|
| 513 |
+
channel\fR <https://doc.rust\-lang.org/book/appendix\-07\-nightly\-rust.html> and
|
| 514 |
+
requires the \fB\-Z unstable\-options\fR flag to enable (see
|
| 515 |
+
\fI#10098\fR <https://github.com/rust\-lang/cargo/issues/10098>).
|
| 516 |
+
.RE
|
| 517 |
+
.sp
|
| 518 |
+
\fB\-h\fR,
|
| 519 |
+
\fB\-\-help\fR
|
| 520 |
+
.RS 4
|
| 521 |
+
Prints help information.
|
| 522 |
+
.RE
|
| 523 |
+
.sp
|
| 524 |
+
\fB\-Z\fR \fIflag\fR
|
| 525 |
+
.RS 4
|
| 526 |
+
Unstable (nightly\-only) flags to Cargo. Run \fBcargo \-Z help\fR for details.
|
| 527 |
+
.RE
|
| 528 |
+
.SH "ENVIRONMENT"
|
| 529 |
+
See \fIthe reference\fR <https://doc.rust\-lang.org/cargo/reference/environment\-variables.html> for
|
| 530 |
+
details on environment variables that Cargo reads.
|
| 531 |
+
.SH "EXIT STATUS"
|
| 532 |
+
.sp
|
| 533 |
+
.RS 4
|
| 534 |
+
\h'-04'\(bu\h'+03'\fB0\fR: Cargo succeeded.
|
| 535 |
+
.RE
|
| 536 |
+
.sp
|
| 537 |
+
.RS 4
|
| 538 |
+
\h'-04'\(bu\h'+03'\fB101\fR: Cargo failed to complete.
|
| 539 |
+
.RE
|
| 540 |
+
.SH "EXAMPLES"
|
| 541 |
+
.sp
|
| 542 |
+
.RS 4
|
| 543 |
+
\h'-04' 1.\h'+01'Output JSON about the current package:
|
| 544 |
+
.sp
|
| 545 |
+
.RS 4
|
| 546 |
+
.nf
|
| 547 |
+
cargo metadata \-\-format\-version=1
|
| 548 |
+
.fi
|
| 549 |
+
.RE
|
| 550 |
+
.RE
|
| 551 |
+
.SH "SEE ALSO"
|
| 552 |
+
\fBcargo\fR(1), \fBcargo\-pkgid\fR(1), \fIPackage ID Specifications\fR <https://doc.rust\-lang.org/cargo/reference/pkgid\-spec.html>, \fIJSON messages\fR <https://doc.rust\-lang.org/cargo/reference/external\-tools.html#json\-messages>
|
rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-new.1
ADDED
|
@@ -0,0 +1,166 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
'\" t
|
| 2 |
+
.TH "CARGO\-NEW" "1"
|
| 3 |
+
.nh
|
| 4 |
+
.ad l
|
| 5 |
+
.ss \n[.ss] 0
|
| 6 |
+
.SH "NAME"
|
| 7 |
+
cargo\-new \[em] Create a new Cargo package
|
| 8 |
+
.SH "SYNOPSIS"
|
| 9 |
+
\fBcargo new\fR [\fIoptions\fR] \fIpath\fR
|
| 10 |
+
.SH "DESCRIPTION"
|
| 11 |
+
This command will create a new Cargo package in the given directory. This
|
| 12 |
+
includes a simple template with a \fBCargo.toml\fR manifest, sample source file,
|
| 13 |
+
and a VCS ignore file. If the directory is not already in a VCS repository,
|
| 14 |
+
then a new repository is created (see \fB\-\-vcs\fR below).
|
| 15 |
+
.sp
|
| 16 |
+
See \fBcargo\-init\fR(1) for a similar command which will create a new manifest
|
| 17 |
+
in an existing directory.
|
| 18 |
+
.SH "OPTIONS"
|
| 19 |
+
.SS "New Options"
|
| 20 |
+
.sp
|
| 21 |
+
\fB\-\-bin\fR
|
| 22 |
+
.RS 4
|
| 23 |
+
Create a package with a binary target (\fBsrc/main.rs\fR).
|
| 24 |
+
This is the default behavior.
|
| 25 |
+
.RE
|
| 26 |
+
.sp
|
| 27 |
+
\fB\-\-lib\fR
|
| 28 |
+
.RS 4
|
| 29 |
+
Create a package with a library target (\fBsrc/lib.rs\fR).
|
| 30 |
+
.RE
|
| 31 |
+
.sp
|
| 32 |
+
\fB\-\-edition\fR \fIedition\fR
|
| 33 |
+
.RS 4
|
| 34 |
+
Specify the Rust edition to use. Default is 2024.
|
| 35 |
+
Possible values: 2015, 2018, 2021, 2024
|
| 36 |
+
.RE
|
| 37 |
+
.sp
|
| 38 |
+
\fB\-\-name\fR \fIname\fR
|
| 39 |
+
.RS 4
|
| 40 |
+
Set the package name. Defaults to the directory name.
|
| 41 |
+
.RE
|
| 42 |
+
.sp
|
| 43 |
+
\fB\-\-vcs\fR \fIvcs\fR
|
| 44 |
+
.RS 4
|
| 45 |
+
Initialize a new VCS repository for the given version control system (git,
|
| 46 |
+
hg, pijul, or fossil) or do not initialize any version control at all
|
| 47 |
+
(none). If not specified, defaults to \fBgit\fR or the configuration value
|
| 48 |
+
\fBcargo\-new.vcs\fR, or \fBnone\fR if already inside a VCS repository.
|
| 49 |
+
.RE
|
| 50 |
+
.sp
|
| 51 |
+
\fB\-\-registry\fR \fIregistry\fR
|
| 52 |
+
.RS 4
|
| 53 |
+
This sets the \fBpublish\fR field in \fBCargo.toml\fR to the given registry name
|
| 54 |
+
which will restrict publishing only to that registry.
|
| 55 |
+
.sp
|
| 56 |
+
Registry names are defined in \fICargo config files\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 57 |
+
If not specified, the default registry defined by the \fBregistry.default\fR
|
| 58 |
+
config key is used. If the default registry is not set and \fB\-\-registry\fR is not
|
| 59 |
+
used, the \fBpublish\fR field will not be set which means that publishing will not
|
| 60 |
+
be restricted.
|
| 61 |
+
.RE
|
| 62 |
+
.SS "Display Options"
|
| 63 |
+
.sp
|
| 64 |
+
\fB\-v\fR,
|
| 65 |
+
\fB\-\-verbose\fR
|
| 66 |
+
.RS 4
|
| 67 |
+
Use verbose output. May be specified twice for \[lq]very verbose\[rq] output which
|
| 68 |
+
includes extra output such as dependency warnings and build script output.
|
| 69 |
+
May also be specified with the \fBterm.verbose\fR
|
| 70 |
+
\fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 71 |
+
.RE
|
| 72 |
+
.sp
|
| 73 |
+
\fB\-q\fR,
|
| 74 |
+
\fB\-\-quiet\fR
|
| 75 |
+
.RS 4
|
| 76 |
+
Do not print cargo log messages.
|
| 77 |
+
May also be specified with the \fBterm.quiet\fR
|
| 78 |
+
\fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 79 |
+
.RE
|
| 80 |
+
.sp
|
| 81 |
+
\fB\-\-color\fR \fIwhen\fR
|
| 82 |
+
.RS 4
|
| 83 |
+
Control when colored output is used. Valid values:
|
| 84 |
+
.sp
|
| 85 |
+
.RS 4
|
| 86 |
+
\h'-04'\(bu\h'+03'\fBauto\fR (default): Automatically detect if color support is available on the
|
| 87 |
+
terminal.
|
| 88 |
+
.RE
|
| 89 |
+
.sp
|
| 90 |
+
.RS 4
|
| 91 |
+
\h'-04'\(bu\h'+03'\fBalways\fR: Always display colors.
|
| 92 |
+
.RE
|
| 93 |
+
.sp
|
| 94 |
+
.RS 4
|
| 95 |
+
\h'-04'\(bu\h'+03'\fBnever\fR: Never display colors.
|
| 96 |
+
.RE
|
| 97 |
+
.sp
|
| 98 |
+
May also be specified with the \fBterm.color\fR
|
| 99 |
+
\fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 100 |
+
.RE
|
| 101 |
+
.SS "Common Options"
|
| 102 |
+
.sp
|
| 103 |
+
\fB+\fR\fItoolchain\fR
|
| 104 |
+
.RS 4
|
| 105 |
+
If Cargo has been installed with rustup, and the first argument to \fBcargo\fR
|
| 106 |
+
begins with \fB+\fR, it will be interpreted as a rustup toolchain name (such
|
| 107 |
+
as \fB+stable\fR or \fB+nightly\fR).
|
| 108 |
+
See the \fIrustup documentation\fR <https://rust\-lang.github.io/rustup/overrides.html>
|
| 109 |
+
for more information about how toolchain overrides work.
|
| 110 |
+
.RE
|
| 111 |
+
.sp
|
| 112 |
+
\fB\-\-config\fR \fIKEY=VALUE\fR or \fIPATH\fR
|
| 113 |
+
.RS 4
|
| 114 |
+
Overrides a Cargo configuration value. The argument should be in TOML syntax of \fBKEY=VALUE\fR,
|
| 115 |
+
or provided as a path to an extra configuration file. This flag may be specified multiple times.
|
| 116 |
+
See the \fIcommand\-line overrides section\fR <https://doc.rust\-lang.org/cargo/reference/config.html#command\-line\-overrides> for more information.
|
| 117 |
+
.RE
|
| 118 |
+
.sp
|
| 119 |
+
\fB\-C\fR \fIPATH\fR
|
| 120 |
+
.RS 4
|
| 121 |
+
Changes the current working directory before executing any specified operations. This affects
|
| 122 |
+
things like where cargo looks by default for the project manifest (\fBCargo.toml\fR), as well as
|
| 123 |
+
the directories searched for discovering \fB\&.cargo/config.toml\fR, for example. This option must
|
| 124 |
+
appear before the command name, for example \fBcargo \-C path/to/my\-project build\fR\&.
|
| 125 |
+
.sp
|
| 126 |
+
This option is only available on the \fInightly
|
| 127 |
+
channel\fR <https://doc.rust\-lang.org/book/appendix\-07\-nightly\-rust.html> and
|
| 128 |
+
requires the \fB\-Z unstable\-options\fR flag to enable (see
|
| 129 |
+
\fI#10098\fR <https://github.com/rust\-lang/cargo/issues/10098>).
|
| 130 |
+
.RE
|
| 131 |
+
.sp
|
| 132 |
+
\fB\-h\fR,
|
| 133 |
+
\fB\-\-help\fR
|
| 134 |
+
.RS 4
|
| 135 |
+
Prints help information.
|
| 136 |
+
.RE
|
| 137 |
+
.sp
|
| 138 |
+
\fB\-Z\fR \fIflag\fR
|
| 139 |
+
.RS 4
|
| 140 |
+
Unstable (nightly\-only) flags to Cargo. Run \fBcargo \-Z help\fR for details.
|
| 141 |
+
.RE
|
| 142 |
+
.SH "ENVIRONMENT"
|
| 143 |
+
See \fIthe reference\fR <https://doc.rust\-lang.org/cargo/reference/environment\-variables.html> for
|
| 144 |
+
details on environment variables that Cargo reads.
|
| 145 |
+
.SH "EXIT STATUS"
|
| 146 |
+
.sp
|
| 147 |
+
.RS 4
|
| 148 |
+
\h'-04'\(bu\h'+03'\fB0\fR: Cargo succeeded.
|
| 149 |
+
.RE
|
| 150 |
+
.sp
|
| 151 |
+
.RS 4
|
| 152 |
+
\h'-04'\(bu\h'+03'\fB101\fR: Cargo failed to complete.
|
| 153 |
+
.RE
|
| 154 |
+
.SH "EXAMPLES"
|
| 155 |
+
.sp
|
| 156 |
+
.RS 4
|
| 157 |
+
\h'-04' 1.\h'+01'Create a binary Cargo package in the given directory:
|
| 158 |
+
.sp
|
| 159 |
+
.RS 4
|
| 160 |
+
.nf
|
| 161 |
+
cargo new foo
|
| 162 |
+
.fi
|
| 163 |
+
.RE
|
| 164 |
+
.RE
|
| 165 |
+
.SH "SEE ALSO"
|
| 166 |
+
\fBcargo\fR(1), \fBcargo\-init\fR(1)
|
rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-owner.1
ADDED
|
@@ -0,0 +1,197 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
'\" t
|
| 2 |
+
.TH "CARGO\-OWNER" "1"
|
| 3 |
+
.nh
|
| 4 |
+
.ad l
|
| 5 |
+
.ss \n[.ss] 0
|
| 6 |
+
.SH "NAME"
|
| 7 |
+
cargo\-owner \[em] Manage the owners of a crate on the registry
|
| 8 |
+
.SH "SYNOPSIS"
|
| 9 |
+
\fBcargo owner\fR [\fIoptions\fR] \fB\-\-add\fR \fIlogin\fR [\fIcrate\fR]
|
| 10 |
+
.br
|
| 11 |
+
\fBcargo owner\fR [\fIoptions\fR] \fB\-\-remove\fR \fIlogin\fR [\fIcrate\fR]
|
| 12 |
+
.br
|
| 13 |
+
\fBcargo owner\fR [\fIoptions\fR] \fB\-\-list\fR [\fIcrate\fR]
|
| 14 |
+
.SH "DESCRIPTION"
|
| 15 |
+
This command will modify the owners for a crate on the registry. Owners of a
|
| 16 |
+
crate can upload new versions and yank old versions. Non\-team owners can also
|
| 17 |
+
modify the set of owners, so take care!
|
| 18 |
+
.sp
|
| 19 |
+
This command requires you to be authenticated with either the \fB\-\-token\fR option
|
| 20 |
+
or using \fBcargo\-login\fR(1).
|
| 21 |
+
.sp
|
| 22 |
+
If the crate name is not specified, it will use the package name from the
|
| 23 |
+
current directory.
|
| 24 |
+
.sp
|
| 25 |
+
See \fIthe reference\fR <https://doc.rust\-lang.org/cargo/reference/publishing.html#cargo\-owner> for more
|
| 26 |
+
information about owners and publishing.
|
| 27 |
+
.SH "OPTIONS"
|
| 28 |
+
.SS "Owner Options"
|
| 29 |
+
.sp
|
| 30 |
+
\fB\-a\fR,
|
| 31 |
+
\fB\-\-add\fR \fIlogin\fR\[u2026]
|
| 32 |
+
.RS 4
|
| 33 |
+
Invite the given user or team as an owner.
|
| 34 |
+
.RE
|
| 35 |
+
.sp
|
| 36 |
+
\fB\-r\fR,
|
| 37 |
+
\fB\-\-remove\fR \fIlogin\fR\[u2026]
|
| 38 |
+
.RS 4
|
| 39 |
+
Remove the given user or team as an owner.
|
| 40 |
+
.RE
|
| 41 |
+
.sp
|
| 42 |
+
\fB\-l\fR,
|
| 43 |
+
\fB\-\-list\fR
|
| 44 |
+
.RS 4
|
| 45 |
+
List owners of a crate.
|
| 46 |
+
.RE
|
| 47 |
+
.sp
|
| 48 |
+
\fB\-\-token\fR \fItoken\fR
|
| 49 |
+
.RS 4
|
| 50 |
+
API token to use when authenticating. This overrides the token stored in
|
| 51 |
+
the credentials file (which is created by \fBcargo\-login\fR(1)).
|
| 52 |
+
.sp
|
| 53 |
+
\fICargo config\fR <https://doc.rust\-lang.org/cargo/reference/config.html> environment variables can be
|
| 54 |
+
used to override the tokens stored in the credentials file. The token for
|
| 55 |
+
crates.io may be specified with the \fBCARGO_REGISTRY_TOKEN\fR environment
|
| 56 |
+
variable. Tokens for other registries may be specified with environment
|
| 57 |
+
variables of the form \fBCARGO_REGISTRIES_NAME_TOKEN\fR where \fBNAME\fR is the name
|
| 58 |
+
of the registry in all capital letters.
|
| 59 |
+
.RE
|
| 60 |
+
.sp
|
| 61 |
+
\fB\-\-index\fR \fIindex\fR
|
| 62 |
+
.RS 4
|
| 63 |
+
The URL of the registry index to use.
|
| 64 |
+
.RE
|
| 65 |
+
.sp
|
| 66 |
+
\fB\-\-registry\fR \fIregistry\fR
|
| 67 |
+
.RS 4
|
| 68 |
+
Name of the registry to use. Registry names are defined in \fICargo config
|
| 69 |
+
files\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&. If not specified, the default registry is used,
|
| 70 |
+
which is defined by the \fBregistry.default\fR config key which defaults to
|
| 71 |
+
\fBcrates\-io\fR\&.
|
| 72 |
+
.RE
|
| 73 |
+
.SS "Display Options"
|
| 74 |
+
.sp
|
| 75 |
+
\fB\-v\fR,
|
| 76 |
+
\fB\-\-verbose\fR
|
| 77 |
+
.RS 4
|
| 78 |
+
Use verbose output. May be specified twice for \[lq]very verbose\[rq] output which
|
| 79 |
+
includes extra output such as dependency warnings and build script output.
|
| 80 |
+
May also be specified with the \fBterm.verbose\fR
|
| 81 |
+
\fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 82 |
+
.RE
|
| 83 |
+
.sp
|
| 84 |
+
\fB\-q\fR,
|
| 85 |
+
\fB\-\-quiet\fR
|
| 86 |
+
.RS 4
|
| 87 |
+
Do not print cargo log messages.
|
| 88 |
+
May also be specified with the \fBterm.quiet\fR
|
| 89 |
+
\fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 90 |
+
.RE
|
| 91 |
+
.sp
|
| 92 |
+
\fB\-\-color\fR \fIwhen\fR
|
| 93 |
+
.RS 4
|
| 94 |
+
Control when colored output is used. Valid values:
|
| 95 |
+
.sp
|
| 96 |
+
.RS 4
|
| 97 |
+
\h'-04'\(bu\h'+03'\fBauto\fR (default): Automatically detect if color support is available on the
|
| 98 |
+
terminal.
|
| 99 |
+
.RE
|
| 100 |
+
.sp
|
| 101 |
+
.RS 4
|
| 102 |
+
\h'-04'\(bu\h'+03'\fBalways\fR: Always display colors.
|
| 103 |
+
.RE
|
| 104 |
+
.sp
|
| 105 |
+
.RS 4
|
| 106 |
+
\h'-04'\(bu\h'+03'\fBnever\fR: Never display colors.
|
| 107 |
+
.RE
|
| 108 |
+
.sp
|
| 109 |
+
May also be specified with the \fBterm.color\fR
|
| 110 |
+
\fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 111 |
+
.RE
|
| 112 |
+
.SS "Common Options"
|
| 113 |
+
.sp
|
| 114 |
+
\fB+\fR\fItoolchain\fR
|
| 115 |
+
.RS 4
|
| 116 |
+
If Cargo has been installed with rustup, and the first argument to \fBcargo\fR
|
| 117 |
+
begins with \fB+\fR, it will be interpreted as a rustup toolchain name (such
|
| 118 |
+
as \fB+stable\fR or \fB+nightly\fR).
|
| 119 |
+
See the \fIrustup documentation\fR <https://rust\-lang.github.io/rustup/overrides.html>
|
| 120 |
+
for more information about how toolchain overrides work.
|
| 121 |
+
.RE
|
| 122 |
+
.sp
|
| 123 |
+
\fB\-\-config\fR \fIKEY=VALUE\fR or \fIPATH\fR
|
| 124 |
+
.RS 4
|
| 125 |
+
Overrides a Cargo configuration value. The argument should be in TOML syntax of \fBKEY=VALUE\fR,
|
| 126 |
+
or provided as a path to an extra configuration file. This flag may be specified multiple times.
|
| 127 |
+
See the \fIcommand\-line overrides section\fR <https://doc.rust\-lang.org/cargo/reference/config.html#command\-line\-overrides> for more information.
|
| 128 |
+
.RE
|
| 129 |
+
.sp
|
| 130 |
+
\fB\-C\fR \fIPATH\fR
|
| 131 |
+
.RS 4
|
| 132 |
+
Changes the current working directory before executing any specified operations. This affects
|
| 133 |
+
things like where cargo looks by default for the project manifest (\fBCargo.toml\fR), as well as
|
| 134 |
+
the directories searched for discovering \fB\&.cargo/config.toml\fR, for example. This option must
|
| 135 |
+
appear before the command name, for example \fBcargo \-C path/to/my\-project build\fR\&.
|
| 136 |
+
.sp
|
| 137 |
+
This option is only available on the \fInightly
|
| 138 |
+
channel\fR <https://doc.rust\-lang.org/book/appendix\-07\-nightly\-rust.html> and
|
| 139 |
+
requires the \fB\-Z unstable\-options\fR flag to enable (see
|
| 140 |
+
\fI#10098\fR <https://github.com/rust\-lang/cargo/issues/10098>).
|
| 141 |
+
.RE
|
| 142 |
+
.sp
|
| 143 |
+
\fB\-h\fR,
|
| 144 |
+
\fB\-\-help\fR
|
| 145 |
+
.RS 4
|
| 146 |
+
Prints help information.
|
| 147 |
+
.RE
|
| 148 |
+
.sp
|
| 149 |
+
\fB\-Z\fR \fIflag\fR
|
| 150 |
+
.RS 4
|
| 151 |
+
Unstable (nightly\-only) flags to Cargo. Run \fBcargo \-Z help\fR for details.
|
| 152 |
+
.RE
|
| 153 |
+
.SH "ENVIRONMENT"
|
| 154 |
+
See \fIthe reference\fR <https://doc.rust\-lang.org/cargo/reference/environment\-variables.html> for
|
| 155 |
+
details on environment variables that Cargo reads.
|
| 156 |
+
.SH "EXIT STATUS"
|
| 157 |
+
.sp
|
| 158 |
+
.RS 4
|
| 159 |
+
\h'-04'\(bu\h'+03'\fB0\fR: Cargo succeeded.
|
| 160 |
+
.RE
|
| 161 |
+
.sp
|
| 162 |
+
.RS 4
|
| 163 |
+
\h'-04'\(bu\h'+03'\fB101\fR: Cargo failed to complete.
|
| 164 |
+
.RE
|
| 165 |
+
.SH "EXAMPLES"
|
| 166 |
+
.sp
|
| 167 |
+
.RS 4
|
| 168 |
+
\h'-04' 1.\h'+01'List owners of a package:
|
| 169 |
+
.sp
|
| 170 |
+
.RS 4
|
| 171 |
+
.nf
|
| 172 |
+
cargo owner \-\-list foo
|
| 173 |
+
.fi
|
| 174 |
+
.RE
|
| 175 |
+
.RE
|
| 176 |
+
.sp
|
| 177 |
+
.RS 4
|
| 178 |
+
\h'-04' 2.\h'+01'Invite an owner to a package:
|
| 179 |
+
.sp
|
| 180 |
+
.RS 4
|
| 181 |
+
.nf
|
| 182 |
+
cargo owner \-\-add username foo
|
| 183 |
+
.fi
|
| 184 |
+
.RE
|
| 185 |
+
.RE
|
| 186 |
+
.sp
|
| 187 |
+
.RS 4
|
| 188 |
+
\h'-04' 3.\h'+01'Remove an owner from a package:
|
| 189 |
+
.sp
|
| 190 |
+
.RS 4
|
| 191 |
+
.nf
|
| 192 |
+
cargo owner \-\-remove username foo
|
| 193 |
+
.fi
|
| 194 |
+
.RE
|
| 195 |
+
.RE
|
| 196 |
+
.SH "SEE ALSO"
|
| 197 |
+
\fBcargo\fR(1), \fBcargo\-login\fR(1), \fBcargo\-publish\fR(1)
|
rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-package.1
ADDED
|
@@ -0,0 +1,472 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
'\" t
|
| 2 |
+
.TH "CARGO\-PACKAGE" "1"
|
| 3 |
+
.nh
|
| 4 |
+
.ad l
|
| 5 |
+
.ss \n[.ss] 0
|
| 6 |
+
.SH "NAME"
|
| 7 |
+
cargo\-package \[em] Assemble the local package into a distributable tarball
|
| 8 |
+
.SH "SYNOPSIS"
|
| 9 |
+
\fBcargo package\fR [\fIoptions\fR]
|
| 10 |
+
.SH "DESCRIPTION"
|
| 11 |
+
This command will create a distributable, compressed \fB\&.crate\fR file with the
|
| 12 |
+
source code of the package in the current directory. The resulting file will be
|
| 13 |
+
stored in the \fBtarget/package\fR directory. This performs the following steps:
|
| 14 |
+
.sp
|
| 15 |
+
.RS 4
|
| 16 |
+
\h'-04' 1.\h'+01'Load and check the current workspace, performing some basic checks.
|
| 17 |
+
.sp
|
| 18 |
+
.RS 4
|
| 19 |
+
\h'-04'\(bu\h'+03'Path dependencies are not allowed unless they have a version key. Cargo
|
| 20 |
+
will ignore the path key for dependencies in published packages.
|
| 21 |
+
\fBdev\-dependencies\fR do not have this restriction.
|
| 22 |
+
.RE
|
| 23 |
+
.RE
|
| 24 |
+
.sp
|
| 25 |
+
.RS 4
|
| 26 |
+
\h'-04' 2.\h'+01'Create the compressed \fB\&.crate\fR file.
|
| 27 |
+
.sp
|
| 28 |
+
.RS 4
|
| 29 |
+
\h'-04'\(bu\h'+03'The original \fBCargo.toml\fR file is rewritten and normalized.
|
| 30 |
+
.RE
|
| 31 |
+
.sp
|
| 32 |
+
.RS 4
|
| 33 |
+
\h'-04'\(bu\h'+03'\fB[patch]\fR, \fB[replace]\fR, and \fB[workspace]\fR sections are removed from the
|
| 34 |
+
manifest.
|
| 35 |
+
.RE
|
| 36 |
+
.sp
|
| 37 |
+
.RS 4
|
| 38 |
+
\h'-04'\(bu\h'+03'\fBCargo.lock\fR is always included. When missing, a new lock file will be
|
| 39 |
+
generated unless the \fB\-\-exclude\-lockfile\fR flag is used. \fBcargo\-install\fR(1)
|
| 40 |
+
will use the packaged lock file if the \fB\-\-locked\fR flag is used.
|
| 41 |
+
.RE
|
| 42 |
+
.sp
|
| 43 |
+
.RS 4
|
| 44 |
+
\h'-04'\(bu\h'+03'A \fB\&.cargo_vcs_info.json\fR file is included that contains information
|
| 45 |
+
about the current VCS checkout hash if available, as well as a flag if the
|
| 46 |
+
worktree is dirty.
|
| 47 |
+
.RE
|
| 48 |
+
.sp
|
| 49 |
+
.RS 4
|
| 50 |
+
\h'-04'\(bu\h'+03'Symlinks are flattened to their target files.
|
| 51 |
+
.RE
|
| 52 |
+
.sp
|
| 53 |
+
.RS 4
|
| 54 |
+
\h'-04'\(bu\h'+03'Files and directories are included or excluded based on rules mentioned in
|
| 55 |
+
\fIthe \f(BI[include]\fI and \f(BI[exclude]\fI fields\fR <https://doc.rust\-lang.org/cargo/reference/manifest.html#the\-exclude\-and\-include\-fields>\&.
|
| 56 |
+
.RE
|
| 57 |
+
.RE
|
| 58 |
+
.sp
|
| 59 |
+
.RS 4
|
| 60 |
+
\h'-04' 3.\h'+01'Extract the \fB\&.crate\fR file and build it to verify it can build.
|
| 61 |
+
.sp
|
| 62 |
+
.RS 4
|
| 63 |
+
\h'-04'\(bu\h'+03'This will rebuild your package from scratch to ensure that it can be
|
| 64 |
+
built from a pristine state. The \fB\-\-no\-verify\fR flag can be used to skip
|
| 65 |
+
this step.
|
| 66 |
+
.RE
|
| 67 |
+
.RE
|
| 68 |
+
.sp
|
| 69 |
+
.RS 4
|
| 70 |
+
\h'-04' 4.\h'+01'Check that build scripts did not modify any source files.
|
| 71 |
+
.RE
|
| 72 |
+
.sp
|
| 73 |
+
The list of files included can be controlled with the \fBinclude\fR and \fBexclude\fR
|
| 74 |
+
fields in the manifest.
|
| 75 |
+
.sp
|
| 76 |
+
See \fIthe reference\fR <https://doc.rust\-lang.org/cargo/reference/publishing.html> for more details about
|
| 77 |
+
packaging and publishing.
|
| 78 |
+
.SS ".cargo_vcs_info.json format"
|
| 79 |
+
Will generate a \fB\&.cargo_vcs_info.json\fR in the following format
|
| 80 |
+
.sp
|
| 81 |
+
.RS 4
|
| 82 |
+
.nf
|
| 83 |
+
{
|
| 84 |
+
"git": {
|
| 85 |
+
"sha1": "aac20b6e7e543e6dd4118b246c77225e3a3a1302",
|
| 86 |
+
"dirty": true
|
| 87 |
+
},
|
| 88 |
+
"path_in_vcs": ""
|
| 89 |
+
}
|
| 90 |
+
.fi
|
| 91 |
+
.RE
|
| 92 |
+
.sp
|
| 93 |
+
\fBdirty\fR indicates that the Git worktree was dirty when the package
|
| 94 |
+
was built.
|
| 95 |
+
.sp
|
| 96 |
+
\fBpath_in_vcs\fR will be set to a repo\-relative path for packages
|
| 97 |
+
in subdirectories of the version control repository.
|
| 98 |
+
.sp
|
| 99 |
+
The compatibility of this file is maintained under the same policy
|
| 100 |
+
as the JSON output of \fBcargo\-metadata\fR(1).
|
| 101 |
+
.sp
|
| 102 |
+
Note that this file provides a best\-effort snapshot of the VCS information.
|
| 103 |
+
However, the provenance of the package is not verified.
|
| 104 |
+
There is no guarantee that the source code in the tarball matches the VCS information.
|
| 105 |
+
.SH "OPTIONS"
|
| 106 |
+
.SS "Package Options"
|
| 107 |
+
.sp
|
| 108 |
+
\fB\-l\fR,
|
| 109 |
+
\fB\-\-list\fR
|
| 110 |
+
.RS 4
|
| 111 |
+
Print files included in a package without making one.
|
| 112 |
+
.RE
|
| 113 |
+
.sp
|
| 114 |
+
\fB\-\-no\-verify\fR
|
| 115 |
+
.RS 4
|
| 116 |
+
Don\[cq]t verify the contents by building them.
|
| 117 |
+
.RE
|
| 118 |
+
.sp
|
| 119 |
+
\fB\-\-no\-metadata\fR
|
| 120 |
+
.RS 4
|
| 121 |
+
Ignore warnings about a lack of human\-usable metadata (such as the description
|
| 122 |
+
or the license).
|
| 123 |
+
.RE
|
| 124 |
+
.sp
|
| 125 |
+
\fB\-\-allow\-dirty\fR
|
| 126 |
+
.RS 4
|
| 127 |
+
Allow working directories with uncommitted VCS changes to be packaged.
|
| 128 |
+
.RE
|
| 129 |
+
.sp
|
| 130 |
+
\fB\-\-exclude\-lockfile\fR
|
| 131 |
+
.RS 4
|
| 132 |
+
Don\[cq]t include the lock file when packaging.
|
| 133 |
+
.sp
|
| 134 |
+
This flag is not for general use.
|
| 135 |
+
Some tools may expect a lock file to be present (e.g. \fBcargo install \-\-locked\fR).
|
| 136 |
+
Consider other options before using this.
|
| 137 |
+
.RE
|
| 138 |
+
.sp
|
| 139 |
+
\fB\-\-index\fR \fIindex\fR
|
| 140 |
+
.RS 4
|
| 141 |
+
The URL of the registry index to use.
|
| 142 |
+
.RE
|
| 143 |
+
.sp
|
| 144 |
+
\fB\-\-registry\fR \fIregistry\fR
|
| 145 |
+
.RS 4
|
| 146 |
+
Name of the registry to package for; see \fBcargo publish \-\-help\fR for more details
|
| 147 |
+
about configuration of registry names. The packages will not be published
|
| 148 |
+
to this registry, but if we are packaging multiple inter\-dependent crates,
|
| 149 |
+
lock\-files will be generated under the assumption that dependencies will be
|
| 150 |
+
published to this registry.
|
| 151 |
+
.RE
|
| 152 |
+
.sp
|
| 153 |
+
\fB\-\-message\-format\fR \fIfmt\fR
|
| 154 |
+
.RS 4
|
| 155 |
+
Specifies the output message format.
|
| 156 |
+
Currently, it only works with \fB\-\-list\fR and affects the file listing format.
|
| 157 |
+
This is unstable and requires \fB\-Zunstable\-options\fR\&.
|
| 158 |
+
Valid output formats:
|
| 159 |
+
.sp
|
| 160 |
+
.RS 4
|
| 161 |
+
\h'-04'\(bu\h'+03'\fBhuman\fR (default): Display in a file\-per\-line format.
|
| 162 |
+
.RE
|
| 163 |
+
.sp
|
| 164 |
+
.RS 4
|
| 165 |
+
\h'-04'\(bu\h'+03'\fBjson\fR: Emit machine\-readable JSON information about each package.
|
| 166 |
+
One package per JSON line (Newline delimited JSON).
|
| 167 |
+
.sp
|
| 168 |
+
.RS 4
|
| 169 |
+
.nf
|
| 170 |
+
{
|
| 171 |
+
/* The Package ID Spec of the package. */
|
| 172 |
+
"id": "path+file:///home/foo#0.0.0",
|
| 173 |
+
/* Files of this package */
|
| 174 |
+
"files" {
|
| 175 |
+
/* Relative path in the archive file. */
|
| 176 |
+
"Cargo.toml.orig": {
|
| 177 |
+
/* Where the file is from.
|
| 178 |
+
\- "generate" for file being generated during packaging
|
| 179 |
+
\- "copy" for file being copied from another location.
|
| 180 |
+
*/
|
| 181 |
+
"kind": "copy",
|
| 182 |
+
/* For the "copy" kind,
|
| 183 |
+
it is an absolute path to the actual file content.
|
| 184 |
+
For the "generate" kind,
|
| 185 |
+
it is the original file the generated one is based on.
|
| 186 |
+
*/
|
| 187 |
+
"path": "/home/foo/Cargo.toml"
|
| 188 |
+
},
|
| 189 |
+
"Cargo.toml": {
|
| 190 |
+
"kind": "generate",
|
| 191 |
+
"path": "/home/foo/Cargo.toml"
|
| 192 |
+
},
|
| 193 |
+
"src/main.rs": {
|
| 194 |
+
"kind": "copy",
|
| 195 |
+
"path": "/home/foo/src/main.rs"
|
| 196 |
+
}
|
| 197 |
+
}
|
| 198 |
+
}
|
| 199 |
+
.fi
|
| 200 |
+
.RE
|
| 201 |
+
.RE
|
| 202 |
+
.RE
|
| 203 |
+
.SS "Package Selection"
|
| 204 |
+
By default, when no package selection options are given, the packages selected
|
| 205 |
+
depend on the selected manifest file (based on the current working directory if
|
| 206 |
+
\fB\-\-manifest\-path\fR is not given). If the manifest is the root of a workspace then
|
| 207 |
+
the workspaces default members are selected, otherwise only the package defined
|
| 208 |
+
by the manifest will be selected.
|
| 209 |
+
.sp
|
| 210 |
+
The default members of a workspace can be set explicitly with the
|
| 211 |
+
\fBworkspace.default\-members\fR key in the root manifest. If this is not set, a
|
| 212 |
+
virtual workspace will include all workspace members (equivalent to passing
|
| 213 |
+
\fB\-\-workspace\fR), and a non\-virtual workspace will include only the root crate itself.
|
| 214 |
+
.sp
|
| 215 |
+
\fB\-p\fR \fIspec\fR\[u2026],
|
| 216 |
+
\fB\-\-package\fR \fIspec\fR\[u2026]
|
| 217 |
+
.RS 4
|
| 218 |
+
Package only the specified packages. See \fBcargo\-pkgid\fR(1) for the
|
| 219 |
+
SPEC format. This flag may be specified multiple times and supports common Unix
|
| 220 |
+
glob patterns like \fB*\fR, \fB?\fR and \fB[]\fR\&. However, to avoid your shell accidentally
|
| 221 |
+
expanding glob patterns before Cargo handles them, you must use single quotes or
|
| 222 |
+
double quotes around each pattern.
|
| 223 |
+
.RE
|
| 224 |
+
.sp
|
| 225 |
+
\fB\-\-workspace\fR
|
| 226 |
+
.RS 4
|
| 227 |
+
Package all members in the workspace.
|
| 228 |
+
.RE
|
| 229 |
+
.sp
|
| 230 |
+
\fB\-\-exclude\fR \fISPEC\fR\[u2026]
|
| 231 |
+
.RS 4
|
| 232 |
+
Exclude the specified packages. Must be used in conjunction with the
|
| 233 |
+
\fB\-\-workspace\fR flag. This flag may be specified multiple times and supports
|
| 234 |
+
common Unix glob patterns like \fB*\fR, \fB?\fR and \fB[]\fR\&. However, to avoid your shell
|
| 235 |
+
accidentally expanding glob patterns before Cargo handles them, you must use
|
| 236 |
+
single quotes or double quotes around each pattern.
|
| 237 |
+
.RE
|
| 238 |
+
.SS "Compilation Options"
|
| 239 |
+
.sp
|
| 240 |
+
\fB\-\-target\fR \fItriple\fR
|
| 241 |
+
.RS 4
|
| 242 |
+
Package for the specified target architecture. Flag may be specified multiple times. The default is the host architecture. The general format of the triple is
|
| 243 |
+
\fB<arch><sub>\-<vendor>\-<sys>\-<abi>\fR\&.
|
| 244 |
+
.sp
|
| 245 |
+
Possible values:
|
| 246 |
+
.sp
|
| 247 |
+
.RS 4
|
| 248 |
+
\h'-04'\(bu\h'+03'Any supported target in \fBrustc \-\-print target\-list\fR\&.
|
| 249 |
+
.RE
|
| 250 |
+
.sp
|
| 251 |
+
.RS 4
|
| 252 |
+
\h'-04'\(bu\h'+03'\fB"host\-tuple"\fR, which will internally be substituted by the host\[cq]s target. This can be particularly useful if you\[cq]re cross\-compiling some crates, and don\[cq]t want to specify your host\[cq]s machine as a target (for instance, an \fBxtask\fR in a shared project that may be worked on by many hosts).
|
| 253 |
+
.RE
|
| 254 |
+
.sp
|
| 255 |
+
.RS 4
|
| 256 |
+
\h'-04'\(bu\h'+03'A path to a custom target specification. See \fICustom Target Lookup Path\fR <https://doc.rust\-lang.org/rustc/targets/custom.html#custom\-target\-lookup\-path> for more information.
|
| 257 |
+
.RE
|
| 258 |
+
.sp
|
| 259 |
+
This may also be specified with the \fBbuild.target\fR \fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 260 |
+
.sp
|
| 261 |
+
Note that specifying this flag makes Cargo run in a different mode where the
|
| 262 |
+
target artifacts are placed in a separate directory. See the
|
| 263 |
+
\fIbuild cache\fR <https://doc.rust\-lang.org/cargo/reference/build\-cache.html> documentation for more details.
|
| 264 |
+
.RE
|
| 265 |
+
.sp
|
| 266 |
+
\fB\-\-target\-dir\fR \fIdirectory\fR
|
| 267 |
+
.RS 4
|
| 268 |
+
Directory for all generated artifacts and intermediate files. May also be
|
| 269 |
+
specified with the \fBCARGO_TARGET_DIR\fR environment variable, or the
|
| 270 |
+
\fBbuild.target\-dir\fR \fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 271 |
+
Defaults to \fBtarget\fR in the root of the workspace.
|
| 272 |
+
.RE
|
| 273 |
+
.SS "Feature Selection"
|
| 274 |
+
The feature flags allow you to control which features are enabled. When no
|
| 275 |
+
feature options are given, the \fBdefault\fR feature is activated for every
|
| 276 |
+
selected package.
|
| 277 |
+
.sp
|
| 278 |
+
See \fIthe features documentation\fR <https://doc.rust\-lang.org/cargo/reference/features.html#command\-line\-feature\-options>
|
| 279 |
+
for more details.
|
| 280 |
+
.sp
|
| 281 |
+
\fB\-F\fR \fIfeatures\fR,
|
| 282 |
+
\fB\-\-features\fR \fIfeatures\fR
|
| 283 |
+
.RS 4
|
| 284 |
+
Space or comma separated list of features to activate. Features of workspace
|
| 285 |
+
members may be enabled with \fBpackage\-name/feature\-name\fR syntax. This flag may
|
| 286 |
+
be specified multiple times, which enables all specified features.
|
| 287 |
+
.RE
|
| 288 |
+
.sp
|
| 289 |
+
\fB\-\-all\-features\fR
|
| 290 |
+
.RS 4
|
| 291 |
+
Activate all available features of all selected packages.
|
| 292 |
+
.RE
|
| 293 |
+
.sp
|
| 294 |
+
\fB\-\-no\-default\-features\fR
|
| 295 |
+
.RS 4
|
| 296 |
+
Do not activate the \fBdefault\fR feature of the selected packages.
|
| 297 |
+
.RE
|
| 298 |
+
.SS "Manifest Options"
|
| 299 |
+
.sp
|
| 300 |
+
\fB\-\-manifest\-path\fR \fIpath\fR
|
| 301 |
+
.RS 4
|
| 302 |
+
Path to the \fBCargo.toml\fR file. By default, Cargo searches for the
|
| 303 |
+
\fBCargo.toml\fR file in the current directory or any parent directory.
|
| 304 |
+
.RE
|
| 305 |
+
.sp
|
| 306 |
+
\fB\-\-locked\fR
|
| 307 |
+
.RS 4
|
| 308 |
+
Asserts that the exact same dependencies and versions are used as when the
|
| 309 |
+
existing \fBCargo.lock\fR file was originally generated. Cargo will exit with an
|
| 310 |
+
error when either of the following scenarios arises:
|
| 311 |
+
.sp
|
| 312 |
+
.RS 4
|
| 313 |
+
\h'-04'\(bu\h'+03'The lock file is missing.
|
| 314 |
+
.RE
|
| 315 |
+
.sp
|
| 316 |
+
.RS 4
|
| 317 |
+
\h'-04'\(bu\h'+03'Cargo attempted to change the lock file due to a different dependency resolution.
|
| 318 |
+
.RE
|
| 319 |
+
.sp
|
| 320 |
+
It may be used in environments where deterministic builds are desired,
|
| 321 |
+
such as in CI pipelines.
|
| 322 |
+
.RE
|
| 323 |
+
.sp
|
| 324 |
+
\fB\-\-offline\fR
|
| 325 |
+
.RS 4
|
| 326 |
+
Prevents Cargo from accessing the network for any reason. Without this
|
| 327 |
+
flag, Cargo will stop with an error if it needs to access the network and
|
| 328 |
+
the network is not available. With this flag, Cargo will attempt to
|
| 329 |
+
proceed without the network if possible.
|
| 330 |
+
.sp
|
| 331 |
+
Beware that this may result in different dependency resolution than online
|
| 332 |
+
mode. Cargo will restrict itself to crates that are downloaded locally, even
|
| 333 |
+
if there might be a newer version as indicated in the local copy of the index.
|
| 334 |
+
See the \fBcargo\-fetch\fR(1) command to download dependencies before going
|
| 335 |
+
offline.
|
| 336 |
+
.sp
|
| 337 |
+
May also be specified with the \fBnet.offline\fR \fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 338 |
+
.RE
|
| 339 |
+
.sp
|
| 340 |
+
\fB\-\-frozen\fR
|
| 341 |
+
.RS 4
|
| 342 |
+
Equivalent to specifying both \fB\-\-locked\fR and \fB\-\-offline\fR\&.
|
| 343 |
+
.RE
|
| 344 |
+
.SS "Miscellaneous Options"
|
| 345 |
+
.sp
|
| 346 |
+
\fB\-j\fR \fIN\fR,
|
| 347 |
+
\fB\-\-jobs\fR \fIN\fR
|
| 348 |
+
.RS 4
|
| 349 |
+
Number of parallel jobs to run. May also be specified with the
|
| 350 |
+
\fBbuild.jobs\fR \fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&. Defaults to
|
| 351 |
+
the number of logical CPUs. If negative, it sets the maximum number of
|
| 352 |
+
parallel jobs to the number of logical CPUs plus provided value. If
|
| 353 |
+
a string \fBdefault\fR is provided, it sets the value back to defaults.
|
| 354 |
+
Should not be 0.
|
| 355 |
+
.RE
|
| 356 |
+
.sp
|
| 357 |
+
\fB\-\-keep\-going\fR
|
| 358 |
+
.RS 4
|
| 359 |
+
Build as many crates in the dependency graph as possible, rather than aborting
|
| 360 |
+
the build on the first one that fails to build.
|
| 361 |
+
.sp
|
| 362 |
+
For example if the current package depends on dependencies \fBfails\fR and \fBworks\fR,
|
| 363 |
+
one of which fails to build, \fBcargo package \-j1\fR may or may not build the
|
| 364 |
+
one that succeeds (depending on which one of the two builds Cargo picked to run
|
| 365 |
+
first), whereas \fBcargo package \-j1 \-\-keep\-going\fR would definitely run both
|
| 366 |
+
builds, even if the one run first fails.
|
| 367 |
+
.RE
|
| 368 |
+
.SS "Display Options"
|
| 369 |
+
.sp
|
| 370 |
+
\fB\-v\fR,
|
| 371 |
+
\fB\-\-verbose\fR
|
| 372 |
+
.RS 4
|
| 373 |
+
Use verbose output. May be specified twice for \[lq]very verbose\[rq] output which
|
| 374 |
+
includes extra output such as dependency warnings and build script output.
|
| 375 |
+
May also be specified with the \fBterm.verbose\fR
|
| 376 |
+
\fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 377 |
+
.RE
|
| 378 |
+
.sp
|
| 379 |
+
\fB\-q\fR,
|
| 380 |
+
\fB\-\-quiet\fR
|
| 381 |
+
.RS 4
|
| 382 |
+
Do not print cargo log messages.
|
| 383 |
+
May also be specified with the \fBterm.quiet\fR
|
| 384 |
+
\fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 385 |
+
.RE
|
| 386 |
+
.sp
|
| 387 |
+
\fB\-\-color\fR \fIwhen\fR
|
| 388 |
+
.RS 4
|
| 389 |
+
Control when colored output is used. Valid values:
|
| 390 |
+
.sp
|
| 391 |
+
.RS 4
|
| 392 |
+
\h'-04'\(bu\h'+03'\fBauto\fR (default): Automatically detect if color support is available on the
|
| 393 |
+
terminal.
|
| 394 |
+
.RE
|
| 395 |
+
.sp
|
| 396 |
+
.RS 4
|
| 397 |
+
\h'-04'\(bu\h'+03'\fBalways\fR: Always display colors.
|
| 398 |
+
.RE
|
| 399 |
+
.sp
|
| 400 |
+
.RS 4
|
| 401 |
+
\h'-04'\(bu\h'+03'\fBnever\fR: Never display colors.
|
| 402 |
+
.RE
|
| 403 |
+
.sp
|
| 404 |
+
May also be specified with the \fBterm.color\fR
|
| 405 |
+
\fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 406 |
+
.RE
|
| 407 |
+
.SS "Common Options"
|
| 408 |
+
.sp
|
| 409 |
+
\fB+\fR\fItoolchain\fR
|
| 410 |
+
.RS 4
|
| 411 |
+
If Cargo has been installed with rustup, and the first argument to \fBcargo\fR
|
| 412 |
+
begins with \fB+\fR, it will be interpreted as a rustup toolchain name (such
|
| 413 |
+
as \fB+stable\fR or \fB+nightly\fR).
|
| 414 |
+
See the \fIrustup documentation\fR <https://rust\-lang.github.io/rustup/overrides.html>
|
| 415 |
+
for more information about how toolchain overrides work.
|
| 416 |
+
.RE
|
| 417 |
+
.sp
|
| 418 |
+
\fB\-\-config\fR \fIKEY=VALUE\fR or \fIPATH\fR
|
| 419 |
+
.RS 4
|
| 420 |
+
Overrides a Cargo configuration value. The argument should be in TOML syntax of \fBKEY=VALUE\fR,
|
| 421 |
+
or provided as a path to an extra configuration file. This flag may be specified multiple times.
|
| 422 |
+
See the \fIcommand\-line overrides section\fR <https://doc.rust\-lang.org/cargo/reference/config.html#command\-line\-overrides> for more information.
|
| 423 |
+
.RE
|
| 424 |
+
.sp
|
| 425 |
+
\fB\-C\fR \fIPATH\fR
|
| 426 |
+
.RS 4
|
| 427 |
+
Changes the current working directory before executing any specified operations. This affects
|
| 428 |
+
things like where cargo looks by default for the project manifest (\fBCargo.toml\fR), as well as
|
| 429 |
+
the directories searched for discovering \fB\&.cargo/config.toml\fR, for example. This option must
|
| 430 |
+
appear before the command name, for example \fBcargo \-C path/to/my\-project build\fR\&.
|
| 431 |
+
.sp
|
| 432 |
+
This option is only available on the \fInightly
|
| 433 |
+
channel\fR <https://doc.rust\-lang.org/book/appendix\-07\-nightly\-rust.html> and
|
| 434 |
+
requires the \fB\-Z unstable\-options\fR flag to enable (see
|
| 435 |
+
\fI#10098\fR <https://github.com/rust\-lang/cargo/issues/10098>).
|
| 436 |
+
.RE
|
| 437 |
+
.sp
|
| 438 |
+
\fB\-h\fR,
|
| 439 |
+
\fB\-\-help\fR
|
| 440 |
+
.RS 4
|
| 441 |
+
Prints help information.
|
| 442 |
+
.RE
|
| 443 |
+
.sp
|
| 444 |
+
\fB\-Z\fR \fIflag\fR
|
| 445 |
+
.RS 4
|
| 446 |
+
Unstable (nightly\-only) flags to Cargo. Run \fBcargo \-Z help\fR for details.
|
| 447 |
+
.RE
|
| 448 |
+
.SH "ENVIRONMENT"
|
| 449 |
+
See \fIthe reference\fR <https://doc.rust\-lang.org/cargo/reference/environment\-variables.html> for
|
| 450 |
+
details on environment variables that Cargo reads.
|
| 451 |
+
.SH "EXIT STATUS"
|
| 452 |
+
.sp
|
| 453 |
+
.RS 4
|
| 454 |
+
\h'-04'\(bu\h'+03'\fB0\fR: Cargo succeeded.
|
| 455 |
+
.RE
|
| 456 |
+
.sp
|
| 457 |
+
.RS 4
|
| 458 |
+
\h'-04'\(bu\h'+03'\fB101\fR: Cargo failed to complete.
|
| 459 |
+
.RE
|
| 460 |
+
.SH "EXAMPLES"
|
| 461 |
+
.sp
|
| 462 |
+
.RS 4
|
| 463 |
+
\h'-04' 1.\h'+01'Create a compressed \fB\&.crate\fR file of the current package:
|
| 464 |
+
.sp
|
| 465 |
+
.RS 4
|
| 466 |
+
.nf
|
| 467 |
+
cargo package
|
| 468 |
+
.fi
|
| 469 |
+
.RE
|
| 470 |
+
.RE
|
| 471 |
+
.SH "SEE ALSO"
|
| 472 |
+
\fBcargo\fR(1), \fBcargo\-publish\fR(1)
|
rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-pkgid.1
ADDED
|
@@ -0,0 +1,258 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
'\" t
|
| 2 |
+
.TH "CARGO\-PKGID" "1"
|
| 3 |
+
.nh
|
| 4 |
+
.ad l
|
| 5 |
+
.ss \n[.ss] 0
|
| 6 |
+
.SH "NAME"
|
| 7 |
+
cargo\-pkgid \[em] Print a fully qualified package specification
|
| 8 |
+
.SH "SYNOPSIS"
|
| 9 |
+
\fBcargo pkgid\fR [\fIoptions\fR] [\fIspec\fR]
|
| 10 |
+
.SH "DESCRIPTION"
|
| 11 |
+
Given a \fIspec\fR argument, print out the fully qualified package ID specifier
|
| 12 |
+
for a package or dependency in the current workspace. This command will
|
| 13 |
+
generate an error if \fIspec\fR is ambiguous as to which package it refers to in
|
| 14 |
+
the dependency graph. If no \fIspec\fR is given, then the specifier for the local
|
| 15 |
+
package is printed.
|
| 16 |
+
.sp
|
| 17 |
+
This command requires that a lockfile is available and dependencies have been
|
| 18 |
+
fetched.
|
| 19 |
+
.sp
|
| 20 |
+
A package specifier consists of a name, version, and source URL. You are
|
| 21 |
+
allowed to use partial specifiers to succinctly match a specific package as
|
| 22 |
+
long as it matches only one package. This specifier is also used by other parts
|
| 23 |
+
in Cargo, such as \fBcargo\-metadata\fR(1) and \fIJSON messages\fR <https://doc.rust\-lang.org/cargo/reference/external\-tools.html#json\-messages> emitted by Cargo.
|
| 24 |
+
.sp
|
| 25 |
+
The format of a \fIspec\fR can be one of the following:
|
| 26 |
+
|
| 27 |
+
.TS
|
| 28 |
+
allbox tab(:);
|
| 29 |
+
lt lt.
|
| 30 |
+
T{
|
| 31 |
+
SPEC Structure
|
| 32 |
+
T}:T{
|
| 33 |
+
Example SPEC
|
| 34 |
+
T}
|
| 35 |
+
T{
|
| 36 |
+
\fIname\fR
|
| 37 |
+
T}:T{
|
| 38 |
+
\fBbitflags\fR
|
| 39 |
+
T}
|
| 40 |
+
T{
|
| 41 |
+
\fIname\fR\fB@\fR\fIversion\fR
|
| 42 |
+
T}:T{
|
| 43 |
+
\fBbitflags@1.0.4\fR
|
| 44 |
+
T}
|
| 45 |
+
T{
|
| 46 |
+
\fIurl\fR
|
| 47 |
+
T}:T{
|
| 48 |
+
\fBhttps://github.com/rust\-lang/cargo\fR
|
| 49 |
+
T}
|
| 50 |
+
T{
|
| 51 |
+
\fIurl\fR\fB#\fR\fIversion\fR
|
| 52 |
+
T}:T{
|
| 53 |
+
\fBhttps://github.com/rust\-lang/cargo#0.33.0\fR
|
| 54 |
+
T}
|
| 55 |
+
T{
|
| 56 |
+
\fIurl\fR\fB#\fR\fIname\fR
|
| 57 |
+
T}:T{
|
| 58 |
+
\fBhttps://github.com/rust\-lang/crates.io\-index#bitflags\fR
|
| 59 |
+
T}
|
| 60 |
+
T{
|
| 61 |
+
\fIurl\fR\fB#\fR\fIname\fR\fB@\fR\fIversion\fR
|
| 62 |
+
T}:T{
|
| 63 |
+
\fBhttps://github.com/rust\-lang/cargo#crates\-io@0.21.0\fR
|
| 64 |
+
T}
|
| 65 |
+
.TE
|
| 66 |
+
.sp
|
| 67 |
+
.sp
|
| 68 |
+
The specification grammar can be found in chapter \fIPackage ID Specifications\fR <https://doc.rust\-lang.org/cargo/reference/pkgid\-spec.html>\&.
|
| 69 |
+
.SH "OPTIONS"
|
| 70 |
+
.SS "Package Selection"
|
| 71 |
+
.sp
|
| 72 |
+
\fB\-p\fR \fIspec\fR,
|
| 73 |
+
\fB\-\-package\fR \fIspec\fR
|
| 74 |
+
.RS 4
|
| 75 |
+
Get the package ID for the given package instead of the current package.
|
| 76 |
+
.RE
|
| 77 |
+
.SS "Display Options"
|
| 78 |
+
.sp
|
| 79 |
+
\fB\-v\fR,
|
| 80 |
+
\fB\-\-verbose\fR
|
| 81 |
+
.RS 4
|
| 82 |
+
Use verbose output. May be specified twice for \[lq]very verbose\[rq] output which
|
| 83 |
+
includes extra output such as dependency warnings and build script output.
|
| 84 |
+
May also be specified with the \fBterm.verbose\fR
|
| 85 |
+
\fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 86 |
+
.RE
|
| 87 |
+
.sp
|
| 88 |
+
\fB\-q\fR,
|
| 89 |
+
\fB\-\-quiet\fR
|
| 90 |
+
.RS 4
|
| 91 |
+
Do not print cargo log messages.
|
| 92 |
+
May also be specified with the \fBterm.quiet\fR
|
| 93 |
+
\fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 94 |
+
.RE
|
| 95 |
+
.sp
|
| 96 |
+
\fB\-\-color\fR \fIwhen\fR
|
| 97 |
+
.RS 4
|
| 98 |
+
Control when colored output is used. Valid values:
|
| 99 |
+
.sp
|
| 100 |
+
.RS 4
|
| 101 |
+
\h'-04'\(bu\h'+03'\fBauto\fR (default): Automatically detect if color support is available on the
|
| 102 |
+
terminal.
|
| 103 |
+
.RE
|
| 104 |
+
.sp
|
| 105 |
+
.RS 4
|
| 106 |
+
\h'-04'\(bu\h'+03'\fBalways\fR: Always display colors.
|
| 107 |
+
.RE
|
| 108 |
+
.sp
|
| 109 |
+
.RS 4
|
| 110 |
+
\h'-04'\(bu\h'+03'\fBnever\fR: Never display colors.
|
| 111 |
+
.RE
|
| 112 |
+
.sp
|
| 113 |
+
May also be specified with the \fBterm.color\fR
|
| 114 |
+
\fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 115 |
+
.RE
|
| 116 |
+
.SS "Manifest Options"
|
| 117 |
+
.sp
|
| 118 |
+
\fB\-\-manifest\-path\fR \fIpath\fR
|
| 119 |
+
.RS 4
|
| 120 |
+
Path to the \fBCargo.toml\fR file. By default, Cargo searches for the
|
| 121 |
+
\fBCargo.toml\fR file in the current directory or any parent directory.
|
| 122 |
+
.RE
|
| 123 |
+
.sp
|
| 124 |
+
\fB\-\-locked\fR
|
| 125 |
+
.RS 4
|
| 126 |
+
Asserts that the exact same dependencies and versions are used as when the
|
| 127 |
+
existing \fBCargo.lock\fR file was originally generated. Cargo will exit with an
|
| 128 |
+
error when either of the following scenarios arises:
|
| 129 |
+
.sp
|
| 130 |
+
.RS 4
|
| 131 |
+
\h'-04'\(bu\h'+03'The lock file is missing.
|
| 132 |
+
.RE
|
| 133 |
+
.sp
|
| 134 |
+
.RS 4
|
| 135 |
+
\h'-04'\(bu\h'+03'Cargo attempted to change the lock file due to a different dependency resolution.
|
| 136 |
+
.RE
|
| 137 |
+
.sp
|
| 138 |
+
It may be used in environments where deterministic builds are desired,
|
| 139 |
+
such as in CI pipelines.
|
| 140 |
+
.RE
|
| 141 |
+
.sp
|
| 142 |
+
\fB\-\-offline\fR
|
| 143 |
+
.RS 4
|
| 144 |
+
Prevents Cargo from accessing the network for any reason. Without this
|
| 145 |
+
flag, Cargo will stop with an error if it needs to access the network and
|
| 146 |
+
the network is not available. With this flag, Cargo will attempt to
|
| 147 |
+
proceed without the network if possible.
|
| 148 |
+
.sp
|
| 149 |
+
Beware that this may result in different dependency resolution than online
|
| 150 |
+
mode. Cargo will restrict itself to crates that are downloaded locally, even
|
| 151 |
+
if there might be a newer version as indicated in the local copy of the index.
|
| 152 |
+
See the \fBcargo\-fetch\fR(1) command to download dependencies before going
|
| 153 |
+
offline.
|
| 154 |
+
.sp
|
| 155 |
+
May also be specified with the \fBnet.offline\fR \fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 156 |
+
.RE
|
| 157 |
+
.sp
|
| 158 |
+
\fB\-\-frozen\fR
|
| 159 |
+
.RS 4
|
| 160 |
+
Equivalent to specifying both \fB\-\-locked\fR and \fB\-\-offline\fR\&.
|
| 161 |
+
.RE
|
| 162 |
+
.SS "Common Options"
|
| 163 |
+
.sp
|
| 164 |
+
\fB+\fR\fItoolchain\fR
|
| 165 |
+
.RS 4
|
| 166 |
+
If Cargo has been installed with rustup, and the first argument to \fBcargo\fR
|
| 167 |
+
begins with \fB+\fR, it will be interpreted as a rustup toolchain name (such
|
| 168 |
+
as \fB+stable\fR or \fB+nightly\fR).
|
| 169 |
+
See the \fIrustup documentation\fR <https://rust\-lang.github.io/rustup/overrides.html>
|
| 170 |
+
for more information about how toolchain overrides work.
|
| 171 |
+
.RE
|
| 172 |
+
.sp
|
| 173 |
+
\fB\-\-config\fR \fIKEY=VALUE\fR or \fIPATH\fR
|
| 174 |
+
.RS 4
|
| 175 |
+
Overrides a Cargo configuration value. The argument should be in TOML syntax of \fBKEY=VALUE\fR,
|
| 176 |
+
or provided as a path to an extra configuration file. This flag may be specified multiple times.
|
| 177 |
+
See the \fIcommand\-line overrides section\fR <https://doc.rust\-lang.org/cargo/reference/config.html#command\-line\-overrides> for more information.
|
| 178 |
+
.RE
|
| 179 |
+
.sp
|
| 180 |
+
\fB\-C\fR \fIPATH\fR
|
| 181 |
+
.RS 4
|
| 182 |
+
Changes the current working directory before executing any specified operations. This affects
|
| 183 |
+
things like where cargo looks by default for the project manifest (\fBCargo.toml\fR), as well as
|
| 184 |
+
the directories searched for discovering \fB\&.cargo/config.toml\fR, for example. This option must
|
| 185 |
+
appear before the command name, for example \fBcargo \-C path/to/my\-project build\fR\&.
|
| 186 |
+
.sp
|
| 187 |
+
This option is only available on the \fInightly
|
| 188 |
+
channel\fR <https://doc.rust\-lang.org/book/appendix\-07\-nightly\-rust.html> and
|
| 189 |
+
requires the \fB\-Z unstable\-options\fR flag to enable (see
|
| 190 |
+
\fI#10098\fR <https://github.com/rust\-lang/cargo/issues/10098>).
|
| 191 |
+
.RE
|
| 192 |
+
.sp
|
| 193 |
+
\fB\-h\fR,
|
| 194 |
+
\fB\-\-help\fR
|
| 195 |
+
.RS 4
|
| 196 |
+
Prints help information.
|
| 197 |
+
.RE
|
| 198 |
+
.sp
|
| 199 |
+
\fB\-Z\fR \fIflag\fR
|
| 200 |
+
.RS 4
|
| 201 |
+
Unstable (nightly\-only) flags to Cargo. Run \fBcargo \-Z help\fR for details.
|
| 202 |
+
.RE
|
| 203 |
+
.SH "ENVIRONMENT"
|
| 204 |
+
See \fIthe reference\fR <https://doc.rust\-lang.org/cargo/reference/environment\-variables.html> for
|
| 205 |
+
details on environment variables that Cargo reads.
|
| 206 |
+
.SH "EXIT STATUS"
|
| 207 |
+
.sp
|
| 208 |
+
.RS 4
|
| 209 |
+
\h'-04'\(bu\h'+03'\fB0\fR: Cargo succeeded.
|
| 210 |
+
.RE
|
| 211 |
+
.sp
|
| 212 |
+
.RS 4
|
| 213 |
+
\h'-04'\(bu\h'+03'\fB101\fR: Cargo failed to complete.
|
| 214 |
+
.RE
|
| 215 |
+
.SH "EXAMPLES"
|
| 216 |
+
.sp
|
| 217 |
+
.RS 4
|
| 218 |
+
\h'-04' 1.\h'+01'Retrieve package specification for \fBfoo\fR package:
|
| 219 |
+
.sp
|
| 220 |
+
.RS 4
|
| 221 |
+
.nf
|
| 222 |
+
cargo pkgid foo
|
| 223 |
+
.fi
|
| 224 |
+
.RE
|
| 225 |
+
.RE
|
| 226 |
+
.sp
|
| 227 |
+
.RS 4
|
| 228 |
+
\h'-04' 2.\h'+01'Retrieve package specification for version 1.0.0 of \fBfoo\fR:
|
| 229 |
+
.sp
|
| 230 |
+
.RS 4
|
| 231 |
+
.nf
|
| 232 |
+
cargo pkgid foo@1.0.0
|
| 233 |
+
.fi
|
| 234 |
+
.RE
|
| 235 |
+
.RE
|
| 236 |
+
.sp
|
| 237 |
+
.RS 4
|
| 238 |
+
\h'-04' 3.\h'+01'Retrieve package specification for \fBfoo\fR from crates.io:
|
| 239 |
+
.sp
|
| 240 |
+
.RS 4
|
| 241 |
+
.nf
|
| 242 |
+
cargo pkgid https://github.com/rust\-lang/crates.io\-index#foo
|
| 243 |
+
.fi
|
| 244 |
+
.RE
|
| 245 |
+
.RE
|
| 246 |
+
.sp
|
| 247 |
+
.RS 4
|
| 248 |
+
\h'-04' 4.\h'+01'Retrieve package specification for \fBfoo\fR from a local package:
|
| 249 |
+
.sp
|
| 250 |
+
.RS 4
|
| 251 |
+
.nf
|
| 252 |
+
cargo pkgid file:///path/to/local/package#foo
|
| 253 |
+
.fi
|
| 254 |
+
.RE
|
| 255 |
+
.RE
|
| 256 |
+
.SH "SEE ALSO"
|
| 257 |
+
\fBcargo\fR(1), \fBcargo\-generate\-lockfile\fR(1), \fBcargo\-metadata\fR(1),
|
| 258 |
+
\fIPackage ID Specifications\fR <https://doc.rust\-lang.org/cargo/reference/pkgid\-spec.html>, \fIJSON messages\fR <https://doc.rust\-lang.org/cargo/reference/external\-tools.html#json\-messages>
|
rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-publish.1
ADDED
|
@@ -0,0 +1,353 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
'\" t
|
| 2 |
+
.TH "CARGO\-PUBLISH" "1"
|
| 3 |
+
.nh
|
| 4 |
+
.ad l
|
| 5 |
+
.ss \n[.ss] 0
|
| 6 |
+
.SH "NAME"
|
| 7 |
+
cargo\-publish \[em] Upload a package to the registry
|
| 8 |
+
.SH "SYNOPSIS"
|
| 9 |
+
\fBcargo publish\fR [\fIoptions\fR]
|
| 10 |
+
.SH "DESCRIPTION"
|
| 11 |
+
This command will create a distributable, compressed \fB\&.crate\fR file with the
|
| 12 |
+
source code of the package in the current directory and upload it to a
|
| 13 |
+
registry. The default registry is <https://crates.io>\&. This performs the
|
| 14 |
+
following steps:
|
| 15 |
+
.sp
|
| 16 |
+
.RS 4
|
| 17 |
+
\h'-04' 1.\h'+01'Performs a few checks, including:
|
| 18 |
+
.sp
|
| 19 |
+
.RS 4
|
| 20 |
+
\h'-04'\(bu\h'+03'Checks the \fBpackage.publish\fR key in the manifest for restrictions on
|
| 21 |
+
which registries you are allowed to publish to.
|
| 22 |
+
.RE
|
| 23 |
+
.RE
|
| 24 |
+
.sp
|
| 25 |
+
.RS 4
|
| 26 |
+
\h'-04' 2.\h'+01'Create a \fB\&.crate\fR file by following the steps in \fBcargo\-package\fR(1).
|
| 27 |
+
.RE
|
| 28 |
+
.sp
|
| 29 |
+
.RS 4
|
| 30 |
+
\h'-04' 3.\h'+01'Upload the crate to the registry. The server will perform additional
|
| 31 |
+
checks on the crate.
|
| 32 |
+
.RE
|
| 33 |
+
.sp
|
| 34 |
+
.RS 4
|
| 35 |
+
\h'-04' 4.\h'+01'The client will poll waiting for the package to appear in the index,
|
| 36 |
+
and may timeout. In that case, you will need to check for completion
|
| 37 |
+
manually. This timeout does not affect the upload.
|
| 38 |
+
.RE
|
| 39 |
+
.sp
|
| 40 |
+
This command requires you to be authenticated using \fBcargo\-login\fR(1)
|
| 41 |
+
or environment variables of the \fI\f(BIregistry.token\fI\fR <https://doc.rust\-lang.org/cargo/reference/config.html#registrytoken>
|
| 42 |
+
and \fI\f(BIregistries.<name>.token\fI\fR <https://doc.rust\-lang.org/cargo/reference/config.html#registriesnametoken> config fields.
|
| 43 |
+
.sp
|
| 44 |
+
See \fIthe reference\fR <https://doc.rust\-lang.org/cargo/reference/publishing.html> for more details about
|
| 45 |
+
packaging and publishing.
|
| 46 |
+
.SH "OPTIONS"
|
| 47 |
+
.SS "Publish Options"
|
| 48 |
+
.sp
|
| 49 |
+
\fB\-\-dry\-run\fR
|
| 50 |
+
.RS 4
|
| 51 |
+
Perform all checks without uploading.
|
| 52 |
+
.RE
|
| 53 |
+
.sp
|
| 54 |
+
\fB\-\-no\-verify\fR
|
| 55 |
+
.RS 4
|
| 56 |
+
Don\[cq]t verify the contents by building them.
|
| 57 |
+
.RE
|
| 58 |
+
.sp
|
| 59 |
+
\fB\-\-allow\-dirty\fR
|
| 60 |
+
.RS 4
|
| 61 |
+
Allow working directories with uncommitted VCS changes to be packaged.
|
| 62 |
+
.RE
|
| 63 |
+
.sp
|
| 64 |
+
\fB\-\-index\fR \fIindex\fR
|
| 65 |
+
.RS 4
|
| 66 |
+
The URL of the registry index to use.
|
| 67 |
+
.RE
|
| 68 |
+
.sp
|
| 69 |
+
\fB\-\-registry\fR \fIregistry\fR
|
| 70 |
+
.RS 4
|
| 71 |
+
Name of the registry to publish to. Registry names are defined in \fICargo
|
| 72 |
+
config files\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&. If not specified, and there is a
|
| 73 |
+
\fI\f(BIpackage.publish\fI\fR <https://doc.rust\-lang.org/cargo/reference/manifest.html#the\-publish\-field> field in
|
| 74 |
+
\fBCargo.toml\fR with a single registry, then it will publish to that registry.
|
| 75 |
+
Otherwise it will use the default registry, which is defined by the
|
| 76 |
+
\fI\f(BIregistry.default\fI\fR <https://doc.rust\-lang.org/cargo/reference/config.html#registrydefault> config key
|
| 77 |
+
which defaults to \fBcrates\-io\fR\&.
|
| 78 |
+
.RE
|
| 79 |
+
.SS "Package Selection"
|
| 80 |
+
By default, when no package selection options are given, the packages selected
|
| 81 |
+
depend on the selected manifest file (based on the current working directory if
|
| 82 |
+
\fB\-\-manifest\-path\fR is not given). If the manifest is the root of a workspace then
|
| 83 |
+
the workspaces default members are selected, otherwise only the package defined
|
| 84 |
+
by the manifest will be selected.
|
| 85 |
+
.sp
|
| 86 |
+
The default members of a workspace can be set explicitly with the
|
| 87 |
+
\fBworkspace.default\-members\fR key in the root manifest. If this is not set, a
|
| 88 |
+
virtual workspace will include all workspace members (equivalent to passing
|
| 89 |
+
\fB\-\-workspace\fR), and a non\-virtual workspace will include only the root crate itself.
|
| 90 |
+
.sp
|
| 91 |
+
\fB\-p\fR \fIspec\fR\[u2026],
|
| 92 |
+
\fB\-\-package\fR \fIspec\fR\[u2026]
|
| 93 |
+
.RS 4
|
| 94 |
+
Publish only the specified packages. See \fBcargo\-pkgid\fR(1) for the
|
| 95 |
+
SPEC format. This flag may be specified multiple times and supports common Unix
|
| 96 |
+
glob patterns like \fB*\fR, \fB?\fR and \fB[]\fR\&. However, to avoid your shell accidentally
|
| 97 |
+
expanding glob patterns before Cargo handles them, you must use single quotes or
|
| 98 |
+
double quotes around each pattern.
|
| 99 |
+
.RE
|
| 100 |
+
.sp
|
| 101 |
+
\fB\-\-workspace\fR
|
| 102 |
+
.RS 4
|
| 103 |
+
Publish all members in the workspace.
|
| 104 |
+
.RE
|
| 105 |
+
.sp
|
| 106 |
+
\fB\-\-all\fR
|
| 107 |
+
.RS 4
|
| 108 |
+
Deprecated alias for \fB\-\-workspace\fR\&.
|
| 109 |
+
.RE
|
| 110 |
+
.sp
|
| 111 |
+
\fB\-\-exclude\fR \fISPEC\fR\[u2026]
|
| 112 |
+
.RS 4
|
| 113 |
+
Exclude the specified packages. Must be used in conjunction with the
|
| 114 |
+
\fB\-\-workspace\fR flag. This flag may be specified multiple times and supports
|
| 115 |
+
common Unix glob patterns like \fB*\fR, \fB?\fR and \fB[]\fR\&. However, to avoid your shell
|
| 116 |
+
accidentally expanding glob patterns before Cargo handles them, you must use
|
| 117 |
+
single quotes or double quotes around each pattern.
|
| 118 |
+
.RE
|
| 119 |
+
.SS "Compilation Options"
|
| 120 |
+
.sp
|
| 121 |
+
\fB\-\-target\fR \fItriple\fR
|
| 122 |
+
.RS 4
|
| 123 |
+
Publish for the specified target architecture. Flag may be specified multiple times. The default is the host architecture. The general format of the triple is
|
| 124 |
+
\fB<arch><sub>\-<vendor>\-<sys>\-<abi>\fR\&.
|
| 125 |
+
.sp
|
| 126 |
+
Possible values:
|
| 127 |
+
.sp
|
| 128 |
+
.RS 4
|
| 129 |
+
\h'-04'\(bu\h'+03'Any supported target in \fBrustc \-\-print target\-list\fR\&.
|
| 130 |
+
.RE
|
| 131 |
+
.sp
|
| 132 |
+
.RS 4
|
| 133 |
+
\h'-04'\(bu\h'+03'\fB"host\-tuple"\fR, which will internally be substituted by the host\[cq]s target. This can be particularly useful if you\[cq]re cross\-compiling some crates, and don\[cq]t want to specify your host\[cq]s machine as a target (for instance, an \fBxtask\fR in a shared project that may be worked on by many hosts).
|
| 134 |
+
.RE
|
| 135 |
+
.sp
|
| 136 |
+
.RS 4
|
| 137 |
+
\h'-04'\(bu\h'+03'A path to a custom target specification. See \fICustom Target Lookup Path\fR <https://doc.rust\-lang.org/rustc/targets/custom.html#custom\-target\-lookup\-path> for more information.
|
| 138 |
+
.RE
|
| 139 |
+
.sp
|
| 140 |
+
This may also be specified with the \fBbuild.target\fR \fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 141 |
+
.sp
|
| 142 |
+
Note that specifying this flag makes Cargo run in a different mode where the
|
| 143 |
+
target artifacts are placed in a separate directory. See the
|
| 144 |
+
\fIbuild cache\fR <https://doc.rust\-lang.org/cargo/reference/build\-cache.html> documentation for more details.
|
| 145 |
+
.RE
|
| 146 |
+
.sp
|
| 147 |
+
\fB\-\-target\-dir\fR \fIdirectory\fR
|
| 148 |
+
.RS 4
|
| 149 |
+
Directory for all generated artifacts and intermediate files. May also be
|
| 150 |
+
specified with the \fBCARGO_TARGET_DIR\fR environment variable, or the
|
| 151 |
+
\fBbuild.target\-dir\fR \fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 152 |
+
Defaults to \fBtarget\fR in the root of the workspace.
|
| 153 |
+
.RE
|
| 154 |
+
.SS "Feature Selection"
|
| 155 |
+
The feature flags allow you to control which features are enabled. When no
|
| 156 |
+
feature options are given, the \fBdefault\fR feature is activated for every
|
| 157 |
+
selected package.
|
| 158 |
+
.sp
|
| 159 |
+
See \fIthe features documentation\fR <https://doc.rust\-lang.org/cargo/reference/features.html#command\-line\-feature\-options>
|
| 160 |
+
for more details.
|
| 161 |
+
.sp
|
| 162 |
+
\fB\-F\fR \fIfeatures\fR,
|
| 163 |
+
\fB\-\-features\fR \fIfeatures\fR
|
| 164 |
+
.RS 4
|
| 165 |
+
Space or comma separated list of features to activate. Features of workspace
|
| 166 |
+
members may be enabled with \fBpackage\-name/feature\-name\fR syntax. This flag may
|
| 167 |
+
be specified multiple times, which enables all specified features.
|
| 168 |
+
.RE
|
| 169 |
+
.sp
|
| 170 |
+
\fB\-\-all\-features\fR
|
| 171 |
+
.RS 4
|
| 172 |
+
Activate all available features of all selected packages.
|
| 173 |
+
.RE
|
| 174 |
+
.sp
|
| 175 |
+
\fB\-\-no\-default\-features\fR
|
| 176 |
+
.RS 4
|
| 177 |
+
Do not activate the \fBdefault\fR feature of the selected packages.
|
| 178 |
+
.RE
|
| 179 |
+
.SS "Manifest Options"
|
| 180 |
+
.sp
|
| 181 |
+
\fB\-\-manifest\-path\fR \fIpath\fR
|
| 182 |
+
.RS 4
|
| 183 |
+
Path to the \fBCargo.toml\fR file. By default, Cargo searches for the
|
| 184 |
+
\fBCargo.toml\fR file in the current directory or any parent directory.
|
| 185 |
+
.RE
|
| 186 |
+
.sp
|
| 187 |
+
\fB\-\-locked\fR
|
| 188 |
+
.RS 4
|
| 189 |
+
Asserts that the exact same dependencies and versions are used as when the
|
| 190 |
+
existing \fBCargo.lock\fR file was originally generated. Cargo will exit with an
|
| 191 |
+
error when either of the following scenarios arises:
|
| 192 |
+
.sp
|
| 193 |
+
.RS 4
|
| 194 |
+
\h'-04'\(bu\h'+03'The lock file is missing.
|
| 195 |
+
.RE
|
| 196 |
+
.sp
|
| 197 |
+
.RS 4
|
| 198 |
+
\h'-04'\(bu\h'+03'Cargo attempted to change the lock file due to a different dependency resolution.
|
| 199 |
+
.RE
|
| 200 |
+
.sp
|
| 201 |
+
It may be used in environments where deterministic builds are desired,
|
| 202 |
+
such as in CI pipelines.
|
| 203 |
+
.RE
|
| 204 |
+
.sp
|
| 205 |
+
\fB\-\-offline\fR
|
| 206 |
+
.RS 4
|
| 207 |
+
Prevents Cargo from accessing the network for any reason. Without this
|
| 208 |
+
flag, Cargo will stop with an error if it needs to access the network and
|
| 209 |
+
the network is not available. With this flag, Cargo will attempt to
|
| 210 |
+
proceed without the network if possible.
|
| 211 |
+
.sp
|
| 212 |
+
Beware that this may result in different dependency resolution than online
|
| 213 |
+
mode. Cargo will restrict itself to crates that are downloaded locally, even
|
| 214 |
+
if there might be a newer version as indicated in the local copy of the index.
|
| 215 |
+
See the \fBcargo\-fetch\fR(1) command to download dependencies before going
|
| 216 |
+
offline.
|
| 217 |
+
.sp
|
| 218 |
+
May also be specified with the \fBnet.offline\fR \fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 219 |
+
.RE
|
| 220 |
+
.sp
|
| 221 |
+
\fB\-\-frozen\fR
|
| 222 |
+
.RS 4
|
| 223 |
+
Equivalent to specifying both \fB\-\-locked\fR and \fB\-\-offline\fR\&.
|
| 224 |
+
.RE
|
| 225 |
+
.SS "Miscellaneous Options"
|
| 226 |
+
.sp
|
| 227 |
+
\fB\-j\fR \fIN\fR,
|
| 228 |
+
\fB\-\-jobs\fR \fIN\fR
|
| 229 |
+
.RS 4
|
| 230 |
+
Number of parallel jobs to run. May also be specified with the
|
| 231 |
+
\fBbuild.jobs\fR \fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&. Defaults to
|
| 232 |
+
the number of logical CPUs. If negative, it sets the maximum number of
|
| 233 |
+
parallel jobs to the number of logical CPUs plus provided value. If
|
| 234 |
+
a string \fBdefault\fR is provided, it sets the value back to defaults.
|
| 235 |
+
Should not be 0.
|
| 236 |
+
.RE
|
| 237 |
+
.sp
|
| 238 |
+
\fB\-\-keep\-going\fR
|
| 239 |
+
.RS 4
|
| 240 |
+
Build as many crates in the dependency graph as possible, rather than aborting
|
| 241 |
+
the build on the first one that fails to build.
|
| 242 |
+
.sp
|
| 243 |
+
For example if the current package depends on dependencies \fBfails\fR and \fBworks\fR,
|
| 244 |
+
one of which fails to build, \fBcargo publish \-j1\fR may or may not build the
|
| 245 |
+
one that succeeds (depending on which one of the two builds Cargo picked to run
|
| 246 |
+
first), whereas \fBcargo publish \-j1 \-\-keep\-going\fR would definitely run both
|
| 247 |
+
builds, even if the one run first fails.
|
| 248 |
+
.RE
|
| 249 |
+
.SS "Display Options"
|
| 250 |
+
.sp
|
| 251 |
+
\fB\-v\fR,
|
| 252 |
+
\fB\-\-verbose\fR
|
| 253 |
+
.RS 4
|
| 254 |
+
Use verbose output. May be specified twice for \[lq]very verbose\[rq] output which
|
| 255 |
+
includes extra output such as dependency warnings and build script output.
|
| 256 |
+
May also be specified with the \fBterm.verbose\fR
|
| 257 |
+
\fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 258 |
+
.RE
|
| 259 |
+
.sp
|
| 260 |
+
\fB\-q\fR,
|
| 261 |
+
\fB\-\-quiet\fR
|
| 262 |
+
.RS 4
|
| 263 |
+
Do not print cargo log messages.
|
| 264 |
+
May also be specified with the \fBterm.quiet\fR
|
| 265 |
+
\fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 266 |
+
.RE
|
| 267 |
+
.sp
|
| 268 |
+
\fB\-\-color\fR \fIwhen\fR
|
| 269 |
+
.RS 4
|
| 270 |
+
Control when colored output is used. Valid values:
|
| 271 |
+
.sp
|
| 272 |
+
.RS 4
|
| 273 |
+
\h'-04'\(bu\h'+03'\fBauto\fR (default): Automatically detect if color support is available on the
|
| 274 |
+
terminal.
|
| 275 |
+
.RE
|
| 276 |
+
.sp
|
| 277 |
+
.RS 4
|
| 278 |
+
\h'-04'\(bu\h'+03'\fBalways\fR: Always display colors.
|
| 279 |
+
.RE
|
| 280 |
+
.sp
|
| 281 |
+
.RS 4
|
| 282 |
+
\h'-04'\(bu\h'+03'\fBnever\fR: Never display colors.
|
| 283 |
+
.RE
|
| 284 |
+
.sp
|
| 285 |
+
May also be specified with the \fBterm.color\fR
|
| 286 |
+
\fIconfig value\fR <https://doc.rust\-lang.org/cargo/reference/config.html>\&.
|
| 287 |
+
.RE
|
| 288 |
+
.SS "Common Options"
|
| 289 |
+
.sp
|
| 290 |
+
\fB+\fR\fItoolchain\fR
|
| 291 |
+
.RS 4
|
| 292 |
+
If Cargo has been installed with rustup, and the first argument to \fBcargo\fR
|
| 293 |
+
begins with \fB+\fR, it will be interpreted as a rustup toolchain name (such
|
| 294 |
+
as \fB+stable\fR or \fB+nightly\fR).
|
| 295 |
+
See the \fIrustup documentation\fR <https://rust\-lang.github.io/rustup/overrides.html>
|
| 296 |
+
for more information about how toolchain overrides work.
|
| 297 |
+
.RE
|
| 298 |
+
.sp
|
| 299 |
+
\fB\-\-config\fR \fIKEY=VALUE\fR or \fIPATH\fR
|
| 300 |
+
.RS 4
|
| 301 |
+
Overrides a Cargo configuration value. The argument should be in TOML syntax of \fBKEY=VALUE\fR,
|
| 302 |
+
or provided as a path to an extra configuration file. This flag may be specified multiple times.
|
| 303 |
+
See the \fIcommand\-line overrides section\fR <https://doc.rust\-lang.org/cargo/reference/config.html#command\-line\-overrides> for more information.
|
| 304 |
+
.RE
|
| 305 |
+
.sp
|
| 306 |
+
\fB\-C\fR \fIPATH\fR
|
| 307 |
+
.RS 4
|
| 308 |
+
Changes the current working directory before executing any specified operations. This affects
|
| 309 |
+
things like where cargo looks by default for the project manifest (\fBCargo.toml\fR), as well as
|
| 310 |
+
the directories searched for discovering \fB\&.cargo/config.toml\fR, for example. This option must
|
| 311 |
+
appear before the command name, for example \fBcargo \-C path/to/my\-project build\fR\&.
|
| 312 |
+
.sp
|
| 313 |
+
This option is only available on the \fInightly
|
| 314 |
+
channel\fR <https://doc.rust\-lang.org/book/appendix\-07\-nightly\-rust.html> and
|
| 315 |
+
requires the \fB\-Z unstable\-options\fR flag to enable (see
|
| 316 |
+
\fI#10098\fR <https://github.com/rust\-lang/cargo/issues/10098>).
|
| 317 |
+
.RE
|
| 318 |
+
.sp
|
| 319 |
+
\fB\-h\fR,
|
| 320 |
+
\fB\-\-help\fR
|
| 321 |
+
.RS 4
|
| 322 |
+
Prints help information.
|
| 323 |
+
.RE
|
| 324 |
+
.sp
|
| 325 |
+
\fB\-Z\fR \fIflag\fR
|
| 326 |
+
.RS 4
|
| 327 |
+
Unstable (nightly\-only) flags to Cargo. Run \fBcargo \-Z help\fR for details.
|
| 328 |
+
.RE
|
| 329 |
+
.SH "ENVIRONMENT"
|
| 330 |
+
See \fIthe reference\fR <https://doc.rust\-lang.org/cargo/reference/environment\-variables.html> for
|
| 331 |
+
details on environment variables that Cargo reads.
|
| 332 |
+
.SH "EXIT STATUS"
|
| 333 |
+
.sp
|
| 334 |
+
.RS 4
|
| 335 |
+
\h'-04'\(bu\h'+03'\fB0\fR: Cargo succeeded.
|
| 336 |
+
.RE
|
| 337 |
+
.sp
|
| 338 |
+
.RS 4
|
| 339 |
+
\h'-04'\(bu\h'+03'\fB101\fR: Cargo failed to complete.
|
| 340 |
+
.RE
|
| 341 |
+
.SH "EXAMPLES"
|
| 342 |
+
.sp
|
| 343 |
+
.RS 4
|
| 344 |
+
\h'-04' 1.\h'+01'Publish the current package:
|
| 345 |
+
.sp
|
| 346 |
+
.RS 4
|
| 347 |
+
.nf
|
| 348 |
+
cargo publish
|
| 349 |
+
.fi
|
| 350 |
+
.RE
|
| 351 |
+
.RE
|
| 352 |
+
.SH "SEE ALSO"
|
| 353 |
+
\fBcargo\fR(1), \fBcargo\-package\fR(1), \fBcargo\-login\fR(1)
|
rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/zsh/site-functions/_cargo
ADDED
|
@@ -0,0 +1,478 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
#compdef cargo
|
| 2 |
+
|
| 3 |
+
autoload -U regexp-replace
|
| 4 |
+
|
| 5 |
+
_cargo() {
|
| 6 |
+
local curcontext="$curcontext" ret=1
|
| 7 |
+
local -a command_scope_spec common jobs parallel features manifest msgfmt triple target registry
|
| 8 |
+
local -a state line state_descr # These are set by _arguments
|
| 9 |
+
typeset -A opt_args
|
| 10 |
+
|
| 11 |
+
common=(
|
| 12 |
+
'(-q --quiet)*'{-v,--verbose}'[use verbose output]'
|
| 13 |
+
'(-q --quiet -v --verbose)'{-q,--quiet}'[no output printed to stdout]'
|
| 14 |
+
'-Z+[pass unstable (nightly-only) flags to cargo]: :_cargo_unstable_flags'
|
| 15 |
+
'--offline[run without accessing the network]'
|
| 16 |
+
'--frozen[require that Cargo.lock and cache are up-to-date]'
|
| 17 |
+
'--locked[require that Cargo.lock is up-to-date]'
|
| 18 |
+
'--color=[specify colorization option]:coloring:(auto always never)'
|
| 19 |
+
'(- 1 *)'{-h,--help}'[show help message]'
|
| 20 |
+
)
|
| 21 |
+
|
| 22 |
+
# leading items in parentheses are an exclusion list for the arguments following that arg
|
| 23 |
+
# See: http://zsh.sourceforge.net/Doc/Release/Completion-System.html#Completion-Functions
|
| 24 |
+
# - => exclude all other options
|
| 25 |
+
# 1 => exclude positional arg 1
|
| 26 |
+
# * => exclude all other args
|
| 27 |
+
# +blah => exclude +blah
|
| 28 |
+
_arguments -s -S -C $common \
|
| 29 |
+
'(- 1 *)--list[list installed commands]' \
|
| 30 |
+
'(- 1 *)--explain=[provide a detailed explanation of an error message]:error code' \
|
| 31 |
+
'(- 1 *)'{-V,--version}'[show version information]' \
|
| 32 |
+
'(+beta +nightly)+stable[use the stable toolchain]' \
|
| 33 |
+
'(+stable +nightly)+beta[use the beta toolchain]' \
|
| 34 |
+
'(+stable +beta)+nightly[use the nightly toolchain]' \
|
| 35 |
+
'1: :_cargo_cmds' \
|
| 36 |
+
'*:: :->args'
|
| 37 |
+
|
| 38 |
+
# These flags are mutually exclusive specifiers for the scope of a command; as
|
| 39 |
+
# they are used in multiple places without change, they are expanded into the
|
| 40 |
+
# appropriate command's `_arguments` where appropriate.
|
| 41 |
+
command_scope_spec=(
|
| 42 |
+
'(--bin --example --test --lib)--bench=[specify benchmark name]: :_cargo_benchmark_names'
|
| 43 |
+
'(--bench --bin --test --lib)--example=[specify example name]:example name:_cargo_example_names'
|
| 44 |
+
'(--bench --example --test --lib)--bin=[specify binary name]:binary name'
|
| 45 |
+
'(--bench --bin --example --test)--lib=[specify library name]:library name'
|
| 46 |
+
'(--bench --bin --example --lib)--test=[specify test name]:test name'
|
| 47 |
+
)
|
| 48 |
+
|
| 49 |
+
jobs=(
|
| 50 |
+
'(-j --jobs)'{-j+,--jobs=}'[specify number of parallel jobs]:jobs [# of CPUs]'
|
| 51 |
+
)
|
| 52 |
+
|
| 53 |
+
parallel=(
|
| 54 |
+
"${jobs[@]}"
|
| 55 |
+
'--keep-going[do not abort build on first build error]'
|
| 56 |
+
)
|
| 57 |
+
|
| 58 |
+
features=(
|
| 59 |
+
'(--all-features)'{-F+,--features=}'[specify features to activate]:feature'
|
| 60 |
+
'(--features -F)--all-features[activate all available features]'
|
| 61 |
+
"--no-default-features[don't build the default features]"
|
| 62 |
+
)
|
| 63 |
+
|
| 64 |
+
msgfmt='--message-format=[specify error format]:error format [human]:(human json short)'
|
| 65 |
+
triple='--target=[specify target triple]:target triple:_cargo_target_triple'
|
| 66 |
+
target='--target-dir=[specify directory for all generated artifacts]:directory:_directories'
|
| 67 |
+
manifest='--manifest-path=[specify path to manifest]:path:_directories'
|
| 68 |
+
registry='--registry=[specify registry to use]:registry'
|
| 69 |
+
|
| 70 |
+
case $state in
|
| 71 |
+
args)
|
| 72 |
+
curcontext="${curcontext%:*}-${words[1]}:"
|
| 73 |
+
case ${words[1]} in
|
| 74 |
+
add)
|
| 75 |
+
_arguments -s -A "^--" $common $manifest $registry \
|
| 76 |
+
{-F+,--features=}'[specify features to activate]:feature' \
|
| 77 |
+
"--default-features[enable the default features]" \
|
| 78 |
+
"--no-default-features[don't enable the default features]" \
|
| 79 |
+
"--optional[mark the dependency as optional]" \
|
| 80 |
+
"--no-optional[mark the dependency as required]" \
|
| 81 |
+
"--dev[add as a dev dependency]" \
|
| 82 |
+
"--build[add as a build dependency]" \
|
| 83 |
+
"--target=[add as a dependency to the given target platform]" \
|
| 84 |
+
"--rename=[rename the dependency]" \
|
| 85 |
+
"--dry-run[don't actually write the manifest]" \
|
| 86 |
+
'--branch=[branch to use when adding from git]:branch' \
|
| 87 |
+
'--git=[specify URL from which to add the crate]:url:_urls' \
|
| 88 |
+
'--path=[local filesystem path to crate to add]: :_directories' \
|
| 89 |
+
'--rev=[specific commit to use when adding from git]:commit' \
|
| 90 |
+
'--tag=[tag to use when adding from git]:tag' \
|
| 91 |
+
'--ignore-rust-version[Ignore rust-version specification in packages]' \
|
| 92 |
+
'1: :_guard "^-*" "crate name"' \
|
| 93 |
+
'*:args:_default'
|
| 94 |
+
;;
|
| 95 |
+
bench)
|
| 96 |
+
_arguments -s -A "^--" $common $jobs $features $msgfmt $triple $target $manifest \
|
| 97 |
+
"${command_scope_spec[@]}" \
|
| 98 |
+
'--all-targets[benchmark all targets]' \
|
| 99 |
+
"--no-run[compile but don't run]" \
|
| 100 |
+
'(-p --package)'{-p+,--package=}'[specify package to run benchmarks for]:package:_cargo_package_names' \
|
| 101 |
+
'--exclude=[exclude packages from the benchmark]:spec' \
|
| 102 |
+
'--no-fail-fast[run all benchmarks regardless of failure]' \
|
| 103 |
+
'--ignore-rust-version[Ignore rust-version specification in packages]' \
|
| 104 |
+
'1: :_guard "^-*" "bench name"' \
|
| 105 |
+
'*:args:_default'
|
| 106 |
+
;;
|
| 107 |
+
|
| 108 |
+
build | b)
|
| 109 |
+
_arguments -s -S $common $parallel $features $msgfmt $triple $target $manifest \
|
| 110 |
+
'--all-targets[equivalent to specifying --lib --bins --tests --benches --examples]' \
|
| 111 |
+
"${command_scope_spec[@]}" \
|
| 112 |
+
'(-p --package)'{-p+,--package=}'[specify package to build]:package:_cargo_package_names' \
|
| 113 |
+
'--release[build in release mode]' \
|
| 114 |
+
'--ignore-rust-version[Ignore rust-version specification in packages]'
|
| 115 |
+
;;
|
| 116 |
+
|
| 117 |
+
check | c)
|
| 118 |
+
_arguments -s -S $common $parallel $features $msgfmt $triple $target $manifest \
|
| 119 |
+
'--all-targets[equivalent to specifying --lib --bins --tests --benches --examples]' \
|
| 120 |
+
"${command_scope_spec[@]}" \
|
| 121 |
+
'(-p --package)'{-p+,--package=}'[specify package to check]:package:_cargo_package_names' \
|
| 122 |
+
'--release[check in release mode]' \
|
| 123 |
+
'--ignore-rust-version[Ignore rust-version specification in packages]'
|
| 124 |
+
;;
|
| 125 |
+
|
| 126 |
+
clean)
|
| 127 |
+
_arguments -s -S $common $triple $target $manifest \
|
| 128 |
+
'(-p --package)'{-p+,--package=}'[specify package to clean]:package:_cargo_package_names' \
|
| 129 |
+
'--release[clean release artifacts]' \
|
| 130 |
+
'--doc[clean just the documentation directory]'
|
| 131 |
+
;;
|
| 132 |
+
|
| 133 |
+
doc | d)
|
| 134 |
+
_arguments -s -S $common $parallel $features $msgfmt $triple $target $manifest \
|
| 135 |
+
'--no-deps[do not build docs for dependencies]' \
|
| 136 |
+
'--document-private-items[include non-public items in the documentation]' \
|
| 137 |
+
'--open[open docs in browser after the build]' \
|
| 138 |
+
'(-p --package)'{-p+,--package=}'[specify package to document]:package:_cargo_package_names' \
|
| 139 |
+
'--release[build artifacts in release mode, with optimizations]' \
|
| 140 |
+
'--ignore-rust-version[Ignore rust-version specification in packages]'
|
| 141 |
+
;;
|
| 142 |
+
|
| 143 |
+
fetch)
|
| 144 |
+
_arguments -s -S $common $triple $manifest
|
| 145 |
+
;;
|
| 146 |
+
|
| 147 |
+
fix)
|
| 148 |
+
_arguments -s -S $common $parallel $features $msgfmt $triple $target $manifest \
|
| 149 |
+
"${command_scope_spec[@]}" \
|
| 150 |
+
'--broken-code[fix code even if it already has compiler errors]' \
|
| 151 |
+
'--edition[fix in preparation for the next edition]' \
|
| 152 |
+
'--edition-idioms[fix warnings to migrate to the idioms of an edition]' \
|
| 153 |
+
'--allow-no-vcs[fix code even if a VCS was not detected]' \
|
| 154 |
+
'--allow-dirty[fix code even if the working directory is dirty]' \
|
| 155 |
+
'--allow-staged[fix code even if the working directory has staged changes]' \
|
| 156 |
+
'--ignore-rust-version[Ignore rust-version specification in packages]'
|
| 157 |
+
;;
|
| 158 |
+
|
| 159 |
+
generate-lockfile)
|
| 160 |
+
_arguments -s -S $common $manifest
|
| 161 |
+
;;
|
| 162 |
+
|
| 163 |
+
help)
|
| 164 |
+
_cargo_cmds
|
| 165 |
+
;;
|
| 166 |
+
info)
|
| 167 |
+
_arguments -s -A "^--" $common $registry \
|
| 168 |
+
'--index=[specify registry index]:index' \
|
| 169 |
+
'*: :_guard "^-*" "crate"'
|
| 170 |
+
;;
|
| 171 |
+
|
| 172 |
+
init)
|
| 173 |
+
_arguments -s -S $common $registry \
|
| 174 |
+
'--lib[use library template]' \
|
| 175 |
+
'--edition=[specify edition to set for the crate generated]:edition:(2015 2018 2021)' \
|
| 176 |
+
'--vcs=[initialize a new repo with a given VCS]:vcs:(git hg pijul fossil none)' \
|
| 177 |
+
'--name=[set the resulting package name]:name' \
|
| 178 |
+
'1:path:_directories'
|
| 179 |
+
;;
|
| 180 |
+
|
| 181 |
+
install)
|
| 182 |
+
_arguments -s -S $common $parallel $features $triple $registry \
|
| 183 |
+
'(-f --force)'{-f,--force}'[force overwriting of existing crates or binaries]' \
|
| 184 |
+
'--bin=[only install the specified binary]:binary' \
|
| 185 |
+
'--branch=[branch to use when installing from git]:branch' \
|
| 186 |
+
'--debug[Build in debug mode (with the "dev" profile) instead of release mode]' \
|
| 187 |
+
'--example=[install the specified example instead of binaries]:example:_cargo_example_names' \
|
| 188 |
+
'--git=[specify URL from which to install the crate]:url:_urls' \
|
| 189 |
+
'--path=[local filesystem path to crate to install]: :_directories' \
|
| 190 |
+
'--rev=[specific commit to use when installing from git]:commit' \
|
| 191 |
+
'--root=[directory to install packages into]: :_directories' \
|
| 192 |
+
'--tag=[tag to use when installing from git]:tag' \
|
| 193 |
+
'--version=[version to install from crates.io]:version' \
|
| 194 |
+
'--list[list all installed packages and their versions]' \
|
| 195 |
+
'--ignore-rust-version[Ignore rust-version specification in packages]' \
|
| 196 |
+
'*: :_guard "^-*" "crate"'
|
| 197 |
+
;;
|
| 198 |
+
|
| 199 |
+
locate-project)
|
| 200 |
+
_arguments -s -S $common $manifest \
|
| 201 |
+
'--message-format=[specify output representation]:output representation [json]:(json plain)' \
|
| 202 |
+
'--workspace[locate Cargo.toml of the workspace root]'
|
| 203 |
+
;;
|
| 204 |
+
|
| 205 |
+
login)
|
| 206 |
+
_arguments -s -S $common $registry \
|
| 207 |
+
'*: :_guard "^-*" "token"'
|
| 208 |
+
;;
|
| 209 |
+
|
| 210 |
+
metadata)
|
| 211 |
+
_arguments -s -S $common $features $manifest \
|
| 212 |
+
"--no-deps[output information only about the root package and don't fetch dependencies]" \
|
| 213 |
+
'--format-version=[specify format version]:version [1]:(1)'
|
| 214 |
+
;;
|
| 215 |
+
|
| 216 |
+
new)
|
| 217 |
+
_arguments -s -S $common $registry \
|
| 218 |
+
'--lib[use library template]' \
|
| 219 |
+
'--vcs:initialize a new repo with a given VCS:(git hg none)' \
|
| 220 |
+
'--name=[set the resulting package name]'
|
| 221 |
+
;;
|
| 222 |
+
|
| 223 |
+
owner)
|
| 224 |
+
_arguments -s -S $common $registry \
|
| 225 |
+
'(-a --add)'{-a,--add}'[specify name of a user or team to invite as an owner]:name' \
|
| 226 |
+
'--index=[specify registry index]:index' \
|
| 227 |
+
'(-l --list)'{-l,--list}'[list owners of a crate]' \
|
| 228 |
+
'(-r --remove)'{-r,--remove}'[specify name of a user or team to remove as an owner]:name' \
|
| 229 |
+
'--token=[specify API token to use when authenticating]:token' \
|
| 230 |
+
'*: :_guard "^-*" "crate"'
|
| 231 |
+
;;
|
| 232 |
+
|
| 233 |
+
package)
|
| 234 |
+
_arguments -s -S $common $parallel $features $triple $target $manifest $registry \
|
| 235 |
+
'--index=[specify registry index]:index' \
|
| 236 |
+
'(-l --list)'{-l,--list}'[print files included in a package without making one]' \
|
| 237 |
+
'--no-metadata[ignore warnings about a lack of human-usable metadata]' \
|
| 238 |
+
'--allow-dirty[allow dirty working directories to be packaged]' \
|
| 239 |
+
"--no-verify[don't build to verify contents]"
|
| 240 |
+
;;
|
| 241 |
+
|
| 242 |
+
pkgid)
|
| 243 |
+
_arguments -s -S $common $manifest \
|
| 244 |
+
'(-p --package)'{-p+,--package=}'[specify package to get ID specifier for]:package:_cargo_package_names' \
|
| 245 |
+
'*: :_guard "^-*" "spec"'
|
| 246 |
+
;;
|
| 247 |
+
|
| 248 |
+
publish)
|
| 249 |
+
_arguments -s -S $common $parallel $features $triple $target $manifest $registry \
|
| 250 |
+
'--index=[specify registry index]:index' \
|
| 251 |
+
'--allow-dirty[allow dirty working directories to be packaged]' \
|
| 252 |
+
"--no-verify[don't verify the contents by building them]" \
|
| 253 |
+
'--dry-run[perform all checks without uploading]'
|
| 254 |
+
;;
|
| 255 |
+
|
| 256 |
+
remove | rm)
|
| 257 |
+
_arguments -s -A "^--" $common $manifest \
|
| 258 |
+
"--dev[remove as a dev dependency]" \
|
| 259 |
+
"--build[remove as a build dependency]" \
|
| 260 |
+
"--target=[remove as a dependency from the given target platform]" \
|
| 261 |
+
"--dry-run[don't actually write the manifest]" \
|
| 262 |
+
'(-p --package)'{-p+,--package=}'[package to remove from]:package:_cargo_package_names' \
|
| 263 |
+
'1: :_guard "^-*" "crate name"' \
|
| 264 |
+
'*:args:_default'
|
| 265 |
+
;;
|
| 266 |
+
|
| 267 |
+
run | r)
|
| 268 |
+
_arguments -s -S $common $parallel $features $msgfmt $triple $target $manifest \
|
| 269 |
+
'--example=[name of the bin target]:name:_cargo_example_names' \
|
| 270 |
+
'--bin=[name of the bin target]:name' \
|
| 271 |
+
'(-p --package)'{-p+,--package=}'[specify package with the target to run]:package:_cargo_package_names' \
|
| 272 |
+
'--release[build in release mode]' \
|
| 273 |
+
'--ignore-rust-version[Ignore rust-version specification in packages]' \
|
| 274 |
+
'*: :_default'
|
| 275 |
+
;;
|
| 276 |
+
|
| 277 |
+
rustc)
|
| 278 |
+
_arguments -s -S $common $parallel $features $msgfmt $triple $target $manifest \
|
| 279 |
+
'(-p --package)'{-p+,--package=}'[specify package to build]:package:_cargo_package_names' \
|
| 280 |
+
'--profile=[specify profile to build the selected target for]:profile' \
|
| 281 |
+
'--release[build artifacts in release mode, with optimizations]' \
|
| 282 |
+
"${command_scope_spec[@]}" \
|
| 283 |
+
'--ignore-rust-version[Ignore rust-version specification in packages]' \
|
| 284 |
+
'*: : _dispatch rustc rustc -default-'
|
| 285 |
+
;;
|
| 286 |
+
|
| 287 |
+
rustdoc)
|
| 288 |
+
_arguments -s -S $common $parallel $features $msgfmt $triple $target $manifest \
|
| 289 |
+
'--document-private-items[include non-public items in the documentation]' \
|
| 290 |
+
'--open[open the docs in a browser after the operation]' \
|
| 291 |
+
'(-p --package)'{-p+,--package=}'[specify package to document]:package:_cargo_package_names' \
|
| 292 |
+
'--release[build artifacts in release mode, with optimizations]' \
|
| 293 |
+
"${command_scope_spec[@]}" \
|
| 294 |
+
'--ignore-rust-version[Ignore rust-version specification in packages]' \
|
| 295 |
+
'*: : _dispatch rustdoc rustdoc -default-'
|
| 296 |
+
;;
|
| 297 |
+
|
| 298 |
+
search)
|
| 299 |
+
_arguments -s -S $common $registry \
|
| 300 |
+
'--index=[specify registry index]:index' \
|
| 301 |
+
'--limit=[limit the number of results]:results [10]' \
|
| 302 |
+
'*: :_guard "^-*" "query"'
|
| 303 |
+
;;
|
| 304 |
+
|
| 305 |
+
test | t)
|
| 306 |
+
_arguments -s -S $common $jobs $features $msgfmt $triple $target $manifest \
|
| 307 |
+
'--test=[test name]: :_cargo_test_names' \
|
| 308 |
+
'--no-fail-fast[run all tests regardless of failure]' \
|
| 309 |
+
'--no-run[compile but do not run]' \
|
| 310 |
+
'(-p --package)'{-p+,--package=}'[package to run tests for]:package:_cargo_package_names' \
|
| 311 |
+
'--all[test all packages in the workspace]' \
|
| 312 |
+
'--release[build artifacts in release mode, with optimizations]' \
|
| 313 |
+
'1: :_cargo_test_names' \
|
| 314 |
+
'(--doc --bin --example --test --bench)--lib[only test library]' \
|
| 315 |
+
'(--lib --bin --example --test --bench)--doc[only test documentation]' \
|
| 316 |
+
'(--lib --doc --example --test --bench)--bin=[binary name]' \
|
| 317 |
+
'(--lib --doc --bin --test --bench)--example=[example name]:_cargo_example_names' \
|
| 318 |
+
'(--lib --doc --bin --example --bench)--test=[test name]' \
|
| 319 |
+
'(--lib --doc --bin --example --test)--bench=[benchmark name]' \
|
| 320 |
+
'--ignore-rust-version[Ignore rust-version specification in packages]' \
|
| 321 |
+
'*: :_default'
|
| 322 |
+
;;
|
| 323 |
+
|
| 324 |
+
tree)
|
| 325 |
+
_arguments -s -S $common $features $triple $manifest \
|
| 326 |
+
'(-p --package)'{-p+,--package=}'[package to use as the root]:package:_cargo_package_names' \
|
| 327 |
+
'(-i --invert)'{-i+,--invert=}'[invert the tree for the given package]:package:_cargo_package_names' \
|
| 328 |
+
'--prefix=[line prefix]:prefix:(depth indent none)' \
|
| 329 |
+
'--no-dedupe[repeat shared dependencies]' \
|
| 330 |
+
'(-d --duplicates)'{-d,--duplicates}'[packages with multiple versions]' \
|
| 331 |
+
'--charset=[utf8 or ascii]:charset:(utf8 ascii)' \
|
| 332 |
+
'(-f --format)'{-f,--format=}'[format string]:format' \
|
| 333 |
+
'(-e --edges)'{-e,--edges=}'[edge kinds]:kind:(features normal build dev all no-dev no-build no-normal)' \
|
| 334 |
+
;;
|
| 335 |
+
|
| 336 |
+
uninstall)
|
| 337 |
+
_arguments -s -S $common \
|
| 338 |
+
'(-p --package)'{-p+,--package=}'[specify package to uninstall]:package:_cargo_package_names' \
|
| 339 |
+
'--bin=[only uninstall the specified binary]:name' \
|
| 340 |
+
'--root=[directory to uninstall packages from]: :_files -/' \
|
| 341 |
+
'*:crate:_cargo_installed_crates -F line'
|
| 342 |
+
;;
|
| 343 |
+
|
| 344 |
+
update)
|
| 345 |
+
_arguments -s -S $common $manifest \
|
| 346 |
+
'--aggressive=[force dependency update]' \
|
| 347 |
+
'--recursive=[force dependency update]' \
|
| 348 |
+
"--dry-run[don't actually write the lockfile]" \
|
| 349 |
+
'(-p --package)'{-p+,--package=}'[specify package to update]:package:_cargo_package_names' \
|
| 350 |
+
'--precise=[update single dependency to precise release]:release' \
|
| 351 |
+
'*:package:_cargo_package_names'
|
| 352 |
+
;;
|
| 353 |
+
|
| 354 |
+
version)
|
| 355 |
+
_arguments -s -S $common
|
| 356 |
+
;;
|
| 357 |
+
|
| 358 |
+
yank)
|
| 359 |
+
_arguments -s -S $common $registry \
|
| 360 |
+
'--version=[specify yank version]:version' \
|
| 361 |
+
'--undo[undo a yank, putting a version back into the index]' \
|
| 362 |
+
'--index=[specify registry index to yank from]:registry index' \
|
| 363 |
+
'--token=[specify API token to use when authenticating]:token' \
|
| 364 |
+
'*: :_guard "^-*" "crate"'
|
| 365 |
+
;;
|
| 366 |
+
*)
|
| 367 |
+
# allow plugins to define their own functions
|
| 368 |
+
if ! _call_function ret _cargo-${words[1]}; then
|
| 369 |
+
# fallback on default completion for unknown commands
|
| 370 |
+
_default && ret=0
|
| 371 |
+
fi
|
| 372 |
+
(( ! ret ))
|
| 373 |
+
;;
|
| 374 |
+
esac
|
| 375 |
+
;;
|
| 376 |
+
esac
|
| 377 |
+
}
|
| 378 |
+
|
| 379 |
+
_cargo_unstable_flags() {
|
| 380 |
+
local flags
|
| 381 |
+
flags=( help ${${${(M)${(f)"$(_call_program flags cargo -Z help)"}:#*--*}/ #-- #/:}##*-Z } )
|
| 382 |
+
_describe -t flags 'unstable flag' flags
|
| 383 |
+
}
|
| 384 |
+
|
| 385 |
+
_cargo_installed_crates() {
|
| 386 |
+
local expl
|
| 387 |
+
_description crates expl 'crate'
|
| 388 |
+
compadd "$@" "$expl[@]" - ${${${(f)"$(cargo install --list)"}:# *}%% *}
|
| 389 |
+
}
|
| 390 |
+
|
| 391 |
+
_cargo_cmds() {
|
| 392 |
+
local -a commands
|
| 393 |
+
# This uses Parameter Expansion Flags, which are a built-in Zsh feature.
|
| 394 |
+
# See more: http://zsh.sourceforge.net/Doc/Release/Expansion.html#Parameter-Expansion-Flags
|
| 395 |
+
# and http://zsh.sourceforge.net/Doc/Release/Expansion.html#Parameter-Expansion
|
| 396 |
+
#
|
| 397 |
+
# # How this work?
|
| 398 |
+
#
|
| 399 |
+
# First it splits the result of `cargo --list` at newline, then it removes the first line.
|
| 400 |
+
# Then it removes indentation (4 whitespaces) before each items. (Note the x## pattern [1]).
|
| 401 |
+
# Then it replaces those spaces between item and description with a `:`
|
| 402 |
+
#
|
| 403 |
+
# [1]: https://github.com/zsh-users/zsh-completions/blob/master/zsh-completions-howto.org#patterns
|
| 404 |
+
commands=( ${${${(M)"${(f)$(_call_program commands cargo --list)}":# *}/ ##/}/ ##/:} )
|
| 405 |
+
_describe -t commands 'command' commands
|
| 406 |
+
}
|
| 407 |
+
|
| 408 |
+
_cargo_target_triple() {
|
| 409 |
+
local -a result
|
| 410 |
+
|
| 411 |
+
if (( $+commands[rustup] )); then
|
| 412 |
+
result=( ${(f)"$(rustup target list --installed)"} )
|
| 413 |
+
else
|
| 414 |
+
result=( ${(f)"$(rustc --print target-list)"} )
|
| 415 |
+
fi
|
| 416 |
+
|
| 417 |
+
_describe 'target triple' result
|
| 418 |
+
}
|
| 419 |
+
|
| 420 |
+
#FIXME: Disabled until fixed
|
| 421 |
+
#gets package names from the manifest file
|
| 422 |
+
_cargo_package_names() {
|
| 423 |
+
_message -e packages package
|
| 424 |
+
}
|
| 425 |
+
|
| 426 |
+
# Extracts the values of "name" from the array given in $1 and shows them as
|
| 427 |
+
# command line options for completion
|
| 428 |
+
_cargo_names_from_array() {
|
| 429 |
+
local manifest=$(cargo locate-project --message-format plain)
|
| 430 |
+
if [[ -z $manifest ]]; then
|
| 431 |
+
return 0
|
| 432 |
+
fi
|
| 433 |
+
|
| 434 |
+
local last_line
|
| 435 |
+
local -a names;
|
| 436 |
+
local in_block=false
|
| 437 |
+
local block_name=$1
|
| 438 |
+
names=()
|
| 439 |
+
while read -r line; do
|
| 440 |
+
if [[ $last_line == "[[$block_name]]" ]]; then
|
| 441 |
+
in_block=true
|
| 442 |
+
else
|
| 443 |
+
if [[ $last_line =~ '\s*\[\[.*' ]]; then
|
| 444 |
+
in_block=false
|
| 445 |
+
fi
|
| 446 |
+
fi
|
| 447 |
+
|
| 448 |
+
if [[ $in_block == true ]]; then
|
| 449 |
+
if [[ $line =~ '\s*name\s*=' ]]; then
|
| 450 |
+
regexp-replace line '^\s*name\s*=\s*|"' ''
|
| 451 |
+
names+=( "$line" )
|
| 452 |
+
fi
|
| 453 |
+
fi
|
| 454 |
+
|
| 455 |
+
last_line=$line
|
| 456 |
+
done < "$manifest"
|
| 457 |
+
_describe "$block_name" names
|
| 458 |
+
|
| 459 |
+
}
|
| 460 |
+
|
| 461 |
+
#Gets the test names from the manifest file
|
| 462 |
+
_cargo_test_names() {
|
| 463 |
+
_cargo_names_from_array "test"
|
| 464 |
+
}
|
| 465 |
+
|
| 466 |
+
#Gets the bench names from the manifest file
|
| 467 |
+
_cargo_benchmark_names() {
|
| 468 |
+
_cargo_names_from_array "bench"
|
| 469 |
+
}
|
| 470 |
+
|
| 471 |
+
_cargo_example_names() {
|
| 472 |
+
if [[ -d examples ]]; then
|
| 473 |
+
local -a files=(${(@f)$(echo examples/*.rs(:t:r))})
|
| 474 |
+
_values 'example' "${files[@]}"
|
| 475 |
+
fi
|
| 476 |
+
}
|
| 477 |
+
|
| 478 |
+
_cargo
|
rust/.rustup/update-hashes/stable-x86_64-pc-windows-msvc
ADDED
|
@@ -0,0 +1 @@
|
|
|
|
|
|
|
| 1 |
+
821ff14e4c4a1cbe1e89
|
sqlite_gui/printsupport/windowsprintersupport.dll
ADDED
|
Binary file (55.3 kB). View file
|
|
|
sqlite_gui/translations/qt_ar.qm
ADDED
|
Binary file (130 Bytes). View file
|
|
|
sqlite_gui/translations/qt_cs.qm
ADDED
|
Binary file (157 Bytes). View file
|
|
|
sqlite_gui/translations/qt_de.qm
ADDED
|
Binary file (153 Bytes). View file
|
|
|
sqlite_gui/translations/qt_en.qm
ADDED
|
@@ -0,0 +1 @@
|
|
|
|
|
|
|
| 1 |
+
<�d��!�`���
|
sqlite_gui/translations/qt_es.qm
ADDED
|
Binary file (153 Bytes). View file
|
|
|
sqlite_gui/translations/qt_fr.qm
ADDED
|
Binary file (153 Bytes). View file
|
|
|
sqlite_gui/translations/qt_it.qm
ADDED
|
Binary file (153 Bytes). View file
|
|
|
sqlite_gui/translations/qt_ja.qm
ADDED
|
Binary file (146 Bytes). View file
|
|
|
sqlite_gui/translations/qt_ko.qm
ADDED
|
Binary file (146 Bytes). View file
|
|
|
sqlite_gui/translations/qt_pl.qm
ADDED
|
Binary file (161 Bytes). View file
|
|
|
sqlite_gui/translations/qt_pt.qm
ADDED
|
Binary file (70.3 kB). View file
|
|
|
sqlite_gui/translations/qt_ru.qm
ADDED
|
Binary file (164 Bytes). View file
|
|
|
sqlite_gui/translations/qt_uk.qm
ADDED
|
Binary file (164 Bytes). View file
|
|
|
sqlite_gui/translations/qt_zh_TW.qm
ADDED
|
Binary file (141 Bytes). View file
|
|
|
sqlite_gui/translations/qtbase_en.qm
ADDED
|
@@ -0,0 +1 @@
|
|
|
|
|
|
|
| 1 |
+
<�d��!�`���
|
sqlite_gui/translations/qtmultimedia_ar.qm
ADDED
|
Binary file (11.5 kB). View file
|
|
|
sqlite_gui/translations/qtmultimedia_cs.qm
ADDED
|
Binary file (15.9 kB). View file
|
|
|
sqlite_gui/translations/qtmultimedia_de.qm
ADDED
|
Binary file (15 kB). View file
|
|
|
sqlite_gui/translations/qtmultimedia_en.qm
ADDED
|
@@ -0,0 +1 @@
|
|
|
|
|
|
|
| 1 |
+
<�d��!�`���
|