2025-03-14 21:59:59 -06:00
|
|
|
# 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.
|
2026-02-18 06:55:01 -07:00
|
|
|
> More information: <https://rust-lang.github.io/rustup/>.
|
2025-03-14 21:59:59 -06:00
|
|
|
|
|
|
|
|
- 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 {{std::fs|usize|fn|...}}`
|
|
|
|
|
|
|
|
|
|
- Open the Rust Programming Language book:
|
|
|
|
|
|
|
|
|
|
`rustup doc --book`
|
|
|
|
|
|
|
|
|
|
- Open the Cargo book:
|
|
|
|
|
|
|
|
|
|
`rustup doc --cargo`
|
|
|
|
|
|
|
|
|
|
- Open the Rust Reference:
|
|
|
|
|
|
|
|
|
|
`rustup doc --reference`
|
