https://github.com/man-n/man-n

Browse npm with man(1)
https://github.com/man-n/man-n

Last synced: 4 months ago
JSON representation

Browse npm with man(1)

• Host: GitHub
• URL: https://github.com/man-n/man-n
• Owner: man-n
• License: other
• Created: 2015-07-04T14:06:12.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2015-11-23T16:43:48.000Z (about 9 years ago)
• Last Synced: 2024-09-15T03:31:30.351Z (5 months ago)
• Language: Shell
• Homepage:
• Size: 379 KB
• Stars: 43
• Watchers: 4
• Forks: 5
• Open Issues: 2
• Metadata Files:
  • Readme: readme.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# man-n

View npm package READMEs with `man(1)`.

![screenshot of man-n showing the browserify docs](screenshot.png)

## Installation

```sh

$ npm install -g man-n

```

## Usage

```sh

$ man-n -h

  Usage: man-n [options] 

  Options:

    -h, --help  output usage information

    -l, --link  default to man(1)

  Examples:

    $ man-n browserify          # show browserify docs

```

## Aliasing

Tired of typing that dash, or even that `n`? Add the following to your

`.bashrc`, `.bash_profile`, or `.zshrc`

```sh

# Link `man-n` to `man`

$ alias "man=man-n --link"

```

...and from now on, you can just type `man browserify` to access package

documentation. However, **man**(1) will prefer normal man pages, so when you

wan’t to get the readme of **which**(n), use `man n which` instead of

`man which`.

## License

[MIT](https://tldrlegal.com/license/mit-license)