man-n

View npm package READMEs with man(1).

Installation

$ npm install -g man-n

Usage

$ man-n -h
  Usage: man-n [options] <package>
 
  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

# 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