diff --git a/rust/.rustup/settings.toml b/rust/.rustup/settings.toml new file mode 100644 index 0000000000000000000000000000000000000000..b3dbdae13aadeac997ae375c6d7032e01c0bfc2e --- /dev/null +++ b/rust/.rustup/settings.toml @@ -0,0 +1,5 @@ +version = "12" +default_toolchain = "stable-x86_64-pc-windows-msvc" +profile = "minimal" + +[overrides] diff --git a/rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/bin/rust-gdb b/rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/bin/rust-gdb new file mode 100644 index 0000000000000000000000000000000000000000..9abed30ea6f736f420eb71fab86e18f375ebb609 --- /dev/null +++ b/rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/bin/rust-gdb @@ -0,0 +1,28 @@ +#!/bin/sh +# Exit if anything fails +set -e + +# Prefer rustc in the same directory as this script +DIR="$(dirname "$0")" +if [ -x "$DIR/rustc" ]; then + RUSTC="$DIR/rustc" +else + RUSTC="rustc" +fi + +# Find out where the pretty printer Python module is +RUSTC_SYSROOT="$("$RUSTC" --print=sysroot)" +GDB_PYTHON_MODULE_DIRECTORY="$RUSTC_SYSROOT/lib/rustlib/etc" +# Get the commit hash for path remapping +RUSTC_COMMIT_HASH="$("$RUSTC" -vV | sed -n 's/commit-hash: \([a-zA-Z0-9_]*\)/\1/p')" + +# Run GDB with the additional arguments that load the pretty printers +# Set the environment variable `RUST_GDB` to overwrite the call to a +# different/specific command (defaults to `gdb`). +RUST_GDB="${RUST_GDB:-gdb}" +PYTHONPATH="$PYTHONPATH:$GDB_PYTHON_MODULE_DIRECTORY" exec ${RUST_GDB} \ + --directory="$GDB_PYTHON_MODULE_DIRECTORY" \ + -iex "add-auto-load-safe-path $GDB_PYTHON_MODULE_DIRECTORY" \ + -iex "set substitute-path /rustc/$RUSTC_COMMIT_HASH $RUSTC_SYSROOT/lib/rustlib/src/rust" \ + "$@" + diff --git a/rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/bin/rust-gdbgui b/rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/bin/rust-gdbgui new file mode 100644 index 0000000000000000000000000000000000000000..471810cbb18f1681d88e9fe04f5876fb20d0ef9b --- /dev/null +++ b/rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/bin/rust-gdbgui @@ -0,0 +1,67 @@ +#!/bin/sh + +# Exit if anything fails +set -e + +if [ $# -eq 0 ] || [ "$1" = "-h" ] || [ "$1" = "-help" ] || [ "$1" = "--help" ]; then + echo " +rust-gdbgui +=========== +gdbgui - https://gdbgui.com - is a graphical front-end to GDB +that runs in a browser. This script invokes gdbgui with the Rust +pretty printers loaded. + +Simple usage : rust-gdbgui target/debug/myprog +With arguments: rust-gdbgui 'target/debug/myprog arg1 arg2...' + (note the quotes) + + +Hints +===== +gdbgui won't be able to find the rust 'main' method automatically, so +in its options make sure to disable the 'Add breakpoint to main after +loading executable' setting to avoid a 'File not found: main' warning +on startup. + +Instead, type 'main' into gdbgui's file browser and you should get +auto-completion on the filename. Just pick 'main.rs', add a breakpoint +by clicking in the line number gutter, and type 'r' or hit the Restart +icon to start your program running. +" + exit 0 +fi + +# Prefer rustc in the same directory as this script +DIR="$(dirname "$0")" +if [ -x "$DIR/rustc" ]; then + RUSTC="$DIR/rustc" +else + RUSTC="rustc" +fi + +# Find out where the pretty printer Python module is +RUSTC_SYSROOT="$("$RUSTC" --print=sysroot)" +GDB_PYTHON_MODULE_DIRECTORY="$RUSTC_SYSROOT/lib/rustlib/etc" +# Get the commit hash for path remapping +RUSTC_COMMIT_HASH="$("$RUSTC" -vV | sed -n 's/commit-hash: \([a-zA-Z0-9_]*\)/\1/p')" + +# Set the environment variable `RUST_GDB` to overwrite the call to a +# different/specific command (defaults to `gdb`). +RUST_GDB="${RUST_GDB:-gdb}" + +# Set the environment variable `RUST_GDBGUI` to overwrite the call to a +# different/specific command (defaults to `gdbgui`). +RUST_GDBGUI="${RUST_GDBGUI:-gdbgui}" + +# These arguments get passed through to GDB and make it load the +# Rust pretty printers. +GDB_ARGS="--directory=\"$GDB_PYTHON_MODULE_DIRECTORY\" \ + -iex \"add-auto-load-safe-path $GDB_PYTHON_MODULE_DIRECTORY\" \ + -iex \"set substitute-path /rustc/$RUSTC_COMMIT_HASH $RUSTC_SYSROOT/lib/rustlib/src/rust\"" + +# Finally we execute gdbgui. +PYTHONPATH="$PYTHONPATH:$GDB_PYTHON_MODULE_DIRECTORY" \ + exec ${RUST_GDBGUI} \ + --gdb-cmd "${RUST_GDB} ${GDB_ARGS}" \ + "${@}" + diff --git a/rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/bin/rust-lldb b/rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/bin/rust-lldb new file mode 100644 index 0000000000000000000000000000000000000000..f8f31903060c3551485cc224e3bade22751fa01a --- /dev/null +++ b/rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/bin/rust-lldb @@ -0,0 +1,37 @@ +#!/bin/sh + +# Exit if anything fails +set -e + +# Find the host triple so we can find lldb in rustlib. +host=$(rustc --print host-tuple) + +# Find out where to look for the pretty printer Python module +RUSTC_SYSROOT=$(rustc --print sysroot) +RUST_LLDB="$RUSTC_SYSROOT/lib/rustlib/$host/bin/lldb" + +lldb=lldb +if [ -f "$RUST_LLDB" ]; then + lldb="$RUST_LLDB" +else + if ! command -v "$lldb" > /dev/null; then + echo "$lldb not found! Please install it." >&2 + exit 1 + else + LLDB_VERSION=$("$lldb" --version | cut -d ' ' -f3) + + if [ "$LLDB_VERSION" = "3.5.0" ]; then + cat << EOF >&2 +*** +WARNING: This version of LLDB has known issues with Rust and cannot display the contents of local variables! +*** +EOF + fi + fi +fi + +script_import="command script import \"$RUSTC_SYSROOT/lib/rustlib/etc/lldb_lookup.py\"" +commands_file="$RUSTC_SYSROOT/lib/rustlib/etc/lldb_commands" + +# Call LLDB with the commands added to the argument list +exec "$lldb" --one-line-before-file "$script_import" --source-before-file "$commands_file" "$@" diff --git a/rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/bin/rust-windbg.cmd b/rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/bin/rust-windbg.cmd new file mode 100644 index 0000000000000000000000000000000000000000..2deb2a03a397646a84dc928f1c35a15a91b5e476 --- /dev/null +++ b/rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/bin/rust-windbg.cmd @@ -0,0 +1,8 @@ +@echo off +setlocal + +for /f "delims=" %%i in ('rustc --print=sysroot') do set rustc_sysroot=%%i + +set rust_etc=%rustc_sysroot%\lib\rustlib\etc + +windbg -c ".nvload %rust_etc%\intrinsic.natvis; .nvload %rust_etc%\liballoc.natvis; .nvload %rust_etc%\libcore.natvis;" %* diff --git a/rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/etc/target-spec-json-schema.json b/rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/etc/target-spec-json-schema.json new file mode 100644 index 0000000000000000000000000000000000000000..a046ccc797ce4ec0f331b140ada79bf923057e36 --- /dev/null +++ b/rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/etc/target-spec-json-schema.json @@ -0,0 +1,1361 @@ +{ + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "TargetSpecJson", + "type": "object", + "properties": { + "abi": { + "anyOf": [ + { + "$ref": "#/$defs/Abi" + }, + { + "type": "null" + } + ] + }, + "abi-return-struct-as-int": { + "type": [ + "boolean", + "null" + ] + }, + "allow-asm": { + "type": [ + "boolean", + "null" + ] + }, + "allows-weak-linkage": { + "type": [ + "boolean", + "null" + ] + }, + "arch": { + "$ref": "#/$defs/Arch" + }, + "archive-format": { + "type": [ + "string", + "null" + ] + }, + "asm-args": { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + }, + "atomic-cas": { + "type": [ + "boolean", + "null" + ] + }, + "binary-format": { + "anyOf": [ + { + "$ref": "#/$defs/BinaryFormat" + }, + { + "type": "null" + } + ] + }, + "c-enum-min-bits": { + "type": [ + "integer", + "null" + ], + "format": "uint64", + "minimum": 0 + }, + "code-model": { + "anyOf": [ + { + "$ref": "#/$defs/CodeModel" + }, + { + "type": "null" + } + ] + }, + "cpu": { + "type": [ + "string", + "null" + ] + }, + "crt-objects-fallback": { + "anyOf": [ + { + "$ref": "#/$defs/LinkSelfContainedDefault" + }, + { + "type": "null" + } + ] + }, + "crt-static-allows-dylibs": { + "type": [ + "boolean", + "null" + ] + }, + "crt-static-default": { + "type": [ + "boolean", + "null" + ] + }, + "crt-static-respected": { + "type": [ + "boolean", + "null" + ] + }, + "data-layout": { + "type": "string" + }, + "debuginfo-kind": { + "anyOf": [ + { + "$ref": "#/$defs/DebuginfoKind" + }, + { + "type": "null" + } + ] + }, + "default-codegen-backend": { + "type": [ + "string", + "null" + ] + }, + "default-codegen-units": { + "type": [ + "integer", + "null" + ], + "format": "uint64", + "minimum": 0 + }, + "default-dwarf-version": { + "type": [ + "integer", + "null" + ], + "format": "uint32", + "minimum": 0 + }, + "default-sanitizers": { + "type": [ + "array", + "null" + ], + "items": { + "$ref": "#/$defs/SanitizerSet" + } + }, + "default-uwtable": { + "type": [ + "boolean", + "null" + ] + }, + "default-visibility": { + "anyOf": [ + { + "$ref": "#/$defs/SymbolVisibility" + }, + { + "type": "null" + } + ] + }, + "direct-access-external-data": { + "type": [ + "boolean", + "null" + ] + }, + "disable-redzone": { + "type": [ + "boolean", + "null" + ] + }, + "dll-prefix": { + "type": [ + "string", + "null" + ] + }, + "dll-suffix": { + "type": [ + "string", + "null" + ] + }, + "dll-tls-export": { + "type": [ + "boolean", + "null" + ] + }, + "dynamic-linking": { + "type": [ + "boolean", + "null" + ] + }, + "eh-frame-header": { + "type": [ + "boolean", + "null" + ] + }, + "emit-debug-gdb-scripts": { + "type": [ + "boolean", + "null" + ] + }, + "entry-abi": { + "anyOf": [ + { + "$ref": "#/$defs/ExternAbi" + }, + { + "type": "null" + } + ] + }, + "entry-name": { + "type": [ + "string", + "null" + ] + }, + "env": { + "anyOf": [ + { + "$ref": "#/$defs/Env" + }, + { + "type": "null" + } + ] + }, + "exe-suffix": { + "type": [ + "string", + "null" + ] + }, + "executables": { + "type": [ + "boolean", + "null" + ] + }, + "features": { + "type": [ + "string", + "null" + ] + }, + "frame-pointer": { + "anyOf": [ + { + "$ref": "#/$defs/FramePointer" + }, + { + "type": "null" + } + ] + }, + "function-sections": { + "type": [ + "boolean", + "null" + ] + }, + "generate-arange-section": { + "type": [ + "boolean", + "null" + ] + }, + "has-rpath": { + "type": [ + "boolean", + "null" + ] + }, + "has-thread-local": { + "type": [ + "boolean", + "null" + ] + }, + "has-thumb-interworking": { + "type": [ + "boolean", + "null" + ] + }, + "is-like-aix": { + "type": [ + "boolean", + "null" + ] + }, + "is-like-android": { + "type": [ + "boolean", + "null" + ] + }, + "is-like-darwin": { + "type": [ + "boolean", + "null" + ] + }, + "is-like-gpu": { + "type": [ + "boolean", + "null" + ] + }, + "is-like-msvc": { + "type": [ + "boolean", + "null" + ] + }, + "is-like-solaris": { + "type": [ + "boolean", + "null" + ] + }, + "is-like-vexos": { + "type": [ + "boolean", + "null" + ] + }, + "is-like-wasm": { + "type": [ + "boolean", + "null" + ] + }, + "is-like-windows": { + "type": [ + "boolean", + "null" + ] + }, + "late-link-args": { + "type": [ + "object", + "null" + ], + "additionalProperties": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "late-link-args-dynamic": { + "type": [ + "object", + "null" + ], + "additionalProperties": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "late-link-args-static": { + "type": [ + "object", + "null" + ], + "additionalProperties": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "limit-rdylib-exports": { + "type": [ + "boolean", + "null" + ] + }, + "link-env": { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + }, + "link-env-remove": { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + }, + "link-script": { + "type": [ + "string", + "null" + ] + }, + "link-self-contained": { + "anyOf": [ + { + "$ref": "#/$defs/LinkSelfContainedComponentsWrapper" + }, + { + "type": "null" + } + ] + }, + "linker": { + "type": [ + "string", + "null" + ] + }, + "linker-flavor": { + "anyOf": [ + { + "$ref": "#/$defs/LinkerFlavor" + }, + { + "type": "null" + } + ] + }, + "linker-is-gnu": { + "type": [ + "boolean", + "null" + ] + }, + "lld-flavor": { + "anyOf": [ + { + "$ref": "#/$defs/LldFlavor" + }, + { + "type": "null" + } + ] + }, + "llvm-abiname": { + "type": [ + "string", + "null" + ] + }, + "llvm-args": { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + }, + "llvm-floatabi": { + "anyOf": [ + { + "$ref": "#/$defs/FloatAbi" + }, + { + "type": "null" + } + ] + }, + "llvm-mcount-intrinsic": { + "type": [ + "string", + "null" + ] + }, + "llvm-target": { + "type": "string" + }, + "main-needs-argc-argv": { + "type": [ + "boolean", + "null" + ] + }, + "max-atomic-width": { + "type": [ + "integer", + "null" + ], + "format": "uint64", + "minimum": 0 + }, + "merge-functions": { + "anyOf": [ + { + "$ref": "#/$defs/MergeFunctions" + }, + { + "type": "null" + } + ] + }, + "metadata": { + "anyOf": [ + { + "$ref": "#/$defs/TargetSpecJsonMetadata" + }, + { + "type": "null" + } + ] + }, + "min-atomic-width": { + "type": [ + "integer", + "null" + ], + "format": "uint64", + "minimum": 0 + }, + "min-global-align": { + "type": [ + "integer", + "null" + ], + "format": "uint64", + "minimum": 0 + }, + "need-explicit-cpu": { + "type": [ + "boolean", + "null" + ] + }, + "no-builtins": { + "type": [ + "boolean", + "null" + ] + }, + "no-default-libraries": { + "type": [ + "boolean", + "null" + ] + }, + "obj-is-bitcode": { + "type": [ + "boolean", + "null" + ] + }, + "only-cdylib": { + "type": [ + "boolean", + "null" + ] + }, + "os": { + "anyOf": [ + { + "$ref": "#/$defs/Os" + }, + { + "type": "null" + } + ] + }, + "override-export-symbols": { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + }, + "panic-strategy": { + "anyOf": [ + { + "$ref": "#/$defs/PanicStrategy" + }, + { + "type": "null" + } + ] + }, + "plt-by-default": { + "type": [ + "boolean", + "null" + ] + }, + "position-independent-executables": { + "type": [ + "boolean", + "null" + ] + }, + "post-link-args": { + "type": [ + "object", + "null" + ], + "additionalProperties": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "post-link-objects": { + "type": [ + "object", + "null" + ], + "additionalProperties": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "post-link-objects-fallback": { + "type": [ + "object", + "null" + ], + "additionalProperties": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "pre-link-args": { + "type": [ + "object", + "null" + ], + "additionalProperties": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "pre-link-objects": { + "type": [ + "object", + "null" + ], + "additionalProperties": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "pre-link-objects-fallback": { + "type": [ + "object", + "null" + ], + "additionalProperties": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "relax-elf-relocations": { + "type": [ + "boolean", + "null" + ] + }, + "relocation-model": { + "anyOf": [ + { + "$ref": "#/$defs/RelocModel" + }, + { + "type": "null" + } + ] + }, + "relro-level": { + "anyOf": [ + { + "$ref": "#/$defs/RelroLevel" + }, + { + "type": "null" + } + ] + }, + "requires-lto": { + "type": [ + "boolean", + "null" + ] + }, + "requires-uwtable": { + "type": [ + "boolean", + "null" + ] + }, + "rustc-abi": { + "anyOf": [ + { + "$ref": "#/$defs/RustcAbi" + }, + { + "type": "null" + } + ] + }, + "simd-types-indirect": { + "type": [ + "boolean", + "null" + ] + }, + "singlethread": { + "type": [ + "boolean", + "null" + ] + }, + "small-data-threshold-support": { + "anyOf": [ + { + "$ref": "#/$defs/SmallDataThresholdSupport" + }, + { + "type": "null" + } + ] + }, + "split-debuginfo": { + "anyOf": [ + { + "$ref": "#/$defs/SplitDebuginfo" + }, + { + "type": "null" + } + ] + }, + "stack-probes": { + "anyOf": [ + { + "$ref": "#/$defs/StackProbeType" + }, + { + "type": "null" + } + ] + }, + "static-initializer-must-be-acyclic": { + "type": [ + "boolean", + "null" + ] + }, + "static-position-independent-executables": { + "type": [ + "boolean", + "null" + ] + }, + "staticlib-prefix": { + "type": [ + "string", + "null" + ] + }, + "staticlib-suffix": { + "type": [ + "string", + "null" + ] + }, + "supported-sanitizers": { + "type": [ + "array", + "null" + ], + "items": { + "$ref": "#/$defs/SanitizerSet" + } + }, + "supported-split-debuginfo": { + "type": [ + "array", + "null" + ], + "items": { + "$ref": "#/$defs/SplitDebuginfo" + } + }, + "supports-stack-protector": { + "type": [ + "boolean", + "null" + ] + }, + "supports-xray": { + "type": [ + "boolean", + "null" + ] + }, + "target-c-int-width": { + "type": [ + "integer", + "null" + ], + "format": "uint16", + "maximum": 65535, + "minimum": 0 + }, + "target-endian": { + "anyOf": [ + { + "$ref": "#/$defs/Endian" + }, + { + "type": "null" + } + ] + }, + "target-family": { + "anyOf": [ + { + "$ref": "#/$defs/TargetFamiliesJson" + }, + { + "type": "null" + } + ] + }, + "target-mcount": { + "type": [ + "string", + "null" + ] + }, + "target-pointer-width": { + "type": "integer", + "format": "uint16", + "maximum": 65535, + "minimum": 0 + }, + "tls-model": { + "anyOf": [ + { + "$ref": "#/$defs/TlsModel" + }, + { + "type": "null" + } + ] + }, + "trap-unreachable": { + "type": [ + "boolean", + "null" + ] + }, + "use-ctors-section": { + "type": [ + "boolean", + "null" + ] + }, + "vendor": { + "type": [ + "string", + "null" + ] + } + }, + "additionalProperties": false, + "required": [ + "llvm-target", + "target-pointer-width", + "data-layout", + "arch" + ], + "$defs": { + "Abi": { + "type": "string" + }, + "Arch": { + "type": "string" + }, + "BinaryFormat": { + "type": "string", + "enum": [ + "coff", + "elf", + "mach-o", + "wasm", + "xcoff" + ] + }, + "CodeModel": { + "type": "string", + "enum": [ + "tiny", + "small", + "kernel", + "medium", + "large" + ] + }, + "DebuginfoKind": { + "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).", + "oneOf": [ + { + "description": "DWARF debuginfo (such as that used on `x86_64_unknown_linux_gnu`).", + "type": "string", + "const": "dwarf" + }, + { + "description": "DWARF debuginfo in dSYM files (such as on Apple platforms).", + "type": "string", + "const": "dwarf-dsym" + }, + { + "description": "Program database files (such as on Windows).", + "type": "string", + "const": "pdb" + } + ] + }, + "Endian": { + "type": "string", + "enum": [ + "big", + "little" + ] + }, + "Env": { + "type": "string" + }, + "ExternAbi": { + "type": "string", + "enum": [ + "C", + "C-unwind", + "Rust", + "aapcs", + "aapcs-unwind", + "avr-interrupt", + "avr-non-blocking-interrupt", + "cdecl", + "cdecl-unwind", + "cmse-nonsecure-call", + "cmse-nonsecure-entry", + "custom", + "efiapi", + "fastcall", + "fastcall-unwind", + "gpu-kernel", + "msp430-interrupt", + "ptx-kernel", + "riscv-interrupt-m", + "riscv-interrupt-s", + "rust-call", + "rust-cold", + "rust-invalid", + "rust-preserve-none", + "stdcall", + "stdcall-unwind", + "system", + "system-unwind", + "sysv64", + "sysv64-unwind", + "thiscall", + "thiscall-unwind", + "unadjusted", + "vectorcall", + "vectorcall-unwind", + "win64", + "win64-unwind", + "x86-interrupt" + ] + }, + "FloatAbi": { + "description": "The float ABI setting to be configured in the LLVM target machine.", + "type": "string", + "enum": [ + "soft", + "hard" + ] + }, + "FramePointer": { + "oneOf": [ + { + "description": "Forces the machine code generator to always preserve the frame pointers.", + "type": "string", + "const": "always" + }, + { + "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).", + "type": "string", + "const": "non-leaf" + }, + { + "description": "Allows the machine code generator to omit the frame pointers.\n\nThis option does not guarantee that the frame pointers will be omitted.", + "type": "string", + "const": "may-omit" + } + ] + }, + "LinkSelfContainedComponents": { + "type": "string", + "enum": [ + "crto", + "libc", + "unwind", + "linker", + "sanitizers", + "mingw" + ] + }, + "LinkSelfContainedComponentsWrapper": { + "type": "object", + "properties": { + "components": { + "type": "array", + "items": { + "$ref": "#/$defs/LinkSelfContainedComponents" + } + } + }, + "required": [ + "components" + ] + }, + "LinkSelfContainedDefault": { + "type": "string", + "enum": [ + "false", + "true", + "wasm", + "musl", + "mingw" + ] + }, + "LinkerFlavor": { + "type": "string", + "enum": [ + "gnu", + "gnu-lld", + "gnu-cc", + "gnu-lld-cc", + "darwin", + "darwin-lld", + "darwin-cc", + "darwin-lld-cc", + "wasm-lld", + "wasm-lld-cc", + "unix", + "unix-cc", + "msvc-lld", + "msvc", + "em-cc", + "bpf", + "llbc", + "ptx", + "gcc", + "ld", + "ld.lld", + "ld64.lld", + "lld-link", + "wasm-ld", + "em" + ] + }, + "LldFlavor": { + "type": "string", + "enum": [ + "wasm", + "darwin", + "gnu", + "link" + ] + }, + "MergeFunctions": { + "type": "string", + "enum": [ + "disabled", + "trampolines", + "aliases" + ] + }, + "Os": { + "type": "string" + }, + "PanicStrategy": { + "type": "string", + "enum": [ + "unwind", + "abort", + "immediate-abort" + ] + }, + "RelocModel": { + "type": "string", + "enum": [ + "static", + "pic", + "pie", + "dynamic-no-pic", + "ropi", + "rwpi", + "ropi-rwpi" + ] + }, + "RelroLevel": { + "type": "string", + "enum": [ + "full", + "partial", + "off", + "none" + ] + }, + "RustcAbi": { + "description": "The Rustc-specific variant of the ABI used for this target.", + "oneOf": [ + { + "description": "On x86-32 only: make use of SSE and SSE2 for ABI purposes.", + "type": "string", + "const": "x86-sse2" + }, + { + "description": "On x86-32/64 and S390x: do not use any FPU or SIMD registers for the ABI.", + "type": "string", + "const": "softfloat" + } + ] + }, + "SanitizerSet": { + "type": "string", + "enum": [ + "address", + "leak", + "memory", + "thread", + "hwaddress", + "cfi", + "memtag", + "shadow-call-stack", + "kcfi", + "kernel-address", + "safestack", + "dataflow", + "realtime" + ] + }, + "SmallDataThresholdSupport": { + "type": "string", + "pattern": "^none|default-for-arch|llvm-module-flag=.+|llvm-arg=.+$" + }, + "SplitDebuginfo": { + "oneOf": [ + { + "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", + "type": "string", + "const": "off" + }, + { + "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`)", + "type": "string", + "const": "packed" + }, + { + "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`)", + "type": "string", + "const": "unpacked" + } + ] + }, + "StackProbeType": { + "oneOf": [ + { + "description": "Don't emit any stack probes.", + "type": "object", + "properties": { + "kind": { + "type": "string", + "const": "none" + } + }, + "required": [ + "kind" + ] + }, + { + "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.", + "type": "object", + "properties": { + "kind": { + "type": "string", + "const": "inline" + } + }, + "required": [ + "kind" + ] + }, + { + "description": "Call `__rust_probestack` whenever stack needs to be probed.", + "type": "object", + "properties": { + "kind": { + "type": "string", + "const": "call" + } + }, + "required": [ + "kind" + ] + }, + { + "description": "Use inline option for LLVM versions later than specified in `min_llvm_version_for_inline`\nand call `__rust_probestack` otherwise.", + "type": "object", + "properties": { + "kind": { + "type": "string", + "const": "inline-or-call" + }, + "min-llvm-version-for-inline": { + "type": "array", + "maxItems": 3, + "minItems": 3, + "prefixItems": [ + { + "type": "integer", + "format": "uint32", + "minimum": 0 + }, + { + "type": "integer", + "format": "uint32", + "minimum": 0 + }, + { + "type": "integer", + "format": "uint32", + "minimum": 0 + } + ] + } + }, + "required": [ + "kind", + "min-llvm-version-for-inline" + ] + } + ] + }, + "SymbolVisibility": { + "type": "string", + "enum": [ + "hidden", + "protected", + "interposable" + ] + }, + "TargetFamiliesJson": { + "anyOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "type": "string" + } + ] + }, + "TargetSpecJsonMetadata": { + "type": "object", + "properties": { + "description": { + "type": [ + "string", + "null" + ] + }, + "host_tools": { + "type": [ + "boolean", + "null" + ] + }, + "std": { + "type": [ + "boolean", + "null" + ] + }, + "tier": { + "type": [ + "integer", + "null" + ], + "format": "uint64", + "minimum": 0 + } + } + }, + "TlsModel": { + "type": "string", + "enum": [ + "global-dynamic", + "local-dynamic", + "initial-exec", + "local-exec", + "emulated" + ] + } + } +} diff --git a/rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-add.1 b/rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-add.1 new file mode 100644 index 0000000000000000000000000000000000000000..84a3d528dfd4b7d6e8e35fdeb2e28b9f84024cda --- /dev/null +++ b/rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-add.1 @@ -0,0 +1,369 @@ +'\" t +.TH "CARGO\-ADD" "1" +.nh +.ad l +.ss \n[.ss] 0 +.SH "NAME" +cargo\-add \[em] Add dependencies to a Cargo.toml manifest file +.SH "SYNOPSIS" +\fBcargo add\fR [\fIoptions\fR] \fIcrate\fR\[u2026] +.br +\fBcargo add\fR [\fIoptions\fR] \fB\-\-path\fR \fIpath\fR +.br +\fBcargo add\fR [\fIoptions\fR] \fB\-\-git\fR \fIurl\fR [\fIcrate\fR\[u2026]] +.SH "DESCRIPTION" +This command can add or modify dependencies. +.sp +The source for the dependency can be specified with: +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fIcrate\fR\fB@\fR\fIversion\fR: Fetch from a registry with a version constraint of \[lq]\fIversion\fR\[rq] +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fB\-\-path\fR \fIpath\fR: Fetch from the specified \fIpath\fR +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fB\-\-git\fR \fIurl\fR: Pull from a git repo at \fIurl\fR +.RE +.sp +If no source is specified, then a best effort will be made to select one, including: +.sp +.RS 4 +\h'-04'\(bu\h'+03'Existing dependencies in other tables (like \fBdev\-dependencies\fR) +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'Workspace members +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'Latest release in the registry +.RE +.sp +When you add a package that is already present, the existing entry will be updated with the flags specified. +.sp +Upon successful invocation, the enabled (\fB+\fR) and disabled (\fB\-\fR) \fIfeatures\fR of the specified +dependency will be listed in the command\[cq]s output. +.SH "OPTIONS" +.SS "Source options" +.sp +\fB\-\-git\fR \fIurl\fR +.RS 4 +\fIGit URL to add the specified crate from\fR \&. +.RE +.sp +\fB\-\-branch\fR \fIbranch\fR +.RS 4 +Branch to use when adding from git. +.RE +.sp +\fB\-\-tag\fR \fItag\fR +.RS 4 +Tag to use when adding from git. +.RE +.sp +\fB\-\-rev\fR \fIsha\fR +.RS 4 +Specific commit to use when adding from git. +.RE +.sp +\fB\-\-path\fR \fIpath\fR +.RS 4 +\fIFilesystem path\fR to local crate to add. +.RE +.sp +\fB\-\-base\fR \fIbase\fR +.RS 4 +The \fIpath base\fR to use when adding a local crate. +.sp +\fIUnstable (nightly\-only)\fR +.RE +.sp +\fB\-\-registry\fR \fIregistry\fR +.RS 4 +Name of the registry to use. Registry names are defined in \fICargo config +files\fR \&. If not specified, the default registry is used, +which is defined by the \fBregistry.default\fR config key which defaults to +\fBcrates\-io\fR\&. +.RE +.SS "Section options" +.sp +\fB\-\-dev\fR +.RS 4 +Add as a \fIdevelopment dependency\fR \&. +.RE +.sp +\fB\-\-build\fR +.RS 4 +Add as a \fIbuild dependency\fR \&. +.RE +.sp +\fB\-\-target\fR \fItarget\fR +.RS 4 +Add as a dependency to the \fIgiven target platform\fR \&. +.sp +To avoid unexpected shell expansions, you may use quotes around each target, e.g., \fB\-\-target 'cfg(unix)'\fR\&. +.RE +.SS "Dependency options" +.sp +\fB\-\-dry\-run\fR +.RS 4 +Don\[cq]t actually write the manifest +.RE +.sp +\fB\-\-rename\fR \fIname\fR +.RS 4 +\fIRename\fR the dependency. +.RE +.sp +\fB\-\-optional\fR +.RS 4 +Mark the dependency as \fIoptional\fR \&. +.RE +.sp +\fB\-\-no\-optional\fR +.RS 4 +Mark the dependency as \fIrequired\fR \&. +.RE +.sp +\fB\-\-public\fR +.RS 4 +Mark the dependency as public. +.sp +The dependency can be referenced in your library\[cq]s public API. +.sp +\fIUnstable (nightly\-only)\fR +.RE +.sp +\fB\-\-no\-public\fR +.RS 4 +Mark the dependency as private. +.sp +While you can use the crate in your implementation, it cannot be referenced in your public API. +.sp +\fIUnstable (nightly\-only)\fR +.RE +.sp +\fB\-\-no\-default\-features\fR +.RS 4 +Disable the \fIdefault features\fR \&. +.RE +.sp +\fB\-\-default\-features\fR +.RS 4 +Re\-enable the \fIdefault features\fR \&. +.RE +.sp +\fB\-F\fR \fIfeatures\fR, +\fB\-\-features\fR \fIfeatures\fR +.RS 4 +Space or comma separated list of \fIfeatures to +activate\fR \&. When adding multiple +crates, the features for a specific crate may be enabled with +\fBpackage\-name/feature\-name\fR syntax. This flag may be specified multiple times, +which enables all specified features. +.RE +.SS "Display Options" +.sp +\fB\-v\fR, +\fB\-\-verbose\fR +.RS 4 +Use verbose output. May be specified twice for \[lq]very verbose\[rq] output which +includes extra output such as dependency warnings and build script output. +May also be specified with the \fBterm.verbose\fR +\fIconfig value\fR \&. +.RE +.sp +\fB\-q\fR, +\fB\-\-quiet\fR +.RS 4 +Do not print cargo log messages. +May also be specified with the \fBterm.quiet\fR +\fIconfig value\fR \&. +.RE +.sp +\fB\-\-color\fR \fIwhen\fR +.RS 4 +Control when colored output is used. Valid values: +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBauto\fR (default): Automatically detect if color support is available on the +terminal. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBalways\fR: Always display colors. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBnever\fR: Never display colors. +.RE +.sp +May also be specified with the \fBterm.color\fR +\fIconfig value\fR \&. +.RE +.SS "Manifest Options" +.sp +\fB\-\-manifest\-path\fR \fIpath\fR +.RS 4 +Path to the \fBCargo.toml\fR file. By default, Cargo searches for the +\fBCargo.toml\fR file in the current directory or any parent directory. +.RE +.sp +\fB\-p\fR \fIspec\fR, +\fB\-\-package\fR \fIspec\fR +.RS 4 +Add dependencies to only the specified package. +.RE +.sp +\fB\-\-ignore\-rust\-version\fR +.RS 4 +Ignore \fBrust\-version\fR specification in packages. +.RE +.sp +\fB\-\-locked\fR +.RS 4 +Asserts that the exact same dependencies and versions are used as when the +existing \fBCargo.lock\fR file was originally generated. Cargo will exit with an +error when either of the following scenarios arises: +.sp +.RS 4 +\h'-04'\(bu\h'+03'The lock file is missing. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'Cargo attempted to change the lock file due to a different dependency resolution. +.RE +.sp +It may be used in environments where deterministic builds are desired, +such as in CI pipelines. +.RE +.sp +\fB\-\-offline\fR +.RS 4 +Prevents Cargo from accessing the network for any reason. Without this +flag, Cargo will stop with an error if it needs to access the network and +the network is not available. With this flag, Cargo will attempt to +proceed without the network if possible. +.sp +Beware that this may result in different dependency resolution than online +mode. Cargo will restrict itself to crates that are downloaded locally, even +if there might be a newer version as indicated in the local copy of the index. +See the \fBcargo\-fetch\fR(1) command to download dependencies before going +offline. +.sp +May also be specified with the \fBnet.offline\fR \fIconfig value\fR \&. +.RE +.sp +\fB\-\-frozen\fR +.RS 4 +Equivalent to specifying both \fB\-\-locked\fR and \fB\-\-offline\fR\&. +.RE +.SS "Common Options" +.sp +\fB+\fR\fItoolchain\fR +.RS 4 +If Cargo has been installed with rustup, and the first argument to \fBcargo\fR +begins with \fB+\fR, it will be interpreted as a rustup toolchain name (such +as \fB+stable\fR or \fB+nightly\fR). +See the \fIrustup documentation\fR +for more information about how toolchain overrides work. +.RE +.sp +\fB\-\-config\fR \fIKEY=VALUE\fR or \fIPATH\fR +.RS 4 +Overrides a Cargo configuration value. The argument should be in TOML syntax of \fBKEY=VALUE\fR, +or provided as a path to an extra configuration file. This flag may be specified multiple times. +See the \fIcommand\-line overrides section\fR for more information. +.RE +.sp +\fB\-C\fR \fIPATH\fR +.RS 4 +Changes the current working directory before executing any specified operations. This affects +things like where cargo looks by default for the project manifest (\fBCargo.toml\fR), as well as +the directories searched for discovering \fB\&.cargo/config.toml\fR, for example. This option must +appear before the command name, for example \fBcargo \-C path/to/my\-project build\fR\&. +.sp +This option is only available on the \fInightly +channel\fR and +requires the \fB\-Z unstable\-options\fR flag to enable (see +\fI#10098\fR ). +.RE +.sp +\fB\-h\fR, +\fB\-\-help\fR +.RS 4 +Prints help information. +.RE +.sp +\fB\-Z\fR \fIflag\fR +.RS 4 +Unstable (nightly\-only) flags to Cargo. Run \fBcargo \-Z help\fR for details. +.RE +.SH "ENVIRONMENT" +See \fIthe reference\fR for +details on environment variables that Cargo reads. +.SH "EXIT STATUS" +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fB0\fR: Cargo succeeded. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fB101\fR: Cargo failed to complete. +.RE +.SH "EXAMPLES" +.sp +.RS 4 +\h'-04' 1.\h'+01'Add \fBregex\fR as a dependency +.sp +.RS 4 +.nf +cargo add regex +.fi +.RE +.RE +.sp +.RS 4 +\h'-04' 2.\h'+01'Add \fBtrybuild\fR as a dev\-dependency +.sp +.RS 4 +.nf +cargo add \-\-dev trybuild +.fi +.RE +.RE +.sp +.RS 4 +\h'-04' 3.\h'+01'Add an older version of \fBnom\fR as a dependency +.sp +.RS 4 +.nf +cargo add nom@5 +.fi +.RE +.RE +.sp +.RS 4 +\h'-04' 4.\h'+01'Add support for serializing data structures to json with \fBderive\fRs +.sp +.RS 4 +.nf +cargo add serde serde_json \-F serde/derive +.fi +.RE +.RE +.sp +.RS 4 +\h'-04' 5.\h'+01'Add \fBwindows\fR as a platform specific dependency on \fBcfg(windows)\fR +.sp +.RS 4 +.nf +cargo add windows \-\-target 'cfg(windows)' +.fi +.RE +.RE +.SH "SEE ALSO" +\fBcargo\fR(1), \fBcargo\-remove\fR(1) diff --git a/rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-bench.1 b/rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-bench.1 new file mode 100644 index 0000000000000000000000000000000000000000..998c747ceca0092a0cf5182a3163e32631f2065a --- /dev/null +++ b/rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-bench.1 @@ -0,0 +1,562 @@ +'\" t +.TH "CARGO\-BENCH" "1" +.nh +.ad l +.ss \n[.ss] 0 +.SH "NAME" +cargo\-bench \[em] Execute benchmarks of a package +.SH "SYNOPSIS" +\fBcargo bench\fR [\fIoptions\fR] [\fIbenchname\fR] [\fB\-\-\fR \fIbench\-options\fR] +.SH "DESCRIPTION" +Compile and execute benchmarks. +.sp +The benchmark filtering argument \fIbenchname\fR and all the arguments following +the two dashes (\fB\-\-\fR) are passed to the benchmark binaries and thus to +\fIlibtest\fR (rustc\[cq]s built in unit\-test and micro\-benchmarking framework). If +you are passing arguments to both Cargo and the binary, the ones after \fB\-\-\fR go +to the binary, the ones before go to Cargo. For details about libtest\[cq]s +arguments see the output of \fBcargo bench \-\- \-\-help\fR and check out the rustc +book\[cq]s chapter on how tests work at +\&. +.sp +As an example, this will run only the benchmark named \fBfoo\fR (and skip other +similarly named benchmarks like \fBfoobar\fR): +.sp +.RS 4 +.nf +cargo bench \-\- foo \-\-exact +.fi +.RE +.sp +Benchmarks are built with the \fB\-\-test\fR option to \fBrustc\fR which creates a +special executable by linking your code with libtest. The executable +automatically runs all functions annotated with the \fB#[bench]\fR attribute. +Cargo passes the \fB\-\-bench\fR flag to the test harness to tell it to run +only benchmarks, regardless of whether the harness is libtest or a custom harness. +.sp +The libtest harness may be disabled by setting \fBharness = false\fR in the target +manifest settings, in which case your code will need to provide its own \fBmain\fR +function to handle running benchmarks. +.RS 3 +.ll -5 +.sp +\fBNote\fR: The +\fI\f(BI#[bench]\fI attribute\fR +is currently unstable and only available on the +\fInightly channel\fR \&. +There are some packages available on +\fIcrates.io\fR that may help with +running benchmarks on the stable channel, such as +\fICriterion\fR \&. +.br +.RE +.ll +.sp +By default, \fBcargo bench\fR uses the \fI\f(BIbench\fI profile\fR , which enables +optimizations and disables debugging information. If you need to debug a +benchmark, you can use the \fB\-\-profile=dev\fR command\-line option to switch to +the dev profile. You can then run the debug\-enabled benchmark within a +debugger. +.SS "Working directory of benchmarks" +The working directory of every benchmark is set to the root directory of the +package the benchmark belongs to. +Setting the working directory of benchmarks to the package\[cq]s root directory +makes it possible for benchmarks to reliably access the package\[cq]s files using +relative paths, regardless from where \fBcargo bench\fR was executed from. +.SH "OPTIONS" +.SS "Benchmark Options" +.sp +\fB\-\-no\-run\fR +.RS 4 +Compile, but don\[cq]t run benchmarks. +.RE +.sp +\fB\-\-no\-fail\-fast\fR +.RS 4 +Run all benchmarks regardless of failure. Without this flag, Cargo will exit +after the first executable fails. The Rust test harness will run all benchmarks +within the executable to completion, this flag only applies to the executable +as a whole. +.RE +.SS "Package Selection" +By default, when no package selection options are given, the packages selected +depend on the selected manifest file (based on the current working directory if +\fB\-\-manifest\-path\fR is not given). If the manifest is the root of a workspace then +the workspaces default members are selected, otherwise only the package defined +by the manifest will be selected. +.sp +The default members of a workspace can be set explicitly with the +\fBworkspace.default\-members\fR key in the root manifest. If this is not set, a +virtual workspace will include all workspace members (equivalent to passing +\fB\-\-workspace\fR), and a non\-virtual workspace will include only the root crate itself. +.sp +\fB\-p\fR \fIspec\fR\[u2026], +\fB\-\-package\fR \fIspec\fR\[u2026] +.RS 4 +Benchmark only the specified packages. See \fBcargo\-pkgid\fR(1) for the +SPEC format. This flag may be specified multiple times and supports common Unix +glob patterns like \fB*\fR, \fB?\fR and \fB[]\fR\&. However, to avoid your shell accidentally +expanding glob patterns before Cargo handles them, you must use single quotes or +double quotes around each pattern. +.RE +.sp +\fB\-\-workspace\fR +.RS 4 +Benchmark all members in the workspace. +.RE +.sp +\fB\-\-all\fR +.RS 4 +Deprecated alias for \fB\-\-workspace\fR\&. +.RE +.sp +\fB\-\-exclude\fR \fISPEC\fR\[u2026] +.RS 4 +Exclude the specified packages. Must be used in conjunction with the +\fB\-\-workspace\fR flag. This flag may be specified multiple times and supports +common Unix glob patterns like \fB*\fR, \fB?\fR and \fB[]\fR\&. However, to avoid your shell +accidentally expanding glob patterns before Cargo handles them, you must use +single quotes or double quotes around each pattern. +.RE +.SS "Target Selection" +When no target selection options are given, \fBcargo bench\fR will build the +following targets of the selected packages: +.sp +.RS 4 +\h'-04'\(bu\h'+03'lib \[em] used to link with binaries and benchmarks +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'bins (only if benchmark targets are built and required features are +available) +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'lib as a benchmark +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'bins as benchmarks +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'benchmark targets +.RE +.sp +The default behavior can be changed by setting the \fBbench\fR flag for the target +in the manifest settings. Setting examples to \fBbench = true\fR will build and +run the example as a benchmark, replacing the example\[cq]s \fBmain\fR function with +the libtest harness. +.sp +Setting targets to \fBbench = false\fR will stop them from being benchmarked by +default. Target selection options that take a target by name (such as +\fB\-\-example foo\fR) ignore the \fBbench\fR flag and will always benchmark the given +target. +.sp +See \fIConfiguring a target\fR +for more information on per\-target settings. +.sp +Binary targets are automatically built if there is an integration test or +benchmark being selected to benchmark. This allows an integration +test to execute the binary to exercise and test its behavior. +The \fBCARGO_BIN_EXE_\fR +\fIenvironment variable\fR +is set when the integration test is built and run so that it can use the +\fI\f(BIenv\fI macro\fR or the +\fI\f(BIvar\fI function\fR to locate the +executable. +.sp +Passing target selection flags will benchmark only the specified +targets. +.sp +Note that \fB\-\-bin\fR, \fB\-\-example\fR, \fB\-\-test\fR and \fB\-\-bench\fR flags also +support common Unix glob patterns like \fB*\fR, \fB?\fR and \fB[]\fR\&. However, to avoid your +shell accidentally expanding glob patterns before Cargo handles them, you must +use single quotes or double quotes around each glob pattern. +.sp +\fB\-\-lib\fR +.RS 4 +Benchmark the package\[cq]s library. +.RE +.sp +\fB\-\-bin\fR \fIname\fR\[u2026] +.RS 4 +Benchmark the specified binary. This flag may be specified multiple times +and supports common Unix glob patterns. +.RE +.sp +\fB\-\-bins\fR +.RS 4 +Benchmark all binary targets. +.RE +.sp +\fB\-\-example\fR \fIname\fR\[u2026] +.RS 4 +Benchmark the specified example. This flag may be specified multiple times +and supports common Unix glob patterns. +.RE +.sp +\fB\-\-examples\fR +.RS 4 +Benchmark all example targets. +.RE +.sp +\fB\-\-test\fR \fIname\fR\[u2026] +.RS 4 +Benchmark the specified integration test. This flag may be specified +multiple times and supports common Unix glob patterns. +.RE +.sp +\fB\-\-tests\fR +.RS 4 +Benchmark all targets that have the \fBtest = true\fR manifest +flag set. By default this includes the library and binaries built as +unittests, and integration tests. Be aware that this will also build any +required dependencies, so the lib target may be built twice (once as a +unittest, and once as a dependency for binaries, integration tests, etc.). +Targets may be enabled or disabled by setting the \fBtest\fR flag in the +manifest settings for the target. +.RE +.sp +\fB\-\-bench\fR \fIname\fR\[u2026] +.RS 4 +Benchmark the specified benchmark. This flag may be specified multiple +times and supports common Unix glob patterns. +.RE +.sp +\fB\-\-benches\fR +.RS 4 +Benchmark all targets that have the \fBbench = true\fR +manifest flag set. By default this includes the library and binaries built +as benchmarks, and bench targets. Be aware that this will also build any +required dependencies, so the lib target may be built twice (once as a +benchmark, and once as a dependency for binaries, benchmarks, etc.). +Targets may be enabled or disabled by setting the \fBbench\fR flag in the +manifest settings for the target. +.RE +.sp +\fB\-\-all\-targets\fR +.RS 4 +Benchmark all targets. This is equivalent to specifying \fB\-\-lib \-\-bins \-\-tests \-\-benches \-\-examples\fR\&. +.RE +.SS "Feature Selection" +The feature flags allow you to control which features are enabled. When no +feature options are given, the \fBdefault\fR feature is activated for every +selected package. +.sp +See \fIthe features documentation\fR +for more details. +.sp +\fB\-F\fR \fIfeatures\fR, +\fB\-\-features\fR \fIfeatures\fR +.RS 4 +Space or comma separated list of features to activate. Features of workspace +members may be enabled with \fBpackage\-name/feature\-name\fR syntax. This flag may +be specified multiple times, which enables all specified features. +.RE +.sp +\fB\-\-all\-features\fR +.RS 4 +Activate all available features of all selected packages. +.RE +.sp +\fB\-\-no\-default\-features\fR +.RS 4 +Do not activate the \fBdefault\fR feature of the selected packages. +.RE +.SS "Compilation Options" +.sp +\fB\-\-target\fR \fItriple\fR +.RS 4 +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 +\fB\-\-\-\fR\&. +.sp +Possible values: +.sp +.RS 4 +\h'-04'\(bu\h'+03'Any supported target in \fBrustc \-\-print target\-list\fR\&. +.RE +.sp +.RS 4 +\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). +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'A path to a custom target specification. See \fICustom Target Lookup Path\fR for more information. +.RE +.sp +This may also be specified with the \fBbuild.target\fR \fIconfig value\fR \&. +.sp +Note that specifying this flag makes Cargo run in a different mode where the +target artifacts are placed in a separate directory. See the +\fIbuild cache\fR documentation for more details. +.RE +.sp +\fB\-\-profile\fR \fIname\fR +.RS 4 +Benchmark with the given profile. +See \fIthe reference\fR for more details on profiles. +.RE +.sp +\fB\-\-timings\fR +.RS 4 +Output information how long each compilation takes, and track concurrency +information over time. +.sp +A file \fBcargo\-timing.html\fR will be written to the \fBtarget/cargo\-timings\fR +directory at the end of the build. An additional report with a timestamp +in its filename is also written if you want to look at a previous run. +These reports are suitable for human consumption only, and do not provide +machine\-readable timing data. +.RE +.SS "Output Options" +.sp +\fB\-\-target\-dir\fR \fIdirectory\fR +.RS 4 +Directory for all generated artifacts and intermediate files. May also be +specified with the \fBCARGO_TARGET_DIR\fR environment variable, or the +\fBbuild.target\-dir\fR \fIconfig value\fR \&. +Defaults to \fBtarget\fR in the root of the workspace. +.RE +.SS "Display Options" +By default the Rust test harness hides output from benchmark execution to keep +results readable. Benchmark output can be recovered (e.g., for debugging) by +passing \fB\-\-no\-capture\fR to the benchmark binaries: +.sp +.RS 4 +.nf +cargo bench \-\- \-\-no\-capture +.fi +.RE +.sp +\fB\-v\fR, +\fB\-\-verbose\fR +.RS 4 +Use verbose output. May be specified twice for \[lq]very verbose\[rq] output which +includes extra output such as dependency warnings and build script output. +May also be specified with the \fBterm.verbose\fR +\fIconfig value\fR \&. +.RE +.sp +\fB\-q\fR, +\fB\-\-quiet\fR +.RS 4 +Do not print cargo log messages. +May also be specified with the \fBterm.quiet\fR +\fIconfig value\fR \&. +.RE +.sp +\fB\-\-color\fR \fIwhen\fR +.RS 4 +Control when colored output is used. Valid values: +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBauto\fR (default): Automatically detect if color support is available on the +terminal. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBalways\fR: Always display colors. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBnever\fR: Never display colors. +.RE +.sp +May also be specified with the \fBterm.color\fR +\fIconfig value\fR \&. +.RE +.sp +\fB\-\-message\-format\fR \fIfmt\fR +.RS 4 +The output format for diagnostic messages. Can be specified multiple times +and consists of comma\-separated values. Valid values: +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBhuman\fR (default): Display in a human\-readable text format. Conflicts with +\fBshort\fR and \fBjson\fR\&. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBshort\fR: Emit shorter, human\-readable text messages. Conflicts with \fBhuman\fR +and \fBjson\fR\&. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBjson\fR: Emit JSON messages to stdout. See +\fIthe reference\fR +for more details. Conflicts with \fBhuman\fR and \fBshort\fR\&. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBjson\-diagnostic\-short\fR: Ensure the \fBrendered\fR field of JSON messages contains +the \[lq]short\[rq] rendering from rustc. Cannot be used with \fBhuman\fR or \fBshort\fR\&. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBjson\-diagnostic\-rendered\-ansi\fR: Ensure the \fBrendered\fR field of JSON messages +contains embedded ANSI color codes for respecting rustc\[cq]s default color +scheme. Cannot be used with \fBhuman\fR or \fBshort\fR\&. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBjson\-render\-diagnostics\fR: Instruct Cargo to not include rustc diagnostics +in JSON messages printed, but instead Cargo itself should render the +JSON diagnostics coming from rustc. Cargo\[cq]s own JSON diagnostics and others +coming from rustc are still emitted. Cannot be used with \fBhuman\fR or \fBshort\fR\&. +.RE +.RE +.SS "Manifest Options" +.sp +\fB\-\-manifest\-path\fR \fIpath\fR +.RS 4 +Path to the \fBCargo.toml\fR file. By default, Cargo searches for the +\fBCargo.toml\fR file in the current directory or any parent directory. +.RE +.sp +\fB\-\-ignore\-rust\-version\fR +.RS 4 +Ignore \fBrust\-version\fR specification in packages. +.RE +.sp +\fB\-\-locked\fR +.RS 4 +Asserts that the exact same dependencies and versions are used as when the +existing \fBCargo.lock\fR file was originally generated. Cargo will exit with an +error when either of the following scenarios arises: +.sp +.RS 4 +\h'-04'\(bu\h'+03'The lock file is missing. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'Cargo attempted to change the lock file due to a different dependency resolution. +.RE +.sp +It may be used in environments where deterministic builds are desired, +such as in CI pipelines. +.RE +.sp +\fB\-\-offline\fR +.RS 4 +Prevents Cargo from accessing the network for any reason. Without this +flag, Cargo will stop with an error if it needs to access the network and +the network is not available. With this flag, Cargo will attempt to +proceed without the network if possible. +.sp +Beware that this may result in different dependency resolution than online +mode. Cargo will restrict itself to crates that are downloaded locally, even +if there might be a newer version as indicated in the local copy of the index. +See the \fBcargo\-fetch\fR(1) command to download dependencies before going +offline. +.sp +May also be specified with the \fBnet.offline\fR \fIconfig value\fR \&. +.RE +.sp +\fB\-\-frozen\fR +.RS 4 +Equivalent to specifying both \fB\-\-locked\fR and \fB\-\-offline\fR\&. +.RE +.SS "Common Options" +.sp +\fB+\fR\fItoolchain\fR +.RS 4 +If Cargo has been installed with rustup, and the first argument to \fBcargo\fR +begins with \fB+\fR, it will be interpreted as a rustup toolchain name (such +as \fB+stable\fR or \fB+nightly\fR). +See the \fIrustup documentation\fR +for more information about how toolchain overrides work. +.RE +.sp +\fB\-\-config\fR \fIKEY=VALUE\fR or \fIPATH\fR +.RS 4 +Overrides a Cargo configuration value. The argument should be in TOML syntax of \fBKEY=VALUE\fR, +or provided as a path to an extra configuration file. This flag may be specified multiple times. +See the \fIcommand\-line overrides section\fR for more information. +.RE +.sp +\fB\-C\fR \fIPATH\fR +.RS 4 +Changes the current working directory before executing any specified operations. This affects +things like where cargo looks by default for the project manifest (\fBCargo.toml\fR), as well as +the directories searched for discovering \fB\&.cargo/config.toml\fR, for example. This option must +appear before the command name, for example \fBcargo \-C path/to/my\-project build\fR\&. +.sp +This option is only available on the \fInightly +channel\fR and +requires the \fB\-Z unstable\-options\fR flag to enable (see +\fI#10098\fR ). +.RE +.sp +\fB\-h\fR, +\fB\-\-help\fR +.RS 4 +Prints help information. +.RE +.sp +\fB\-Z\fR \fIflag\fR +.RS 4 +Unstable (nightly\-only) flags to Cargo. Run \fBcargo \-Z help\fR for details. +.RE +.SS "Miscellaneous Options" +The \fB\-\-jobs\fR argument affects the building of the benchmark executable but +does not affect how many threads are used when running the benchmarks. The +Rust test harness runs benchmarks serially in a single thread. +.sp +\fB\-j\fR \fIN\fR, +\fB\-\-jobs\fR \fIN\fR +.RS 4 +Number of parallel jobs to run. May also be specified with the +\fBbuild.jobs\fR \fIconfig value\fR \&. Defaults to +the number of logical CPUs. If negative, it sets the maximum number of +parallel jobs to the number of logical CPUs plus provided value. If +a string \fBdefault\fR is provided, it sets the value back to defaults. +Should not be 0. +.RE +.sp +While \fBcargo bench\fR involves compilation, it does not provide a \fB\-\-keep\-going\fR +flag. Use \fB\-\-no\-fail\-fast\fR to run as many benchmarks as possible without +stopping at the first failure. To \[lq]compile\[rq] as many benchmarks as possible, use +\fB\-\-benches\fR to build benchmark binaries separately. For example: +.sp +.RS 4 +.nf +cargo build \-\-benches \-\-release \-\-keep\-going +cargo bench \-\-no\-fail\-fast +.fi +.RE +.SH "ENVIRONMENT" +See \fIthe reference\fR for +details on environment variables that Cargo reads. +.SH "EXIT STATUS" +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fB0\fR: Cargo succeeded. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fB101\fR: Cargo failed to complete. +.RE +.SH "EXAMPLES" +.sp +.RS 4 +\h'-04' 1.\h'+01'Build and execute all the benchmarks of the current package: +.sp +.RS 4 +.nf +cargo bench +.fi +.RE +.RE +.sp +.RS 4 +\h'-04' 2.\h'+01'Run only a specific benchmark within a specific benchmark target: +.sp +.RS 4 +.nf +cargo bench \-\-bench bench_name \-\- modname::some_benchmark +.fi +.RE +.RE +.SH "SEE ALSO" +\fBcargo\fR(1), \fBcargo\-test\fR(1) diff --git a/rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-build.1 b/rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-build.1 new file mode 100644 index 0000000000000000000000000000000000000000..c90c2200ead9aac3a71717dd2d36f93c184fa5ae --- /dev/null +++ b/rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-build.1 @@ -0,0 +1,474 @@ +'\" t +.TH "CARGO\-BUILD" "1" +.nh +.ad l +.ss \n[.ss] 0 +.SH "NAME" +cargo\-build \[em] Compile the current package +.SH "SYNOPSIS" +\fBcargo build\fR [\fIoptions\fR] +.SH "DESCRIPTION" +Compile local packages and all of their dependencies. +.SH "OPTIONS" +.SS "Package Selection" +By default, when no package selection options are given, the packages selected +depend on the selected manifest file (based on the current working directory if +\fB\-\-manifest\-path\fR is not given). If the manifest is the root of a workspace then +the workspaces default members are selected, otherwise only the package defined +by the manifest will be selected. +.sp +The default members of a workspace can be set explicitly with the +\fBworkspace.default\-members\fR key in the root manifest. If this is not set, a +virtual workspace will include all workspace members (equivalent to passing +\fB\-\-workspace\fR), and a non\-virtual workspace will include only the root crate itself. +.sp +\fB\-p\fR \fIspec\fR\[u2026], +\fB\-\-package\fR \fIspec\fR\[u2026] +.RS 4 +Build only the specified packages. See \fBcargo\-pkgid\fR(1) for the +SPEC format. This flag may be specified multiple times and supports common Unix +glob patterns like \fB*\fR, \fB?\fR and \fB[]\fR\&. However, to avoid your shell accidentally +expanding glob patterns before Cargo handles them, you must use single quotes or +double quotes around each pattern. +.RE +.sp +\fB\-\-workspace\fR +.RS 4 +Build all members in the workspace. +.RE +.sp +\fB\-\-all\fR +.RS 4 +Deprecated alias for \fB\-\-workspace\fR\&. +.RE +.sp +\fB\-\-exclude\fR \fISPEC\fR\[u2026] +.RS 4 +Exclude the specified packages. Must be used in conjunction with the +\fB\-\-workspace\fR flag. This flag may be specified multiple times and supports +common Unix glob patterns like \fB*\fR, \fB?\fR and \fB[]\fR\&. However, to avoid your shell +accidentally expanding glob patterns before Cargo handles them, you must use +single quotes or double quotes around each pattern. +.RE +.SS "Target Selection" +When no target selection options are given, \fBcargo build\fR will build all +binary and library targets of the selected packages. Binaries are skipped if +they have \fBrequired\-features\fR that are missing. +.sp +Binary targets are automatically built if there is an integration test or +benchmark being selected to build. This allows an integration +test to execute the binary to exercise and test its behavior. +The \fBCARGO_BIN_EXE_\fR +\fIenvironment variable\fR +is set when the integration test is built and run so that it can use the +\fI\f(BIenv\fI macro\fR or the +\fI\f(BIvar\fI function\fR to locate the +executable. +.sp +Passing target selection flags will build only the specified +targets. +.sp +Note that \fB\-\-bin\fR, \fB\-\-example\fR, \fB\-\-test\fR and \fB\-\-bench\fR flags also +support common Unix glob patterns like \fB*\fR, \fB?\fR and \fB[]\fR\&. However, to avoid your +shell accidentally expanding glob patterns before Cargo handles them, you must +use single quotes or double quotes around each glob pattern. +.sp +\fB\-\-lib\fR +.RS 4 +Build the package\[cq]s library. +.RE +.sp +\fB\-\-bin\fR \fIname\fR\[u2026] +.RS 4 +Build the specified binary. This flag may be specified multiple times +and supports common Unix glob patterns. +.RE +.sp +\fB\-\-bins\fR +.RS 4 +Build all binary targets. +.RE +.sp +\fB\-\-example\fR \fIname\fR\[u2026] +.RS 4 +Build the specified example. This flag may be specified multiple times +and supports common Unix glob patterns. +.RE +.sp +\fB\-\-examples\fR +.RS 4 +Build all example targets. +.RE +.sp +\fB\-\-test\fR \fIname\fR\[u2026] +.RS 4 +Build the specified integration test. This flag may be specified +multiple times and supports common Unix glob patterns. +.RE +.sp +\fB\-\-tests\fR +.RS 4 +Build all targets that have the \fBtest = true\fR manifest +flag set. By default this includes the library and binaries built as +unittests, and integration tests. Be aware that this will also build any +required dependencies, so the lib target may be built twice (once as a +unittest, and once as a dependency for binaries, integration tests, etc.). +Targets may be enabled or disabled by setting the \fBtest\fR flag in the +manifest settings for the target. +.RE +.sp +\fB\-\-bench\fR \fIname\fR\[u2026] +.RS 4 +Build the specified benchmark. This flag may be specified multiple +times and supports common Unix glob patterns. +.RE +.sp +\fB\-\-benches\fR +.RS 4 +Build all targets that have the \fBbench = true\fR +manifest flag set. By default this includes the library and binaries built +as benchmarks, and bench targets. Be aware that this will also build any +required dependencies, so the lib target may be built twice (once as a +benchmark, and once as a dependency for binaries, benchmarks, etc.). +Targets may be enabled or disabled by setting the \fBbench\fR flag in the +manifest settings for the target. +.RE +.sp +\fB\-\-all\-targets\fR +.RS 4 +Build all targets. This is equivalent to specifying \fB\-\-lib \-\-bins \-\-tests \-\-benches \-\-examples\fR\&. +.RE +.SS "Feature Selection" +The feature flags allow you to control which features are enabled. When no +feature options are given, the \fBdefault\fR feature is activated for every +selected package. +.sp +See \fIthe features documentation\fR +for more details. +.sp +\fB\-F\fR \fIfeatures\fR, +\fB\-\-features\fR \fIfeatures\fR +.RS 4 +Space or comma separated list of features to activate. Features of workspace +members may be enabled with \fBpackage\-name/feature\-name\fR syntax. This flag may +be specified multiple times, which enables all specified features. +.RE +.sp +\fB\-\-all\-features\fR +.RS 4 +Activate all available features of all selected packages. +.RE +.sp +\fB\-\-no\-default\-features\fR +.RS 4 +Do not activate the \fBdefault\fR feature of the selected packages. +.RE +.SS "Compilation Options" +.sp +\fB\-\-target\fR \fItriple\fR +.RS 4 +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 +\fB\-\-\-\fR\&. +.sp +Possible values: +.sp +.RS 4 +\h'-04'\(bu\h'+03'Any supported target in \fBrustc \-\-print target\-list\fR\&. +.RE +.sp +.RS 4 +\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). +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'A path to a custom target specification. See \fICustom Target Lookup Path\fR for more information. +.RE +.sp +This may also be specified with the \fBbuild.target\fR \fIconfig value\fR \&. +.sp +Note that specifying this flag makes Cargo run in a different mode where the +target artifacts are placed in a separate directory. See the +\fIbuild cache\fR documentation for more details. +.RE +.sp +\fB\-r\fR, +\fB\-\-release\fR +.RS 4 +Build optimized artifacts with the \fBrelease\fR profile. +See also the \fB\-\-profile\fR option for choosing a specific profile by name. +.RE +.sp +\fB\-\-profile\fR \fIname\fR +.RS 4 +Build with the given profile. +See \fIthe reference\fR for more details on profiles. +.RE +.sp +\fB\-\-timings\fR +.RS 4 +Output information how long each compilation takes, and track concurrency +information over time. +.sp +A file \fBcargo\-timing.html\fR will be written to the \fBtarget/cargo\-timings\fR +directory at the end of the build. An additional report with a timestamp +in its filename is also written if you want to look at a previous run. +These reports are suitable for human consumption only, and do not provide +machine\-readable timing data. +.RE +.SS "Output Options" +.sp +\fB\-\-target\-dir\fR \fIdirectory\fR +.RS 4 +Directory for all generated artifacts and intermediate files. May also be +specified with the \fBCARGO_TARGET_DIR\fR environment variable, or the +\fBbuild.target\-dir\fR \fIconfig value\fR \&. +Defaults to \fBtarget\fR in the root of the workspace. +.RE +.sp +\fB\-\-artifact\-dir\fR \fIdirectory\fR +.RS 4 +Copy final artifacts to this directory. +.sp +This option is unstable and available only on the +\fInightly channel\fR +and requires the \fB\-Z unstable\-options\fR flag to enable. +See for more information. +.RE +.SS "Display Options" +.sp +\fB\-v\fR, +\fB\-\-verbose\fR +.RS 4 +Use verbose output. May be specified twice for \[lq]very verbose\[rq] output which +includes extra output such as dependency warnings and build script output. +May also be specified with the \fBterm.verbose\fR +\fIconfig value\fR \&. +.RE +.sp +\fB\-q\fR, +\fB\-\-quiet\fR +.RS 4 +Do not print cargo log messages. +May also be specified with the \fBterm.quiet\fR +\fIconfig value\fR \&. +.RE +.sp +\fB\-\-color\fR \fIwhen\fR +.RS 4 +Control when colored output is used. Valid values: +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBauto\fR (default): Automatically detect if color support is available on the +terminal. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBalways\fR: Always display colors. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBnever\fR: Never display colors. +.RE +.sp +May also be specified with the \fBterm.color\fR +\fIconfig value\fR \&. +.RE +.sp +\fB\-\-message\-format\fR \fIfmt\fR +.RS 4 +The output format for diagnostic messages. Can be specified multiple times +and consists of comma\-separated values. Valid values: +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBhuman\fR (default): Display in a human\-readable text format. Conflicts with +\fBshort\fR and \fBjson\fR\&. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBshort\fR: Emit shorter, human\-readable text messages. Conflicts with \fBhuman\fR +and \fBjson\fR\&. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBjson\fR: Emit JSON messages to stdout. See +\fIthe reference\fR +for more details. Conflicts with \fBhuman\fR and \fBshort\fR\&. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBjson\-diagnostic\-short\fR: Ensure the \fBrendered\fR field of JSON messages contains +the \[lq]short\[rq] rendering from rustc. Cannot be used with \fBhuman\fR or \fBshort\fR\&. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBjson\-diagnostic\-rendered\-ansi\fR: Ensure the \fBrendered\fR field of JSON messages +contains embedded ANSI color codes for respecting rustc\[cq]s default color +scheme. Cannot be used with \fBhuman\fR or \fBshort\fR\&. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBjson\-render\-diagnostics\fR: Instruct Cargo to not include rustc diagnostics +in JSON messages printed, but instead Cargo itself should render the +JSON diagnostics coming from rustc. Cargo\[cq]s own JSON diagnostics and others +coming from rustc are still emitted. Cannot be used with \fBhuman\fR or \fBshort\fR\&. +.RE +.RE +.SS "Manifest Options" +.sp +\fB\-\-manifest\-path\fR \fIpath\fR +.RS 4 +Path to the \fBCargo.toml\fR file. By default, Cargo searches for the +\fBCargo.toml\fR file in the current directory or any parent directory. +.RE +.sp +\fB\-\-ignore\-rust\-version\fR +.RS 4 +Ignore \fBrust\-version\fR specification in packages. +.RE +.sp +\fB\-\-locked\fR +.RS 4 +Asserts that the exact same dependencies and versions are used as when the +existing \fBCargo.lock\fR file was originally generated. Cargo will exit with an +error when either of the following scenarios arises: +.sp +.RS 4 +\h'-04'\(bu\h'+03'The lock file is missing. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'Cargo attempted to change the lock file due to a different dependency resolution. +.RE +.sp +It may be used in environments where deterministic builds are desired, +such as in CI pipelines. +.RE +.sp +\fB\-\-offline\fR +.RS 4 +Prevents Cargo from accessing the network for any reason. Without this +flag, Cargo will stop with an error if it needs to access the network and +the network is not available. With this flag, Cargo will attempt to +proceed without the network if possible. +.sp +Beware that this may result in different dependency resolution than online +mode. Cargo will restrict itself to crates that are downloaded locally, even +if there might be a newer version as indicated in the local copy of the index. +See the \fBcargo\-fetch\fR(1) command to download dependencies before going +offline. +.sp +May also be specified with the \fBnet.offline\fR \fIconfig value\fR \&. +.RE +.sp +\fB\-\-frozen\fR +.RS 4 +Equivalent to specifying both \fB\-\-locked\fR and \fB\-\-offline\fR\&. +.RE +.SS "Common Options" +.sp +\fB+\fR\fItoolchain\fR +.RS 4 +If Cargo has been installed with rustup, and the first argument to \fBcargo\fR +begins with \fB+\fR, it will be interpreted as a rustup toolchain name (such +as \fB+stable\fR or \fB+nightly\fR). +See the \fIrustup documentation\fR +for more information about how toolchain overrides work. +.RE +.sp +\fB\-\-config\fR \fIKEY=VALUE\fR or \fIPATH\fR +.RS 4 +Overrides a Cargo configuration value. The argument should be in TOML syntax of \fBKEY=VALUE\fR, +or provided as a path to an extra configuration file. This flag may be specified multiple times. +See the \fIcommand\-line overrides section\fR for more information. +.RE +.sp +\fB\-C\fR \fIPATH\fR +.RS 4 +Changes the current working directory before executing any specified operations. This affects +things like where cargo looks by default for the project manifest (\fBCargo.toml\fR), as well as +the directories searched for discovering \fB\&.cargo/config.toml\fR, for example. This option must +appear before the command name, for example \fBcargo \-C path/to/my\-project build\fR\&. +.sp +This option is only available on the \fInightly +channel\fR and +requires the \fB\-Z unstable\-options\fR flag to enable (see +\fI#10098\fR ). +.RE +.sp +\fB\-h\fR, +\fB\-\-help\fR +.RS 4 +Prints help information. +.RE +.sp +\fB\-Z\fR \fIflag\fR +.RS 4 +Unstable (nightly\-only) flags to Cargo. Run \fBcargo \-Z help\fR for details. +.RE +.SS "Miscellaneous Options" +.sp +\fB\-j\fR \fIN\fR, +\fB\-\-jobs\fR \fIN\fR +.RS 4 +Number of parallel jobs to run. May also be specified with the +\fBbuild.jobs\fR \fIconfig value\fR \&. Defaults to +the number of logical CPUs. If negative, it sets the maximum number of +parallel jobs to the number of logical CPUs plus provided value. If +a string \fBdefault\fR is provided, it sets the value back to defaults. +Should not be 0. +.RE +.sp +\fB\-\-keep\-going\fR +.RS 4 +Build as many crates in the dependency graph as possible, rather than aborting +the build on the first one that fails to build. +.sp +For example if the current package depends on dependencies \fBfails\fR and \fBworks\fR, +one of which fails to build, \fBcargo build \-j1\fR may or may not build the +one that succeeds (depending on which one of the two builds Cargo picked to run +first), whereas \fBcargo build \-j1 \-\-keep\-going\fR would definitely run both +builds, even if the one run first fails. +.RE +.sp +\fB\-\-future\-incompat\-report\fR +.RS 4 +Displays a future\-incompat report for any future\-incompatible warnings +produced during execution of this command +.sp +See \fBcargo\-report\fR(1) +.RE +.SH "ENVIRONMENT" +See \fIthe reference\fR for +details on environment variables that Cargo reads. +.SH "EXIT STATUS" +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fB0\fR: Cargo succeeded. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fB101\fR: Cargo failed to complete. +.RE +.SH "EXAMPLES" +.sp +.RS 4 +\h'-04' 1.\h'+01'Build the local package and all of its dependencies: +.sp +.RS 4 +.nf +cargo build +.fi +.RE +.RE +.sp +.RS 4 +\h'-04' 2.\h'+01'Build with optimizations: +.sp +.RS 4 +.nf +cargo build \-\-release +.fi +.RE +.RE +.SH "SEE ALSO" +\fBcargo\fR(1), \fBcargo\-rustc\fR(1) diff --git a/rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-check.1 b/rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-check.1 new file mode 100644 index 0000000000000000000000000000000000000000..e5c1d2f090cd42a24abd648a410cfc07a2c6d9ee --- /dev/null +++ b/rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-check.1 @@ -0,0 +1,465 @@ +'\" t +.TH "CARGO\-CHECK" "1" +.nh +.ad l +.ss \n[.ss] 0 +.SH "NAME" +cargo\-check \[em] Check the current package +.SH "SYNOPSIS" +\fBcargo check\fR [\fIoptions\fR] +.SH "DESCRIPTION" +Check a local package and all of its dependencies for errors. This will +essentially compile the packages without performing the final step of code +generation, which is faster than running \fBcargo build\fR\&. The compiler will save +metadata files to disk so that future runs will reuse them if the source has +not been modified. Some diagnostics and errors are only emitted during code +generation, so they inherently won\[cq]t be reported with \fBcargo check\fR\&. +.SH "OPTIONS" +.SS "Package Selection" +By default, when no package selection options are given, the packages selected +depend on the selected manifest file (based on the current working directory if +\fB\-\-manifest\-path\fR is not given). If the manifest is the root of a workspace then +the workspaces default members are selected, otherwise only the package defined +by the manifest will be selected. +.sp +The default members of a workspace can be set explicitly with the +\fBworkspace.default\-members\fR key in the root manifest. If this is not set, a +virtual workspace will include all workspace members (equivalent to passing +\fB\-\-workspace\fR), and a non\-virtual workspace will include only the root crate itself. +.sp +\fB\-p\fR \fIspec\fR\[u2026], +\fB\-\-package\fR \fIspec\fR\[u2026] +.RS 4 +Check only the specified packages. See \fBcargo\-pkgid\fR(1) for the +SPEC format. This flag may be specified multiple times and supports common Unix +glob patterns like \fB*\fR, \fB?\fR and \fB[]\fR\&. However, to avoid your shell accidentally +expanding glob patterns before Cargo handles them, you must use single quotes or +double quotes around each pattern. +.RE +.sp +\fB\-\-workspace\fR +.RS 4 +Check all members in the workspace. +.RE +.sp +\fB\-\-all\fR +.RS 4 +Deprecated alias for \fB\-\-workspace\fR\&. +.RE +.sp +\fB\-\-exclude\fR \fISPEC\fR\[u2026] +.RS 4 +Exclude the specified packages. Must be used in conjunction with the +\fB\-\-workspace\fR flag. This flag may be specified multiple times and supports +common Unix glob patterns like \fB*\fR, \fB?\fR and \fB[]\fR\&. However, to avoid your shell +accidentally expanding glob patterns before Cargo handles them, you must use +single quotes or double quotes around each pattern. +.RE +.SS "Target Selection" +When no target selection options are given, \fBcargo check\fR will check all +binary and library targets of the selected packages. Binaries are skipped if +they have \fBrequired\-features\fR that are missing. +.sp +Passing target selection flags will check only the specified +targets. +.sp +Note that \fB\-\-bin\fR, \fB\-\-example\fR, \fB\-\-test\fR and \fB\-\-bench\fR flags also +support common Unix glob patterns like \fB*\fR, \fB?\fR and \fB[]\fR\&. However, to avoid your +shell accidentally expanding glob patterns before Cargo handles them, you must +use single quotes or double quotes around each glob pattern. +.sp +\fB\-\-lib\fR +.RS 4 +Check the package\[cq]s library. +.RE +.sp +\fB\-\-bin\fR \fIname\fR\[u2026] +.RS 4 +Check the specified binary. This flag may be specified multiple times +and supports common Unix glob patterns. +.RE +.sp +\fB\-\-bins\fR +.RS 4 +Check all binary targets. +.RE +.sp +\fB\-\-example\fR \fIname\fR\[u2026] +.RS 4 +Check the specified example. This flag may be specified multiple times +and supports common Unix glob patterns. +.RE +.sp +\fB\-\-examples\fR +.RS 4 +Check all example targets. +.RE +.sp +\fB\-\-test\fR \fIname\fR\[u2026] +.RS 4 +Check the specified integration test. This flag may be specified +multiple times and supports common Unix glob patterns. +.RE +.sp +\fB\-\-tests\fR +.RS 4 +Check all targets that have the \fBtest = true\fR manifest +flag set. By default this includes the library and binaries built as +unittests, and integration tests. Be aware that this will also build any +required dependencies, so the lib target may be built twice (once as a +unittest, and once as a dependency for binaries, integration tests, etc.). +Targets may be enabled or disabled by setting the \fBtest\fR flag in the +manifest settings for the target. +.RE +.sp +\fB\-\-bench\fR \fIname\fR\[u2026] +.RS 4 +Check the specified benchmark. This flag may be specified multiple +times and supports common Unix glob patterns. +.RE +.sp +\fB\-\-benches\fR +.RS 4 +Check all targets that have the \fBbench = true\fR +manifest flag set. By default this includes the library and binaries built +as benchmarks, and bench targets. Be aware that this will also build any +required dependencies, so the lib target may be built twice (once as a +benchmark, and once as a dependency for binaries, benchmarks, etc.). +Targets may be enabled or disabled by setting the \fBbench\fR flag in the +manifest settings for the target. +.RE +.sp +\fB\-\-all\-targets\fR +.RS 4 +Check all targets. This is equivalent to specifying \fB\-\-lib \-\-bins \-\-tests \-\-benches \-\-examples\fR\&. +.RE +.SS "Feature Selection" +The feature flags allow you to control which features are enabled. When no +feature options are given, the \fBdefault\fR feature is activated for every +selected package. +.sp +See \fIthe features documentation\fR +for more details. +.sp +\fB\-F\fR \fIfeatures\fR, +\fB\-\-features\fR \fIfeatures\fR +.RS 4 +Space or comma separated list of features to activate. Features of workspace +members may be enabled with \fBpackage\-name/feature\-name\fR syntax. This flag may +be specified multiple times, which enables all specified features. +.RE +.sp +\fB\-\-all\-features\fR +.RS 4 +Activate all available features of all selected packages. +.RE +.sp +\fB\-\-no\-default\-features\fR +.RS 4 +Do not activate the \fBdefault\fR feature of the selected packages. +.RE +.SS "Compilation Options" +.sp +\fB\-\-target\fR \fItriple\fR +.RS 4 +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 +\fB\-\-\-\fR\&. +.sp +Possible values: +.sp +.RS 4 +\h'-04'\(bu\h'+03'Any supported target in \fBrustc \-\-print target\-list\fR\&. +.RE +.sp +.RS 4 +\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). +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'A path to a custom target specification. See \fICustom Target Lookup Path\fR for more information. +.RE +.sp +This may also be specified with the \fBbuild.target\fR \fIconfig value\fR \&. +.sp +Note that specifying this flag makes Cargo run in a different mode where the +target artifacts are placed in a separate directory. See the +\fIbuild cache\fR documentation for more details. +.RE +.sp +\fB\-r\fR, +\fB\-\-release\fR +.RS 4 +Check optimized artifacts with the \fBrelease\fR profile. +See also the \fB\-\-profile\fR option for choosing a specific profile by name. +.RE +.sp +\fB\-\-profile\fR \fIname\fR +.RS 4 +Check with the given profile. +.sp +As a special case, specifying the \fBtest\fR profile will also enable checking in +test mode which will enable checking tests and enable the \fBtest\fR cfg option. +See \fIrustc tests\fR for more +detail. +.sp +See \fIthe reference\fR for more details on profiles. +.RE +.sp +\fB\-\-timings\fR +.RS 4 +Output information how long each compilation takes, and track concurrency +information over time. +.sp +A file \fBcargo\-timing.html\fR will be written to the \fBtarget/cargo\-timings\fR +directory at the end of the build. An additional report with a timestamp +in its filename is also written if you want to look at a previous run. +These reports are suitable for human consumption only, and do not provide +machine\-readable timing data. +.RE +.SS "Output Options" +.sp +\fB\-\-target\-dir\fR \fIdirectory\fR +.RS 4 +Directory for all generated artifacts and intermediate files. May also be +specified with the \fBCARGO_TARGET_DIR\fR environment variable, or the +\fBbuild.target\-dir\fR \fIconfig value\fR \&. +Defaults to \fBtarget\fR in the root of the workspace. +.RE +.SS "Display Options" +.sp +\fB\-v\fR, +\fB\-\-verbose\fR +.RS 4 +Use verbose output. May be specified twice for \[lq]very verbose\[rq] output which +includes extra output such as dependency warnings and build script output. +May also be specified with the \fBterm.verbose\fR +\fIconfig value\fR \&. +.RE +.sp +\fB\-q\fR, +\fB\-\-quiet\fR +.RS 4 +Do not print cargo log messages. +May also be specified with the \fBterm.quiet\fR +\fIconfig value\fR \&. +.RE +.sp +\fB\-\-color\fR \fIwhen\fR +.RS 4 +Control when colored output is used. Valid values: +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBauto\fR (default): Automatically detect if color support is available on the +terminal. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBalways\fR: Always display colors. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBnever\fR: Never display colors. +.RE +.sp +May also be specified with the \fBterm.color\fR +\fIconfig value\fR \&. +.RE +.sp +\fB\-\-message\-format\fR \fIfmt\fR +.RS 4 +The output format for diagnostic messages. Can be specified multiple times +and consists of comma\-separated values. Valid values: +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBhuman\fR (default): Display in a human\-readable text format. Conflicts with +\fBshort\fR and \fBjson\fR\&. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBshort\fR: Emit shorter, human\-readable text messages. Conflicts with \fBhuman\fR +and \fBjson\fR\&. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBjson\fR: Emit JSON messages to stdout. See +\fIthe reference\fR +for more details. Conflicts with \fBhuman\fR and \fBshort\fR\&. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBjson\-diagnostic\-short\fR: Ensure the \fBrendered\fR field of JSON messages contains +the \[lq]short\[rq] rendering from rustc. Cannot be used with \fBhuman\fR or \fBshort\fR\&. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBjson\-diagnostic\-rendered\-ansi\fR: Ensure the \fBrendered\fR field of JSON messages +contains embedded ANSI color codes for respecting rustc\[cq]s default color +scheme. Cannot be used with \fBhuman\fR or \fBshort\fR\&. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBjson\-render\-diagnostics\fR: Instruct Cargo to not include rustc diagnostics +in JSON messages printed, but instead Cargo itself should render the +JSON diagnostics coming from rustc. Cargo\[cq]s own JSON diagnostics and others +coming from rustc are still emitted. Cannot be used with \fBhuman\fR or \fBshort\fR\&. +.RE +.RE +.SS "Manifest Options" +.sp +\fB\-\-manifest\-path\fR \fIpath\fR +.RS 4 +Path to the \fBCargo.toml\fR file. By default, Cargo searches for the +\fBCargo.toml\fR file in the current directory or any parent directory. +.RE +.sp +\fB\-\-ignore\-rust\-version\fR +.RS 4 +Ignore \fBrust\-version\fR specification in packages. +.RE +.sp +\fB\-\-locked\fR +.RS 4 +Asserts that the exact same dependencies and versions are used as when the +existing \fBCargo.lock\fR file was originally generated. Cargo will exit with an +error when either of the following scenarios arises: +.sp +.RS 4 +\h'-04'\(bu\h'+03'The lock file is missing. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'Cargo attempted to change the lock file due to a different dependency resolution. +.RE +.sp +It may be used in environments where deterministic builds are desired, +such as in CI pipelines. +.RE +.sp +\fB\-\-offline\fR +.RS 4 +Prevents Cargo from accessing the network for any reason. Without this +flag, Cargo will stop with an error if it needs to access the network and +the network is not available. With this flag, Cargo will attempt to +proceed without the network if possible. +.sp +Beware that this may result in different dependency resolution than online +mode. Cargo will restrict itself to crates that are downloaded locally, even +if there might be a newer version as indicated in the local copy of the index. +See the \fBcargo\-fetch\fR(1) command to download dependencies before going +offline. +.sp +May also be specified with the \fBnet.offline\fR \fIconfig value\fR \&. +.RE +.sp +\fB\-\-frozen\fR +.RS 4 +Equivalent to specifying both \fB\-\-locked\fR and \fB\-\-offline\fR\&. +.RE +.SS "Common Options" +.sp +\fB+\fR\fItoolchain\fR +.RS 4 +If Cargo has been installed with rustup, and the first argument to \fBcargo\fR +begins with \fB+\fR, it will be interpreted as a rustup toolchain name (such +as \fB+stable\fR or \fB+nightly\fR). +See the \fIrustup documentation\fR +for more information about how toolchain overrides work. +.RE +.sp +\fB\-\-config\fR \fIKEY=VALUE\fR or \fIPATH\fR +.RS 4 +Overrides a Cargo configuration value. The argument should be in TOML syntax of \fBKEY=VALUE\fR, +or provided as a path to an extra configuration file. This flag may be specified multiple times. +See the \fIcommand\-line overrides section\fR for more information. +.RE +.sp +\fB\-C\fR \fIPATH\fR +.RS 4 +Changes the current working directory before executing any specified operations. This affects +things like where cargo looks by default for the project manifest (\fBCargo.toml\fR), as well as +the directories searched for discovering \fB\&.cargo/config.toml\fR, for example. This option must +appear before the command name, for example \fBcargo \-C path/to/my\-project build\fR\&. +.sp +This option is only available on the \fInightly +channel\fR and +requires the \fB\-Z unstable\-options\fR flag to enable (see +\fI#10098\fR ). +.RE +.sp +\fB\-h\fR, +\fB\-\-help\fR +.RS 4 +Prints help information. +.RE +.sp +\fB\-Z\fR \fIflag\fR +.RS 4 +Unstable (nightly\-only) flags to Cargo. Run \fBcargo \-Z help\fR for details. +.RE +.SS "Miscellaneous Options" +.sp +\fB\-j\fR \fIN\fR, +\fB\-\-jobs\fR \fIN\fR +.RS 4 +Number of parallel jobs to run. May also be specified with the +\fBbuild.jobs\fR \fIconfig value\fR \&. Defaults to +the number of logical CPUs. If negative, it sets the maximum number of +parallel jobs to the number of logical CPUs plus provided value. If +a string \fBdefault\fR is provided, it sets the value back to defaults. +Should not be 0. +.RE +.sp +\fB\-\-keep\-going\fR +.RS 4 +Build as many crates in the dependency graph as possible, rather than aborting +the build on the first one that fails to build. +.sp +For example if the current package depends on dependencies \fBfails\fR and \fBworks\fR, +one of which fails to build, \fBcargo check \-j1\fR may or may not build the +one that succeeds (depending on which one of the two builds Cargo picked to run +first), whereas \fBcargo check \-j1 \-\-keep\-going\fR would definitely run both +builds, even if the one run first fails. +.RE +.sp +\fB\-\-future\-incompat\-report\fR +.RS 4 +Displays a future\-incompat report for any future\-incompatible warnings +produced during execution of this command +.sp +See \fBcargo\-report\fR(1) +.RE +.SH "ENVIRONMENT" +See \fIthe reference\fR for +details on environment variables that Cargo reads. +.SH "EXIT STATUS" +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fB0\fR: Cargo succeeded. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fB101\fR: Cargo failed to complete. +.RE +.SH "EXAMPLES" +.sp +.RS 4 +\h'-04' 1.\h'+01'Check the local package for errors: +.sp +.RS 4 +.nf +cargo check +.fi +.RE +.RE +.sp +.RS 4 +\h'-04' 2.\h'+01'Check all targets, including unit tests: +.sp +.RS 4 +.nf +cargo check \-\-all\-targets \-\-profile=test +.fi +.RE +.RE +.SH "SEE ALSO" +\fBcargo\fR(1), \fBcargo\-build\fR(1) diff --git a/rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-clean.1 b/rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-clean.1 new file mode 100644 index 0000000000000000000000000000000000000000..bbdebd3c8afe9ba5ee19c366d8daeab16dfed5f0 --- /dev/null +++ b/rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-clean.1 @@ -0,0 +1,248 @@ +'\" t +.TH "CARGO\-CLEAN" "1" +.nh +.ad l +.ss \n[.ss] 0 +.SH "NAME" +cargo\-clean \[em] Remove generated artifacts +.SH "SYNOPSIS" +\fBcargo clean\fR [\fIoptions\fR] +.SH "DESCRIPTION" +Remove artifacts from the target directory that Cargo has generated in the +past. +.sp +With no options, \fBcargo clean\fR will delete the entire target directory. +.SH "OPTIONS" +.SS "Package Selection" +When no packages are selected, all packages and all dependencies in the +workspace are cleaned. +.sp +\fB\-p\fR \fIspec\fR\[u2026], +\fB\-\-package\fR \fIspec\fR\[u2026] +.RS 4 +Clean only the specified packages. This flag may be specified +multiple times. See \fBcargo\-pkgid\fR(1) for the SPEC format. +.RE +.sp +\fB\-\-workspace\fR +.RS 4 +Clean artifacts of the workspace members. +.RE +.SS "Clean Options" +.sp +\fB\-\-dry\-run\fR +.RS 4 +Displays a summary of what would be deleted without deleting anything. +Use with \fB\-\-verbose\fR to display the actual files that would be deleted. +.RE +.sp +\fB\-\-doc\fR +.RS 4 +This option will cause \fBcargo clean\fR to remove only the \fBdoc\fR directory in +the target directory. +.RE +.sp +\fB\-\-release\fR +.RS 4 +Remove all artifacts in the \fBrelease\fR directory. +.RE +.sp +\fB\-\-profile\fR \fIname\fR +.RS 4 +Remove all artifacts in the directory with the given profile name. +.RE +.sp +\fB\-\-target\-dir\fR \fIdirectory\fR +.RS 4 +Directory for all generated artifacts and intermediate files. May also be +specified with the \fBCARGO_TARGET_DIR\fR environment variable, or the +\fBbuild.target\-dir\fR \fIconfig value\fR \&. +Defaults to \fBtarget\fR in the root of the workspace. +.RE +.sp +\fB\-\-target\fR \fItriple\fR +.RS 4 +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 +\fB\-\-\-\fR\&. +.sp +Possible values: +.sp +.RS 4 +\h'-04'\(bu\h'+03'Any supported target in \fBrustc \-\-print target\-list\fR\&. +.RE +.sp +.RS 4 +\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). +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'A path to a custom target specification. See \fICustom Target Lookup Path\fR for more information. +.RE +.sp +This may also be specified with the \fBbuild.target\fR \fIconfig value\fR \&. +.sp +Note that specifying this flag makes Cargo run in a different mode where the +target artifacts are placed in a separate directory. See the +\fIbuild cache\fR documentation for more details. +.RE +.SS "Display Options" +.sp +\fB\-v\fR, +\fB\-\-verbose\fR +.RS 4 +Use verbose output. May be specified twice for \[lq]very verbose\[rq] output which +includes extra output such as dependency warnings and build script output. +May also be specified with the \fBterm.verbose\fR +\fIconfig value\fR \&. +.RE +.sp +\fB\-q\fR, +\fB\-\-quiet\fR +.RS 4 +Do not print cargo log messages. +May also be specified with the \fBterm.quiet\fR +\fIconfig value\fR \&. +.RE +.sp +\fB\-\-color\fR \fIwhen\fR +.RS 4 +Control when colored output is used. Valid values: +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBauto\fR (default): Automatically detect if color support is available on the +terminal. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBalways\fR: Always display colors. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBnever\fR: Never display colors. +.RE +.sp +May also be specified with the \fBterm.color\fR +\fIconfig value\fR \&. +.RE +.SS "Manifest Options" +.sp +\fB\-\-manifest\-path\fR \fIpath\fR +.RS 4 +Path to the \fBCargo.toml\fR file. By default, Cargo searches for the +\fBCargo.toml\fR file in the current directory or any parent directory. +.RE +.sp +\fB\-\-locked\fR +.RS 4 +Asserts that the exact same dependencies and versions are used as when the +existing \fBCargo.lock\fR file was originally generated. Cargo will exit with an +error when either of the following scenarios arises: +.sp +.RS 4 +\h'-04'\(bu\h'+03'The lock file is missing. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'Cargo attempted to change the lock file due to a different dependency resolution. +.RE +.sp +It may be used in environments where deterministic builds are desired, +such as in CI pipelines. +.RE +.sp +\fB\-\-offline\fR +.RS 4 +Prevents Cargo from accessing the network for any reason. Without this +flag, Cargo will stop with an error if it needs to access the network and +the network is not available. With this flag, Cargo will attempt to +proceed without the network if possible. +.sp +Beware that this may result in different dependency resolution than online +mode. Cargo will restrict itself to crates that are downloaded locally, even +if there might be a newer version as indicated in the local copy of the index. +See the \fBcargo\-fetch\fR(1) command to download dependencies before going +offline. +.sp +May also be specified with the \fBnet.offline\fR \fIconfig value\fR \&. +.RE +.sp +\fB\-\-frozen\fR +.RS 4 +Equivalent to specifying both \fB\-\-locked\fR and \fB\-\-offline\fR\&. +.RE +.SS "Common Options" +.sp +\fB+\fR\fItoolchain\fR +.RS 4 +If Cargo has been installed with rustup, and the first argument to \fBcargo\fR +begins with \fB+\fR, it will be interpreted as a rustup toolchain name (such +as \fB+stable\fR or \fB+nightly\fR). +See the \fIrustup documentation\fR +for more information about how toolchain overrides work. +.RE +.sp +\fB\-\-config\fR \fIKEY=VALUE\fR or \fIPATH\fR +.RS 4 +Overrides a Cargo configuration value. The argument should be in TOML syntax of \fBKEY=VALUE\fR, +or provided as a path to an extra configuration file. This flag may be specified multiple times. +See the \fIcommand\-line overrides section\fR for more information. +.RE +.sp +\fB\-C\fR \fIPATH\fR +.RS 4 +Changes the current working directory before executing any specified operations. This affects +things like where cargo looks by default for the project manifest (\fBCargo.toml\fR), as well as +the directories searched for discovering \fB\&.cargo/config.toml\fR, for example. This option must +appear before the command name, for example \fBcargo \-C path/to/my\-project build\fR\&. +.sp +This option is only available on the \fInightly +channel\fR and +requires the \fB\-Z unstable\-options\fR flag to enable (see +\fI#10098\fR ). +.RE +.sp +\fB\-h\fR, +\fB\-\-help\fR +.RS 4 +Prints help information. +.RE +.sp +\fB\-Z\fR \fIflag\fR +.RS 4 +Unstable (nightly\-only) flags to Cargo. Run \fBcargo \-Z help\fR for details. +.RE +.SH "ENVIRONMENT" +See \fIthe reference\fR for +details on environment variables that Cargo reads. +.SH "EXIT STATUS" +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fB0\fR: Cargo succeeded. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fB101\fR: Cargo failed to complete. +.RE +.SH "EXAMPLES" +.sp +.RS 4 +\h'-04' 1.\h'+01'Remove the entire target directory: +.sp +.RS 4 +.nf +cargo clean +.fi +.RE +.RE +.sp +.RS 4 +\h'-04' 2.\h'+01'Remove only the release artifacts: +.sp +.RS 4 +.nf +cargo clean \-\-release +.fi +.RE +.RE +.SH "SEE ALSO" +\fBcargo\fR(1), \fBcargo\-build\fR(1) diff --git a/rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-doc.1 b/rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-doc.1 new file mode 100644 index 0000000000000000000000000000000000000000..891fe20f890cb433057cf186f3e9ea70635f0c8d --- /dev/null +++ b/rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-doc.1 @@ -0,0 +1,417 @@ +'\" t +.TH "CARGO\-DOC" "1" +.nh +.ad l +.ss \n[.ss] 0 +.SH "NAME" +cargo\-doc \[em] Build a package\[cq]s documentation +.SH "SYNOPSIS" +\fBcargo doc\fR [\fIoptions\fR] +.SH "DESCRIPTION" +Build the documentation for the local package and all dependencies. The output +is placed in \fBtarget/doc\fR in rustdoc\[cq]s usual format. +.sp +\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). +.SH "OPTIONS" +.SS "Documentation Options" +.sp +\fB\-\-open\fR +.RS 4 +Open the docs in a browser after building them. This will use your default +browser unless you define another one in the \fBBROWSER\fR environment variable +or use the \fI\f(BIdoc.browser\fI\fR configuration +option. +.RE +.sp +\fB\-\-no\-deps\fR +.RS 4 +Do not build documentation for dependencies. +.RE +.sp +\fB\-\-document\-private\-items\fR +.RS 4 +Include non\-public items in the documentation. This will be enabled by default if documenting a binary target. +.RE +.SS "Package Selection" +By default, when no package selection options are given, the packages selected +depend on the selected manifest file (based on the current working directory if +\fB\-\-manifest\-path\fR is not given). If the manifest is the root of a workspace then +the workspaces default members are selected, otherwise only the package defined +by the manifest will be selected. +.sp +The default members of a workspace can be set explicitly with the +\fBworkspace.default\-members\fR key in the root manifest. If this is not set, a +virtual workspace will include all workspace members (equivalent to passing +\fB\-\-workspace\fR), and a non\-virtual workspace will include only the root crate itself. +.sp +\fB\-p\fR \fIspec\fR\[u2026], +\fB\-\-package\fR \fIspec\fR\[u2026] +.RS 4 +Document only the specified packages. See \fBcargo\-pkgid\fR(1) for the +SPEC format. This flag may be specified multiple times and supports common Unix +glob patterns like \fB*\fR, \fB?\fR and \fB[]\fR\&. However, to avoid your shell accidentally +expanding glob patterns before Cargo handles them, you must use single quotes or +double quotes around each pattern. +.RE +.sp +\fB\-\-workspace\fR +.RS 4 +Document all members in the workspace. +.RE +.sp +\fB\-\-all\fR +.RS 4 +Deprecated alias for \fB\-\-workspace\fR\&. +.RE +.sp +\fB\-\-exclude\fR \fISPEC\fR\[u2026] +.RS 4 +Exclude the specified packages. Must be used in conjunction with the +\fB\-\-workspace\fR flag. This flag may be specified multiple times and supports +common Unix glob patterns like \fB*\fR, \fB?\fR and \fB[]\fR\&. However, to avoid your shell +accidentally expanding glob patterns before Cargo handles them, you must use +single quotes or double quotes around each pattern. +.RE +.SS "Target Selection" +When no target selection options are given, \fBcargo doc\fR will document all +binary and library targets of the selected package. The binary will be skipped +if its name is the same as the lib target. Binaries are skipped if they have +\fBrequired\-features\fR that are missing. +.sp +The default behavior can be changed by setting \fBdoc = false\fR for the target in +the manifest settings. Using target selection options will ignore the \fBdoc\fR +flag and will always document the given target. +.sp +\fB\-\-lib\fR +.RS 4 +Document the package\[cq]s library. +.RE +.sp +\fB\-\-bin\fR \fIname\fR\[u2026] +.RS 4 +Document the specified binary. This flag may be specified multiple times +and supports common Unix glob patterns. +.RE +.sp +\fB\-\-bins\fR +.RS 4 +Document all binary targets. +.RE +.sp +\fB\-\-example\fR \fIname\fR\[u2026] +.RS 4 +Document the specified example. This flag may be specified multiple times +and supports common Unix glob patterns. +.RE +.sp +\fB\-\-examples\fR +.RS 4 +Document all example targets. +.RE +.SS "Feature Selection" +The feature flags allow you to control which features are enabled. When no +feature options are given, the \fBdefault\fR feature is activated for every +selected package. +.sp +See \fIthe features documentation\fR +for more details. +.sp +\fB\-F\fR \fIfeatures\fR, +\fB\-\-features\fR \fIfeatures\fR +.RS 4 +Space or comma separated list of features to activate. Features of workspace +members may be enabled with \fBpackage\-name/feature\-name\fR syntax. This flag may +be specified multiple times, which enables all specified features. +.RE +.sp +\fB\-\-all\-features\fR +.RS 4 +Activate all available features of all selected packages. +.RE +.sp +\fB\-\-no\-default\-features\fR +.RS 4 +Do not activate the \fBdefault\fR feature of the selected packages. +.RE +.SS "Compilation Options" +.sp +\fB\-\-target\fR \fItriple\fR +.RS 4 +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 +\fB\-\-\-\fR\&. +.sp +Possible values: +.sp +.RS 4 +\h'-04'\(bu\h'+03'Any supported target in \fBrustc \-\-print target\-list\fR\&. +.RE +.sp +.RS 4 +\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). +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'A path to a custom target specification. See \fICustom Target Lookup Path\fR for more information. +.RE +.sp +This may also be specified with the \fBbuild.target\fR \fIconfig value\fR \&. +.sp +Note that specifying this flag makes Cargo run in a different mode where the +target artifacts are placed in a separate directory. See the +\fIbuild cache\fR documentation for more details. +.RE +.sp +\fB\-r\fR, +\fB\-\-release\fR +.RS 4 +Document optimized artifacts with the \fBrelease\fR profile. +See also the \fB\-\-profile\fR option for choosing a specific profile by name. +.RE +.sp +\fB\-\-profile\fR \fIname\fR +.RS 4 +Document with the given profile. +See \fIthe reference\fR for more details on profiles. +.RE +.sp +\fB\-\-timings\fR +.RS 4 +Output information how long each compilation takes, and track concurrency +information over time. +.sp +A file \fBcargo\-timing.html\fR will be written to the \fBtarget/cargo\-timings\fR +directory at the end of the build. An additional report with a timestamp +in its filename is also written if you want to look at a previous run. +These reports are suitable for human consumption only, and do not provide +machine\-readable timing data. +.RE +.SS "Output Options" +.sp +\fB\-\-target\-dir\fR \fIdirectory\fR +.RS 4 +Directory for all generated artifacts and intermediate files. May also be +specified with the \fBCARGO_TARGET_DIR\fR environment variable, or the +\fBbuild.target\-dir\fR \fIconfig value\fR \&. +Defaults to \fBtarget\fR in the root of the workspace. +.RE +.SS "Display Options" +.sp +\fB\-v\fR, +\fB\-\-verbose\fR +.RS 4 +Use verbose output. May be specified twice for \[lq]very verbose\[rq] output which +includes extra output such as dependency warnings and build script output. +May also be specified with the \fBterm.verbose\fR +\fIconfig value\fR \&. +.RE +.sp +\fB\-q\fR, +\fB\-\-quiet\fR +.RS 4 +Do not print cargo log messages. +May also be specified with the \fBterm.quiet\fR +\fIconfig value\fR \&. +.RE +.sp +\fB\-\-color\fR \fIwhen\fR +.RS 4 +Control when colored output is used. Valid values: +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBauto\fR (default): Automatically detect if color support is available on the +terminal. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBalways\fR: Always display colors. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBnever\fR: Never display colors. +.RE +.sp +May also be specified with the \fBterm.color\fR +\fIconfig value\fR \&. +.RE +.sp +\fB\-\-message\-format\fR \fIfmt\fR +.RS 4 +The output format for diagnostic messages. Can be specified multiple times +and consists of comma\-separated values. Valid values: +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBhuman\fR (default): Display in a human\-readable text format. Conflicts with +\fBshort\fR and \fBjson\fR\&. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBshort\fR: Emit shorter, human\-readable text messages. Conflicts with \fBhuman\fR +and \fBjson\fR\&. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBjson\fR: Emit JSON messages to stdout. See +\fIthe reference\fR +for more details. Conflicts with \fBhuman\fR and \fBshort\fR\&. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBjson\-diagnostic\-short\fR: Ensure the \fBrendered\fR field of JSON messages contains +the \[lq]short\[rq] rendering from rustc. Cannot be used with \fBhuman\fR or \fBshort\fR\&. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBjson\-diagnostic\-rendered\-ansi\fR: Ensure the \fBrendered\fR field of JSON messages +contains embedded ANSI color codes for respecting rustc\[cq]s default color +scheme. Cannot be used with \fBhuman\fR or \fBshort\fR\&. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBjson\-render\-diagnostics\fR: Instruct Cargo to not include rustc diagnostics +in JSON messages printed, but instead Cargo itself should render the +JSON diagnostics coming from rustc. Cargo\[cq]s own JSON diagnostics and others +coming from rustc are still emitted. Cannot be used with \fBhuman\fR or \fBshort\fR\&. +.RE +.RE +.SS "Manifest Options" +.sp +\fB\-\-manifest\-path\fR \fIpath\fR +.RS 4 +Path to the \fBCargo.toml\fR file. By default, Cargo searches for the +\fBCargo.toml\fR file in the current directory or any parent directory. +.RE +.sp +\fB\-\-ignore\-rust\-version\fR +.RS 4 +Ignore \fBrust\-version\fR specification in packages. +.RE +.sp +\fB\-\-locked\fR +.RS 4 +Asserts that the exact same dependencies and versions are used as when the +existing \fBCargo.lock\fR file was originally generated. Cargo will exit with an +error when either of the following scenarios arises: +.sp +.RS 4 +\h'-04'\(bu\h'+03'The lock file is missing. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'Cargo attempted to change the lock file due to a different dependency resolution. +.RE +.sp +It may be used in environments where deterministic builds are desired, +such as in CI pipelines. +.RE +.sp +\fB\-\-offline\fR +.RS 4 +Prevents Cargo from accessing the network for any reason. Without this +flag, Cargo will stop with an error if it needs to access the network and +the network is not available. With this flag, Cargo will attempt to +proceed without the network if possible. +.sp +Beware that this may result in different dependency resolution than online +mode. Cargo will restrict itself to crates that are downloaded locally, even +if there might be a newer version as indicated in the local copy of the index. +See the \fBcargo\-fetch\fR(1) command to download dependencies before going +offline. +.sp +May also be specified with the \fBnet.offline\fR \fIconfig value\fR \&. +.RE +.sp +\fB\-\-frozen\fR +.RS 4 +Equivalent to specifying both \fB\-\-locked\fR and \fB\-\-offline\fR\&. +.RE +.SS "Common Options" +.sp +\fB+\fR\fItoolchain\fR +.RS 4 +If Cargo has been installed with rustup, and the first argument to \fBcargo\fR +begins with \fB+\fR, it will be interpreted as a rustup toolchain name (such +as \fB+stable\fR or \fB+nightly\fR). +See the \fIrustup documentation\fR +for more information about how toolchain overrides work. +.RE +.sp +\fB\-\-config\fR \fIKEY=VALUE\fR or \fIPATH\fR +.RS 4 +Overrides a Cargo configuration value. The argument should be in TOML syntax of \fBKEY=VALUE\fR, +or provided as a path to an extra configuration file. This flag may be specified multiple times. +See the \fIcommand\-line overrides section\fR for more information. +.RE +.sp +\fB\-C\fR \fIPATH\fR +.RS 4 +Changes the current working directory before executing any specified operations. This affects +things like where cargo looks by default for the project manifest (\fBCargo.toml\fR), as well as +the directories searched for discovering \fB\&.cargo/config.toml\fR, for example. This option must +appear before the command name, for example \fBcargo \-C path/to/my\-project build\fR\&. +.sp +This option is only available on the \fInightly +channel\fR and +requires the \fB\-Z unstable\-options\fR flag to enable (see +\fI#10098\fR ). +.RE +.sp +\fB\-h\fR, +\fB\-\-help\fR +.RS 4 +Prints help information. +.RE +.sp +\fB\-Z\fR \fIflag\fR +.RS 4 +Unstable (nightly\-only) flags to Cargo. Run \fBcargo \-Z help\fR for details. +.RE +.SS "Miscellaneous Options" +.sp +\fB\-j\fR \fIN\fR, +\fB\-\-jobs\fR \fIN\fR +.RS 4 +Number of parallel jobs to run. May also be specified with the +\fBbuild.jobs\fR \fIconfig value\fR \&. Defaults to +the number of logical CPUs. If negative, it sets the maximum number of +parallel jobs to the number of logical CPUs plus provided value. If +a string \fBdefault\fR is provided, it sets the value back to defaults. +Should not be 0. +.RE +.sp +\fB\-\-keep\-going\fR +.RS 4 +Build as many crates in the dependency graph as possible, rather than aborting +the build on the first one that fails to build. +.sp +For example if the current package depends on dependencies \fBfails\fR and \fBworks\fR, +one of which fails to build, \fBcargo doc \-j1\fR may or may not build the +one that succeeds (depending on which one of the two builds Cargo picked to run +first), whereas \fBcargo doc \-j1 \-\-keep\-going\fR would definitely run both +builds, even if the one run first fails. +.RE +.SH "ENVIRONMENT" +See \fIthe reference\fR for +details on environment variables that Cargo reads. +.SH "EXIT STATUS" +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fB0\fR: Cargo succeeded. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fB101\fR: Cargo failed to complete. +.RE +.SH "EXAMPLES" +.sp +.RS 4 +\h'-04' 1.\h'+01'Build the local package documentation and its dependencies and output to +\fBtarget/doc\fR\&. +.sp +.RS 4 +.nf +cargo doc +.fi +.RE +.RE +.SH "SEE ALSO" +\fBcargo\fR(1), \fBcargo\-rustdoc\fR(1), \fBrustdoc\fR(1) diff --git a/rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-fetch.1 b/rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-fetch.1 new file mode 100644 index 0000000000000000000000000000000000000000..41fa1d60b1eb404cadc845809850e80a88e0d3e0 --- /dev/null +++ b/rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-fetch.1 @@ -0,0 +1,199 @@ +'\" t +.TH "CARGO\-FETCH" "1" +.nh +.ad l +.ss \n[.ss] 0 +.SH "NAME" +cargo\-fetch \[em] Fetch dependencies of a package from the network +.SH "SYNOPSIS" +\fBcargo fetch\fR [\fIoptions\fR] +.SH "DESCRIPTION" +If a \fBCargo.lock\fR file is available, this command will ensure that all of the +git dependencies and/or registry dependencies are downloaded and locally +available. Subsequent Cargo commands will be able to run offline after a \fBcargo fetch\fR unless the lock file changes. +.sp +If the lock file is not available, then this command will generate the lock +file before fetching the dependencies. +.sp +If \fB\-\-target\fR is not specified, then all target dependencies are fetched. +.sp +See also the \fIcargo\-prefetch\fR +plugin which adds a command to download popular crates. This may be useful if +you plan to use Cargo without a network with the \fB\-\-offline\fR flag. +.SH "OPTIONS" +.SS "Fetch options" +.sp +\fB\-\-target\fR \fItriple\fR +.RS 4 +Fetch for the specified target architecture. Flag may be specified multiple times. The default is all architectures. The general format of the triple is +\fB\-\-\-\fR\&. +.sp +Possible values: +.sp +.RS 4 +\h'-04'\(bu\h'+03'Any supported target in \fBrustc \-\-print target\-list\fR\&. +.RE +.sp +.RS 4 +\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). +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'A path to a custom target specification. See \fICustom Target Lookup Path\fR for more information. +.RE +.sp +This may also be specified with the \fBbuild.target\fR \fIconfig value\fR \&. +.sp +Note that specifying this flag makes Cargo run in a different mode where the +target artifacts are placed in a separate directory. See the +\fIbuild cache\fR documentation for more details. +.RE +.SS "Display Options" +.sp +\fB\-v\fR, +\fB\-\-verbose\fR +.RS 4 +Use verbose output. May be specified twice for \[lq]very verbose\[rq] output which +includes extra output such as dependency warnings and build script output. +May also be specified with the \fBterm.verbose\fR +\fIconfig value\fR \&. +.RE +.sp +\fB\-q\fR, +\fB\-\-quiet\fR +.RS 4 +Do not print cargo log messages. +May also be specified with the \fBterm.quiet\fR +\fIconfig value\fR \&. +.RE +.sp +\fB\-\-color\fR \fIwhen\fR +.RS 4 +Control when colored output is used. Valid values: +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBauto\fR (default): Automatically detect if color support is available on the +terminal. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBalways\fR: Always display colors. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBnever\fR: Never display colors. +.RE +.sp +May also be specified with the \fBterm.color\fR +\fIconfig value\fR \&. +.RE +.SS "Manifest Options" +.sp +\fB\-\-manifest\-path\fR \fIpath\fR +.RS 4 +Path to the \fBCargo.toml\fR file. By default, Cargo searches for the +\fBCargo.toml\fR file in the current directory or any parent directory. +.RE +.sp +\fB\-\-locked\fR +.RS 4 +Asserts that the exact same dependencies and versions are used as when the +existing \fBCargo.lock\fR file was originally generated. Cargo will exit with an +error when either of the following scenarios arises: +.sp +.RS 4 +\h'-04'\(bu\h'+03'The lock file is missing. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'Cargo attempted to change the lock file due to a different dependency resolution. +.RE +.sp +It may be used in environments where deterministic builds are desired, +such as in CI pipelines. +.RE +.sp +\fB\-\-offline\fR +.RS 4 +Prevents Cargo from accessing the network for any reason. Without this +flag, Cargo will stop with an error if it needs to access the network and +the network is not available. With this flag, Cargo will attempt to +proceed without the network if possible. +.sp +Beware that this may result in different dependency resolution than online +mode. Cargo will restrict itself to crates that are downloaded locally, even +if there might be a newer version as indicated in the local copy of the index. +.sp +May also be specified with the \fBnet.offline\fR \fIconfig value\fR \&. +.RE +.sp +\fB\-\-frozen\fR +.RS 4 +Equivalent to specifying both \fB\-\-locked\fR and \fB\-\-offline\fR\&. +.RE +.SS "Common Options" +.sp +\fB+\fR\fItoolchain\fR +.RS 4 +If Cargo has been installed with rustup, and the first argument to \fBcargo\fR +begins with \fB+\fR, it will be interpreted as a rustup toolchain name (such +as \fB+stable\fR or \fB+nightly\fR). +See the \fIrustup documentation\fR +for more information about how toolchain overrides work. +.RE +.sp +\fB\-\-config\fR \fIKEY=VALUE\fR or \fIPATH\fR +.RS 4 +Overrides a Cargo configuration value. The argument should be in TOML syntax of \fBKEY=VALUE\fR, +or provided as a path to an extra configuration file. This flag may be specified multiple times. +See the \fIcommand\-line overrides section\fR for more information. +.RE +.sp +\fB\-C\fR \fIPATH\fR +.RS 4 +Changes the current working directory before executing any specified operations. This affects +things like where cargo looks by default for the project manifest (\fBCargo.toml\fR), as well as +the directories searched for discovering \fB\&.cargo/config.toml\fR, for example. This option must +appear before the command name, for example \fBcargo \-C path/to/my\-project build\fR\&. +.sp +This option is only available on the \fInightly +channel\fR and +requires the \fB\-Z unstable\-options\fR flag to enable (see +\fI#10098\fR ). +.RE +.sp +\fB\-h\fR, +\fB\-\-help\fR +.RS 4 +Prints help information. +.RE +.sp +\fB\-Z\fR \fIflag\fR +.RS 4 +Unstable (nightly\-only) flags to Cargo. Run \fBcargo \-Z help\fR for details. +.RE +.SH "ENVIRONMENT" +See \fIthe reference\fR for +details on environment variables that Cargo reads. +.SH "EXIT STATUS" +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fB0\fR: Cargo succeeded. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fB101\fR: Cargo failed to complete. +.RE +.SH "EXAMPLES" +.sp +.RS 4 +\h'-04' 1.\h'+01'Fetch all dependencies: +.sp +.RS 4 +.nf +cargo fetch +.fi +.RE +.RE +.SH "SEE ALSO" +\fBcargo\fR(1), \fBcargo\-update\fR(1), \fBcargo\-generate\-lockfile\fR(1) diff --git a/rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-fix.1 b/rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-fix.1 new file mode 100644 index 0000000000000000000000000000000000000000..fd73fa0f5cb12e1c86d1b1d514ce84a7f51cb42c --- /dev/null +++ b/rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-fix.1 @@ -0,0 +1,562 @@ +'\" t +.TH "CARGO\-FIX" "1" +.nh +.ad l +.ss \n[.ss] 0 +.SH "NAME" +cargo\-fix \[em] Automatically fix lint warnings reported by rustc +.SH "SYNOPSIS" +\fBcargo fix\fR [\fIoptions\fR] +.SH "DESCRIPTION" +This Cargo subcommand will automatically take rustc\[cq]s suggestions from +diagnostics like warnings and apply them to your source code. This is intended +to help automate tasks that rustc itself already knows how to tell you to fix! +.sp +Executing \fBcargo fix\fR will under the hood execute \fBcargo\-check\fR(1). Any warnings +applicable to your crate will be automatically fixed (if possible) and all +remaining warnings will be displayed when the check process is finished. For +example if you\[cq]d like to apply all fixes to the current package, you can run: +.sp +.RS 4 +.nf +cargo fix +.fi +.RE +.sp +which behaves the same as \fBcargo check \-\-all\-targets\fR\&. +.sp +\fBcargo fix\fR is only capable of fixing code that is normally compiled with +\fBcargo check\fR\&. If code is conditionally enabled with optional features, you +will need to enable those features for that code to be analyzed: +.sp +.RS 4 +.nf +cargo fix \-\-features foo +.fi +.RE +.sp +Similarly, other \fBcfg\fR expressions like platform\-specific code will need to +pass \fB\-\-target\fR to fix code for the given target. +.sp +.RS 4 +.nf +cargo fix \-\-target x86_64\-pc\-windows\-gnu +.fi +.RE +.sp +If you encounter any problems with \fBcargo fix\fR or otherwise have any questions +or feature requests please don\[cq]t hesitate to file an issue at +\&. +.SS "Edition migration" +The \fBcargo fix\fR subcommand can also be used to migrate a package from one +\fIedition\fR to the next. The general procedure is: +.sp +.RS 4 +\h'-04' 1.\h'+01'Run \fBcargo fix \-\-edition\fR\&. Consider also using the \fB\-\-all\-features\fR flag if +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 +has platform\-specific code gated by \fBcfg\fR attributes. +.RE +.sp +.RS 4 +\h'-04' 2.\h'+01'Modify \fBCargo.toml\fR to set the \fIedition field\fR to the new edition. +.RE +.sp +.RS 4 +\h'-04' 3.\h'+01'Run your project tests to verify that everything still works. If new +warnings are issued, you may want to consider running \fBcargo fix\fR again +(without the \fB\-\-edition\fR flag) to apply any suggestions given by the +compiler. +.RE +.sp +And hopefully that\[cq]s it! Just keep in mind of the caveats mentioned above that +\fBcargo fix\fR cannot update code for inactive features or \fBcfg\fR expressions. +Also, in some rare cases the compiler is unable to automatically migrate all +code to the new edition, and this may require manual changes after building +with the new edition. +.SH "OPTIONS" +.SS "Fix options" +.sp +\fB\-\-broken\-code\fR +.RS 4 +Fix code even if it already has compiler errors. This is useful if \fBcargo fix\fR +fails to apply the changes. It will apply the changes and leave the broken +code in the working directory for you to inspect and manually fix. +.RE +.sp +\fB\-\-edition\fR +.RS 4 +Apply changes that will update the code to the next edition. This will not +update the edition in the \fBCargo.toml\fR manifest, which must be updated +manually after \fBcargo fix \-\-edition\fR has finished. +.RE +.sp +\fB\-\-edition\-idioms\fR +.RS 4 +Apply suggestions that will update code to the preferred style for the current +edition. +.RE +.sp +\fB\-\-allow\-no\-vcs\fR +.RS 4 +Fix code even if a VCS was not detected. +.RE +.sp +\fB\-\-allow\-dirty\fR +.RS 4 +Fix code even if the working directory has changes (including staged changes). +.RE +.sp +\fB\-\-allow\-staged\fR +.RS 4 +Fix code even if the working directory has staged changes. +.RE +.SS "Package Selection" +By default, when no package selection options are given, the packages selected +depend on the selected manifest file (based on the current working directory if +\fB\-\-manifest\-path\fR is not given). If the manifest is the root of a workspace then +the workspaces default members are selected, otherwise only the package defined +by the manifest will be selected. +.sp +The default members of a workspace can be set explicitly with the +\fBworkspace.default\-members\fR key in the root manifest. If this is not set, a +virtual workspace will include all workspace members (equivalent to passing +\fB\-\-workspace\fR), and a non\-virtual workspace will include only the root crate itself. +.sp +\fB\-p\fR \fIspec\fR\[u2026], +\fB\-\-package\fR \fIspec\fR\[u2026] +.RS 4 +Fix only the specified packages. See \fBcargo\-pkgid\fR(1) for the +SPEC format. This flag may be specified multiple times and supports common Unix +glob patterns like \fB*\fR, \fB?\fR and \fB[]\fR\&. However, to avoid your shell accidentally +expanding glob patterns before Cargo handles them, you must use single quotes or +double quotes around each pattern. +.RE +.sp +\fB\-\-workspace\fR +.RS 4 +Fix all members in the workspace. +.RE +.sp +\fB\-\-all\fR +.RS 4 +Deprecated alias for \fB\-\-workspace\fR\&. +.RE +.sp +\fB\-\-exclude\fR \fISPEC\fR\[u2026] +.RS 4 +Exclude the specified packages. Must be used in conjunction with the +\fB\-\-workspace\fR flag. This flag may be specified multiple times and supports +common Unix glob patterns like \fB*\fR, \fB?\fR and \fB[]\fR\&. However, to avoid your shell +accidentally expanding glob patterns before Cargo handles them, you must use +single quotes or double quotes around each pattern. +.RE +.SS "Target Selection" +When no target selection options are given, \fBcargo fix\fR will fix all targets +(\fB\-\-all\-targets\fR implied). Binaries are skipped if they have +\fBrequired\-features\fR that are missing. +.sp +Passing target selection flags will fix only the specified +targets. +.sp +Note that \fB\-\-bin\fR, \fB\-\-example\fR, \fB\-\-test\fR and \fB\-\-bench\fR flags also +support common Unix glob patterns like \fB*\fR, \fB?\fR and \fB[]\fR\&. However, to avoid your +shell accidentally expanding glob patterns before Cargo handles them, you must +use single quotes or double quotes around each glob pattern. +.sp +\fB\-\-lib\fR +.RS 4 +Fix the package\[cq]s library. +.RE +.sp +\fB\-\-bin\fR \fIname\fR\[u2026] +.RS 4 +Fix the specified binary. This flag may be specified multiple times +and supports common Unix glob patterns. +.RE +.sp +\fB\-\-bins\fR +.RS 4 +Fix all binary targets. +.RE +.sp +\fB\-\-example\fR \fIname\fR\[u2026] +.RS 4 +Fix the specified example. This flag may be specified multiple times +and supports common Unix glob patterns. +.RE +.sp +\fB\-\-examples\fR +.RS 4 +Fix all example targets. +.RE +.sp +\fB\-\-test\fR \fIname\fR\[u2026] +.RS 4 +Fix the specified integration test. This flag may be specified +multiple times and supports common Unix glob patterns. +.RE +.sp +\fB\-\-tests\fR +.RS 4 +Fix all targets that have the \fBtest = true\fR manifest +flag set. By default this includes the library and binaries built as +unittests, and integration tests. Be aware that this will also build any +required dependencies, so the lib target may be built twice (once as a +unittest, and once as a dependency for binaries, integration tests, etc.). +Targets may be enabled or disabled by setting the \fBtest\fR flag in the +manifest settings for the target. +.RE +.sp +\fB\-\-bench\fR \fIname\fR\[u2026] +.RS 4 +Fix the specified benchmark. This flag may be specified multiple +times and supports common Unix glob patterns. +.RE +.sp +\fB\-\-benches\fR +.RS 4 +Fix all targets that have the \fBbench = true\fR +manifest flag set. By default this includes the library and binaries built +as benchmarks, and bench targets. Be aware that this will also build any +required dependencies, so the lib target may be built twice (once as a +benchmark, and once as a dependency for binaries, benchmarks, etc.). +Targets may be enabled or disabled by setting the \fBbench\fR flag in the +manifest settings for the target. +.RE +.sp +\fB\-\-all\-targets\fR +.RS 4 +Fix all targets. This is equivalent to specifying \fB\-\-lib \-\-bins \-\-tests \-\-benches \-\-examples\fR\&. +.RE +.SS "Feature Selection" +The feature flags allow you to control which features are enabled. When no +feature options are given, the \fBdefault\fR feature is activated for every +selected package. +.sp +See \fIthe features documentation\fR +for more details. +.sp +\fB\-F\fR \fIfeatures\fR, +\fB\-\-features\fR \fIfeatures\fR +.RS 4 +Space or comma separated list of features to activate. Features of workspace +members may be enabled with \fBpackage\-name/feature\-name\fR syntax. This flag may +be specified multiple times, which enables all specified features. +.RE +.sp +\fB\-\-all\-features\fR +.RS 4 +Activate all available features of all selected packages. +.RE +.sp +\fB\-\-no\-default\-features\fR +.RS 4 +Do not activate the \fBdefault\fR feature of the selected packages. +.RE +.SS "Compilation Options" +.sp +\fB\-\-target\fR \fItriple\fR +.RS 4 +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 +\fB\-\-\-\fR\&. +.sp +Possible values: +.sp +.RS 4 +\h'-04'\(bu\h'+03'Any supported target in \fBrustc \-\-print target\-list\fR\&. +.RE +.sp +.RS 4 +\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). +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'A path to a custom target specification. See \fICustom Target Lookup Path\fR for more information. +.RE +.sp +This may also be specified with the \fBbuild.target\fR \fIconfig value\fR \&. +.sp +Note that specifying this flag makes Cargo run in a different mode where the +target artifacts are placed in a separate directory. See the +\fIbuild cache\fR documentation for more details. +.RE +.sp +\fB\-r\fR, +\fB\-\-release\fR +.RS 4 +Fix optimized artifacts with the \fBrelease\fR profile. +See also the \fB\-\-profile\fR option for choosing a specific profile by name. +.RE +.sp +\fB\-\-profile\fR \fIname\fR +.RS 4 +Fix with the given profile. +.sp +As a special case, specifying the \fBtest\fR profile will also enable checking in +test mode which will enable checking tests and enable the \fBtest\fR cfg option. +See \fIrustc tests\fR for more +detail. +.sp +See \fIthe reference\fR for more details on profiles. +.RE +.sp +\fB\-\-timings\fR +.RS 4 +Output information how long each compilation takes, and track concurrency +information over time. +.sp +A file \fBcargo\-timing.html\fR will be written to the \fBtarget/cargo\-timings\fR +directory at the end of the build. An additional report with a timestamp +in its filename is also written if you want to look at a previous run. +These reports are suitable for human consumption only, and do not provide +machine\-readable timing data. +.RE +.SS "Output Options" +.sp +\fB\-\-target\-dir\fR \fIdirectory\fR +.RS 4 +Directory for all generated artifacts and intermediate files. May also be +specified with the \fBCARGO_TARGET_DIR\fR environment variable, or the +\fBbuild.target\-dir\fR \fIconfig value\fR \&. +Defaults to \fBtarget\fR in the root of the workspace. +.RE +.SS "Display Options" +.sp +\fB\-v\fR, +\fB\-\-verbose\fR +.RS 4 +Use verbose output. May be specified twice for \[lq]very verbose\[rq] output which +includes extra output such as dependency warnings and build script output. +May also be specified with the \fBterm.verbose\fR +\fIconfig value\fR \&. +.RE +.sp +\fB\-q\fR, +\fB\-\-quiet\fR +.RS 4 +Do not print cargo log messages. +May also be specified with the \fBterm.quiet\fR +\fIconfig value\fR \&. +.RE +.sp +\fB\-\-color\fR \fIwhen\fR +.RS 4 +Control when colored output is used. Valid values: +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBauto\fR (default): Automatically detect if color support is available on the +terminal. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBalways\fR: Always display colors. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBnever\fR: Never display colors. +.RE +.sp +May also be specified with the \fBterm.color\fR +\fIconfig value\fR \&. +.RE +.sp +\fB\-\-message\-format\fR \fIfmt\fR +.RS 4 +The output format for diagnostic messages. Can be specified multiple times +and consists of comma\-separated values. Valid values: +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBhuman\fR (default): Display in a human\-readable text format. Conflicts with +\fBshort\fR and \fBjson\fR\&. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBshort\fR: Emit shorter, human\-readable text messages. Conflicts with \fBhuman\fR +and \fBjson\fR\&. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBjson\fR: Emit JSON messages to stdout. See +\fIthe reference\fR +for more details. Conflicts with \fBhuman\fR and \fBshort\fR\&. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBjson\-diagnostic\-short\fR: Ensure the \fBrendered\fR field of JSON messages contains +the \[lq]short\[rq] rendering from rustc. Cannot be used with \fBhuman\fR or \fBshort\fR\&. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBjson\-diagnostic\-rendered\-ansi\fR: Ensure the \fBrendered\fR field of JSON messages +contains embedded ANSI color codes for respecting rustc\[cq]s default color +scheme. Cannot be used with \fBhuman\fR or \fBshort\fR\&. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBjson\-render\-diagnostics\fR: Instruct Cargo to not include rustc diagnostics +in JSON messages printed, but instead Cargo itself should render the +JSON diagnostics coming from rustc. Cargo\[cq]s own JSON diagnostics and others +coming from rustc are still emitted. Cannot be used with \fBhuman\fR or \fBshort\fR\&. +.RE +.RE +.SS "Manifest Options" +.sp +\fB\-\-manifest\-path\fR \fIpath\fR +.RS 4 +Path to the \fBCargo.toml\fR file. By default, Cargo searches for the +\fBCargo.toml\fR file in the current directory or any parent directory. +.RE +.sp +\fB\-\-ignore\-rust\-version\fR +.RS 4 +Ignore \fBrust\-version\fR specification in packages. +.RE +.sp +\fB\-\-locked\fR +.RS 4 +Asserts that the exact same dependencies and versions are used as when the +existing \fBCargo.lock\fR file was originally generated. Cargo will exit with an +error when either of the following scenarios arises: +.sp +.RS 4 +\h'-04'\(bu\h'+03'The lock file is missing. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'Cargo attempted to change the lock file due to a different dependency resolution. +.RE +.sp +It may be used in environments where deterministic builds are desired, +such as in CI pipelines. +.RE +.sp +\fB\-\-offline\fR +.RS 4 +Prevents Cargo from accessing the network for any reason. Without this +flag, Cargo will stop with an error if it needs to access the network and +the network is not available. With this flag, Cargo will attempt to +proceed without the network if possible. +.sp +Beware that this may result in different dependency resolution than online +mode. Cargo will restrict itself to crates that are downloaded locally, even +if there might be a newer version as indicated in the local copy of the index. +See the \fBcargo\-fetch\fR(1) command to download dependencies before going +offline. +.sp +May also be specified with the \fBnet.offline\fR \fIconfig value\fR \&. +.RE +.sp +\fB\-\-frozen\fR +.RS 4 +Equivalent to specifying both \fB\-\-locked\fR and \fB\-\-offline\fR\&. +.RE +.SS "Common Options" +.sp +\fB+\fR\fItoolchain\fR +.RS 4 +If Cargo has been installed with rustup, and the first argument to \fBcargo\fR +begins with \fB+\fR, it will be interpreted as a rustup toolchain name (such +as \fB+stable\fR or \fB+nightly\fR). +See the \fIrustup documentation\fR +for more information about how toolchain overrides work. +.RE +.sp +\fB\-\-config\fR \fIKEY=VALUE\fR or \fIPATH\fR +.RS 4 +Overrides a Cargo configuration value. The argument should be in TOML syntax of \fBKEY=VALUE\fR, +or provided as a path to an extra configuration file. This flag may be specified multiple times. +See the \fIcommand\-line overrides section\fR for more information. +.RE +.sp +\fB\-C\fR \fIPATH\fR +.RS 4 +Changes the current working directory before executing any specified operations. This affects +things like where cargo looks by default for the project manifest (\fBCargo.toml\fR), as well as +the directories searched for discovering \fB\&.cargo/config.toml\fR, for example. This option must +appear before the command name, for example \fBcargo \-C path/to/my\-project build\fR\&. +.sp +This option is only available on the \fInightly +channel\fR and +requires the \fB\-Z unstable\-options\fR flag to enable (see +\fI#10098\fR ). +.RE +.sp +\fB\-h\fR, +\fB\-\-help\fR +.RS 4 +Prints help information. +.RE +.sp +\fB\-Z\fR \fIflag\fR +.RS 4 +Unstable (nightly\-only) flags to Cargo. Run \fBcargo \-Z help\fR for details. +.RE +.SS "Miscellaneous Options" +.sp +\fB\-j\fR \fIN\fR, +\fB\-\-jobs\fR \fIN\fR +.RS 4 +Number of parallel jobs to run. May also be specified with the +\fBbuild.jobs\fR \fIconfig value\fR \&. Defaults to +the number of logical CPUs. If negative, it sets the maximum number of +parallel jobs to the number of logical CPUs plus provided value. If +a string \fBdefault\fR is provided, it sets the value back to defaults. +Should not be 0. +.RE +.sp +\fB\-\-keep\-going\fR +.RS 4 +Build as many crates in the dependency graph as possible, rather than aborting +the build on the first one that fails to build. +.sp +For example if the current package depends on dependencies \fBfails\fR and \fBworks\fR, +one of which fails to build, \fBcargo fix \-j1\fR may or may not build the +one that succeeds (depending on which one of the two builds Cargo picked to run +first), whereas \fBcargo fix \-j1 \-\-keep\-going\fR would definitely run both +builds, even if the one run first fails. +.RE +.SH "ENVIRONMENT" +See \fIthe reference\fR for +details on environment variables that Cargo reads. +.SH "EXIT STATUS" +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fB0\fR: Cargo succeeded. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fB101\fR: Cargo failed to complete. +.RE +.SH "EXAMPLES" +.sp +.RS 4 +\h'-04' 1.\h'+01'Apply compiler suggestions to the local package: +.sp +.RS 4 +.nf +cargo fix +.fi +.RE +.RE +.sp +.RS 4 +\h'-04' 2.\h'+01'Update a package to prepare it for the next edition: +.sp +.RS 4 +.nf +cargo fix \-\-edition +.fi +.RE +.RE +.sp +.RS 4 +\h'-04' 3.\h'+01'Apply suggested idioms for the current edition: +.sp +.RS 4 +.nf +cargo fix \-\-edition\-idioms +.fi +.RE +.RE +.SH "SEE ALSO" +\fBcargo\fR(1), \fBcargo\-check\fR(1) diff --git a/rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-generate-lockfile.1 b/rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-generate-lockfile.1 new file mode 100644 index 0000000000000000000000000000000000000000..04d609a8e0aefbc3f2cd65a290494da9dedc7fa9 --- /dev/null +++ b/rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-generate-lockfile.1 @@ -0,0 +1,192 @@ +'\" t +.TH "CARGO\-GENERATE\-LOCKFILE" "1" +.nh +.ad l +.ss \n[.ss] 0 +.SH "NAME" +cargo\-generate\-lockfile \[em] Generate the lockfile for a package +.SH "SYNOPSIS" +\fBcargo generate\-lockfile\fR [\fIoptions\fR] +.SH "DESCRIPTION" +This command will create the \fBCargo.lock\fR lockfile for the current package or +workspace. If the lockfile already exists, it will be rebuilt with the latest +available version of every package. +.sp +See also \fBcargo\-update\fR(1) which is also capable of creating a \fBCargo.lock\fR +lockfile and has more options for controlling update behavior. +.SH "OPTIONS" +.SS "Display Options" +.sp +\fB\-v\fR, +\fB\-\-verbose\fR +.RS 4 +Use verbose output. May be specified twice for \[lq]very verbose\[rq] output which +includes extra output such as dependency warnings and build script output. +May also be specified with the \fBterm.verbose\fR +\fIconfig value\fR \&. +.RE +.sp +\fB\-q\fR, +\fB\-\-quiet\fR +.RS 4 +Do not print cargo log messages. +May also be specified with the \fBterm.quiet\fR +\fIconfig value\fR \&. +.RE +.sp +\fB\-\-color\fR \fIwhen\fR +.RS 4 +Control when colored output is used. Valid values: +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBauto\fR (default): Automatically detect if color support is available on the +terminal. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBalways\fR: Always display colors. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBnever\fR: Never display colors. +.RE +.sp +May also be specified with the \fBterm.color\fR +\fIconfig value\fR \&. +.RE +.SS "Manifest Options" +.sp +\fB\-\-manifest\-path\fR \fIpath\fR +.RS 4 +Path to the \fBCargo.toml\fR file. By default, Cargo searches for the +\fBCargo.toml\fR file in the current directory or any parent directory. +.RE +.sp +\fB\-\-ignore\-rust\-version\fR +.RS 4 +Ignore \fBrust\-version\fR specification in packages. +.RE +.sp +\fB\-\-publish\-time\fR \fIyyyy\-mm\-ddThh:mm:ssZ\fR +.RS 4 +Latest publish time allowed for registry packages (Unstable) +.sp +This is a best\-effort filter on allowed packages, including: +.sp +.RS 4 +\h'-04'\(bu\h'+03'packages from unsupported registries are always accepted +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'only the current yank state is respected, not the state as of \fB\-\-publish\-time\fR +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'precision of the publish time +.RE +.RE +.sp +\fB\-\-locked\fR +.RS 4 +Asserts that the exact same dependencies and versions are used as when the +existing \fBCargo.lock\fR file was originally generated. Cargo will exit with an +error when either of the following scenarios arises: +.sp +.RS 4 +\h'-04'\(bu\h'+03'The lock file is missing. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'Cargo attempted to change the lock file due to a different dependency resolution. +.RE +.sp +It may be used in environments where deterministic builds are desired, +such as in CI pipelines. +.RE +.sp +\fB\-\-offline\fR +.RS 4 +Prevents Cargo from accessing the network for any reason. Without this +flag, Cargo will stop with an error if it needs to access the network and +the network is not available. With this flag, Cargo will attempt to +proceed without the network if possible. +.sp +Beware that this may result in different dependency resolution than online +mode. Cargo will restrict itself to crates that are downloaded locally, even +if there might be a newer version as indicated in the local copy of the index. +See the \fBcargo\-fetch\fR(1) command to download dependencies before going +offline. +.sp +May also be specified with the \fBnet.offline\fR \fIconfig value\fR \&. +.RE +.sp +\fB\-\-frozen\fR +.RS 4 +Equivalent to specifying both \fB\-\-locked\fR and \fB\-\-offline\fR\&. +.RE +.SS "Common Options" +.sp +\fB+\fR\fItoolchain\fR +.RS 4 +If Cargo has been installed with rustup, and the first argument to \fBcargo\fR +begins with \fB+\fR, it will be interpreted as a rustup toolchain name (such +as \fB+stable\fR or \fB+nightly\fR). +See the \fIrustup documentation\fR +for more information about how toolchain overrides work. +.RE +.sp +\fB\-\-config\fR \fIKEY=VALUE\fR or \fIPATH\fR +.RS 4 +Overrides a Cargo configuration value. The argument should be in TOML syntax of \fBKEY=VALUE\fR, +or provided as a path to an extra configuration file. This flag may be specified multiple times. +See the \fIcommand\-line overrides section\fR for more information. +.RE +.sp +\fB\-C\fR \fIPATH\fR +.RS 4 +Changes the current working directory before executing any specified operations. This affects +things like where cargo looks by default for the project manifest (\fBCargo.toml\fR), as well as +the directories searched for discovering \fB\&.cargo/config.toml\fR, for example. This option must +appear before the command name, for example \fBcargo \-C path/to/my\-project build\fR\&. +.sp +This option is only available on the \fInightly +channel\fR and +requires the \fB\-Z unstable\-options\fR flag to enable (see +\fI#10098\fR ). +.RE +.sp +\fB\-h\fR, +\fB\-\-help\fR +.RS 4 +Prints help information. +.RE +.sp +\fB\-Z\fR \fIflag\fR +.RS 4 +Unstable (nightly\-only) flags to Cargo. Run \fBcargo \-Z help\fR for details. +.RE +.SH "ENVIRONMENT" +See \fIthe reference\fR for +details on environment variables that Cargo reads. +.SH "EXIT STATUS" +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fB0\fR: Cargo succeeded. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fB101\fR: Cargo failed to complete. +.RE +.SH "EXAMPLES" +.sp +.RS 4 +\h'-04' 1.\h'+01'Create or update the lockfile for the current package or workspace: +.sp +.RS 4 +.nf +cargo generate\-lockfile +.fi +.RE +.RE +.SH "SEE ALSO" +\fBcargo\fR(1), \fBcargo\-update\fR(1) diff --git a/rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-help.1 b/rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-help.1 new file mode 100644 index 0000000000000000000000000000000000000000..46b810b5e3c96ac490aef2ff8798b187b8203606 --- /dev/null +++ b/rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-help.1 @@ -0,0 +1,167 @@ +'\" t +.TH "CARGO\-HELP" "1" +.nh +.ad l +.ss \n[.ss] 0 +.SH "NAME" +cargo\-help \[em] Get help for a Cargo command +.SH "SYNOPSIS" +\fBcargo help\fR [\fIsubcommand\fR] +.SH "DESCRIPTION" +Prints a help message for the given command. +.SH "OPTIONS" +.SS "Display Options" +.sp +\fB\-v\fR, +\fB\-\-verbose\fR +.RS 4 +Use verbose output. May be specified twice for \[lq]very verbose\[rq] output which +includes extra output such as dependency warnings and build script output. +May also be specified with the \fBterm.verbose\fR +\fIconfig value\fR \&. +.RE +.sp +\fB\-q\fR, +\fB\-\-quiet\fR +.RS 4 +Do not print cargo log messages. +May also be specified with the \fBterm.quiet\fR +\fIconfig value\fR \&. +.RE +.sp +\fB\-\-color\fR \fIwhen\fR +.RS 4 +Control when colored output is used. Valid values: +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBauto\fR (default): Automatically detect if color support is available on the +terminal. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBalways\fR: Always display colors. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBnever\fR: Never display colors. +.RE +.sp +May also be specified with the \fBterm.color\fR +\fIconfig value\fR \&. +.RE +.SS "Manifest Options" +.sp +\fB\-\-locked\fR +.RS 4 +Asserts that the exact same dependencies and versions are used as when the +existing \fBCargo.lock\fR file was originally generated. Cargo will exit with an +error when either of the following scenarios arises: +.sp +.RS 4 +\h'-04'\(bu\h'+03'The lock file is missing. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'Cargo attempted to change the lock file due to a different dependency resolution. +.RE +.sp +It may be used in environments where deterministic builds are desired, +such as in CI pipelines. +.RE +.sp +\fB\-\-offline\fR +.RS 4 +Prevents Cargo from accessing the network for any reason. Without this +flag, Cargo will stop with an error if it needs to access the network and +the network is not available. With this flag, Cargo will attempt to +proceed without the network if possible. +.sp +Beware that this may result in different dependency resolution than online +mode. Cargo will restrict itself to crates that are downloaded locally, even +if there might be a newer version as indicated in the local copy of the index. +See the \fBcargo\-fetch\fR(1) command to download dependencies before going +offline. +.sp +May also be specified with the \fBnet.offline\fR \fIconfig value\fR \&. +.RE +.sp +\fB\-\-frozen\fR +.RS 4 +Equivalent to specifying both \fB\-\-locked\fR and \fB\-\-offline\fR\&. +.RE +.SS "Common Options" +.sp +\fB+\fR\fItoolchain\fR +.RS 4 +If Cargo has been installed with rustup, and the first argument to \fBcargo\fR +begins with \fB+\fR, it will be interpreted as a rustup toolchain name (such +as \fB+stable\fR or \fB+nightly\fR). +See the \fIrustup documentation\fR +for more information about how toolchain overrides work. +.RE +.sp +\fB\-\-config\fR \fIKEY=VALUE\fR or \fIPATH\fR +.RS 4 +Overrides a Cargo configuration value. The argument should be in TOML syntax of \fBKEY=VALUE\fR, +or provided as a path to an extra configuration file. This flag may be specified multiple times. +See the \fIcommand\-line overrides section\fR for more information. +.RE +.sp +\fB\-C\fR \fIPATH\fR +.RS 4 +Changes the current working directory before executing any specified operations. This affects +things like where cargo looks by default for the project manifest (\fBCargo.toml\fR), as well as +the directories searched for discovering \fB\&.cargo/config.toml\fR, for example. This option must +appear before the command name, for example \fBcargo \-C path/to/my\-project build\fR\&. +.sp +This option is only available on the \fInightly +channel\fR and +requires the \fB\-Z unstable\-options\fR flag to enable (see +\fI#10098\fR ). +.RE +.sp +\fB\-h\fR, +\fB\-\-help\fR +.RS 4 +Prints help information. +.RE +.sp +\fB\-Z\fR \fIflag\fR +.RS 4 +Unstable (nightly\-only) flags to Cargo. Run \fBcargo \-Z help\fR for details. +.RE +.SH "ENVIRONMENT" +See \fIthe reference\fR for +details on environment variables that Cargo reads. +.SH "EXIT STATUS" +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fB0\fR: Cargo succeeded. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fB101\fR: Cargo failed to complete. +.RE +.SH "EXAMPLES" +.sp +.RS 4 +\h'-04' 1.\h'+01'Get help for a command: +.sp +.RS 4 +.nf +cargo help build +.fi +.RE +.RE +.sp +.RS 4 +\h'-04' 2.\h'+01'Help is also available with the \fB\-\-help\fR flag: +.sp +.RS 4 +.nf +cargo build \-\-help +.fi +.RE +.RE +.SH "SEE ALSO" +\fBcargo\fR(1) diff --git a/rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-info.1 b/rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-info.1 new file mode 100644 index 0000000000000000000000000000000000000000..1be7b69460d014b36545d80063f42d24401658f5 --- /dev/null +++ b/rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-info.1 @@ -0,0 +1,201 @@ +'\" t +.TH "CARGO\-INFO" "1" +.nh +.ad l +.ss \n[.ss] 0 +.SH "NAME" +cargo\-info \[em] Display information about a package. +.SH "SYNOPSIS" +\fBcargo info\fR [\fIoptions\fR] \fIspec\fR +.SH "DESCRIPTION" +This command displays information about a package. It fetches data from the package\[cq]s Cargo.toml file +and presents it in a human\-readable format. +.SH "OPTIONS" +.SS "Info Options" +.sp +\fIspec\fR +.RS 4 +Fetch information about the specified package. The \fIspec\fR can be a package ID, see \fBcargo\-pkgid\fR(1) for the SPEC +format. +If the specified package is part of the current workspace, information from the local Cargo.toml file will be displayed. +If the \fBCargo.lock\fR file does not exist, it will be created. If no version is specified, the appropriate version will be +selected based on the Minimum Supported Rust Version (MSRV). +.RE +.sp +\fB\-\-index\fR \fIindex\fR +.RS 4 +The URL of the registry index to use. +.RE +.sp +\fB\-\-registry\fR \fIregistry\fR +.RS 4 +Name of the registry to use. Registry names are defined in \fICargo config +files\fR \&. If not specified, the default registry is used, +which is defined by the \fBregistry.default\fR config key which defaults to +\fBcrates\-io\fR\&. +.RE +.SS "Display Options" +.sp +\fB\-v\fR, +\fB\-\-verbose\fR +.RS 4 +Use verbose output. May be specified twice for \[lq]very verbose\[rq] output which +includes extra output such as dependency warnings and build script output. +May also be specified with the \fBterm.verbose\fR +\fIconfig value\fR \&. +.RE +.sp +\fB\-q\fR, +\fB\-\-quiet\fR +.RS 4 +Do not print cargo log messages. +May also be specified with the \fBterm.quiet\fR +\fIconfig value\fR \&. +.RE +.sp +\fB\-\-color\fR \fIwhen\fR +.RS 4 +Control when colored output is used. Valid values: +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBauto\fR (default): Automatically detect if color support is available on the +terminal. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBalways\fR: Always display colors. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBnever\fR: Never display colors. +.RE +.sp +May also be specified with the \fBterm.color\fR +\fIconfig value\fR \&. +.RE +.SS "Manifest Options" +.sp +\fB\-\-locked\fR +.RS 4 +Asserts that the exact same dependencies and versions are used as when the +existing \fBCargo.lock\fR file was originally generated. Cargo will exit with an +error when either of the following scenarios arises: +.sp +.RS 4 +\h'-04'\(bu\h'+03'The lock file is missing. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'Cargo attempted to change the lock file due to a different dependency resolution. +.RE +.sp +It may be used in environments where deterministic builds are desired, +such as in CI pipelines. +.RE +.sp +\fB\-\-offline\fR +.RS 4 +Prevents Cargo from accessing the network for any reason. Without this +flag, Cargo will stop with an error if it needs to access the network and +the network is not available. With this flag, Cargo will attempt to +proceed without the network if possible. +.sp +Beware that this may result in different dependency resolution than online +mode. Cargo will restrict itself to crates that are downloaded locally, even +if there might be a newer version as indicated in the local copy of the index. +See the \fBcargo\-fetch\fR(1) command to download dependencies before going +offline. +.sp +May also be specified with the \fBnet.offline\fR \fIconfig value\fR \&. +.RE +.sp +\fB\-\-frozen\fR +.RS 4 +Equivalent to specifying both \fB\-\-locked\fR and \fB\-\-offline\fR\&. +.RE +.SS "Common Options" +.sp +\fB+\fR\fItoolchain\fR +.RS 4 +If Cargo has been installed with rustup, and the first argument to \fBcargo\fR +begins with \fB+\fR, it will be interpreted as a rustup toolchain name (such +as \fB+stable\fR or \fB+nightly\fR). +See the \fIrustup documentation\fR +for more information about how toolchain overrides work. +.RE +.sp +\fB\-\-config\fR \fIKEY=VALUE\fR or \fIPATH\fR +.RS 4 +Overrides a Cargo configuration value. The argument should be in TOML syntax of \fBKEY=VALUE\fR, +or provided as a path to an extra configuration file. This flag may be specified multiple times. +See the \fIcommand\-line overrides section\fR for more information. +.RE +.sp +\fB\-C\fR \fIPATH\fR +.RS 4 +Changes the current working directory before executing any specified operations. This affects +things like where cargo looks by default for the project manifest (\fBCargo.toml\fR), as well as +the directories searched for discovering \fB\&.cargo/config.toml\fR, for example. This option must +appear before the command name, for example \fBcargo \-C path/to/my\-project build\fR\&. +.sp +This option is only available on the \fInightly +channel\fR and +requires the \fB\-Z unstable\-options\fR flag to enable (see +\fI#10098\fR ). +.RE +.sp +\fB\-h\fR, +\fB\-\-help\fR +.RS 4 +Prints help information. +.RE +.sp +\fB\-Z\fR \fIflag\fR +.RS 4 +Unstable (nightly\-only) flags to Cargo. Run \fBcargo \-Z help\fR for details. +.RE +.SH "ENVIRONMENT" +See \fIthe reference\fR for +details on environment variables that Cargo reads. +.SH "EXIT STATUS" +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fB0\fR: Cargo succeeded. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fB101\fR: Cargo failed to complete. +.RE +.SH "EXAMPLES" +.sp +.RS 4 +\h'-04' 1.\h'+01'Inspect the \fBserde\fR package from crates.io: +.sp +.RS 4 +.nf + cargo info serde +.fi +.RE +.RE +.sp +.RS 4 +\h'-04' 2.\h'+01'Inspect the \fBserde\fR package with version \fB1.0.0\fR: +.sp +.RS 4 +.nf + cargo info serde@1.0.0 +.fi +.RE +.RE +.sp +.RS 4 +\h'-04' 3.\h'+01'Inspect the \fBserde\fR package form the local registry: +.sp +.RS 4 +.nf + cargo info serde \-\-registry my\-registry +.fi +.RE +.RE +.SH "SEE ALSO" +\fBcargo\fR(1), \fBcargo\-search\fR(1) diff --git a/rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-init.1 b/rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-init.1 new file mode 100644 index 0000000000000000000000000000000000000000..abeb9ebb99f970406d8785a6b599df5b93efd186 --- /dev/null +++ b/rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-init.1 @@ -0,0 +1,171 @@ +'\" t +.TH "CARGO\-INIT" "1" +.nh +.ad l +.ss \n[.ss] 0 +.SH "NAME" +cargo\-init \[em] Create a new Cargo package in an existing directory +.SH "SYNOPSIS" +\fBcargo init\fR [\fIoptions\fR] [\fIpath\fR] +.SH "DESCRIPTION" +This command will create a new Cargo manifest in the current directory. Give a +path as an argument to create in the given directory. +.sp +If there are typically\-named Rust source files already in the directory, those +will be used. If not, then a sample \fBsrc/main.rs\fR file will be created, or +\fBsrc/lib.rs\fR if \fB\-\-lib\fR is passed. +.sp +If the directory is not already in a VCS repository, then a new repository +is created (see \fB\-\-vcs\fR below). +.sp +See \fBcargo\-new\fR(1) for a similar command which will create a new package in +a new directory. +.SH "OPTIONS" +.SS "Init Options" +.sp +\fB\-\-bin\fR +.RS 4 +Create a package with a binary target (\fBsrc/main.rs\fR). +This is the default behavior. +.RE +.sp +\fB\-\-lib\fR +.RS 4 +Create a package with a library target (\fBsrc/lib.rs\fR). +.RE +.sp +\fB\-\-edition\fR \fIedition\fR +.RS 4 +Specify the Rust edition to use. Default is 2024. +Possible values: 2015, 2018, 2021, 2024 +.RE +.sp +\fB\-\-name\fR \fIname\fR +.RS 4 +Set the package name. Defaults to the directory name. +.RE +.sp +\fB\-\-vcs\fR \fIvcs\fR +.RS 4 +Initialize a new VCS repository for the given version control system (git, +hg, pijul, or fossil) or do not initialize any version control at all +(none). If not specified, defaults to \fBgit\fR or the configuration value +\fBcargo\-new.vcs\fR, or \fBnone\fR if already inside a VCS repository. +.RE +.sp +\fB\-\-registry\fR \fIregistry\fR +.RS 4 +This sets the \fBpublish\fR field in \fBCargo.toml\fR to the given registry name +which will restrict publishing only to that registry. +.sp +Registry names are defined in \fICargo config files\fR \&. +If not specified, the default registry defined by the \fBregistry.default\fR +config key is used. If the default registry is not set and \fB\-\-registry\fR is not +used, the \fBpublish\fR field will not be set which means that publishing will not +be restricted. +.RE +.SS "Display Options" +.sp +\fB\-v\fR, +\fB\-\-verbose\fR +.RS 4 +Use verbose output. May be specified twice for \[lq]very verbose\[rq] output which +includes extra output such as dependency warnings and build script output. +May also be specified with the \fBterm.verbose\fR +\fIconfig value\fR \&. +.RE +.sp +\fB\-q\fR, +\fB\-\-quiet\fR +.RS 4 +Do not print cargo log messages. +May also be specified with the \fBterm.quiet\fR +\fIconfig value\fR \&. +.RE +.sp +\fB\-\-color\fR \fIwhen\fR +.RS 4 +Control when colored output is used. Valid values: +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBauto\fR (default): Automatically detect if color support is available on the +terminal. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBalways\fR: Always display colors. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBnever\fR: Never display colors. +.RE +.sp +May also be specified with the \fBterm.color\fR +\fIconfig value\fR \&. +.RE +.SS "Common Options" +.sp +\fB+\fR\fItoolchain\fR +.RS 4 +If Cargo has been installed with rustup, and the first argument to \fBcargo\fR +begins with \fB+\fR, it will be interpreted as a rustup toolchain name (such +as \fB+stable\fR or \fB+nightly\fR). +See the \fIrustup documentation\fR +for more information about how toolchain overrides work. +.RE +.sp +\fB\-\-config\fR \fIKEY=VALUE\fR or \fIPATH\fR +.RS 4 +Overrides a Cargo configuration value. The argument should be in TOML syntax of \fBKEY=VALUE\fR, +or provided as a path to an extra configuration file. This flag may be specified multiple times. +See the \fIcommand\-line overrides section\fR for more information. +.RE +.sp +\fB\-C\fR \fIPATH\fR +.RS 4 +Changes the current working directory before executing any specified operations. This affects +things like where cargo looks by default for the project manifest (\fBCargo.toml\fR), as well as +the directories searched for discovering \fB\&.cargo/config.toml\fR, for example. This option must +appear before the command name, for example \fBcargo \-C path/to/my\-project build\fR\&. +.sp +This option is only available on the \fInightly +channel\fR and +requires the \fB\-Z unstable\-options\fR flag to enable (see +\fI#10098\fR ). +.RE +.sp +\fB\-h\fR, +\fB\-\-help\fR +.RS 4 +Prints help information. +.RE +.sp +\fB\-Z\fR \fIflag\fR +.RS 4 +Unstable (nightly\-only) flags to Cargo. Run \fBcargo \-Z help\fR for details. +.RE +.SH "ENVIRONMENT" +See \fIthe reference\fR for +details on environment variables that Cargo reads. +.SH "EXIT STATUS" +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fB0\fR: Cargo succeeded. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fB101\fR: Cargo failed to complete. +.RE +.SH "EXAMPLES" +.sp +.RS 4 +\h'-04' 1.\h'+01'Create a binary Cargo package in the current directory: +.sp +.RS 4 +.nf +cargo init +.fi +.RE +.RE +.SH "SEE ALSO" +\fBcargo\fR(1), \fBcargo\-new\fR(1) diff --git a/rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-install.1 b/rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-install.1 new file mode 100644 index 0000000000000000000000000000000000000000..f96f53c1e5de306038a1b68a9e6daa758516f1dd --- /dev/null +++ b/rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-install.1 @@ -0,0 +1,538 @@ +'\" t +.TH "CARGO\-INSTALL" "1" +.nh +.ad l +.ss \n[.ss] 0 +.SH "NAME" +cargo\-install \[em] Build and install a Rust binary +.SH "SYNOPSIS" +\fBcargo install\fR [\fIoptions\fR] \fIcrate\fR[@\fIversion\fR]\[u2026] +.br +\fBcargo install\fR [\fIoptions\fR] \fB\-\-path\fR \fIpath\fR +.br +\fBcargo install\fR [\fIoptions\fR] \fB\-\-git\fR \fIurl\fR [\fIcrate\fR\[u2026]] +.br +\fBcargo install\fR [\fIoptions\fR] \fB\-\-list\fR +.SH "DESCRIPTION" +This command manages Cargo\[cq]s local set of installed binary crates. Only +packages which have executable \fB[[bin]]\fR or \fB[[example]]\fR targets can be +installed, and all executables are installed into the installation root\[cq]s +\fBbin\fR folder. By default only binaries, not examples, are installed. +.sp +The installation root is determined, in order of precedence: +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fB\-\-root\fR option +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBCARGO_INSTALL_ROOT\fR environment variable +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBinstall.root\fR Cargo \fIconfig value\fR +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBCARGO_HOME\fR environment variable +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fB$HOME/.cargo\fR +.RE +.sp +There are multiple sources from which a crate can be installed. The default +source location is crates.io but the \fB\-\-git\fR, \fB\-\-path\fR, and \fB\-\-registry\fR flags +can change this source. If the source contains more than one package (such as +crates.io or a git repository with multiple crates) the \fIcrate\fR argument is +required to indicate which crate should be installed. +.sp +Crates from crates.io can optionally specify the version they wish to install +via the \fB\-\-version\fR flags, and similarly packages from git repositories can +optionally specify the branch, tag, or revision that should be installed. If a +crate has multiple binaries, the \fB\-\-bin\fR argument can selectively install only +one of them, and if you\[cq]d rather install examples the \fB\-\-example\fR argument can +be used as well. +.sp +If the package is already installed, Cargo will reinstall it if the installed +version does not appear to be up\-to\-date. If any of the following values +change, then Cargo will reinstall the package: +.sp +.RS 4 +\h'-04'\(bu\h'+03'The package version and source. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'The set of binary names installed. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'The chosen features. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'The profile (\fB\-\-profile\fR). +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'The target (\fB\-\-target\fR). +.RE +.sp +Installing with \fB\-\-path\fR will always build and install, unless there are +conflicting binaries from another package. The \fB\-\-force\fR flag may be used to +force Cargo to always reinstall the package. +.sp +If the source is crates.io or \fB\-\-git\fR then by default the crate will be built +in a temporary target directory. To avoid this, the target directory can be +specified by setting the \fBCARGO_TARGET_DIR\fR environment variable to a relative +path. In particular, this can be useful for caching build artifacts on +continuous integration systems. +.SS "Dealing with the Lockfile" +By default, the \fBCargo.lock\fR file that is included with the package will be +ignored. This means that Cargo will recompute which versions of dependencies +to use, possibly using newer versions that have been released since the +package was published. The \fB\-\-locked\fR flag can be used to force Cargo to use +the packaged \fBCargo.lock\fR file if it is available. This may be useful for +ensuring reproducible builds, to use the exact same set of dependencies that +were available when the package was published. It may also be useful if a +newer version of a dependency is published that no longer builds on your +system, or has other problems. The downside to using \fB\-\-locked\fR is that you +will not receive any fixes or updates to any dependency. Note that Cargo did +not start publishing \fBCargo.lock\fR files until version 1.37, which means +packages published with prior versions will not have a \fBCargo.lock\fR file +available. +.SS "Configuration Discovery" +This command operates on system or user level, not project level. +This means that the local \fIconfiguration discovery\fR is ignored. +Instead, the configuration discovery begins at \fB$CARGO_HOME/config.toml\fR\&. +If the package is installed with \fB\-\-path $PATH\fR, the local configuration +will be used, beginning discovery at \fB$PATH/.cargo/config.toml\fR\&. +.SH "OPTIONS" +.SS "Install Options" +.sp +\fB\-\-vers\fR \fIversion\fR, +\fB\-\-version\fR \fIversion\fR +.RS 4 +Specify a version to install. This may be a \fIversion +requirement\fR , like \fB~1.2\fR, to have Cargo +select the newest version from the given requirement. If the version does not +have a requirement operator (such as \fB^\fR or \fB~\fR), then it must be in the form +\fIMAJOR.MINOR.PATCH\fR, and will install exactly that version; it is \fInot\fR +treated as a caret requirement like Cargo dependencies are. +.RE +.sp +\fB\-\-git\fR \fIurl\fR +.RS 4 +Git URL to install the specified crate from. +.RE +.sp +\fB\-\-branch\fR \fIbranch\fR +.RS 4 +Branch to use when installing from git. +.RE +.sp +\fB\-\-tag\fR \fItag\fR +.RS 4 +Tag to use when installing from git. +.RE +.sp +\fB\-\-rev\fR \fIsha\fR +.RS 4 +Specific commit to use when installing from git. +.RE +.sp +\fB\-\-path\fR \fIpath\fR +.RS 4 +Filesystem path to local crate to install from. +.RE +.sp +\fB\-\-list\fR +.RS 4 +List all installed packages and their versions. +.RE +.sp +\fB\-n\fR, +\fB\-\-dry\-run\fR +.RS 4 +(unstable) Perform all checks without installing. +.RE +.sp +\fB\-f\fR, +\fB\-\-force\fR +.RS 4 +Force overwriting existing crates or binaries. This can be used if a package +has installed a binary with the same name as another package. This is also +useful if something has changed on the system that you want to rebuild with, +such as a newer version of \fBrustc\fR\&. +.RE +.sp +\fB\-\-no\-track\fR +.RS 4 +By default, Cargo keeps track of the installed packages with a metadata file +stored in the installation root directory. This flag tells Cargo not to use or +create that file. With this flag, Cargo will refuse to overwrite any existing +files unless the \fB\-\-force\fR flag is used. This also disables Cargo\[cq]s ability to +protect against multiple concurrent invocations of Cargo installing at the +same time. +.RE +.sp +\fB\-\-bin\fR \fIname\fR\[u2026] +.RS 4 +Install only the specified binary. +.RE +.sp +\fB\-\-bins\fR +.RS 4 +Install all binaries. This is the default behavior. +.RE +.sp +\fB\-\-example\fR \fIname\fR\[u2026] +.RS 4 +Install only the specified example. +.RE +.sp +\fB\-\-examples\fR +.RS 4 +Install all examples. +.RE +.sp +\fB\-\-root\fR \fIdir\fR +.RS 4 +Directory to install packages into. +.RE +.sp +\fB\-\-registry\fR \fIregistry\fR +.RS 4 +Name of the registry to use. Registry names are defined in \fICargo config +files\fR \&. If not specified, the default registry is used, +which is defined by the \fBregistry.default\fR config key which defaults to +\fBcrates\-io\fR\&. +.RE +.sp +\fB\-\-index\fR \fIindex\fR +.RS 4 +The URL of the registry index to use. +.RE +.SS "Feature Selection" +The feature flags allow you to control which features are enabled. When no +feature options are given, the \fBdefault\fR feature is activated for every +selected package. +.sp +See \fIthe features documentation\fR +for more details. +.sp +\fB\-F\fR \fIfeatures\fR, +\fB\-\-features\fR \fIfeatures\fR +.RS 4 +Space or comma separated list of features to activate. Features of workspace +members may be enabled with \fBpackage\-name/feature\-name\fR syntax. This flag may +be specified multiple times, which enables all specified features. +.RE +.sp +\fB\-\-all\-features\fR +.RS 4 +Activate all available features of all selected packages. +.RE +.sp +\fB\-\-no\-default\-features\fR +.RS 4 +Do not activate the \fBdefault\fR feature of the selected packages. +.RE +.SS "Compilation Options" +.sp +\fB\-\-target\fR \fItriple\fR +.RS 4 +Install for the specified target architecture. The default is the host architecture. The general format of the triple is +\fB\-\-\-\fR\&. +.sp +Possible values: +.sp +.RS 4 +\h'-04'\(bu\h'+03'Any supported target in \fBrustc \-\-print target\-list\fR\&. +.RE +.sp +.RS 4 +\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). +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'A path to a custom target specification. See \fICustom Target Lookup Path\fR for more information. +.RE +.sp +This may also be specified with the \fBbuild.target\fR \fIconfig value\fR \&. +.sp +Note that specifying this flag makes Cargo run in a different mode where the +target artifacts are placed in a separate directory. See the +\fIbuild cache\fR documentation for more details. +.RE +.sp +\fB\-\-target\-dir\fR \fIdirectory\fR +.RS 4 +Directory for all generated artifacts and intermediate files. May also be +specified with the \fBCARGO_TARGET_DIR\fR environment variable, or the +\fBbuild.target\-dir\fR \fIconfig value\fR \&. +Defaults to a new temporary folder located in the +temporary directory of the platform. +.sp +When using \fB\-\-path\fR, by default it will use \fBtarget\fR directory in the workspace +of the local crate unless \fB\-\-target\-dir\fR +is specified. +.RE +.sp +\fB\-\-debug\fR +.RS 4 +Build with the \fBdev\fR profile instead of the \fBrelease\fR profile. +See also the \fB\-\-profile\fR option for choosing a specific profile by name. +.RE +.sp +\fB\-\-profile\fR \fIname\fR +.RS 4 +Install with the given profile. +See \fIthe reference\fR for more details on profiles. +.RE +.sp +\fB\-\-timings\fR +.RS 4 +Output information how long each compilation takes, and track concurrency +information over time. +.sp +A file \fBcargo\-timing.html\fR will be written to the \fBtarget/cargo\-timings\fR +directory at the end of the build. An additional report with a timestamp +in its filename is also written if you want to look at a previous run. +These reports are suitable for human consumption only, and do not provide +machine\-readable timing data. +.RE +.SS "Manifest Options" +.sp +\fB\-\-ignore\-rust\-version\fR +.RS 4 +Ignore \fBrust\-version\fR specification in packages. +.RE +.sp +\fB\-\-locked\fR +.RS 4 +Asserts that the exact same dependencies and versions are used as when the +existing \fBCargo.lock\fR file was originally generated. Cargo will exit with an +error when either of the following scenarios arises: +.sp +.RS 4 +\h'-04'\(bu\h'+03'The lock file is missing. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'Cargo attempted to change the lock file due to a different dependency resolution. +.RE +.sp +It may be used in environments where deterministic builds are desired, +such as in CI pipelines. +.RE +.sp +\fB\-\-offline\fR +.RS 4 +Prevents Cargo from accessing the network for any reason. Without this +flag, Cargo will stop with an error if it needs to access the network and +the network is not available. With this flag, Cargo will attempt to +proceed without the network if possible. +.sp +Beware that this may result in different dependency resolution than online +mode. Cargo will restrict itself to crates that are downloaded locally, even +if there might be a newer version as indicated in the local copy of the index. +See the \fBcargo\-fetch\fR(1) command to download dependencies before going +offline. +.sp +May also be specified with the \fBnet.offline\fR \fIconfig value\fR \&. +.RE +.sp +\fB\-\-frozen\fR +.RS 4 +Equivalent to specifying both \fB\-\-locked\fR and \fB\-\-offline\fR\&. +.RE +.SS "Miscellaneous Options" +.sp +\fB\-j\fR \fIN\fR, +\fB\-\-jobs\fR \fIN\fR +.RS 4 +Number of parallel jobs to run. May also be specified with the +\fBbuild.jobs\fR \fIconfig value\fR \&. Defaults to +the number of logical CPUs. If negative, it sets the maximum number of +parallel jobs to the number of logical CPUs plus provided value. If +a string \fBdefault\fR is provided, it sets the value back to defaults. +Should not be 0. +.RE +.sp +\fB\-\-keep\-going\fR +.RS 4 +Build as many crates in the dependency graph as possible, rather than aborting +the build on the first one that fails to build. +.sp +For example if the current package depends on dependencies \fBfails\fR and \fBworks\fR, +one of which fails to build, \fBcargo install \-j1\fR may or may not build the +one that succeeds (depending on which one of the two builds Cargo picked to run +first), whereas \fBcargo install \-j1 \-\-keep\-going\fR would definitely run both +builds, even if the one run first fails. +.RE +.SS "Display Options" +.sp +\fB\-v\fR, +\fB\-\-verbose\fR +.RS 4 +Use verbose output. May be specified twice for \[lq]very verbose\[rq] output which +includes extra output such as dependency warnings and build script output. +May also be specified with the \fBterm.verbose\fR +\fIconfig value\fR \&. +.RE +.sp +\fB\-q\fR, +\fB\-\-quiet\fR +.RS 4 +Do not print cargo log messages. +May also be specified with the \fBterm.quiet\fR +\fIconfig value\fR \&. +.RE +.sp +\fB\-\-color\fR \fIwhen\fR +.RS 4 +Control when colored output is used. Valid values: +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBauto\fR (default): Automatically detect if color support is available on the +terminal. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBalways\fR: Always display colors. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBnever\fR: Never display colors. +.RE +.sp +May also be specified with the \fBterm.color\fR +\fIconfig value\fR \&. +.RE +.sp +\fB\-\-message\-format\fR \fIfmt\fR +.RS 4 +The output format for diagnostic messages. Can be specified multiple times +and consists of comma\-separated values. Valid values: +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBhuman\fR (default): Display in a human\-readable text format. Conflicts with +\fBshort\fR and \fBjson\fR\&. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBshort\fR: Emit shorter, human\-readable text messages. Conflicts with \fBhuman\fR +and \fBjson\fR\&. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBjson\fR: Emit JSON messages to stdout. See +\fIthe reference\fR +for more details. Conflicts with \fBhuman\fR and \fBshort\fR\&. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBjson\-diagnostic\-short\fR: Ensure the \fBrendered\fR field of JSON messages contains +the \[lq]short\[rq] rendering from rustc. Cannot be used with \fBhuman\fR or \fBshort\fR\&. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBjson\-diagnostic\-rendered\-ansi\fR: Ensure the \fBrendered\fR field of JSON messages +contains embedded ANSI color codes for respecting rustc\[cq]s default color +scheme. Cannot be used with \fBhuman\fR or \fBshort\fR\&. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBjson\-render\-diagnostics\fR: Instruct Cargo to not include rustc diagnostics +in JSON messages printed, but instead Cargo itself should render the +JSON diagnostics coming from rustc. Cargo\[cq]s own JSON diagnostics and others +coming from rustc are still emitted. Cannot be used with \fBhuman\fR or \fBshort\fR\&. +.RE +.RE +.SS "Common Options" +.sp +\fB+\fR\fItoolchain\fR +.RS 4 +If Cargo has been installed with rustup, and the first argument to \fBcargo\fR +begins with \fB+\fR, it will be interpreted as a rustup toolchain name (such +as \fB+stable\fR or \fB+nightly\fR). +See the \fIrustup documentation\fR +for more information about how toolchain overrides work. +.RE +.sp +\fB\-\-config\fR \fIKEY=VALUE\fR or \fIPATH\fR +.RS 4 +Overrides a Cargo configuration value. The argument should be in TOML syntax of \fBKEY=VALUE\fR, +or provided as a path to an extra configuration file. This flag may be specified multiple times. +See the \fIcommand\-line overrides section\fR for more information. +.RE +.sp +\fB\-C\fR \fIPATH\fR +.RS 4 +Changes the current working directory before executing any specified operations. This affects +things like where cargo looks by default for the project manifest (\fBCargo.toml\fR), as well as +the directories searched for discovering \fB\&.cargo/config.toml\fR, for example. This option must +appear before the command name, for example \fBcargo \-C path/to/my\-project build\fR\&. +.sp +This option is only available on the \fInightly +channel\fR and +requires the \fB\-Z unstable\-options\fR flag to enable (see +\fI#10098\fR ). +.RE +.sp +\fB\-h\fR, +\fB\-\-help\fR +.RS 4 +Prints help information. +.RE +.sp +\fB\-Z\fR \fIflag\fR +.RS 4 +Unstable (nightly\-only) flags to Cargo. Run \fBcargo \-Z help\fR for details. +.RE +.SH "ENVIRONMENT" +See \fIthe reference\fR for +details on environment variables that Cargo reads. +.SH "EXIT STATUS" +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fB0\fR: Cargo succeeded. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fB101\fR: Cargo failed to complete. +.RE +.SH "EXAMPLES" +.sp +.RS 4 +\h'-04' 1.\h'+01'Install or upgrade a package from crates.io: +.sp +.RS 4 +.nf +cargo install ripgrep +.fi +.RE +.RE +.sp +.RS 4 +\h'-04' 2.\h'+01'Install or reinstall the package in the current directory: +.sp +.RS 4 +.nf +cargo install \-\-path . +.fi +.RE +.RE +.sp +.RS 4 +\h'-04' 3.\h'+01'View the list of installed packages: +.sp +.RS 4 +.nf +cargo install \-\-list +.fi +.RE +.RE +.SH "SEE ALSO" +\fBcargo\fR(1), \fBcargo\-uninstall\fR(1), \fBcargo\-search\fR(1), \fBcargo\-publish\fR(1) diff --git a/rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-locate-project.1 b/rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-locate-project.1 new file mode 100644 index 0000000000000000000000000000000000000000..83f7876a480eb02c48dafb802693a10ba68f84b4 --- /dev/null +++ b/rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-locate-project.1 @@ -0,0 +1,150 @@ +'\" t +.TH "CARGO\-LOCATE\-PROJECT" "1" +.nh +.ad l +.ss \n[.ss] 0 +.SH "NAME" +cargo\-locate\-project \[em] Print a JSON representation of a Cargo.toml file\[cq]s location +.SH "SYNOPSIS" +\fBcargo locate\-project\fR [\fIoptions\fR] +.SH "DESCRIPTION" +This command will print a JSON object to stdout with the full path to the manifest. The +manifest is found by searching upward for a file named \fBCargo.toml\fR starting from the current +working directory. +.sp +If the project happens to be a part of a workspace, the manifest of the project, rather than +the workspace root, is output. This can be overridden by the \fB\-\-workspace\fR flag. The root +workspace is found by traversing further upward or by using the field \fBpackage.workspace\fR after +locating the manifest of a workspace member. +.SH "OPTIONS" +.sp +\fB\-\-workspace\fR +.RS 4 +Locate the \fBCargo.toml\fR at the root of the workspace, as opposed to the current +workspace member. +.RE +.SS "Display Options" +.sp +\fB\-\-message\-format\fR \fIfmt\fR +.RS 4 +The representation in which to print the project location. Valid values: +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBjson\fR (default): JSON object with the path under the key \[lq]root\[rq]\&. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBplain\fR: Just the path. +.RE +.RE +.sp +\fB\-v\fR, +\fB\-\-verbose\fR +.RS 4 +Use verbose output. May be specified twice for \[lq]very verbose\[rq] output which +includes extra output such as dependency warnings and build script output. +May also be specified with the \fBterm.verbose\fR +\fIconfig value\fR \&. +.RE +.sp +\fB\-q\fR, +\fB\-\-quiet\fR +.RS 4 +Do not print cargo log messages. +May also be specified with the \fBterm.quiet\fR +\fIconfig value\fR \&. +.RE +.sp +\fB\-\-color\fR \fIwhen\fR +.RS 4 +Control when colored output is used. Valid values: +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBauto\fR (default): Automatically detect if color support is available on the +terminal. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBalways\fR: Always display colors. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBnever\fR: Never display colors. +.RE +.sp +May also be specified with the \fBterm.color\fR +\fIconfig value\fR \&. +.RE +.SS "Manifest Options" +.sp +\fB\-\-manifest\-path\fR \fIpath\fR +.RS 4 +Path to the \fBCargo.toml\fR file. By default, Cargo searches for the +\fBCargo.toml\fR file in the current directory or any parent directory. +.RE +.SS "Common Options" +.sp +\fB+\fR\fItoolchain\fR +.RS 4 +If Cargo has been installed with rustup, and the first argument to \fBcargo\fR +begins with \fB+\fR, it will be interpreted as a rustup toolchain name (such +as \fB+stable\fR or \fB+nightly\fR). +See the \fIrustup documentation\fR +for more information about how toolchain overrides work. +.RE +.sp +\fB\-\-config\fR \fIKEY=VALUE\fR or \fIPATH\fR +.RS 4 +Overrides a Cargo configuration value. The argument should be in TOML syntax of \fBKEY=VALUE\fR, +or provided as a path to an extra configuration file. This flag may be specified multiple times. +See the \fIcommand\-line overrides section\fR for more information. +.RE +.sp +\fB\-C\fR \fIPATH\fR +.RS 4 +Changes the current working directory before executing any specified operations. This affects +things like where cargo looks by default for the project manifest (\fBCargo.toml\fR), as well as +the directories searched for discovering \fB\&.cargo/config.toml\fR, for example. This option must +appear before the command name, for example \fBcargo \-C path/to/my\-project build\fR\&. +.sp +This option is only available on the \fInightly +channel\fR and +requires the \fB\-Z unstable\-options\fR flag to enable (see +\fI#10098\fR ). +.RE +.sp +\fB\-h\fR, +\fB\-\-help\fR +.RS 4 +Prints help information. +.RE +.sp +\fB\-Z\fR \fIflag\fR +.RS 4 +Unstable (nightly\-only) flags to Cargo. Run \fBcargo \-Z help\fR for details. +.RE +.SH "ENVIRONMENT" +See \fIthe reference\fR for +details on environment variables that Cargo reads. +.SH "EXIT STATUS" +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fB0\fR: Cargo succeeded. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fB101\fR: Cargo failed to complete. +.RE +.SH "EXAMPLES" +.sp +.RS 4 +\h'-04' 1.\h'+01'Display the path to the manifest based on the current directory: +.sp +.RS 4 +.nf +cargo locate\-project +.fi +.RE +.RE +.SH "SEE ALSO" +\fBcargo\fR(1), \fBcargo\-metadata\fR(1) diff --git a/rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-login.1 b/rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-login.1 new file mode 100644 index 0000000000000000000000000000000000000000..55f7189b87b65044523efa22c9a1ab5203e483c5 --- /dev/null +++ b/rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-login.1 @@ -0,0 +1,154 @@ +'\" t +.TH "CARGO\-LOGIN" "1" +.nh +.ad l +.ss \n[.ss] 0 +.SH "NAME" +cargo\-login \[em] Log in to a registry +.SH "SYNOPSIS" +\fBcargo login\fR [\fIoptions\fR] [\fB\-\-\fR \fIargs\fR] +.SH "DESCRIPTION" +This command will run a credential provider to save a token so that commands +that require authentication, such as \fBcargo\-publish\fR(1), will be +automatically authenticated. +.sp +All the arguments following the two dashes (\fB\-\-\fR) are passed to the credential provider. +.sp +For the default \fBcargo:token\fR credential provider, the token is saved +in \fB$CARGO_HOME/credentials.toml\fR\&. \fBCARGO_HOME\fR defaults to \fB\&.cargo\fR +in your home directory. +.sp +If a registry has a credential\-provider specified, it will be used. Otherwise, +the providers from the config value \fBregistry.global\-credential\-providers\fR will +be attempted, starting from the end of the list. +.sp +The \fItoken\fR will be read from stdin. +.sp +The API token for crates.io may be retrieved from \&. +.sp +Take care to keep the token secret, it should not be shared with anyone else. +.SH "OPTIONS" +.SS "Login Options" +.sp +\fB\-\-registry\fR \fIregistry\fR +.RS 4 +Name of the registry to use. Registry names are defined in \fICargo config +files\fR \&. If not specified, the default registry is used, +which is defined by the \fBregistry.default\fR config key which defaults to +\fBcrates\-io\fR\&. +.RE +.SS "Display Options" +.sp +\fB\-v\fR, +\fB\-\-verbose\fR +.RS 4 +Use verbose output. May be specified twice for \[lq]very verbose\[rq] output which +includes extra output such as dependency warnings and build script output. +May also be specified with the \fBterm.verbose\fR +\fIconfig value\fR \&. +.RE +.sp +\fB\-q\fR, +\fB\-\-quiet\fR +.RS 4 +Do not print cargo log messages. +May also be specified with the \fBterm.quiet\fR +\fIconfig value\fR \&. +.RE +.sp +\fB\-\-color\fR \fIwhen\fR +.RS 4 +Control when colored output is used. Valid values: +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBauto\fR (default): Automatically detect if color support is available on the +terminal. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBalways\fR: Always display colors. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBnever\fR: Never display colors. +.RE +.sp +May also be specified with the \fBterm.color\fR +\fIconfig value\fR \&. +.RE +.SS "Common Options" +.sp +\fB+\fR\fItoolchain\fR +.RS 4 +If Cargo has been installed with rustup, and the first argument to \fBcargo\fR +begins with \fB+\fR, it will be interpreted as a rustup toolchain name (such +as \fB+stable\fR or \fB+nightly\fR). +See the \fIrustup documentation\fR +for more information about how toolchain overrides work. +.RE +.sp +\fB\-\-config\fR \fIKEY=VALUE\fR or \fIPATH\fR +.RS 4 +Overrides a Cargo configuration value. The argument should be in TOML syntax of \fBKEY=VALUE\fR, +or provided as a path to an extra configuration file. This flag may be specified multiple times. +See the \fIcommand\-line overrides section\fR for more information. +.RE +.sp +\fB\-C\fR \fIPATH\fR +.RS 4 +Changes the current working directory before executing any specified operations. This affects +things like where cargo looks by default for the project manifest (\fBCargo.toml\fR), as well as +the directories searched for discovering \fB\&.cargo/config.toml\fR, for example. This option must +appear before the command name, for example \fBcargo \-C path/to/my\-project build\fR\&. +.sp +This option is only available on the \fInightly +channel\fR and +requires the \fB\-Z unstable\-options\fR flag to enable (see +\fI#10098\fR ). +.RE +.sp +\fB\-h\fR, +\fB\-\-help\fR +.RS 4 +Prints help information. +.RE +.sp +\fB\-Z\fR \fIflag\fR +.RS 4 +Unstable (nightly\-only) flags to Cargo. Run \fBcargo \-Z help\fR for details. +.RE +.SH "ENVIRONMENT" +See \fIthe reference\fR for +details on environment variables that Cargo reads. +.SH "EXIT STATUS" +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fB0\fR: Cargo succeeded. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fB101\fR: Cargo failed to complete. +.RE +.SH "EXAMPLES" +.sp +.RS 4 +\h'-04' 1.\h'+01'Save the token for the default registry: +.sp +.RS 4 +.nf +cargo login +.fi +.RE +.RE +.sp +.RS 4 +\h'-04' 2.\h'+01'Save the token for a specific registry: +.sp +.RS 4 +.nf +cargo login \-\-registry my\-registry +.fi +.RE +.RE +.SH "SEE ALSO" +\fBcargo\fR(1), \fBcargo\-logout\fR(1), \fBcargo\-publish\fR(1) diff --git a/rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-logout.1 b/rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-logout.1 new file mode 100644 index 0000000000000000000000000000000000000000..1611d543548d7c69e53d756a6993e6ec11326891 --- /dev/null +++ b/rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-logout.1 @@ -0,0 +1,153 @@ +'\" t +.TH "CARGO\-LOGOUT" "1" +.nh +.ad l +.ss \n[.ss] 0 +.SH "NAME" +cargo\-logout \[em] Remove an API token from the registry locally +.SH "SYNOPSIS" +\fBcargo logout\fR [\fIoptions\fR] +.SH "DESCRIPTION" +This command will run a credential provider to remove a saved token. +.sp +For the default \fBcargo:token\fR credential provider, credentials are stored +in \fB$CARGO_HOME/credentials.toml\fR where \fB$CARGO_HOME\fR defaults to \fB\&.cargo\fR +in your home directory. +.sp +If a registry has a credential\-provider specified, it will be used. Otherwise, +the providers from the config value \fBregistry.global\-credential\-providers\fR will +be attempted, starting from the end of the list. +.sp +If \fB\-\-registry\fR is not specified, then the credentials for the default +registry will be removed (configured by +\fI\f(BIregistry.default\fI\fR , which defaults +to ). +.sp +This will not revoke the token on the server. If you need to revoke the token, +visit the registry website and follow its instructions (see + to revoke the token for ). +.SH "OPTIONS" +.SS "Logout Options" +.sp +\fB\-\-registry\fR \fIregistry\fR +.RS 4 +Name of the registry to use. Registry names are defined in \fICargo config +files\fR \&. If not specified, the default registry is used, +which is defined by the \fBregistry.default\fR config key which defaults to +\fBcrates\-io\fR\&. +.RE +.SS "Display Options" +.sp +\fB\-v\fR, +\fB\-\-verbose\fR +.RS 4 +Use verbose output. May be specified twice for \[lq]very verbose\[rq] output which +includes extra output such as dependency warnings and build script output. +May also be specified with the \fBterm.verbose\fR +\fIconfig value\fR \&. +.RE +.sp +\fB\-q\fR, +\fB\-\-quiet\fR +.RS 4 +Do not print cargo log messages. +May also be specified with the \fBterm.quiet\fR +\fIconfig value\fR \&. +.RE +.sp +\fB\-\-color\fR \fIwhen\fR +.RS 4 +Control when colored output is used. Valid values: +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBauto\fR (default): Automatically detect if color support is available on the +terminal. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBalways\fR: Always display colors. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBnever\fR: Never display colors. +.RE +.sp +May also be specified with the \fBterm.color\fR +\fIconfig value\fR \&. +.RE +.SS "Common Options" +.sp +\fB+\fR\fItoolchain\fR +.RS 4 +If Cargo has been installed with rustup, and the first argument to \fBcargo\fR +begins with \fB+\fR, it will be interpreted as a rustup toolchain name (such +as \fB+stable\fR or \fB+nightly\fR). +See the \fIrustup documentation\fR +for more information about how toolchain overrides work. +.RE +.sp +\fB\-\-config\fR \fIKEY=VALUE\fR or \fIPATH\fR +.RS 4 +Overrides a Cargo configuration value. The argument should be in TOML syntax of \fBKEY=VALUE\fR, +or provided as a path to an extra configuration file. This flag may be specified multiple times. +See the \fIcommand\-line overrides section\fR for more information. +.RE +.sp +\fB\-C\fR \fIPATH\fR +.RS 4 +Changes the current working directory before executing any specified operations. This affects +things like where cargo looks by default for the project manifest (\fBCargo.toml\fR), as well as +the directories searched for discovering \fB\&.cargo/config.toml\fR, for example. This option must +appear before the command name, for example \fBcargo \-C path/to/my\-project build\fR\&. +.sp +This option is only available on the \fInightly +channel\fR and +requires the \fB\-Z unstable\-options\fR flag to enable (see +\fI#10098\fR ). +.RE +.sp +\fB\-h\fR, +\fB\-\-help\fR +.RS 4 +Prints help information. +.RE +.sp +\fB\-Z\fR \fIflag\fR +.RS 4 +Unstable (nightly\-only) flags to Cargo. Run \fBcargo \-Z help\fR for details. +.RE +.SH "ENVIRONMENT" +See \fIthe reference\fR for +details on environment variables that Cargo reads. +.SH "EXIT STATUS" +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fB0\fR: Cargo succeeded. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fB101\fR: Cargo failed to complete. +.RE +.SH "EXAMPLES" +.sp +.RS 4 +\h'-04' 1.\h'+01'Remove the default registry token: +.sp +.RS 4 +.nf +cargo logout +.fi +.RE +.RE +.sp +.RS 4 +\h'-04' 2.\h'+01'Remove the token for a specific registry: +.sp +.RS 4 +.nf +cargo logout \-\-registry my\-registry +.fi +.RE +.RE +.SH "SEE ALSO" +\fBcargo\fR(1), \fBcargo\-login\fR(1) diff --git a/rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-metadata.1 b/rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-metadata.1 new file mode 100644 index 0000000000000000000000000000000000000000..ad6dee4ebb5c05fd99402997a6e18d40694e40e5 --- /dev/null +++ b/rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-metadata.1 @@ -0,0 +1,552 @@ +'\" t +.TH "CARGO\-METADATA" "1" +.nh +.ad l +.ss \n[.ss] 0 +.SH "NAME" +cargo\-metadata \[em] Machine\-readable metadata about the current package +.SH "SYNOPSIS" +\fBcargo metadata\fR [\fIoptions\fR] +.SH "DESCRIPTION" +Output JSON to stdout containing information about the workspace members and +resolved dependencies of the current package. +.sp +The output format is subject to change in future versions of Cargo. It +is recommended to include the \fB\-\-format\-version\fR flag to future\-proof your code +and ensure the output is in the format you are expecting. For more on the +expectations, see \[lq]Compatibility\[rq]\&. +.sp +See the \fIcargo_metadata crate\fR +for a Rust API for reading the metadata. +.SH "OUTPUT FORMAT" +.SS "Compatibility" +Within the same output format version, the compatibility is maintained, except +some scenarios. The following is a non\-exhaustive list of changes that are not +considered as incompatible: +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBAdding new fields\fR \[em] New fields will be added when needed. Reserving this +helps Cargo evolve without bumping the format version too often. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBAdding new values for enum\-like fields\fR \[em] Same as adding new fields. It +keeps metadata evolving without stagnation. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBChanging opaque representations\fR \[em] The inner representations of some +fields are implementation details. For example, fields related to +\[lq]Source ID\[rq] are treated as opaque identifiers to differentiate packages or +sources. Consumers shouldn\[cq]t rely on those representations unless specified. +.RE +.SS "JSON format" +The JSON output has the following format: +.sp +.RS 4 +.nf +{ + /* Array of all packages in the workspace. + It also includes all feature\-enabled dependencies unless \-\-no\-deps is used. + */ + "packages": [ + { + /* The name of the package. */ + "name": "my\-package", + /* The version of the package. */ + "version": "0.1.0", + /* The Package ID for referring to the + package within the document and as the `\-\-package` argument to many commands + */ + "id": "file:///path/to/my\-package#0.1.0", + /* The license value from the manifest, or null. */ + "license": "MIT/Apache\-2.0", + /* The license\-file value from the manifest, or null. */ + "license_file": "LICENSE", + /* The description value from the manifest, or null. */ + "description": "Package description.", + /* The source ID of the package, an "opaque" identifier representing + where a package is retrieved from. See "Compatibility" above for + the stability guarantee. + + This is null for path dependencies and workspace members. + + For other dependencies, it is a string with the format: + \- "registry+URL" for registry\-based dependencies. + Example: "registry+https://github.com/rust\-lang/crates.io\-index" + \- "git+URL" for git\-based dependencies. + Example: "git+https://github.com/rust\-lang/cargo?rev=5e85ba14aaa20f8133863373404cb0af69eeef2c#5e85ba14aaa20f8133863373404cb0af69eeef2c" + \- "sparse+URL" for dependencies from a sparse registry + Example: "sparse+https://my\-sparse\-registry.org" + + The value after the `+` is not explicitly defined, and may change + between versions of Cargo and may not directly correlate to other + things, such as registry definitions in a config file. New source + kinds may be added in the future which will have different `+` + prefixed identifiers. + */ + "source": null, + /* Array of dependencies declared in the package's manifest. */ + "dependencies": [ + { + /* The name of the dependency. */ + "name": "bitflags", + /* The source ID of the dependency. May be null, see + description for the package source. + */ + "source": "registry+https://github.com/rust\-lang/crates.io\-index", + /* The version requirement for the dependency. + Dependencies without a version requirement have a value of "*". + */ + "req": "^1.0", + /* The dependency kind. + "dev", "build", or null for a normal dependency. + */ + "kind": null, + /* If the dependency is renamed, this is the new name for + the dependency as a string. null if it is not renamed. + */ + "rename": null, + /* Boolean of whether or not this is an optional dependency. */ + "optional": false, + /* Boolean of whether or not default features are enabled. */ + "uses_default_features": true, + /* Array of features enabled. */ + "features": [], + /* The target platform for the dependency. + null if not a target dependency. + */ + "target": "cfg(windows)", + /* The file system path for a local path dependency. + not present if not a path dependency. + */ + "path": "/path/to/dep", + /* A string of the URL of the registry this dependency is from. + If not specified or null, the dependency is from the default + registry (crates.io). + */ + "registry": null, + /* (unstable) Boolean flag of whether or not this is a pulbic + dependency. This field is only present when + `\-Zpublic\-dependency` is enabled. + */ + "public": false + } + ], + /* Array of Cargo targets. */ + "targets": [ + { + /* Array of target kinds. + \- lib targets list the `crate\-type` values from the + manifest such as "lib", "rlib", "dylib", + "proc\-macro", etc. (default ["lib"]) + \- binary is ["bin"] + \- example is ["example"] + \- integration test is ["test"] + \- benchmark is ["bench"] + \- build script is ["custom\-build"] + */ + "kind": [ + "bin" + ], + /* Array of crate types. + \- lib and example libraries list the `crate\-type` values + from the manifest such as "lib", "rlib", "dylib", + "proc\-macro", etc. (default ["lib"]) + \- all other target kinds are ["bin"] + */ + "crate_types": [ + "bin" + ], + /* The name of the target. + For lib targets, dashes will be replaced with underscores. + */ + "name": "my\-package", + /* Absolute path to the root source file of the target. */ + "src_path": "/path/to/my\-package/src/main.rs", + /* The Rust edition of the target. + Defaults to the package edition. + */ + "edition": "2018", + /* Array of required features. + This property is not included if no required features are set. + */ + "required\-features": ["feat1"], + /* Whether the target should be documented by `cargo doc`. */ + "doc": true, + /* Whether or not this target has doc tests enabled, and + the target is compatible with doc testing. + */ + "doctest": false, + /* Whether or not this target should be built and run with `\-\-test` + */ + "test": true + } + ], + /* Set of features defined for the package. + Each feature maps to an array of features or dependencies it + enables. + */ + "features": { + "default": [ + "feat1" + ], + "feat1": [], + "feat2": [] + }, + /* Absolute path to this package's manifest. */ + "manifest_path": "/path/to/my\-package/Cargo.toml", + /* Package metadata. + This is null if no metadata is specified. + */ + "metadata": { + "docs": { + "rs": { + "all\-features": true + } + } + }, + /* List of registries to which this package may be published. + Publishing is unrestricted if null, and forbidden if an empty array. */ + "publish": [ + "crates\-io" + ], + /* Array of authors from the manifest. + Empty array if no authors specified. + */ + "authors": [ + "Jane Doe " + ], + /* Array of categories from the manifest. */ + "categories": [ + "command\-line\-utilities" + ], + /* Optional string that is the default binary picked by cargo run. */ + "default_run": null, + /* Optional string that is the minimum supported rust version */ + "rust_version": "1.56", + /* Array of keywords from the manifest. */ + "keywords": [ + "cli" + ], + /* The readme value from the manifest or null if not specified. */ + "readme": "README.md", + /* The repository value from the manifest or null if not specified. */ + "repository": "https://github.com/rust\-lang/cargo", + /* The homepage value from the manifest or null if not specified. */ + "homepage": "https://rust\-lang.org", + /* The documentation value from the manifest or null if not specified. */ + "documentation": "https://doc.rust\-lang.org/stable/std", + /* The default edition of the package. + Note that individual targets may have different editions. + */ + "edition": "2018", + /* Optional string that is the name of a native library the package + is linking to. + */ + "links": null, + } + ], + /* Array of members of the workspace. + Each entry is the Package ID for the package. + */ + "workspace_members": [ + "file:///path/to/my\-package#0.1.0", + ], + /* Array of default members of the workspace. + Each entry is the Package ID for the package. + */ + "workspace_default_members": [ + "file:///path/to/my\-package#0.1.0", + ], + // The resolved dependency graph for the entire workspace. The enabled + // features are based on the enabled features for the "current" package. + // Inactivated optional dependencies are not listed. + // + // This is null if \-\-no\-deps is specified. + // + // By default, this includes all dependencies for all target platforms. + // The `\-\-filter\-platform` flag may be used to narrow to a specific + // target triple. + "resolve": { + /* Array of nodes within the dependency graph. + Each node is a package. + */ + "nodes": [ + { + /* The Package ID of this node. */ + "id": "file:///path/to/my\-package#0.1.0", + /* The dependencies of this package, an array of Package IDs. */ + "dependencies": [ + "https://github.com/rust\-lang/crates.io\-index#bitflags@1.0.4" + ], + /* The dependencies of this package. This is an alternative to + "dependencies" which contains additional information. In + particular, this handles renamed dependencies. + */ + "deps": [ + { + /* The name of the dependency's library target. + If this is a renamed dependency, this is the new + name. + */ + "name": "bitflags", + /* The Package ID of the dependency. */ + "pkg": "https://github.com/rust\-lang/crates.io\-index#bitflags@1.0.4" + /* Array of dependency kinds. Added in Cargo 1.40. */ + "dep_kinds": [ + { + /* The dependency kind. + "dev", "build", or null for a normal dependency. + */ + "kind": null, + /* The target platform for the dependency. + null if not a target dependency. + */ + "target": "cfg(windows)" + } + ] + } + ], + /* Array of features enabled on this package. */ + "features": [ + "default" + ] + } + ], + /* The package in the current working directory (if \-\-manifest\-path is not given). + This is null if there is a virtual workspace. Otherwise it is + the Package ID of the package. + */ + "root": "file:///path/to/my\-package#0.1.0", + }, + /* The absolute path to the target directory where Cargo places its output. */ + "target_directory": "/path/to/my\-package/target", + /* The absolute path to the build directory where Cargo places intermediate build artifacts. (unstable) */ + "build_directory": "/path/to/my\-package/build\-dir", + /* The version of the schema for this metadata structure. + This will be changed if incompatible changes are ever made. + */ + "version": 1, + /* The absolute path to the root of the workspace. */ + "workspace_root": "/path/to/my\-package" + /* Workspace metadata. + This is null if no metadata is specified. */ + "metadata": { + "docs": { + "rs": { + "all\-features": true + } + } + } +} +.fi +.RE +.sp +Notes: +.sp +.RS 4 +\h'-04'\(bu\h'+03'For \fB"id"\fR field syntax, see \fIPackage ID Specifications\fR in the reference. +.RE +.SH "OPTIONS" +.SS "Output Options" +.sp +\fB\-\-no\-deps\fR +.RS 4 +Output information only about the workspace members and don\[cq]t fetch +dependencies. +.RE +.sp +\fB\-\-format\-version\fR \fIversion\fR +.RS 4 +Specify the version of the output format to use. Currently \fB1\fR is the only +possible value. +.RE +.sp +\fB\-\-filter\-platform\fR \fItriple\fR +.RS 4 +This filters the \fBresolve\fR output to only include dependencies for the +given \fItarget triple\fR \&. +A literal \fB"host\-tuple"\fR can be used, which will internally be substituted by the host\[cq]s target. +Without this flag, the resolve includes all targets. +.sp +Note that the dependencies listed in the \[lq]packages\[rq] array still includes all +dependencies. Each package definition is intended to be an unaltered +reproduction of the information within \fBCargo.toml\fR\&. +.RE +.SS "Feature Selection" +The feature flags allow you to control which features are enabled. When no +feature options are given, the \fBdefault\fR feature is activated for every +selected package. +.sp +See \fIthe features documentation\fR +for more details. +.sp +\fB\-F\fR \fIfeatures\fR, +\fB\-\-features\fR \fIfeatures\fR +.RS 4 +Space or comma separated list of features to activate. Features of workspace +members may be enabled with \fBpackage\-name/feature\-name\fR syntax. This flag may +be specified multiple times, which enables all specified features. +.RE +.sp +\fB\-\-all\-features\fR +.RS 4 +Activate all available features of all selected packages. +.RE +.sp +\fB\-\-no\-default\-features\fR +.RS 4 +Do not activate the \fBdefault\fR feature of the selected packages. +.RE +.SS "Display Options" +.sp +\fB\-v\fR, +\fB\-\-verbose\fR +.RS 4 +Use verbose output. May be specified twice for \[lq]very verbose\[rq] output which +includes extra output such as dependency warnings and build script output. +May also be specified with the \fBterm.verbose\fR +\fIconfig value\fR \&. +.RE +.sp +\fB\-q\fR, +\fB\-\-quiet\fR +.RS 4 +Do not print cargo log messages. +May also be specified with the \fBterm.quiet\fR +\fIconfig value\fR \&. +.RE +.sp +\fB\-\-color\fR \fIwhen\fR +.RS 4 +Control when colored output is used. Valid values: +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBauto\fR (default): Automatically detect if color support is available on the +terminal. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBalways\fR: Always display colors. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBnever\fR: Never display colors. +.RE +.sp +May also be specified with the \fBterm.color\fR +\fIconfig value\fR \&. +.RE +.SS "Manifest Options" +.sp +\fB\-\-manifest\-path\fR \fIpath\fR +.RS 4 +Path to the \fBCargo.toml\fR file. By default, Cargo searches for the +\fBCargo.toml\fR file in the current directory or any parent directory. +.RE +.sp +\fB\-\-locked\fR +.RS 4 +Asserts that the exact same dependencies and versions are used as when the +existing \fBCargo.lock\fR file was originally generated. Cargo will exit with an +error when either of the following scenarios arises: +.sp +.RS 4 +\h'-04'\(bu\h'+03'The lock file is missing. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'Cargo attempted to change the lock file due to a different dependency resolution. +.RE +.sp +It may be used in environments where deterministic builds are desired, +such as in CI pipelines. +.RE +.sp +\fB\-\-offline\fR +.RS 4 +Prevents Cargo from accessing the network for any reason. Without this +flag, Cargo will stop with an error if it needs to access the network and +the network is not available. With this flag, Cargo will attempt to +proceed without the network if possible. +.sp +Beware that this may result in different dependency resolution than online +mode. Cargo will restrict itself to crates that are downloaded locally, even +if there might be a newer version as indicated in the local copy of the index. +See the \fBcargo\-fetch\fR(1) command to download dependencies before going +offline. +.sp +May also be specified with the \fBnet.offline\fR \fIconfig value\fR \&. +.RE +.sp +\fB\-\-frozen\fR +.RS 4 +Equivalent to specifying both \fB\-\-locked\fR and \fB\-\-offline\fR\&. +.RE +.SS "Common Options" +.sp +\fB+\fR\fItoolchain\fR +.RS 4 +If Cargo has been installed with rustup, and the first argument to \fBcargo\fR +begins with \fB+\fR, it will be interpreted as a rustup toolchain name (such +as \fB+stable\fR or \fB+nightly\fR). +See the \fIrustup documentation\fR +for more information about how toolchain overrides work. +.RE +.sp +\fB\-\-config\fR \fIKEY=VALUE\fR or \fIPATH\fR +.RS 4 +Overrides a Cargo configuration value. The argument should be in TOML syntax of \fBKEY=VALUE\fR, +or provided as a path to an extra configuration file. This flag may be specified multiple times. +See the \fIcommand\-line overrides section\fR for more information. +.RE +.sp +\fB\-C\fR \fIPATH\fR +.RS 4 +Changes the current working directory before executing any specified operations. This affects +things like where cargo looks by default for the project manifest (\fBCargo.toml\fR), as well as +the directories searched for discovering \fB\&.cargo/config.toml\fR, for example. This option must +appear before the command name, for example \fBcargo \-C path/to/my\-project build\fR\&. +.sp +This option is only available on the \fInightly +channel\fR and +requires the \fB\-Z unstable\-options\fR flag to enable (see +\fI#10098\fR ). +.RE +.sp +\fB\-h\fR, +\fB\-\-help\fR +.RS 4 +Prints help information. +.RE +.sp +\fB\-Z\fR \fIflag\fR +.RS 4 +Unstable (nightly\-only) flags to Cargo. Run \fBcargo \-Z help\fR for details. +.RE +.SH "ENVIRONMENT" +See \fIthe reference\fR for +details on environment variables that Cargo reads. +.SH "EXIT STATUS" +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fB0\fR: Cargo succeeded. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fB101\fR: Cargo failed to complete. +.RE +.SH "EXAMPLES" +.sp +.RS 4 +\h'-04' 1.\h'+01'Output JSON about the current package: +.sp +.RS 4 +.nf +cargo metadata \-\-format\-version=1 +.fi +.RE +.RE +.SH "SEE ALSO" +\fBcargo\fR(1), \fBcargo\-pkgid\fR(1), \fIPackage ID Specifications\fR , \fIJSON messages\fR diff --git a/rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-new.1 b/rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-new.1 new file mode 100644 index 0000000000000000000000000000000000000000..6a33a8a7c966fd2da25abb21425f2e94aef498ef --- /dev/null +++ b/rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-new.1 @@ -0,0 +1,166 @@ +'\" t +.TH "CARGO\-NEW" "1" +.nh +.ad l +.ss \n[.ss] 0 +.SH "NAME" +cargo\-new \[em] Create a new Cargo package +.SH "SYNOPSIS" +\fBcargo new\fR [\fIoptions\fR] \fIpath\fR +.SH "DESCRIPTION" +This command will create a new Cargo package in the given directory. This +includes a simple template with a \fBCargo.toml\fR manifest, sample source file, +and a VCS ignore file. If the directory is not already in a VCS repository, +then a new repository is created (see \fB\-\-vcs\fR below). +.sp +See \fBcargo\-init\fR(1) for a similar command which will create a new manifest +in an existing directory. +.SH "OPTIONS" +.SS "New Options" +.sp +\fB\-\-bin\fR +.RS 4 +Create a package with a binary target (\fBsrc/main.rs\fR). +This is the default behavior. +.RE +.sp +\fB\-\-lib\fR +.RS 4 +Create a package with a library target (\fBsrc/lib.rs\fR). +.RE +.sp +\fB\-\-edition\fR \fIedition\fR +.RS 4 +Specify the Rust edition to use. Default is 2024. +Possible values: 2015, 2018, 2021, 2024 +.RE +.sp +\fB\-\-name\fR \fIname\fR +.RS 4 +Set the package name. Defaults to the directory name. +.RE +.sp +\fB\-\-vcs\fR \fIvcs\fR +.RS 4 +Initialize a new VCS repository for the given version control system (git, +hg, pijul, or fossil) or do not initialize any version control at all +(none). If not specified, defaults to \fBgit\fR or the configuration value +\fBcargo\-new.vcs\fR, or \fBnone\fR if already inside a VCS repository. +.RE +.sp +\fB\-\-registry\fR \fIregistry\fR +.RS 4 +This sets the \fBpublish\fR field in \fBCargo.toml\fR to the given registry name +which will restrict publishing only to that registry. +.sp +Registry names are defined in \fICargo config files\fR \&. +If not specified, the default registry defined by the \fBregistry.default\fR +config key is used. If the default registry is not set and \fB\-\-registry\fR is not +used, the \fBpublish\fR field will not be set which means that publishing will not +be restricted. +.RE +.SS "Display Options" +.sp +\fB\-v\fR, +\fB\-\-verbose\fR +.RS 4 +Use verbose output. May be specified twice for \[lq]very verbose\[rq] output which +includes extra output such as dependency warnings and build script output. +May also be specified with the \fBterm.verbose\fR +\fIconfig value\fR \&. +.RE +.sp +\fB\-q\fR, +\fB\-\-quiet\fR +.RS 4 +Do not print cargo log messages. +May also be specified with the \fBterm.quiet\fR +\fIconfig value\fR \&. +.RE +.sp +\fB\-\-color\fR \fIwhen\fR +.RS 4 +Control when colored output is used. Valid values: +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBauto\fR (default): Automatically detect if color support is available on the +terminal. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBalways\fR: Always display colors. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBnever\fR: Never display colors. +.RE +.sp +May also be specified with the \fBterm.color\fR +\fIconfig value\fR \&. +.RE +.SS "Common Options" +.sp +\fB+\fR\fItoolchain\fR +.RS 4 +If Cargo has been installed with rustup, and the first argument to \fBcargo\fR +begins with \fB+\fR, it will be interpreted as a rustup toolchain name (such +as \fB+stable\fR or \fB+nightly\fR). +See the \fIrustup documentation\fR +for more information about how toolchain overrides work. +.RE +.sp +\fB\-\-config\fR \fIKEY=VALUE\fR or \fIPATH\fR +.RS 4 +Overrides a Cargo configuration value. The argument should be in TOML syntax of \fBKEY=VALUE\fR, +or provided as a path to an extra configuration file. This flag may be specified multiple times. +See the \fIcommand\-line overrides section\fR for more information. +.RE +.sp +\fB\-C\fR \fIPATH\fR +.RS 4 +Changes the current working directory before executing any specified operations. This affects +things like where cargo looks by default for the project manifest (\fBCargo.toml\fR), as well as +the directories searched for discovering \fB\&.cargo/config.toml\fR, for example. This option must +appear before the command name, for example \fBcargo \-C path/to/my\-project build\fR\&. +.sp +This option is only available on the \fInightly +channel\fR and +requires the \fB\-Z unstable\-options\fR flag to enable (see +\fI#10098\fR ). +.RE +.sp +\fB\-h\fR, +\fB\-\-help\fR +.RS 4 +Prints help information. +.RE +.sp +\fB\-Z\fR \fIflag\fR +.RS 4 +Unstable (nightly\-only) flags to Cargo. Run \fBcargo \-Z help\fR for details. +.RE +.SH "ENVIRONMENT" +See \fIthe reference\fR for +details on environment variables that Cargo reads. +.SH "EXIT STATUS" +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fB0\fR: Cargo succeeded. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fB101\fR: Cargo failed to complete. +.RE +.SH "EXAMPLES" +.sp +.RS 4 +\h'-04' 1.\h'+01'Create a binary Cargo package in the given directory: +.sp +.RS 4 +.nf +cargo new foo +.fi +.RE +.RE +.SH "SEE ALSO" +\fBcargo\fR(1), \fBcargo\-init\fR(1) diff --git a/rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-owner.1 b/rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-owner.1 new file mode 100644 index 0000000000000000000000000000000000000000..36e0d4d681a6f819eaa6a8036502f1d7ffd8405c --- /dev/null +++ b/rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-owner.1 @@ -0,0 +1,197 @@ +'\" t +.TH "CARGO\-OWNER" "1" +.nh +.ad l +.ss \n[.ss] 0 +.SH "NAME" +cargo\-owner \[em] Manage the owners of a crate on the registry +.SH "SYNOPSIS" +\fBcargo owner\fR [\fIoptions\fR] \fB\-\-add\fR \fIlogin\fR [\fIcrate\fR] +.br +\fBcargo owner\fR [\fIoptions\fR] \fB\-\-remove\fR \fIlogin\fR [\fIcrate\fR] +.br +\fBcargo owner\fR [\fIoptions\fR] \fB\-\-list\fR [\fIcrate\fR] +.SH "DESCRIPTION" +This command will modify the owners for a crate on the registry. Owners of a +crate can upload new versions and yank old versions. Non\-team owners can also +modify the set of owners, so take care! +.sp +This command requires you to be authenticated with either the \fB\-\-token\fR option +or using \fBcargo\-login\fR(1). +.sp +If the crate name is not specified, it will use the package name from the +current directory. +.sp +See \fIthe reference\fR for more +information about owners and publishing. +.SH "OPTIONS" +.SS "Owner Options" +.sp +\fB\-a\fR, +\fB\-\-add\fR \fIlogin\fR\[u2026] +.RS 4 +Invite the given user or team as an owner. +.RE +.sp +\fB\-r\fR, +\fB\-\-remove\fR \fIlogin\fR\[u2026] +.RS 4 +Remove the given user or team as an owner. +.RE +.sp +\fB\-l\fR, +\fB\-\-list\fR +.RS 4 +List owners of a crate. +.RE +.sp +\fB\-\-token\fR \fItoken\fR +.RS 4 +API token to use when authenticating. This overrides the token stored in +the credentials file (which is created by \fBcargo\-login\fR(1)). +.sp +\fICargo config\fR environment variables can be +used to override the tokens stored in the credentials file. The token for +crates.io may be specified with the \fBCARGO_REGISTRY_TOKEN\fR environment +variable. Tokens for other registries may be specified with environment +variables of the form \fBCARGO_REGISTRIES_NAME_TOKEN\fR where \fBNAME\fR is the name +of the registry in all capital letters. +.RE +.sp +\fB\-\-index\fR \fIindex\fR +.RS 4 +The URL of the registry index to use. +.RE +.sp +\fB\-\-registry\fR \fIregistry\fR +.RS 4 +Name of the registry to use. Registry names are defined in \fICargo config +files\fR \&. If not specified, the default registry is used, +which is defined by the \fBregistry.default\fR config key which defaults to +\fBcrates\-io\fR\&. +.RE +.SS "Display Options" +.sp +\fB\-v\fR, +\fB\-\-verbose\fR +.RS 4 +Use verbose output. May be specified twice for \[lq]very verbose\[rq] output which +includes extra output such as dependency warnings and build script output. +May also be specified with the \fBterm.verbose\fR +\fIconfig value\fR \&. +.RE +.sp +\fB\-q\fR, +\fB\-\-quiet\fR +.RS 4 +Do not print cargo log messages. +May also be specified with the \fBterm.quiet\fR +\fIconfig value\fR \&. +.RE +.sp +\fB\-\-color\fR \fIwhen\fR +.RS 4 +Control when colored output is used. Valid values: +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBauto\fR (default): Automatically detect if color support is available on the +terminal. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBalways\fR: Always display colors. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBnever\fR: Never display colors. +.RE +.sp +May also be specified with the \fBterm.color\fR +\fIconfig value\fR \&. +.RE +.SS "Common Options" +.sp +\fB+\fR\fItoolchain\fR +.RS 4 +If Cargo has been installed with rustup, and the first argument to \fBcargo\fR +begins with \fB+\fR, it will be interpreted as a rustup toolchain name (such +as \fB+stable\fR or \fB+nightly\fR). +See the \fIrustup documentation\fR +for more information about how toolchain overrides work. +.RE +.sp +\fB\-\-config\fR \fIKEY=VALUE\fR or \fIPATH\fR +.RS 4 +Overrides a Cargo configuration value. The argument should be in TOML syntax of \fBKEY=VALUE\fR, +or provided as a path to an extra configuration file. This flag may be specified multiple times. +See the \fIcommand\-line overrides section\fR for more information. +.RE +.sp +\fB\-C\fR \fIPATH\fR +.RS 4 +Changes the current working directory before executing any specified operations. This affects +things like where cargo looks by default for the project manifest (\fBCargo.toml\fR), as well as +the directories searched for discovering \fB\&.cargo/config.toml\fR, for example. This option must +appear before the command name, for example \fBcargo \-C path/to/my\-project build\fR\&. +.sp +This option is only available on the \fInightly +channel\fR and +requires the \fB\-Z unstable\-options\fR flag to enable (see +\fI#10098\fR ). +.RE +.sp +\fB\-h\fR, +\fB\-\-help\fR +.RS 4 +Prints help information. +.RE +.sp +\fB\-Z\fR \fIflag\fR +.RS 4 +Unstable (nightly\-only) flags to Cargo. Run \fBcargo \-Z help\fR for details. +.RE +.SH "ENVIRONMENT" +See \fIthe reference\fR for +details on environment variables that Cargo reads. +.SH "EXIT STATUS" +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fB0\fR: Cargo succeeded. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fB101\fR: Cargo failed to complete. +.RE +.SH "EXAMPLES" +.sp +.RS 4 +\h'-04' 1.\h'+01'List owners of a package: +.sp +.RS 4 +.nf +cargo owner \-\-list foo +.fi +.RE +.RE +.sp +.RS 4 +\h'-04' 2.\h'+01'Invite an owner to a package: +.sp +.RS 4 +.nf +cargo owner \-\-add username foo +.fi +.RE +.RE +.sp +.RS 4 +\h'-04' 3.\h'+01'Remove an owner from a package: +.sp +.RS 4 +.nf +cargo owner \-\-remove username foo +.fi +.RE +.RE +.SH "SEE ALSO" +\fBcargo\fR(1), \fBcargo\-login\fR(1), \fBcargo\-publish\fR(1) diff --git a/rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-package.1 b/rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-package.1 new file mode 100644 index 0000000000000000000000000000000000000000..0e162bbfd12baa623008fece324cd0fb2d1ca71c --- /dev/null +++ b/rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-package.1 @@ -0,0 +1,472 @@ +'\" t +.TH "CARGO\-PACKAGE" "1" +.nh +.ad l +.ss \n[.ss] 0 +.SH "NAME" +cargo\-package \[em] Assemble the local package into a distributable tarball +.SH "SYNOPSIS" +\fBcargo package\fR [\fIoptions\fR] +.SH "DESCRIPTION" +This command will create a distributable, compressed \fB\&.crate\fR file with the +source code of the package in the current directory. The resulting file will be +stored in the \fBtarget/package\fR directory. This performs the following steps: +.sp +.RS 4 +\h'-04' 1.\h'+01'Load and check the current workspace, performing some basic checks. +.sp +.RS 4 +\h'-04'\(bu\h'+03'Path dependencies are not allowed unless they have a version key. Cargo +will ignore the path key for dependencies in published packages. +\fBdev\-dependencies\fR do not have this restriction. +.RE +.RE +.sp +.RS 4 +\h'-04' 2.\h'+01'Create the compressed \fB\&.crate\fR file. +.sp +.RS 4 +\h'-04'\(bu\h'+03'The original \fBCargo.toml\fR file is rewritten and normalized. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fB[patch]\fR, \fB[replace]\fR, and \fB[workspace]\fR sections are removed from the +manifest. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBCargo.lock\fR is always included. When missing, a new lock file will be +generated unless the \fB\-\-exclude\-lockfile\fR flag is used. \fBcargo\-install\fR(1) +will use the packaged lock file if the \fB\-\-locked\fR flag is used. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'A \fB\&.cargo_vcs_info.json\fR file is included that contains information +about the current VCS checkout hash if available, as well as a flag if the +worktree is dirty. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'Symlinks are flattened to their target files. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'Files and directories are included or excluded based on rules mentioned in +\fIthe \f(BI[include]\fI and \f(BI[exclude]\fI fields\fR \&. +.RE +.RE +.sp +.RS 4 +\h'-04' 3.\h'+01'Extract the \fB\&.crate\fR file and build it to verify it can build. +.sp +.RS 4 +\h'-04'\(bu\h'+03'This will rebuild your package from scratch to ensure that it can be +built from a pristine state. The \fB\-\-no\-verify\fR flag can be used to skip +this step. +.RE +.RE +.sp +.RS 4 +\h'-04' 4.\h'+01'Check that build scripts did not modify any source files. +.RE +.sp +The list of files included can be controlled with the \fBinclude\fR and \fBexclude\fR +fields in the manifest. +.sp +See \fIthe reference\fR for more details about +packaging and publishing. +.SS ".cargo_vcs_info.json format" +Will generate a \fB\&.cargo_vcs_info.json\fR in the following format +.sp +.RS 4 +.nf +{ + "git": { + "sha1": "aac20b6e7e543e6dd4118b246c77225e3a3a1302", + "dirty": true + }, + "path_in_vcs": "" +} +.fi +.RE +.sp +\fBdirty\fR indicates that the Git worktree was dirty when the package +was built. +.sp +\fBpath_in_vcs\fR will be set to a repo\-relative path for packages +in subdirectories of the version control repository. +.sp +The compatibility of this file is maintained under the same policy +as the JSON output of \fBcargo\-metadata\fR(1). +.sp +Note that this file provides a best\-effort snapshot of the VCS information. +However, the provenance of the package is not verified. +There is no guarantee that the source code in the tarball matches the VCS information. +.SH "OPTIONS" +.SS "Package Options" +.sp +\fB\-l\fR, +\fB\-\-list\fR +.RS 4 +Print files included in a package without making one. +.RE +.sp +\fB\-\-no\-verify\fR +.RS 4 +Don\[cq]t verify the contents by building them. +.RE +.sp +\fB\-\-no\-metadata\fR +.RS 4 +Ignore warnings about a lack of human\-usable metadata (such as the description +or the license). +.RE +.sp +\fB\-\-allow\-dirty\fR +.RS 4 +Allow working directories with uncommitted VCS changes to be packaged. +.RE +.sp +\fB\-\-exclude\-lockfile\fR +.RS 4 +Don\[cq]t include the lock file when packaging. +.sp +This flag is not for general use. +Some tools may expect a lock file to be present (e.g. \fBcargo install \-\-locked\fR). +Consider other options before using this. +.RE +.sp +\fB\-\-index\fR \fIindex\fR +.RS 4 +The URL of the registry index to use. +.RE +.sp +\fB\-\-registry\fR \fIregistry\fR +.RS 4 +Name of the registry to package for; see \fBcargo publish \-\-help\fR for more details +about configuration of registry names. The packages will not be published +to this registry, but if we are packaging multiple inter\-dependent crates, +lock\-files will be generated under the assumption that dependencies will be +published to this registry. +.RE +.sp +\fB\-\-message\-format\fR \fIfmt\fR +.RS 4 +Specifies the output message format. +Currently, it only works with \fB\-\-list\fR and affects the file listing format. +This is unstable and requires \fB\-Zunstable\-options\fR\&. +Valid output formats: +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBhuman\fR (default): Display in a file\-per\-line format. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBjson\fR: Emit machine\-readable JSON information about each package. +One package per JSON line (Newline delimited JSON). +.sp +.RS 4 +.nf +{ + /* The Package ID Spec of the package. */ + "id": "path+file:///home/foo#0.0.0", + /* Files of this package */ + "files" { + /* Relative path in the archive file. */ + "Cargo.toml.orig": { + /* Where the file is from. + \- "generate" for file being generated during packaging + \- "copy" for file being copied from another location. + */ + "kind": "copy", + /* For the "copy" kind, + it is an absolute path to the actual file content. + For the "generate" kind, + it is the original file the generated one is based on. + */ + "path": "/home/foo/Cargo.toml" + }, + "Cargo.toml": { + "kind": "generate", + "path": "/home/foo/Cargo.toml" + }, + "src/main.rs": { + "kind": "copy", + "path": "/home/foo/src/main.rs" + } + } +} +.fi +.RE +.RE +.RE +.SS "Package Selection" +By default, when no package selection options are given, the packages selected +depend on the selected manifest file (based on the current working directory if +\fB\-\-manifest\-path\fR is not given). If the manifest is the root of a workspace then +the workspaces default members are selected, otherwise only the package defined +by the manifest will be selected. +.sp +The default members of a workspace can be set explicitly with the +\fBworkspace.default\-members\fR key in the root manifest. If this is not set, a +virtual workspace will include all workspace members (equivalent to passing +\fB\-\-workspace\fR), and a non\-virtual workspace will include only the root crate itself. +.sp +\fB\-p\fR \fIspec\fR\[u2026], +\fB\-\-package\fR \fIspec\fR\[u2026] +.RS 4 +Package only the specified packages. See \fBcargo\-pkgid\fR(1) for the +SPEC format. This flag may be specified multiple times and supports common Unix +glob patterns like \fB*\fR, \fB?\fR and \fB[]\fR\&. However, to avoid your shell accidentally +expanding glob patterns before Cargo handles them, you must use single quotes or +double quotes around each pattern. +.RE +.sp +\fB\-\-workspace\fR +.RS 4 +Package all members in the workspace. +.RE +.sp +\fB\-\-exclude\fR \fISPEC\fR\[u2026] +.RS 4 +Exclude the specified packages. Must be used in conjunction with the +\fB\-\-workspace\fR flag. This flag may be specified multiple times and supports +common Unix glob patterns like \fB*\fR, \fB?\fR and \fB[]\fR\&. However, to avoid your shell +accidentally expanding glob patterns before Cargo handles them, you must use +single quotes or double quotes around each pattern. +.RE +.SS "Compilation Options" +.sp +\fB\-\-target\fR \fItriple\fR +.RS 4 +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 +\fB\-\-\-\fR\&. +.sp +Possible values: +.sp +.RS 4 +\h'-04'\(bu\h'+03'Any supported target in \fBrustc \-\-print target\-list\fR\&. +.RE +.sp +.RS 4 +\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). +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'A path to a custom target specification. See \fICustom Target Lookup Path\fR for more information. +.RE +.sp +This may also be specified with the \fBbuild.target\fR \fIconfig value\fR \&. +.sp +Note that specifying this flag makes Cargo run in a different mode where the +target artifacts are placed in a separate directory. See the +\fIbuild cache\fR documentation for more details. +.RE +.sp +\fB\-\-target\-dir\fR \fIdirectory\fR +.RS 4 +Directory for all generated artifacts and intermediate files. May also be +specified with the \fBCARGO_TARGET_DIR\fR environment variable, or the +\fBbuild.target\-dir\fR \fIconfig value\fR \&. +Defaults to \fBtarget\fR in the root of the workspace. +.RE +.SS "Feature Selection" +The feature flags allow you to control which features are enabled. When no +feature options are given, the \fBdefault\fR feature is activated for every +selected package. +.sp +See \fIthe features documentation\fR +for more details. +.sp +\fB\-F\fR \fIfeatures\fR, +\fB\-\-features\fR \fIfeatures\fR +.RS 4 +Space or comma separated list of features to activate. Features of workspace +members may be enabled with \fBpackage\-name/feature\-name\fR syntax. This flag may +be specified multiple times, which enables all specified features. +.RE +.sp +\fB\-\-all\-features\fR +.RS 4 +Activate all available features of all selected packages. +.RE +.sp +\fB\-\-no\-default\-features\fR +.RS 4 +Do not activate the \fBdefault\fR feature of the selected packages. +.RE +.SS "Manifest Options" +.sp +\fB\-\-manifest\-path\fR \fIpath\fR +.RS 4 +Path to the \fBCargo.toml\fR file. By default, Cargo searches for the +\fBCargo.toml\fR file in the current directory or any parent directory. +.RE +.sp +\fB\-\-locked\fR +.RS 4 +Asserts that the exact same dependencies and versions are used as when the +existing \fBCargo.lock\fR file was originally generated. Cargo will exit with an +error when either of the following scenarios arises: +.sp +.RS 4 +\h'-04'\(bu\h'+03'The lock file is missing. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'Cargo attempted to change the lock file due to a different dependency resolution. +.RE +.sp +It may be used in environments where deterministic builds are desired, +such as in CI pipelines. +.RE +.sp +\fB\-\-offline\fR +.RS 4 +Prevents Cargo from accessing the network for any reason. Without this +flag, Cargo will stop with an error if it needs to access the network and +the network is not available. With this flag, Cargo will attempt to +proceed without the network if possible. +.sp +Beware that this may result in different dependency resolution than online +mode. Cargo will restrict itself to crates that are downloaded locally, even +if there might be a newer version as indicated in the local copy of the index. +See the \fBcargo\-fetch\fR(1) command to download dependencies before going +offline. +.sp +May also be specified with the \fBnet.offline\fR \fIconfig value\fR \&. +.RE +.sp +\fB\-\-frozen\fR +.RS 4 +Equivalent to specifying both \fB\-\-locked\fR and \fB\-\-offline\fR\&. +.RE +.SS "Miscellaneous Options" +.sp +\fB\-j\fR \fIN\fR, +\fB\-\-jobs\fR \fIN\fR +.RS 4 +Number of parallel jobs to run. May also be specified with the +\fBbuild.jobs\fR \fIconfig value\fR \&. Defaults to +the number of logical CPUs. If negative, it sets the maximum number of +parallel jobs to the number of logical CPUs plus provided value. If +a string \fBdefault\fR is provided, it sets the value back to defaults. +Should not be 0. +.RE +.sp +\fB\-\-keep\-going\fR +.RS 4 +Build as many crates in the dependency graph as possible, rather than aborting +the build on the first one that fails to build. +.sp +For example if the current package depends on dependencies \fBfails\fR and \fBworks\fR, +one of which fails to build, \fBcargo package \-j1\fR may or may not build the +one that succeeds (depending on which one of the two builds Cargo picked to run +first), whereas \fBcargo package \-j1 \-\-keep\-going\fR would definitely run both +builds, even if the one run first fails. +.RE +.SS "Display Options" +.sp +\fB\-v\fR, +\fB\-\-verbose\fR +.RS 4 +Use verbose output. May be specified twice for \[lq]very verbose\[rq] output which +includes extra output such as dependency warnings and build script output. +May also be specified with the \fBterm.verbose\fR +\fIconfig value\fR \&. +.RE +.sp +\fB\-q\fR, +\fB\-\-quiet\fR +.RS 4 +Do not print cargo log messages. +May also be specified with the \fBterm.quiet\fR +\fIconfig value\fR \&. +.RE +.sp +\fB\-\-color\fR \fIwhen\fR +.RS 4 +Control when colored output is used. Valid values: +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBauto\fR (default): Automatically detect if color support is available on the +terminal. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBalways\fR: Always display colors. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBnever\fR: Never display colors. +.RE +.sp +May also be specified with the \fBterm.color\fR +\fIconfig value\fR \&. +.RE +.SS "Common Options" +.sp +\fB+\fR\fItoolchain\fR +.RS 4 +If Cargo has been installed with rustup, and the first argument to \fBcargo\fR +begins with \fB+\fR, it will be interpreted as a rustup toolchain name (such +as \fB+stable\fR or \fB+nightly\fR). +See the \fIrustup documentation\fR +for more information about how toolchain overrides work. +.RE +.sp +\fB\-\-config\fR \fIKEY=VALUE\fR or \fIPATH\fR +.RS 4 +Overrides a Cargo configuration value. The argument should be in TOML syntax of \fBKEY=VALUE\fR, +or provided as a path to an extra configuration file. This flag may be specified multiple times. +See the \fIcommand\-line overrides section\fR for more information. +.RE +.sp +\fB\-C\fR \fIPATH\fR +.RS 4 +Changes the current working directory before executing any specified operations. This affects +things like where cargo looks by default for the project manifest (\fBCargo.toml\fR), as well as +the directories searched for discovering \fB\&.cargo/config.toml\fR, for example. This option must +appear before the command name, for example \fBcargo \-C path/to/my\-project build\fR\&. +.sp +This option is only available on the \fInightly +channel\fR and +requires the \fB\-Z unstable\-options\fR flag to enable (see +\fI#10098\fR ). +.RE +.sp +\fB\-h\fR, +\fB\-\-help\fR +.RS 4 +Prints help information. +.RE +.sp +\fB\-Z\fR \fIflag\fR +.RS 4 +Unstable (nightly\-only) flags to Cargo. Run \fBcargo \-Z help\fR for details. +.RE +.SH "ENVIRONMENT" +See \fIthe reference\fR for +details on environment variables that Cargo reads. +.SH "EXIT STATUS" +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fB0\fR: Cargo succeeded. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fB101\fR: Cargo failed to complete. +.RE +.SH "EXAMPLES" +.sp +.RS 4 +\h'-04' 1.\h'+01'Create a compressed \fB\&.crate\fR file of the current package: +.sp +.RS 4 +.nf +cargo package +.fi +.RE +.RE +.SH "SEE ALSO" +\fBcargo\fR(1), \fBcargo\-publish\fR(1) diff --git a/rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-pkgid.1 b/rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-pkgid.1 new file mode 100644 index 0000000000000000000000000000000000000000..94c4fd1ea42436a3583243788e7d744b22937fb1 --- /dev/null +++ b/rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-pkgid.1 @@ -0,0 +1,258 @@ +'\" t +.TH "CARGO\-PKGID" "1" +.nh +.ad l +.ss \n[.ss] 0 +.SH "NAME" +cargo\-pkgid \[em] Print a fully qualified package specification +.SH "SYNOPSIS" +\fBcargo pkgid\fR [\fIoptions\fR] [\fIspec\fR] +.SH "DESCRIPTION" +Given a \fIspec\fR argument, print out the fully qualified package ID specifier +for a package or dependency in the current workspace. This command will +generate an error if \fIspec\fR is ambiguous as to which package it refers to in +the dependency graph. If no \fIspec\fR is given, then the specifier for the local +package is printed. +.sp +This command requires that a lockfile is available and dependencies have been +fetched. +.sp +A package specifier consists of a name, version, and source URL. You are +allowed to use partial specifiers to succinctly match a specific package as +long as it matches only one package. This specifier is also used by other parts +in Cargo, such as \fBcargo\-metadata\fR(1) and \fIJSON messages\fR emitted by Cargo. +.sp +The format of a \fIspec\fR can be one of the following: + +.TS +allbox tab(:); +lt lt. +T{ +SPEC Structure +T}:T{ +Example SPEC +T} +T{ +\fIname\fR +T}:T{ +\fBbitflags\fR +T} +T{ +\fIname\fR\fB@\fR\fIversion\fR +T}:T{ +\fBbitflags@1.0.4\fR +T} +T{ +\fIurl\fR +T}:T{ +\fBhttps://github.com/rust\-lang/cargo\fR +T} +T{ +\fIurl\fR\fB#\fR\fIversion\fR +T}:T{ +\fBhttps://github.com/rust\-lang/cargo#0.33.0\fR +T} +T{ +\fIurl\fR\fB#\fR\fIname\fR +T}:T{ +\fBhttps://github.com/rust\-lang/crates.io\-index#bitflags\fR +T} +T{ +\fIurl\fR\fB#\fR\fIname\fR\fB@\fR\fIversion\fR +T}:T{ +\fBhttps://github.com/rust\-lang/cargo#crates\-io@0.21.0\fR +T} +.TE +.sp +.sp +The specification grammar can be found in chapter \fIPackage ID Specifications\fR \&. +.SH "OPTIONS" +.SS "Package Selection" +.sp +\fB\-p\fR \fIspec\fR, +\fB\-\-package\fR \fIspec\fR +.RS 4 +Get the package ID for the given package instead of the current package. +.RE +.SS "Display Options" +.sp +\fB\-v\fR, +\fB\-\-verbose\fR +.RS 4 +Use verbose output. May be specified twice for \[lq]very verbose\[rq] output which +includes extra output such as dependency warnings and build script output. +May also be specified with the \fBterm.verbose\fR +\fIconfig value\fR \&. +.RE +.sp +\fB\-q\fR, +\fB\-\-quiet\fR +.RS 4 +Do not print cargo log messages. +May also be specified with the \fBterm.quiet\fR +\fIconfig value\fR \&. +.RE +.sp +\fB\-\-color\fR \fIwhen\fR +.RS 4 +Control when colored output is used. Valid values: +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBauto\fR (default): Automatically detect if color support is available on the +terminal. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBalways\fR: Always display colors. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBnever\fR: Never display colors. +.RE +.sp +May also be specified with the \fBterm.color\fR +\fIconfig value\fR \&. +.RE +.SS "Manifest Options" +.sp +\fB\-\-manifest\-path\fR \fIpath\fR +.RS 4 +Path to the \fBCargo.toml\fR file. By default, Cargo searches for the +\fBCargo.toml\fR file in the current directory or any parent directory. +.RE +.sp +\fB\-\-locked\fR +.RS 4 +Asserts that the exact same dependencies and versions are used as when the +existing \fBCargo.lock\fR file was originally generated. Cargo will exit with an +error when either of the following scenarios arises: +.sp +.RS 4 +\h'-04'\(bu\h'+03'The lock file is missing. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'Cargo attempted to change the lock file due to a different dependency resolution. +.RE +.sp +It may be used in environments where deterministic builds are desired, +such as in CI pipelines. +.RE +.sp +\fB\-\-offline\fR +.RS 4 +Prevents Cargo from accessing the network for any reason. Without this +flag, Cargo will stop with an error if it needs to access the network and +the network is not available. With this flag, Cargo will attempt to +proceed without the network if possible. +.sp +Beware that this may result in different dependency resolution than online +mode. Cargo will restrict itself to crates that are downloaded locally, even +if there might be a newer version as indicated in the local copy of the index. +See the \fBcargo\-fetch\fR(1) command to download dependencies before going +offline. +.sp +May also be specified with the \fBnet.offline\fR \fIconfig value\fR \&. +.RE +.sp +\fB\-\-frozen\fR +.RS 4 +Equivalent to specifying both \fB\-\-locked\fR and \fB\-\-offline\fR\&. +.RE +.SS "Common Options" +.sp +\fB+\fR\fItoolchain\fR +.RS 4 +If Cargo has been installed with rustup, and the first argument to \fBcargo\fR +begins with \fB+\fR, it will be interpreted as a rustup toolchain name (such +as \fB+stable\fR or \fB+nightly\fR). +See the \fIrustup documentation\fR +for more information about how toolchain overrides work. +.RE +.sp +\fB\-\-config\fR \fIKEY=VALUE\fR or \fIPATH\fR +.RS 4 +Overrides a Cargo configuration value. The argument should be in TOML syntax of \fBKEY=VALUE\fR, +or provided as a path to an extra configuration file. This flag may be specified multiple times. +See the \fIcommand\-line overrides section\fR for more information. +.RE +.sp +\fB\-C\fR \fIPATH\fR +.RS 4 +Changes the current working directory before executing any specified operations. This affects +things like where cargo looks by default for the project manifest (\fBCargo.toml\fR), as well as +the directories searched for discovering \fB\&.cargo/config.toml\fR, for example. This option must +appear before the command name, for example \fBcargo \-C path/to/my\-project build\fR\&. +.sp +This option is only available on the \fInightly +channel\fR and +requires the \fB\-Z unstable\-options\fR flag to enable (see +\fI#10098\fR ). +.RE +.sp +\fB\-h\fR, +\fB\-\-help\fR +.RS 4 +Prints help information. +.RE +.sp +\fB\-Z\fR \fIflag\fR +.RS 4 +Unstable (nightly\-only) flags to Cargo. Run \fBcargo \-Z help\fR for details. +.RE +.SH "ENVIRONMENT" +See \fIthe reference\fR for +details on environment variables that Cargo reads. +.SH "EXIT STATUS" +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fB0\fR: Cargo succeeded. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fB101\fR: Cargo failed to complete. +.RE +.SH "EXAMPLES" +.sp +.RS 4 +\h'-04' 1.\h'+01'Retrieve package specification for \fBfoo\fR package: +.sp +.RS 4 +.nf +cargo pkgid foo +.fi +.RE +.RE +.sp +.RS 4 +\h'-04' 2.\h'+01'Retrieve package specification for version 1.0.0 of \fBfoo\fR: +.sp +.RS 4 +.nf +cargo pkgid foo@1.0.0 +.fi +.RE +.RE +.sp +.RS 4 +\h'-04' 3.\h'+01'Retrieve package specification for \fBfoo\fR from crates.io: +.sp +.RS 4 +.nf +cargo pkgid https://github.com/rust\-lang/crates.io\-index#foo +.fi +.RE +.RE +.sp +.RS 4 +\h'-04' 4.\h'+01'Retrieve package specification for \fBfoo\fR from a local package: +.sp +.RS 4 +.nf +cargo pkgid file:///path/to/local/package#foo +.fi +.RE +.RE +.SH "SEE ALSO" +\fBcargo\fR(1), \fBcargo\-generate\-lockfile\fR(1), \fBcargo\-metadata\fR(1), +\fIPackage ID Specifications\fR , \fIJSON messages\fR diff --git a/rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-publish.1 b/rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-publish.1 new file mode 100644 index 0000000000000000000000000000000000000000..a41c729ff1f28ab8907c73576ce9e8382d0990ea --- /dev/null +++ b/rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/man/man1/cargo-publish.1 @@ -0,0 +1,353 @@ +'\" t +.TH "CARGO\-PUBLISH" "1" +.nh +.ad l +.ss \n[.ss] 0 +.SH "NAME" +cargo\-publish \[em] Upload a package to the registry +.SH "SYNOPSIS" +\fBcargo publish\fR [\fIoptions\fR] +.SH "DESCRIPTION" +This command will create a distributable, compressed \fB\&.crate\fR file with the +source code of the package in the current directory and upload it to a +registry. The default registry is \&. This performs the +following steps: +.sp +.RS 4 +\h'-04' 1.\h'+01'Performs a few checks, including: +.sp +.RS 4 +\h'-04'\(bu\h'+03'Checks the \fBpackage.publish\fR key in the manifest for restrictions on +which registries you are allowed to publish to. +.RE +.RE +.sp +.RS 4 +\h'-04' 2.\h'+01'Create a \fB\&.crate\fR file by following the steps in \fBcargo\-package\fR(1). +.RE +.sp +.RS 4 +\h'-04' 3.\h'+01'Upload the crate to the registry. The server will perform additional +checks on the crate. +.RE +.sp +.RS 4 +\h'-04' 4.\h'+01'The client will poll waiting for the package to appear in the index, +and may timeout. In that case, you will need to check for completion +manually. This timeout does not affect the upload. +.RE +.sp +This command requires you to be authenticated using \fBcargo\-login\fR(1) +or environment variables of the \fI\f(BIregistry.token\fI\fR +and \fI\f(BIregistries..token\fI\fR config fields. +.sp +See \fIthe reference\fR for more details about +packaging and publishing. +.SH "OPTIONS" +.SS "Publish Options" +.sp +\fB\-\-dry\-run\fR +.RS 4 +Perform all checks without uploading. +.RE +.sp +\fB\-\-no\-verify\fR +.RS 4 +Don\[cq]t verify the contents by building them. +.RE +.sp +\fB\-\-allow\-dirty\fR +.RS 4 +Allow working directories with uncommitted VCS changes to be packaged. +.RE +.sp +\fB\-\-index\fR \fIindex\fR +.RS 4 +The URL of the registry index to use. +.RE +.sp +\fB\-\-registry\fR \fIregistry\fR +.RS 4 +Name of the registry to publish to. Registry names are defined in \fICargo +config files\fR \&. If not specified, and there is a +\fI\f(BIpackage.publish\fI\fR field in +\fBCargo.toml\fR with a single registry, then it will publish to that registry. +Otherwise it will use the default registry, which is defined by the +\fI\f(BIregistry.default\fI\fR config key +which defaults to \fBcrates\-io\fR\&. +.RE +.SS "Package Selection" +By default, when no package selection options are given, the packages selected +depend on the selected manifest file (based on the current working directory if +\fB\-\-manifest\-path\fR is not given). If the manifest is the root of a workspace then +the workspaces default members are selected, otherwise only the package defined +by the manifest will be selected. +.sp +The default members of a workspace can be set explicitly with the +\fBworkspace.default\-members\fR key in the root manifest. If this is not set, a +virtual workspace will include all workspace members (equivalent to passing +\fB\-\-workspace\fR), and a non\-virtual workspace will include only the root crate itself. +.sp +\fB\-p\fR \fIspec\fR\[u2026], +\fB\-\-package\fR \fIspec\fR\[u2026] +.RS 4 +Publish only the specified packages. See \fBcargo\-pkgid\fR(1) for the +SPEC format. This flag may be specified multiple times and supports common Unix +glob patterns like \fB*\fR, \fB?\fR and \fB[]\fR\&. However, to avoid your shell accidentally +expanding glob patterns before Cargo handles them, you must use single quotes or +double quotes around each pattern. +.RE +.sp +\fB\-\-workspace\fR +.RS 4 +Publish all members in the workspace. +.RE +.sp +\fB\-\-all\fR +.RS 4 +Deprecated alias for \fB\-\-workspace\fR\&. +.RE +.sp +\fB\-\-exclude\fR \fISPEC\fR\[u2026] +.RS 4 +Exclude the specified packages. Must be used in conjunction with the +\fB\-\-workspace\fR flag. This flag may be specified multiple times and supports +common Unix glob patterns like \fB*\fR, \fB?\fR and \fB[]\fR\&. However, to avoid your shell +accidentally expanding glob patterns before Cargo handles them, you must use +single quotes or double quotes around each pattern. +.RE +.SS "Compilation Options" +.sp +\fB\-\-target\fR \fItriple\fR +.RS 4 +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 +\fB\-\-\-\fR\&. +.sp +Possible values: +.sp +.RS 4 +\h'-04'\(bu\h'+03'Any supported target in \fBrustc \-\-print target\-list\fR\&. +.RE +.sp +.RS 4 +\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). +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'A path to a custom target specification. See \fICustom Target Lookup Path\fR for more information. +.RE +.sp +This may also be specified with the \fBbuild.target\fR \fIconfig value\fR \&. +.sp +Note that specifying this flag makes Cargo run in a different mode where the +target artifacts are placed in a separate directory. See the +\fIbuild cache\fR documentation for more details. +.RE +.sp +\fB\-\-target\-dir\fR \fIdirectory\fR +.RS 4 +Directory for all generated artifacts and intermediate files. May also be +specified with the \fBCARGO_TARGET_DIR\fR environment variable, or the +\fBbuild.target\-dir\fR \fIconfig value\fR \&. +Defaults to \fBtarget\fR in the root of the workspace. +.RE +.SS "Feature Selection" +The feature flags allow you to control which features are enabled. When no +feature options are given, the \fBdefault\fR feature is activated for every +selected package. +.sp +See \fIthe features documentation\fR +for more details. +.sp +\fB\-F\fR \fIfeatures\fR, +\fB\-\-features\fR \fIfeatures\fR +.RS 4 +Space or comma separated list of features to activate. Features of workspace +members may be enabled with \fBpackage\-name/feature\-name\fR syntax. This flag may +be specified multiple times, which enables all specified features. +.RE +.sp +\fB\-\-all\-features\fR +.RS 4 +Activate all available features of all selected packages. +.RE +.sp +\fB\-\-no\-default\-features\fR +.RS 4 +Do not activate the \fBdefault\fR feature of the selected packages. +.RE +.SS "Manifest Options" +.sp +\fB\-\-manifest\-path\fR \fIpath\fR +.RS 4 +Path to the \fBCargo.toml\fR file. By default, Cargo searches for the +\fBCargo.toml\fR file in the current directory or any parent directory. +.RE +.sp +\fB\-\-locked\fR +.RS 4 +Asserts that the exact same dependencies and versions are used as when the +existing \fBCargo.lock\fR file was originally generated. Cargo will exit with an +error when either of the following scenarios arises: +.sp +.RS 4 +\h'-04'\(bu\h'+03'The lock file is missing. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'Cargo attempted to change the lock file due to a different dependency resolution. +.RE +.sp +It may be used in environments where deterministic builds are desired, +such as in CI pipelines. +.RE +.sp +\fB\-\-offline\fR +.RS 4 +Prevents Cargo from accessing the network for any reason. Without this +flag, Cargo will stop with an error if it needs to access the network and +the network is not available. With this flag, Cargo will attempt to +proceed without the network if possible. +.sp +Beware that this may result in different dependency resolution than online +mode. Cargo will restrict itself to crates that are downloaded locally, even +if there might be a newer version as indicated in the local copy of the index. +See the \fBcargo\-fetch\fR(1) command to download dependencies before going +offline. +.sp +May also be specified with the \fBnet.offline\fR \fIconfig value\fR \&. +.RE +.sp +\fB\-\-frozen\fR +.RS 4 +Equivalent to specifying both \fB\-\-locked\fR and \fB\-\-offline\fR\&. +.RE +.SS "Miscellaneous Options" +.sp +\fB\-j\fR \fIN\fR, +\fB\-\-jobs\fR \fIN\fR +.RS 4 +Number of parallel jobs to run. May also be specified with the +\fBbuild.jobs\fR \fIconfig value\fR \&. Defaults to +the number of logical CPUs. If negative, it sets the maximum number of +parallel jobs to the number of logical CPUs plus provided value. If +a string \fBdefault\fR is provided, it sets the value back to defaults. +Should not be 0. +.RE +.sp +\fB\-\-keep\-going\fR +.RS 4 +Build as many crates in the dependency graph as possible, rather than aborting +the build on the first one that fails to build. +.sp +For example if the current package depends on dependencies \fBfails\fR and \fBworks\fR, +one of which fails to build, \fBcargo publish \-j1\fR may or may not build the +one that succeeds (depending on which one of the two builds Cargo picked to run +first), whereas \fBcargo publish \-j1 \-\-keep\-going\fR would definitely run both +builds, even if the one run first fails. +.RE +.SS "Display Options" +.sp +\fB\-v\fR, +\fB\-\-verbose\fR +.RS 4 +Use verbose output. May be specified twice for \[lq]very verbose\[rq] output which +includes extra output such as dependency warnings and build script output. +May also be specified with the \fBterm.verbose\fR +\fIconfig value\fR \&. +.RE +.sp +\fB\-q\fR, +\fB\-\-quiet\fR +.RS 4 +Do not print cargo log messages. +May also be specified with the \fBterm.quiet\fR +\fIconfig value\fR \&. +.RE +.sp +\fB\-\-color\fR \fIwhen\fR +.RS 4 +Control when colored output is used. Valid values: +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBauto\fR (default): Automatically detect if color support is available on the +terminal. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBalways\fR: Always display colors. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fBnever\fR: Never display colors. +.RE +.sp +May also be specified with the \fBterm.color\fR +\fIconfig value\fR \&. +.RE +.SS "Common Options" +.sp +\fB+\fR\fItoolchain\fR +.RS 4 +If Cargo has been installed with rustup, and the first argument to \fBcargo\fR +begins with \fB+\fR, it will be interpreted as a rustup toolchain name (such +as \fB+stable\fR or \fB+nightly\fR). +See the \fIrustup documentation\fR +for more information about how toolchain overrides work. +.RE +.sp +\fB\-\-config\fR \fIKEY=VALUE\fR or \fIPATH\fR +.RS 4 +Overrides a Cargo configuration value. The argument should be in TOML syntax of \fBKEY=VALUE\fR, +or provided as a path to an extra configuration file. This flag may be specified multiple times. +See the \fIcommand\-line overrides section\fR for more information. +.RE +.sp +\fB\-C\fR \fIPATH\fR +.RS 4 +Changes the current working directory before executing any specified operations. This affects +things like where cargo looks by default for the project manifest (\fBCargo.toml\fR), as well as +the directories searched for discovering \fB\&.cargo/config.toml\fR, for example. This option must +appear before the command name, for example \fBcargo \-C path/to/my\-project build\fR\&. +.sp +This option is only available on the \fInightly +channel\fR and +requires the \fB\-Z unstable\-options\fR flag to enable (see +\fI#10098\fR ). +.RE +.sp +\fB\-h\fR, +\fB\-\-help\fR +.RS 4 +Prints help information. +.RE +.sp +\fB\-Z\fR \fIflag\fR +.RS 4 +Unstable (nightly\-only) flags to Cargo. Run \fBcargo \-Z help\fR for details. +.RE +.SH "ENVIRONMENT" +See \fIthe reference\fR for +details on environment variables that Cargo reads. +.SH "EXIT STATUS" +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fB0\fR: Cargo succeeded. +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'\fB101\fR: Cargo failed to complete. +.RE +.SH "EXAMPLES" +.sp +.RS 4 +\h'-04' 1.\h'+01'Publish the current package: +.sp +.RS 4 +.nf +cargo publish +.fi +.RE +.RE +.SH "SEE ALSO" +\fBcargo\fR(1), \fBcargo\-package\fR(1), \fBcargo\-login\fR(1) diff --git a/rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/zsh/site-functions/_cargo b/rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/zsh/site-functions/_cargo new file mode 100644 index 0000000000000000000000000000000000000000..bec2d1cb38541b30ac9e59e6b14f95671db23743 --- /dev/null +++ b/rust/.rustup/toolchains/stable-x86_64-pc-windows-msvc/share/zsh/site-functions/_cargo @@ -0,0 +1,478 @@ +#compdef cargo + +autoload -U regexp-replace + +_cargo() { + local curcontext="$curcontext" ret=1 + local -a command_scope_spec common jobs parallel features manifest msgfmt triple target registry + local -a state line state_descr # These are set by _arguments + typeset -A opt_args + + common=( + '(-q --quiet)*'{-v,--verbose}'[use verbose output]' + '(-q --quiet -v --verbose)'{-q,--quiet}'[no output printed to stdout]' + '-Z+[pass unstable (nightly-only) flags to cargo]: :_cargo_unstable_flags' + '--offline[run without accessing the network]' + '--frozen[require that Cargo.lock and cache are up-to-date]' + '--locked[require that Cargo.lock is up-to-date]' + '--color=[specify colorization option]:coloring:(auto always never)' + '(- 1 *)'{-h,--help}'[show help message]' + ) + + # leading items in parentheses are an exclusion list for the arguments following that arg + # See: http://zsh.sourceforge.net/Doc/Release/Completion-System.html#Completion-Functions + # - => exclude all other options + # 1 => exclude positional arg 1 + # * => exclude all other args + # +blah => exclude +blah + _arguments -s -S -C $common \ + '(- 1 *)--list[list installed commands]' \ + '(- 1 *)--explain=[provide a detailed explanation of an error message]:error code' \ + '(- 1 *)'{-V,--version}'[show version information]' \ + '(+beta +nightly)+stable[use the stable toolchain]' \ + '(+stable +nightly)+beta[use the beta toolchain]' \ + '(+stable +beta)+nightly[use the nightly toolchain]' \ + '1: :_cargo_cmds' \ + '*:: :->args' + + # These flags are mutually exclusive specifiers for the scope of a command; as + # they are used in multiple places without change, they are expanded into the + # appropriate command's `_arguments` where appropriate. + command_scope_spec=( + '(--bin --example --test --lib)--bench=[specify benchmark name]: :_cargo_benchmark_names' + '(--bench --bin --test --lib)--example=[specify example name]:example name:_cargo_example_names' + '(--bench --example --test --lib)--bin=[specify binary name]:binary name' + '(--bench --bin --example --test)--lib=[specify library name]:library name' + '(--bench --bin --example --lib)--test=[specify test name]:test name' + ) + + jobs=( + '(-j --jobs)'{-j+,--jobs=}'[specify number of parallel jobs]:jobs [# of CPUs]' + ) + + parallel=( + "${jobs[@]}" + '--keep-going[do not abort build on first build error]' + ) + + features=( + '(--all-features)'{-F+,--features=}'[specify features to activate]:feature' + '(--features -F)--all-features[activate all available features]' + "--no-default-features[don't build the default features]" + ) + + msgfmt='--message-format=[specify error format]:error format [human]:(human json short)' + triple='--target=[specify target triple]:target triple:_cargo_target_triple' + target='--target-dir=[specify directory for all generated artifacts]:directory:_directories' + manifest='--manifest-path=[specify path to manifest]:path:_directories' + registry='--registry=[specify registry to use]:registry' + + case $state in + args) + curcontext="${curcontext%:*}-${words[1]}:" + case ${words[1]} in + add) + _arguments -s -A "^--" $common $manifest $registry \ + {-F+,--features=}'[specify features to activate]:feature' \ + "--default-features[enable the default features]" \ + "--no-default-features[don't enable the default features]" \ + "--optional[mark the dependency as optional]" \ + "--no-optional[mark the dependency as required]" \ + "--dev[add as a dev dependency]" \ + "--build[add as a build dependency]" \ + "--target=[add as a dependency to the given target platform]" \ + "--rename=[rename the dependency]" \ + "--dry-run[don't actually write the manifest]" \ + '--branch=[branch to use when adding from git]:branch' \ + '--git=[specify URL from which to add the crate]:url:_urls' \ + '--path=[local filesystem path to crate to add]: :_directories' \ + '--rev=[specific commit to use when adding from git]:commit' \ + '--tag=[tag to use when adding from git]:tag' \ + '--ignore-rust-version[Ignore rust-version specification in packages]' \ + '1: :_guard "^-*" "crate name"' \ + '*:args:_default' + ;; + bench) + _arguments -s -A "^--" $common $jobs $features $msgfmt $triple $target $manifest \ + "${command_scope_spec[@]}" \ + '--all-targets[benchmark all targets]' \ + "--no-run[compile but don't run]" \ + '(-p --package)'{-p+,--package=}'[specify package to run benchmarks for]:package:_cargo_package_names' \ + '--exclude=[exclude packages from the benchmark]:spec' \ + '--no-fail-fast[run all benchmarks regardless of failure]' \ + '--ignore-rust-version[Ignore rust-version specification in packages]' \ + '1: :_guard "^-*" "bench name"' \ + '*:args:_default' + ;; + + build | b) + _arguments -s -S $common $parallel $features $msgfmt $triple $target $manifest \ + '--all-targets[equivalent to specifying --lib --bins --tests --benches --examples]' \ + "${command_scope_spec[@]}" \ + '(-p --package)'{-p+,--package=}'[specify package to build]:package:_cargo_package_names' \ + '--release[build in release mode]' \ + '--ignore-rust-version[Ignore rust-version specification in packages]' + ;; + + check | c) + _arguments -s -S $common $parallel $features $msgfmt $triple $target $manifest \ + '--all-targets[equivalent to specifying --lib --bins --tests --benches --examples]' \ + "${command_scope_spec[@]}" \ + '(-p --package)'{-p+,--package=}'[specify package to check]:package:_cargo_package_names' \ + '--release[check in release mode]' \ + '--ignore-rust-version[Ignore rust-version specification in packages]' + ;; + + clean) + _arguments -s -S $common $triple $target $manifest \ + '(-p --package)'{-p+,--package=}'[specify package to clean]:package:_cargo_package_names' \ + '--release[clean release artifacts]' \ + '--doc[clean just the documentation directory]' + ;; + + doc | d) + _arguments -s -S $common $parallel $features $msgfmt $triple $target $manifest \ + '--no-deps[do not build docs for dependencies]' \ + '--document-private-items[include non-public items in the documentation]' \ + '--open[open docs in browser after the build]' \ + '(-p --package)'{-p+,--package=}'[specify package to document]:package:_cargo_package_names' \ + '--release[build artifacts in release mode, with optimizations]' \ + '--ignore-rust-version[Ignore rust-version specification in packages]' + ;; + + fetch) + _arguments -s -S $common $triple $manifest + ;; + + fix) + _arguments -s -S $common $parallel $features $msgfmt $triple $target $manifest \ + "${command_scope_spec[@]}" \ + '--broken-code[fix code even if it already has compiler errors]' \ + '--edition[fix in preparation for the next edition]' \ + '--edition-idioms[fix warnings to migrate to the idioms of an edition]' \ + '--allow-no-vcs[fix code even if a VCS was not detected]' \ + '--allow-dirty[fix code even if the working directory is dirty]' \ + '--allow-staged[fix code even if the working directory has staged changes]' \ + '--ignore-rust-version[Ignore rust-version specification in packages]' + ;; + + generate-lockfile) + _arguments -s -S $common $manifest + ;; + + help) + _cargo_cmds + ;; + info) + _arguments -s -A "^--" $common $registry \ + '--index=[specify registry index]:index' \ + '*: :_guard "^-*" "crate"' + ;; + + init) + _arguments -s -S $common $registry \ + '--lib[use library template]' \ + '--edition=[specify edition to set for the crate generated]:edition:(2015 2018 2021)' \ + '--vcs=[initialize a new repo with a given VCS]:vcs:(git hg pijul fossil none)' \ + '--name=[set the resulting package name]:name' \ + '1:path:_directories' + ;; + + install) + _arguments -s -S $common $parallel $features $triple $registry \ + '(-f --force)'{-f,--force}'[force overwriting of existing crates or binaries]' \ + '--bin=[only install the specified binary]:binary' \ + '--branch=[branch to use when installing from git]:branch' \ + '--debug[Build in debug mode (with the "dev" profile) instead of release mode]' \ + '--example=[install the specified example instead of binaries]:example:_cargo_example_names' \ + '--git=[specify URL from which to install the crate]:url:_urls' \ + '--path=[local filesystem path to crate to install]: :_directories' \ + '--rev=[specific commit to use when installing from git]:commit' \ + '--root=[directory to install packages into]: :_directories' \ + '--tag=[tag to use when installing from git]:tag' \ + '--version=[version to install from crates.io]:version' \ + '--list[list all installed packages and their versions]' \ + '--ignore-rust-version[Ignore rust-version specification in packages]' \ + '*: :_guard "^-*" "crate"' + ;; + + locate-project) + _arguments -s -S $common $manifest \ + '--message-format=[specify output representation]:output representation [json]:(json plain)' \ + '--workspace[locate Cargo.toml of the workspace root]' + ;; + + login) + _arguments -s -S $common $registry \ + '*: :_guard "^-*" "token"' + ;; + + metadata) + _arguments -s -S $common $features $manifest \ + "--no-deps[output information only about the root package and don't fetch dependencies]" \ + '--format-version=[specify format version]:version [1]:(1)' + ;; + + new) + _arguments -s -S $common $registry \ + '--lib[use library template]' \ + '--vcs:initialize a new repo with a given VCS:(git hg none)' \ + '--name=[set the resulting package name]' + ;; + + owner) + _arguments -s -S $common $registry \ + '(-a --add)'{-a,--add}'[specify name of a user or team to invite as an owner]:name' \ + '--index=[specify registry index]:index' \ + '(-l --list)'{-l,--list}'[list owners of a crate]' \ + '(-r --remove)'{-r,--remove}'[specify name of a user or team to remove as an owner]:name' \ + '--token=[specify API token to use when authenticating]:token' \ + '*: :_guard "^-*" "crate"' + ;; + + package) + _arguments -s -S $common $parallel $features $triple $target $manifest $registry \ + '--index=[specify registry index]:index' \ + '(-l --list)'{-l,--list}'[print files included in a package without making one]' \ + '--no-metadata[ignore warnings about a lack of human-usable metadata]' \ + '--allow-dirty[allow dirty working directories to be packaged]' \ + "--no-verify[don't build to verify contents]" + ;; + + pkgid) + _arguments -s -S $common $manifest \ + '(-p --package)'{-p+,--package=}'[specify package to get ID specifier for]:package:_cargo_package_names' \ + '*: :_guard "^-*" "spec"' + ;; + + publish) + _arguments -s -S $common $parallel $features $triple $target $manifest $registry \ + '--index=[specify registry index]:index' \ + '--allow-dirty[allow dirty working directories to be packaged]' \ + "--no-verify[don't verify the contents by building them]" \ + '--dry-run[perform all checks without uploading]' + ;; + + remove | rm) + _arguments -s -A "^--" $common $manifest \ + "--dev[remove as a dev dependency]" \ + "--build[remove as a build dependency]" \ + "--target=[remove as a dependency from the given target platform]" \ + "--dry-run[don't actually write the manifest]" \ + '(-p --package)'{-p+,--package=}'[package to remove from]:package:_cargo_package_names' \ + '1: :_guard "^-*" "crate name"' \ + '*:args:_default' + ;; + + run | r) + _arguments -s -S $common $parallel $features $msgfmt $triple $target $manifest \ + '--example=[name of the bin target]:name:_cargo_example_names' \ + '--bin=[name of the bin target]:name' \ + '(-p --package)'{-p+,--package=}'[specify package with the target to run]:package:_cargo_package_names' \ + '--release[build in release mode]' \ + '--ignore-rust-version[Ignore rust-version specification in packages]' \ + '*: :_default' + ;; + + rustc) + _arguments -s -S $common $parallel $features $msgfmt $triple $target $manifest \ + '(-p --package)'{-p+,--package=}'[specify package to build]:package:_cargo_package_names' \ + '--profile=[specify profile to build the selected target for]:profile' \ + '--release[build artifacts in release mode, with optimizations]' \ + "${command_scope_spec[@]}" \ + '--ignore-rust-version[Ignore rust-version specification in packages]' \ + '*: : _dispatch rustc rustc -default-' + ;; + + rustdoc) + _arguments -s -S $common $parallel $features $msgfmt $triple $target $manifest \ + '--document-private-items[include non-public items in the documentation]' \ + '--open[open the docs in a browser after the operation]' \ + '(-p --package)'{-p+,--package=}'[specify package to document]:package:_cargo_package_names' \ + '--release[build artifacts in release mode, with optimizations]' \ + "${command_scope_spec[@]}" \ + '--ignore-rust-version[Ignore rust-version specification in packages]' \ + '*: : _dispatch rustdoc rustdoc -default-' + ;; + + search) + _arguments -s -S $common $registry \ + '--index=[specify registry index]:index' \ + '--limit=[limit the number of results]:results [10]' \ + '*: :_guard "^-*" "query"' + ;; + + test | t) + _arguments -s -S $common $jobs $features $msgfmt $triple $target $manifest \ + '--test=[test name]: :_cargo_test_names' \ + '--no-fail-fast[run all tests regardless of failure]' \ + '--no-run[compile but do not run]' \ + '(-p --package)'{-p+,--package=}'[package to run tests for]:package:_cargo_package_names' \ + '--all[test all packages in the workspace]' \ + '--release[build artifacts in release mode, with optimizations]' \ + '1: :_cargo_test_names' \ + '(--doc --bin --example --test --bench)--lib[only test library]' \ + '(--lib --bin --example --test --bench)--doc[only test documentation]' \ + '(--lib --doc --example --test --bench)--bin=[binary name]' \ + '(--lib --doc --bin --test --bench)--example=[example name]:_cargo_example_names' \ + '(--lib --doc --bin --example --bench)--test=[test name]' \ + '(--lib --doc --bin --example --test)--bench=[benchmark name]' \ + '--ignore-rust-version[Ignore rust-version specification in packages]' \ + '*: :_default' + ;; + + tree) + _arguments -s -S $common $features $triple $manifest \ + '(-p --package)'{-p+,--package=}'[package to use as the root]:package:_cargo_package_names' \ + '(-i --invert)'{-i+,--invert=}'[invert the tree for the given package]:package:_cargo_package_names' \ + '--prefix=[line prefix]:prefix:(depth indent none)' \ + '--no-dedupe[repeat shared dependencies]' \ + '(-d --duplicates)'{-d,--duplicates}'[packages with multiple versions]' \ + '--charset=[utf8 or ascii]:charset:(utf8 ascii)' \ + '(-f --format)'{-f,--format=}'[format string]:format' \ + '(-e --edges)'{-e,--edges=}'[edge kinds]:kind:(features normal build dev all no-dev no-build no-normal)' \ + ;; + + uninstall) + _arguments -s -S $common \ + '(-p --package)'{-p+,--package=}'[specify package to uninstall]:package:_cargo_package_names' \ + '--bin=[only uninstall the specified binary]:name' \ + '--root=[directory to uninstall packages from]: :_files -/' \ + '*:crate:_cargo_installed_crates -F line' + ;; + + update) + _arguments -s -S $common $manifest \ + '--aggressive=[force dependency update]' \ + '--recursive=[force dependency update]' \ + "--dry-run[don't actually write the lockfile]" \ + '(-p --package)'{-p+,--package=}'[specify package to update]:package:_cargo_package_names' \ + '--precise=[update single dependency to precise release]:release' \ + '*:package:_cargo_package_names' + ;; + + version) + _arguments -s -S $common + ;; + + yank) + _arguments -s -S $common $registry \ + '--version=[specify yank version]:version' \ + '--undo[undo a yank, putting a version back into the index]' \ + '--index=[specify registry index to yank from]:registry index' \ + '--token=[specify API token to use when authenticating]:token' \ + '*: :_guard "^-*" "crate"' + ;; + *) + # allow plugins to define their own functions + if ! _call_function ret _cargo-${words[1]}; then + # fallback on default completion for unknown commands + _default && ret=0 + fi + (( ! ret )) + ;; + esac + ;; + esac +} + +_cargo_unstable_flags() { + local flags + flags=( help ${${${(M)${(f)"$(_call_program flags cargo -Z help)"}:#*--*}/ #-- #/:}##*-Z } ) + _describe -t flags 'unstable flag' flags +} + +_cargo_installed_crates() { + local expl + _description crates expl 'crate' + compadd "$@" "$expl[@]" - ${${${(f)"$(cargo install --list)"}:# *}%% *} +} + +_cargo_cmds() { + local -a commands + # This uses Parameter Expansion Flags, which are a built-in Zsh feature. + # See more: http://zsh.sourceforge.net/Doc/Release/Expansion.html#Parameter-Expansion-Flags + # and http://zsh.sourceforge.net/Doc/Release/Expansion.html#Parameter-Expansion + # + # # How this work? + # + # First it splits the result of `cargo --list` at newline, then it removes the first line. + # Then it removes indentation (4 whitespaces) before each items. (Note the x## pattern [1]). + # Then it replaces those spaces between item and description with a `:` + # + # [1]: https://github.com/zsh-users/zsh-completions/blob/master/zsh-completions-howto.org#patterns + commands=( ${${${(M)"${(f)$(_call_program commands cargo --list)}":# *}/ ##/}/ ##/:} ) + _describe -t commands 'command' commands +} + +_cargo_target_triple() { + local -a result + + if (( $+commands[rustup] )); then + result=( ${(f)"$(rustup target list --installed)"} ) + else + result=( ${(f)"$(rustc --print target-list)"} ) + fi + + _describe 'target triple' result +} + +#FIXME: Disabled until fixed +#gets package names from the manifest file +_cargo_package_names() { + _message -e packages package +} + +# Extracts the values of "name" from the array given in $1 and shows them as +# command line options for completion +_cargo_names_from_array() { + local manifest=$(cargo locate-project --message-format plain) + if [[ -z $manifest ]]; then + return 0 + fi + + local last_line + local -a names; + local in_block=false + local block_name=$1 + names=() + while read -r line; do + if [[ $last_line == "[[$block_name]]" ]]; then + in_block=true + else + if [[ $last_line =~ '\s*\[\[.*' ]]; then + in_block=false + fi + fi + + if [[ $in_block == true ]]; then + if [[ $line =~ '\s*name\s*=' ]]; then + regexp-replace line '^\s*name\s*=\s*|"' '' + names+=( "$line" ) + fi + fi + + last_line=$line + done < "$manifest" + _describe "$block_name" names + +} + +#Gets the test names from the manifest file +_cargo_test_names() { + _cargo_names_from_array "test" +} + +#Gets the bench names from the manifest file +_cargo_benchmark_names() { + _cargo_names_from_array "bench" +} + +_cargo_example_names() { + if [[ -d examples ]]; then + local -a files=(${(@f)$(echo examples/*.rs(:t:r))}) + _values 'example' "${files[@]}" + fi +} + +_cargo diff --git a/rust/.rustup/update-hashes/stable-x86_64-pc-windows-msvc b/rust/.rustup/update-hashes/stable-x86_64-pc-windows-msvc new file mode 100644 index 0000000000000000000000000000000000000000..1dca97825fb26a21b072718c75c185b77c1e36cd --- /dev/null +++ b/rust/.rustup/update-hashes/stable-x86_64-pc-windows-msvc @@ -0,0 +1 @@ +821ff14e4c4a1cbe1e89 \ No newline at end of file diff --git a/sqlite_gui/printsupport/windowsprintersupport.dll b/sqlite_gui/printsupport/windowsprintersupport.dll new file mode 100644 index 0000000000000000000000000000000000000000..2e50171815562faf200510c5a0468eacf9893c7a Binary files /dev/null and b/sqlite_gui/printsupport/windowsprintersupport.dll differ diff --git a/sqlite_gui/translations/qt_ar.qm b/sqlite_gui/translations/qt_ar.qm new file mode 100644 index 0000000000000000000000000000000000000000..33eda4818b547c6591f79b4643f286c3f2570276 Binary files /dev/null and b/sqlite_gui/translations/qt_ar.qm differ diff --git a/sqlite_gui/translations/qt_cs.qm b/sqlite_gui/translations/qt_cs.qm new file mode 100644 index 0000000000000000000000000000000000000000..40aec718ab693e4a910c48b20d69cf6dadb8c224 Binary files /dev/null and b/sqlite_gui/translations/qt_cs.qm differ diff --git a/sqlite_gui/translations/qt_de.qm b/sqlite_gui/translations/qt_de.qm new file mode 100644 index 0000000000000000000000000000000000000000..2e94a2535cfdc7615b50d5e7e02effdc016c10f3 Binary files /dev/null and b/sqlite_gui/translations/qt_de.qm differ diff --git a/sqlite_gui/translations/qt_en.qm b/sqlite_gui/translations/qt_en.qm new file mode 100644 index 0000000000000000000000000000000000000000..be651eede2edc9cb0da5c140b31664afee169fa8 --- /dev/null +++ b/sqlite_gui/translations/qt_en.qm @@ -0,0 +1 @@ +<¸dÊÍ!¿`¡½Ý \ No newline at end of file diff --git a/sqlite_gui/translations/qt_es.qm b/sqlite_gui/translations/qt_es.qm new file mode 100644 index 0000000000000000000000000000000000000000..6957a6bad06b0732ccd9dc5b5d22282435012608 Binary files /dev/null and b/sqlite_gui/translations/qt_es.qm differ diff --git a/sqlite_gui/translations/qt_fr.qm b/sqlite_gui/translations/qt_fr.qm new file mode 100644 index 0000000000000000000000000000000000000000..151e4d498a55483d3859ee947158984b755e2e3b Binary files /dev/null and b/sqlite_gui/translations/qt_fr.qm differ diff --git a/sqlite_gui/translations/qt_it.qm b/sqlite_gui/translations/qt_it.qm new file mode 100644 index 0000000000000000000000000000000000000000..215d45e9af882d2f2211ee525a77113ccaaf0e66 Binary files /dev/null and b/sqlite_gui/translations/qt_it.qm differ diff --git a/sqlite_gui/translations/qt_ja.qm b/sqlite_gui/translations/qt_ja.qm new file mode 100644 index 0000000000000000000000000000000000000000..aa0e9a6fbed011fbd1b83b74c4f233ebf52944f3 Binary files /dev/null and b/sqlite_gui/translations/qt_ja.qm differ diff --git a/sqlite_gui/translations/qt_ko.qm b/sqlite_gui/translations/qt_ko.qm new file mode 100644 index 0000000000000000000000000000000000000000..8bc348a3bba81e5f25258260f35bdd0238130184 Binary files /dev/null and b/sqlite_gui/translations/qt_ko.qm differ diff --git a/sqlite_gui/translations/qt_pl.qm b/sqlite_gui/translations/qt_pl.qm new file mode 100644 index 0000000000000000000000000000000000000000..2156928c274f17b132612b28e6652ed76f4dec85 Binary files /dev/null and b/sqlite_gui/translations/qt_pl.qm differ diff --git a/sqlite_gui/translations/qt_pt.qm b/sqlite_gui/translations/qt_pt.qm new file mode 100644 index 0000000000000000000000000000000000000000..03353ea8d1fe6a1f534c26f1fcb52d8070ea8662 Binary files /dev/null and b/sqlite_gui/translations/qt_pt.qm differ diff --git a/sqlite_gui/translations/qt_ru.qm b/sqlite_gui/translations/qt_ru.qm new file mode 100644 index 0000000000000000000000000000000000000000..868886a7ee359d71a210f4aeca62cdc4c5db99e1 Binary files /dev/null and b/sqlite_gui/translations/qt_ru.qm differ diff --git a/sqlite_gui/translations/qt_uk.qm b/sqlite_gui/translations/qt_uk.qm new file mode 100644 index 0000000000000000000000000000000000000000..cc60d0750a9c1ae1f2da36714036d51288fd8ff3 Binary files /dev/null and b/sqlite_gui/translations/qt_uk.qm differ diff --git a/sqlite_gui/translations/qt_zh_TW.qm b/sqlite_gui/translations/qt_zh_TW.qm new file mode 100644 index 0000000000000000000000000000000000000000..c4b24c6103a15b38d83d0491a27fb3361f03efbf Binary files /dev/null and b/sqlite_gui/translations/qt_zh_TW.qm differ diff --git a/sqlite_gui/translations/qtbase_en.qm b/sqlite_gui/translations/qtbase_en.qm new file mode 100644 index 0000000000000000000000000000000000000000..be651eede2edc9cb0da5c140b31664afee169fa8 --- /dev/null +++ b/sqlite_gui/translations/qtbase_en.qm @@ -0,0 +1 @@ +<¸dÊÍ!¿`¡½Ý \ No newline at end of file diff --git a/sqlite_gui/translations/qtmultimedia_ar.qm b/sqlite_gui/translations/qtmultimedia_ar.qm new file mode 100644 index 0000000000000000000000000000000000000000..8422ab3b393ca0b87ad35b68913ed67868f91159 Binary files /dev/null and b/sqlite_gui/translations/qtmultimedia_ar.qm differ diff --git a/sqlite_gui/translations/qtmultimedia_cs.qm b/sqlite_gui/translations/qtmultimedia_cs.qm new file mode 100644 index 0000000000000000000000000000000000000000..106a5e4dbe9747dd9122f64d3e32a9a589a25f7e Binary files /dev/null and b/sqlite_gui/translations/qtmultimedia_cs.qm differ diff --git a/sqlite_gui/translations/qtmultimedia_de.qm b/sqlite_gui/translations/qtmultimedia_de.qm new file mode 100644 index 0000000000000000000000000000000000000000..257aa5def5c08c6f82d57a93828fd4f7e2f4b42a Binary files /dev/null and b/sqlite_gui/translations/qtmultimedia_de.qm differ diff --git a/sqlite_gui/translations/qtmultimedia_en.qm b/sqlite_gui/translations/qtmultimedia_en.qm new file mode 100644 index 0000000000000000000000000000000000000000..be651eede2edc9cb0da5c140b31664afee169fa8 --- /dev/null +++ b/sqlite_gui/translations/qtmultimedia_en.qm @@ -0,0 +1 @@ +<¸dÊÍ!¿`¡½Ý \ No newline at end of file diff --git a/sqlite_gui/translations/qtmultimedia_es.qm b/sqlite_gui/translations/qtmultimedia_es.qm new file mode 100644 index 0000000000000000000000000000000000000000..fe500a097423663a7541e9e6fd5f7e2b4398fc91 Binary files /dev/null and b/sqlite_gui/translations/qtmultimedia_es.qm differ diff --git a/sqlite_gui/translations/qtmultimedia_fr.qm b/sqlite_gui/translations/qtmultimedia_fr.qm new file mode 100644 index 0000000000000000000000000000000000000000..da412e899ca2644b5bd5d01a64ac2cc501b478c9 Binary files /dev/null and b/sqlite_gui/translations/qtmultimedia_fr.qm differ diff --git a/sqlite_gui/translations/qtmultimedia_it.qm b/sqlite_gui/translations/qtmultimedia_it.qm new file mode 100644 index 0000000000000000000000000000000000000000..c1060bfb1514c55b3b0b5e08bf76c475aa0597cf Binary files /dev/null and b/sqlite_gui/translations/qtmultimedia_it.qm differ diff --git a/sqlite_gui/translations/qtmultimedia_ja.qm b/sqlite_gui/translations/qtmultimedia_ja.qm new file mode 100644 index 0000000000000000000000000000000000000000..87af0b9bba19dea85985d63f0c4af0dc8e93ee13 Binary files /dev/null and b/sqlite_gui/translations/qtmultimedia_ja.qm differ diff --git a/sqlite_gui/translations/qtmultimedia_ko.qm b/sqlite_gui/translations/qtmultimedia_ko.qm new file mode 100644 index 0000000000000000000000000000000000000000..a48156e4ebe0694f4e4a28bce21cc5e77df513d9 Binary files /dev/null and b/sqlite_gui/translations/qtmultimedia_ko.qm differ diff --git a/sqlite_gui/translations/qtmultimedia_pl.qm b/sqlite_gui/translations/qtmultimedia_pl.qm new file mode 100644 index 0000000000000000000000000000000000000000..09f3a4af37e811c5e800980af4e592c9ae13c5cc Binary files /dev/null and b/sqlite_gui/translations/qtmultimedia_pl.qm differ diff --git a/sqlite_gui/translations/qtmultimedia_ru.qm b/sqlite_gui/translations/qtmultimedia_ru.qm new file mode 100644 index 0000000000000000000000000000000000000000..d6baa83b7d10eb88e262147f9df32aa54767e8ee Binary files /dev/null and b/sqlite_gui/translations/qtmultimedia_ru.qm differ diff --git a/sqlite_gui/translations/qtmultimedia_uk.qm b/sqlite_gui/translations/qtmultimedia_uk.qm new file mode 100644 index 0000000000000000000000000000000000000000..501246e2681dce89ad50b14bf818f4688581745f Binary files /dev/null and b/sqlite_gui/translations/qtmultimedia_uk.qm differ diff --git a/sqlite_gui/translations/qtscript_ar.qm b/sqlite_gui/translations/qtscript_ar.qm new file mode 100644 index 0000000000000000000000000000000000000000..adaad4f207848000f25d641e0e57141c9675c705 Binary files /dev/null and b/sqlite_gui/translations/qtscript_ar.qm differ diff --git a/sqlite_gui/translations/qtscript_cs.qm b/sqlite_gui/translations/qtscript_cs.qm new file mode 100644 index 0000000000000000000000000000000000000000..eb1d8c98f7808a28c9783874d4fbda4c58234c55 Binary files /dev/null and b/sqlite_gui/translations/qtscript_cs.qm differ diff --git a/sqlite_gui/translations/qtscript_de.qm b/sqlite_gui/translations/qtscript_de.qm new file mode 100644 index 0000000000000000000000000000000000000000..1fb35d9d47fb6fa1753217069f7b7c43b7cbf3ee Binary files /dev/null and b/sqlite_gui/translations/qtscript_de.qm differ diff --git a/sqlite_gui/translations/qtscript_en.qm b/sqlite_gui/translations/qtscript_en.qm new file mode 100644 index 0000000000000000000000000000000000000000..be651eede2edc9cb0da5c140b31664afee169fa8 --- /dev/null +++ b/sqlite_gui/translations/qtscript_en.qm @@ -0,0 +1 @@ +<¸dÊÍ!¿`¡½Ý \ No newline at end of file diff --git a/sqlite_gui/translations/qtscript_es.qm b/sqlite_gui/translations/qtscript_es.qm new file mode 100644 index 0000000000000000000000000000000000000000..7e87cd7fc7f5cf157ac3661371c97f5aebc47eba Binary files /dev/null and b/sqlite_gui/translations/qtscript_es.qm differ diff --git a/sqlite_gui/translations/qtscript_fr.qm b/sqlite_gui/translations/qtscript_fr.qm new file mode 100644 index 0000000000000000000000000000000000000000..10b3cd1293b90b70c3e767d71c9373d03da49d06 Binary files /dev/null and b/sqlite_gui/translations/qtscript_fr.qm differ diff --git a/sqlite_gui/translations/qtscript_it.qm b/sqlite_gui/translations/qtscript_it.qm new file mode 100644 index 0000000000000000000000000000000000000000..fe85d3c44c20e9ca7661b025e840da431a9455e9 Binary files /dev/null and b/sqlite_gui/translations/qtscript_it.qm differ diff --git a/sqlite_gui/translations/qtscript_ja.qm b/sqlite_gui/translations/qtscript_ja.qm new file mode 100644 index 0000000000000000000000000000000000000000..19ad9ef455670dbe5a7a9744dccb3b20ed0df239 Binary files /dev/null and b/sqlite_gui/translations/qtscript_ja.qm differ diff --git a/sqlite_gui/translations/qtscript_ko.qm b/sqlite_gui/translations/qtscript_ko.qm new file mode 100644 index 0000000000000000000000000000000000000000..a7ebc661decc84b0d02114d04d417258429c898f Binary files /dev/null and b/sqlite_gui/translations/qtscript_ko.qm differ diff --git a/sqlite_gui/translations/qtscript_pl.qm b/sqlite_gui/translations/qtscript_pl.qm new file mode 100644 index 0000000000000000000000000000000000000000..621fd20fe40c8118e0e497c647c9b8818cc8647d Binary files /dev/null and b/sqlite_gui/translations/qtscript_pl.qm differ diff --git a/sqlite_gui/translations/qtscript_ru.qm b/sqlite_gui/translations/qtscript_ru.qm new file mode 100644 index 0000000000000000000000000000000000000000..4a1d394361eb2d43be0b1ce2071ecec1bea6144e Binary files /dev/null and b/sqlite_gui/translations/qtscript_ru.qm differ diff --git a/sqlite_gui/translations/qtscript_uk.qm b/sqlite_gui/translations/qtscript_uk.qm new file mode 100644 index 0000000000000000000000000000000000000000..c4071739c1cffc6310c6509a774bb0bb36a49a61 Binary files /dev/null and b/sqlite_gui/translations/qtscript_uk.qm differ diff --git a/sqlite_gui/translations/qtxmlpatterns_en.qm b/sqlite_gui/translations/qtxmlpatterns_en.qm new file mode 100644 index 0000000000000000000000000000000000000000..be651eede2edc9cb0da5c140b31664afee169fa8 --- /dev/null +++ b/sqlite_gui/translations/qtxmlpatterns_en.qm @@ -0,0 +1 @@ +<¸dÊÍ!¿`¡½Ý \ No newline at end of file diff --git a/sqlite_gui/translations/qtxmlpatterns_it.qm b/sqlite_gui/translations/qtxmlpatterns_it.qm new file mode 100644 index 0000000000000000000000000000000000000000..7900449799204c48fa006f4d3c08fb62b739f5d8 Binary files /dev/null and b/sqlite_gui/translations/qtxmlpatterns_it.qm differ diff --git a/sqlite_gui/translations/qtxmlpatterns_ja.qm b/sqlite_gui/translations/qtxmlpatterns_ja.qm new file mode 100644 index 0000000000000000000000000000000000000000..d3e2f5c5097e3ae931b28c0c9deec5e21f1e3abd Binary files /dev/null and b/sqlite_gui/translations/qtxmlpatterns_ja.qm differ diff --git a/sqlite_gui/translations/qtxmlpatterns_ko.qm b/sqlite_gui/translations/qtxmlpatterns_ko.qm new file mode 100644 index 0000000000000000000000000000000000000000..d050da0f4ba7e6ddf043e50aee29028dca1f49a0 Binary files /dev/null and b/sqlite_gui/translations/qtxmlpatterns_ko.qm differ diff --git a/sqlite_gui/translations/qtxmlpatterns_uk.qm b/sqlite_gui/translations/qtxmlpatterns_uk.qm new file mode 100644 index 0000000000000000000000000000000000000000..ff8fbe3049a90843cb6f652ca348c86940917786 Binary files /dev/null and b/sqlite_gui/translations/qtxmlpatterns_uk.qm differ