https://github.com/nodenv/nodenv-man
View man pages for currently active node version
https://github.com/nodenv/nodenv-man
hacktoberfest
Last synced: about 1 year ago
JSON representation
View man pages for currently active node version
- Host: GitHub
- URL: https://github.com/nodenv/nodenv-man
- Owner: nodenv
- License: mit
- Created: 2016-02-08T16:44:22.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2024-06-08T02:12:16.000Z (about 2 years ago)
- Last Synced: 2024-08-09T05:53:27.662Z (almost 2 years ago)
- Topics: hacktoberfest
- Language: Shell
- Homepage:
- Size: 43.9 KB
- Stars: 4
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://travis-ci.org/nodenv/nodenv-man)
# Man pages for nodenv Node versions
nodenv-man is a plugin for [nodenv] to easily access the man pages for the
currently set node version, e.g. `node(1)` and `npm(1)`.
Technically, nodenv-man is a wrapper for `man(1)` that takes care of using the
correct manpath.
- [Installation](#installation)
- [Usage](#usage)
## Installation
To install nodenv-man, clone this repository into your `$(nodenv root)/plugins`
directory.
```sh
$ mkdir -p "$(nodenv root)/plugins"
$ git clone https://github.com/nodenv/nodenv-man.git "$(nodenv root)/plugins/nodenv-man"
```
## Usage
Simply use nodenv-man in the same way as your system's `man(1)` program. All
command-line options are passed through to it.
Some examples:
* Show `node(1)` manual:
```sh
$ nodenv man node
```
* Show `npm(1)` manual:
```sh
$ nodenv man 1 npm
```
* Print location of `node(1)` manual:
```sh
$ nodenv man -w node
/usr/local/var/nodenv/versions/4.2.1/share/man/man1/node.1
```
* Change node version and print new location of man page:
```sh
$ NODENV_VERSION=5.0.0 nodenv man -w node
/usr/local/var/nodenv/versions/5.0.0/share/man/man1/node.1
```
[nodenv]: https://github.com/nodenv/nodenv