3

I have downloaded node.js tarball from its website, and now I would like install the manpage that comes with it so that I can view it by typing:

 man nodejs

How can I do this?

Flimm
  • 44,031
Patryk
  • 9,416

2 Answers2

4

It's not man nodejs, but man 1 node. And it will be there by default.

It will be installed for you with the regular installation method (e.g. sudo make install) as the tools/install.py called from the Makefile will take care of it:

if 'freebsd' in sys.platform or 'openbsd' in sys.platform:
  action(['doc/node.1'], 'man/man1/')
else:
  action(['doc/node.1'], 'share/man/man1/')

In other words, it installs node.1 for you in /usr/share/man/man1/.

To read the manpage directly from the source, you can do:

man /path/to/nodejssource/doc/node.1
gertvdijk
  • 69,427
2

In addition to the man page, Node sets up its own help server.

npm help <term>

or to get started:

npm help npm

The documentation is also online at: Node.js API docs

chaskes
  • 15,536