rustup-{install,run,which,help,man}: add page (#10661)

pull/23/head
Lena 2023-09-17 06:48:25 +02:00 committed by GitHub
parent 1700d8a30e
commit 6d01f29bbd
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 55 additions and 0 deletions

View File

@ -0,0 +1,12 @@
# rustup help
> Display help on `rustup` and its subcommands.
> More information: <https://rust-lang.github.io/rustup>.
- Display general help:
`rustup help`
- Display help for a subcommand:
`rustup help {{subcommand}}`

View File

@ -0,0 +1,9 @@
# rustup install
> Install or update Rust toolchains.
> This command is an alias of `rustup update`, but can only install/update one toolchain at a time.
> More information: <https://rust-lang.github.io/rustup>.
- Install or update a specific toolchain (see `rustup help toolchain` for more information):
`rustup install {{toolchain}}`

View File

@ -0,0 +1,12 @@
# rustup man
> View the man page for a given command managed by `rustup`.
> More information: <https://rust-lang.github.io/rustup>.
- View the man page for a given command from the default toolchain:
`rustup man {{command}}`
- View the man page for a given command from the specified toolchain:
`rustup man --toolchain {{command}}`

View File

@ -0,0 +1,9 @@
# rustup run
> Run a command with an environment configured for a given Rust toolchain.
> Note: all commands managed by `rustup` have a shorthand for this: for example, `cargo +nightly build` is equivalent to `rustup run nightly cargo build`.
> More information: <https://rust-lang.github.io/rustup>.
- Run a command using a given Rust toolchain (see `rustup help toolchain` for more information):
`rustup run {{toolchain}} {{command}}`

View File

@ -0,0 +1,13 @@
# rustup which
> Display which binary will be run for a given command managed by `rustup`.
> Like `which`, but searches a Rust toolchain instead of `$PATH`.
> More information: <https://rust-lang.github.io/rustup>.
- Display the path to the binary in the default toolchain:
`rustup which {{command}}`
- Display the path to the binary in the specified toolchain (see `rustup help toolchain` for more information):
`rustup which --toolchain {{toolchain}} {{command}}`