|
1 | 1 | # Environment variables
|
2 | 2 |
|
3 |
| -- `RUSTUP_HOME` (default: `~/.rustup` or `%USERPROFILE%/.rustup`) Sets the |
| 3 | +- `RUSTUP_HOME` (default: `~/.rustup` or `%USERPROFILE%/.rustup`). Sets the |
4 | 4 | root `rustup` folder, used for storing installed toolchains and
|
5 | 5 | configuration options.
|
6 | 6 |
|
7 |
| -- `RUSTUP_TOOLCHAIN` (default: none) If set, will [override] the toolchain used |
| 7 | +- `RUSTUP_TOOLCHAIN` (default: none). If set, will [override] the toolchain used |
8 | 8 | for all rust tool invocations. A toolchain with this name should be installed,
|
9 | 9 | or invocations will fail. This can specify custom toolchains, installable
|
10 | 10 | toolchains, or the absolute path to a toolchain.
|
11 | 11 |
|
12 |
| -- `RUSTUP_DIST_SERVER` (default: `https://static.rust-lang.org`) Sets the root |
| 12 | +- `RUSTUP_DIST_SERVER` (default: `https://static.rust-lang.org`). Sets the root |
13 | 13 | URL for downloading static resources related to Rust. You can change this to
|
14 | 14 | instead use a local mirror, or to test the binaries from the staging
|
15 | 15 | directory.
|
16 | 16 |
|
17 |
| -- `RUSTUP_DIST_ROOT` (default: `https://static.rust-lang.org/dist`) |
18 |
| - Deprecated. Use `RUSTUP_DIST_SERVER` instead. |
| 17 | +- ~~`RUSTUP_DIST_ROOT`~~ *deprecated* (default: `https://static.rust-lang.org/dist`). |
| 18 | + Use `RUSTUP_DIST_SERVER` instead. |
19 | 19 |
|
20 |
| -- `RUSTUP_UPDATE_ROOT` (default `https://static.rust-lang.org/rustup`) Sets |
| 20 | +- `RUSTUP_UPDATE_ROOT` (default `https://static.rust-lang.org/rustup`). Sets |
21 | 21 | the root URL for downloading self-update.
|
22 | 22 |
|
23 | 23 | - `RUSTUP_IO_THREADS` *unstable* (defaults to reported cpu count). Sets the
|
24 | 24 | number of threads to perform close IO in. Set to `1` to force
|
25 | 25 | single-threaded IO for troubleshooting, or an arbitrary number to override
|
26 | 26 | automatic detection.
|
27 | 27 |
|
28 |
| -- `RUSTUP_TRACE_DIR` *unstable* (default: no tracing) Enables tracing and |
| 28 | +- `RUSTUP_TRACE_DIR` *unstable* (default: no tracing). Enables tracing and |
29 | 29 | determines the directory that traces will be written too. Traces are of the
|
30 | 30 | form PID.trace. Traces can be read by the Catapult project [tracing viewer].
|
31 | 31 |
|
32 |
| -- `RUSTUP_TERM_COLOR` (default: `auto`) Controls whether colored output is used in the terminal. |
| 32 | +- `RUSTUP_DEBUG` *unstable*. When set, enables rustup's debug logging. |
| 33 | + |
| 34 | +- `RUSTUP_TERM_COLOR` (default: `auto`). Controls whether colored output is used in the terminal. |
33 | 35 | Set to `auto` to use colors only in tty streams, to `always` to always enable colors,
|
34 | 36 | or to `never` to disable colors.
|
35 | 37 |
|
36 |
| -- `RUSTUP_UNPACK_RAM` *unstable* (default free memory or 500MiB if unable to tell, min 210MiB) Caps the amount of |
| 38 | +- `RUSTUP_UNPACK_RAM` *unstable* (default free memory or 500MiB if unable to tell, min 210MiB). Caps the amount of |
37 | 39 | RAM `rustup` will use for IO tasks while unpacking.
|
38 | 40 |
|
39 |
| -- `RUSTUP_NO_BACKTRACE` Disables backtraces on non-panic errors even when |
| 41 | +- `RUSTUP_NO_BACKTRACE`. Disables backtraces on non-panic errors even when |
40 | 42 | `RUST_BACKTRACE` is set.
|
41 | 43 |
|
42 |
| -- `RUSTUP_PERMIT_COPY_RENAME` *unstable* When set, allows rustup to fall-back |
| 44 | +- `RUSTUP_PERMIT_COPY_RENAME` *unstable*. When set, allows rustup to fall-back |
43 | 45 | to copying files if attempts to `rename` result in cross-device link
|
44 | 46 | errors. These errors occur on OverlayFS, which is used by [Docker][dc]. This
|
45 | 47 | feature sacrifices some transactions protections and may be removed at any
|
|
0 commit comments