Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add man proxy to rustup for viewing rust-toolchain manpages #1690

Closed
tesuji opened this issue Mar 7, 2019 · 2 comments
Closed

Add man proxy to rustup for viewing rust-toolchain manpages #1690

tesuji opened this issue Mar 7, 2019 · 2 comments

Comments

@tesuji
Copy link
Contributor

tesuji commented Mar 7, 2019

Describe the problem you are trying to solve

I cannot directly use man cargo, man rustc, etc.

Describe the solution you'd like

The new command might be: rustup man (which is somewhat similar to rustup completions).

As @kinnison suggest, we could use the man proxy of rustup. This command could alter
the MANPATH to point to appropriate rust-toolchain's manpages and open them with
system man program.

Some examples:

Command Meaning
rustup man cargo Display manpages of cargo
rustup man cargo-new Display manpages of cargo new
rustup +nightly man rustc Display manpages of nightly rustc
rustup man install Symlink-install manpages to ~/.local/share/man/man1
@kinnison
Copy link
Contributor

kinnison commented Mar 7, 2019

I fear we'd have to add a man proxy to rustup which altered the environment to include an appropriate MANPATH and then ran the system version of man. I don't see how any other approach would work given we have to find which manpages to display based on rust-toolchain and friends.

@tesuji tesuji changed the title Add instruction to install manpages Add man proxy to rustup to view manpages Mar 8, 2019
@tesuji tesuji changed the title Add man proxy to rustup to view manpages Add man proxy to rustup for viewing rust-toolchain manpages Mar 8, 2019
@tesuji
Copy link
Contributor Author

tesuji commented Mar 11, 2019

Closed in #616.

@tesuji tesuji closed this as completed Mar 11, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants