-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
7 changed files
with
164 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
--- | ||
layout: page | ||
title: common/rustup-completions (English) | ||
description: "Generate shell completions for `rustup` and `cargo`." | ||
content_hash: 8812ad12e2b0daed1c966ab0916d0d189dd3ebac | ||
last_modified_at: 2023-09-19 | ||
--- | ||
|
||
This entry is very new in the [tldr-pages](https://github.com/tldr-pages/tldr) project, hence translation data is currently unavailable for a while. | ||
|
||
<hr># rustup completions | ||
|
||
Generate shell completions for `rustup` and `cargo`. | ||
More information: <https://rust-lang.github.io/rustup>. | ||
|
||
- Print the completion script to `stdout`: | ||
|
||
`rustup completions `<span class="tldr-var badge badge-pill bg-dark-lm bg-white-dm text-white-lm text-dark-dm font-weight-bold">bash|elvish|fish|powershell|zsh</span>` `<span class="tldr-var badge badge-pill bg-dark-lm bg-white-dm text-white-lm text-dark-dm font-weight-bold">rustup|cargo</span> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
--- | ||
layout: page | ||
title: common/rustup-component (English) | ||
description: "Modify a toolchain's installed components." | ||
content_hash: f3ee0d3469b793bb13e4d53a797b6b626c9127ad | ||
last_modified_at: 2023-09-19 | ||
--- | ||
|
||
This entry is very new in the [tldr-pages](https://github.com/tldr-pages/tldr) project, hence translation data is currently unavailable for a while. | ||
|
||
<hr># rustup component | ||
|
||
Modify a toolchain's installed components. | ||
Without the `--toolchain` option `rustup` will use the default toolchain. See `rustup help toolchain` for more information about toolchains. | ||
More information: <https://rust-lang.github.io/rustup>. | ||
|
||
- Add a component to a toolchain: | ||
|
||
`rustup component add --toolchain `<span class="tldr-var badge badge-pill bg-dark-lm bg-white-dm text-white-lm text-dark-dm font-weight-bold">toolchain</span>` `<span class="tldr-var badge badge-pill bg-dark-lm bg-white-dm text-white-lm text-dark-dm font-weight-bold">component</span> | ||
|
||
- Remove a component from a toolchain: | ||
|
||
`rustup component remove --toolchain `<span class="tldr-var badge badge-pill bg-dark-lm bg-white-dm text-white-lm text-dark-dm font-weight-bold">toolchain</span>` `<span class="tldr-var badge badge-pill bg-dark-lm bg-white-dm text-white-lm text-dark-dm font-weight-bold">component</span> | ||
|
||
- List installed and available components for a toolchain: | ||
|
||
`rustup component list --toolchain `<span class="tldr-var badge badge-pill bg-dark-lm bg-white-dm text-white-lm text-dark-dm font-weight-bold">toolchain</span> | ||
|
||
- List installed components for a toolchain: | ||
|
||
`rustup component list --toolchain `<span class="tldr-var badge badge-pill bg-dark-lm bg-white-dm text-white-lm text-dark-dm font-weight-bold">toolchain</span>` --installed` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
--- | ||
layout: page | ||
title: common/rustup-doc (English) | ||
description: "Open the offline Rust documentation for the current toolchain." | ||
content_hash: fdc5a3b0a9ffdc3c57f9f074a7d02c6dd367e612 | ||
last_modified_at: 2023-09-19 | ||
--- | ||
|
||
This entry is very new in the [tldr-pages](https://github.com/tldr-pages/tldr) project, hence translation data is currently unavailable for a while. | ||
|
||
<hr># rustup doc | ||
|
||
Open the offline Rust documentation for the current toolchain. | ||
There are a lot more documentation pages not mentioned here. See `rustup help doc` for more information. | ||
More information: <https://rust-lang.github.io/rustup>. | ||
|
||
- Open the main page: | ||
|
||
`rustup doc` | ||
|
||
- Open the documentation for a specific topic (a module in the standard library, a type, a keyword, etc.): | ||
|
||
`rustup doc `<span class="tldr-var badge badge-pill bg-dark-lm bg-white-dm text-white-lm text-dark-dm font-weight-bold">std::fs|usize|fn|...</span> | ||
|
||
- Open the Rust Programming Language book: | ||
|
||
`rustup doc --book` | ||
|
||
- Open the Cargo book: | ||
|
||
`rustup doc --cargo` | ||
|
||
- Open the Rust Reference: | ||
|
||
`rustup doc --reference` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
--- | ||
layout: page | ||
title: common/rustup-override (English) | ||
description: "Modify directory toolchain overrides." | ||
content_hash: 59b9a159881593523f74a25066094285f058b950 | ||
last_modified_at: 2023-09-19 | ||
--- | ||
|
||
This entry is very new in the [tldr-pages](https://github.com/tldr-pages/tldr) project, hence translation data is currently unavailable for a while. | ||
|
||
<hr># rustup override | ||
|
||
Modify directory toolchain overrides. | ||
See `rustup help toolchain` for more information about toolchains. | ||
More information: <https://rust-lang.github.io/rustup>. | ||
|
||
- List directiory toolchain overrides: | ||
|
||
`rustup override list` | ||
|
||
- Set the override toolchain for the current directory (i.e. tell `rustup` to run `cargo`, `rustc`, etc. from a specific toolchain when in that directory): | ||
|
||
`rustup override set `<span class="tldr-var badge badge-pill bg-dark-lm bg-white-dm text-white-lm text-dark-dm font-weight-bold">toolchain</span> | ||
|
||
- Remove the toolchain override for the current directory: | ||
|
||
`rustup override unset` | ||
|
||
- Remove all toolchain overrides for directories that no longer exist: | ||
|
||
`rustup override unset --nonexistent` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
--- | ||
layout: page | ||
title: common/rustup-self (English) | ||
description: "Modify the `rustup` installation." | ||
content_hash: 36e2686d58f429b1ca7439e659955821f7fd6229 | ||
last_modified_at: 2023-09-19 | ||
--- | ||
|
||
This entry is very new in the [tldr-pages](https://github.com/tldr-pages/tldr) project, hence translation data is currently unavailable for a while. | ||
|
||
<hr># rustup self | ||
|
||
Modify the `rustup` installation. | ||
More information: <https://rust-lang.github.io/rustup>. | ||
|
||
- Update `rustup`: | ||
|
||
`rustup self update` | ||
|
||
- Uninstall `rustup`: | ||
|
||
`rustup self uninstall` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
--- | ||
layout: page | ||
title: common/rustup-set (English) | ||
description: "Alter `rustup` settings." | ||
content_hash: 092a8d17efc8abada5c6bd8da52f7a1955318882 | ||
last_modified_at: 2023-09-19 | ||
--- | ||
|
||
This entry is very new in the [tldr-pages](https://github.com/tldr-pages/tldr) project, hence translation data is currently unavailable for a while. | ||
|
||
<hr># rustup set | ||
|
||
Alter `rustup` settings. | ||
More information: <https://rust-lang.github.io/rustup>. | ||
|
||
- Set the default host triple: | ||
|
||
`rustup set default-host `<span class="tldr-var badge badge-pill bg-dark-lm bg-white-dm text-white-lm text-dark-dm font-weight-bold">host_triple</span> | ||
|
||
- Set the default profile (`minimal` includes only `rustc`, `rust-std` and `cargo`, whereas `default` adds `rust-docs`, `rustfmt` and `clippy`): | ||
|
||
`rustup set profile `<span class="tldr-var badge badge-pill bg-dark-lm bg-white-dm text-white-lm text-dark-dm font-weight-bold">minimal|default</span> | ||
|
||
- Set whether `rustup` should update itself when running `rustup update`: | ||
|
||
`rustup set auto-self-update `<span class="tldr-var badge badge-pill bg-dark-lm bg-white-dm text-white-lm text-dark-dm font-weight-bold">enable|disable|check-only</span> |
Submodule source
updated
6 files
+8 −0 | pages/common/rustup-completions.md | |
+21 −0 | pages/common/rustup-component.md | |
+25 −0 | pages/common/rustup-doc.md | |
+21 −0 | pages/common/rustup-override.md | |
+12 −0 | pages/common/rustup-self.md | |
+16 −0 | pages/common/rustup-set.md |