Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

make doc

  • Loading branch information...
commit c1cc130628389f1f39c90784afe6fb3fb0f6ad53 1 parent c1dc56c
@isaacs isaacs authored
Showing with 120 additions and 3 deletions.
  1. +20 −1 man/activate.1
  2. +12 −0 man/config.1
  3. +69 −2 man/json.1
  4. +19 −0 man/npm.1
View
21 man/activate.1
@@ -1 +1,20 @@
-Unknown option: --pipe
+.\" Generated with Ronnjs/v0.1
+.\" http://github.com/kapouer/ronnjs/
+.
+.TH "ACTIVATE" "1" "August 2010" "" ""
+.
+.SH "NAME"
+\fBactivate\fR \-\- Activate an installed version of a package
+.
+.SH "SYNOPSIS"
+.
+.nf
+npm activate <name>@<version> [<name>@<version> \.\.\.]
+.
+.fi
+.
+.SH "DESCRIPTION"
+This "activates" a specific version of a package, so that you can just do \fBrequire("foo")\fR without having to specify the version\.
+.
+.SH "SEE ALSO"
+npm\-deactivate(1)
View
12 man/config.1
@@ -147,6 +147,18 @@ Default: \fB$INSTALL_PREFIX/bin\fR
.P
The folder where executable programs are installed\.
.
+.P
+Set to "false" to not install executables
+.
+.SS "manroot"
+Default: $INSTALL_PREFIX/share/man
+.
+.P
+The folder where man pages are installed\.
+.
+.P
+Set to "false" to not install man pages\.
+.
.SS "registry"
Default: https://registry\.npmjs\.org/
.
View
71 man/json.1
@@ -15,6 +15,10 @@ be incorporated into the spec\.
This document is all you need to know about what\'s required in your package\.json
file\.
.
+.P
+A lot of the behavior described in this document is affected by the config
+settings described in \fBnpm help config\fR\|\.
+.
.SH "name"
The \fImost\fR important things in your package\.json are the name and version fields\.
.
@@ -179,6 +183,63 @@ Just like the \fBmain\fR script, the modules linked in this fashion will have th
dependencies and paths set up properly by npm\. (In fact, "main" is just sugar
around setting a module named "index"\.)
.
+.SH "man"
+Specify either a single file or an array of filenames to put in place for the \fBman\fR program to find\.
+.
+.P
+If only a single file is provided, then it\'s installed such that it is the
+result from \fBman <pkgname>\fR, regardless of its actual filename\. For example:
+.
+.IP "" 4
+.
+.nf
+{ "name" : "foo"
+, "man" : "\./man/doc\.1"
+}
+.
+.fi
+.
+.IP "" 0
+.
+.P
+would link the \fB\|\./man/doc\.1\fR file in such that it is the target for \fBman foo\fR
+.
+.P
+If the filename doesn\'t start with the package name, then it\'s prefixed\.
+So, this:
+.
+.IP "" 4
+.
+.nf
+{ "name" : "foo"
+, "man" : [ "\./man/foo\.1", "\./man/bar\.1" ]
+}
+.
+.fi
+.
+.IP "" 0
+.
+.P
+will create files to do \fBman foo\fR and \fBman foo\-bar\fR\|\.
+.
+.P
+Man files must end with a number, and optionally a \fB\|\.gz\fR suffix if they are
+compressed\. The number dictates which man section the file is installed into\.
+.
+.IP "" 4
+.
+.nf
+{ "name" : "foo"
+, "man" : [ "\./man/foo\.1", "\./man/foo\.2" ]
+}
+.
+.fi
+.
+.IP "" 0
+.
+.P
+will create entries for \fBman foo\fR and \fBman 2 foo\fR
+.
.SH "directories"
The CommonJS Packages \fIhttp://wiki\.commonjs\.org/wiki/Packages/1\.0\fR spec details a
few ways that you can indicate the structure of your package using a \fBdirectories\fR
@@ -191,13 +252,19 @@ In the future, this information may be used in other creative ways\.
.SS "directories\.lib"
If you specify a "lib" directory, and do not supply a modules hash, then the lib
folder will be walked and any \fI\|\.js or \fR\|\.node files found will be exposed as a
-default module hash\. This is to provide backwards compatibility for packages that
-may have relied on this functionality when the lib folder was symlinked directly\.
+default module hash\.
.
.P
Providing an explicit modules hash is encouraged over exposing the entire lib
folder\.
.
+.SS "directories\.bin"
+If you specify a "bin" directory, then all the files in that folder will be used
+as the "bin" hash\.
+.
+.P
+If you have a "bin" hash already, then this has no effect\.
+.
.SH "repository"
Specify the place where your code lives\. This is helpful for people who want to
contribute, as well as perhaps maybe being the underpinning of some magical "track
View
19 man/npm.1
@@ -366,5 +366,24 @@ Remove link packages properly
.br
Make several commands more parallel
.
+.IP "\(bu" 4
+0\.1\.27:
+Man pages handled with the "man" entry, or a "man" directory
+.
+.br
+Install man pages in the "manroot" config dir
+.
+.br
+Control log output with the "loglevel" config
+.
+.br
+Support a "bin" directory of executables that get auto\-linked
+.
+.br
+Un\-deprecate the "lib" directory\.
+.
+.br
+Bug killing
+.
.IP "" 0
Please sign in to comment.
Something went wrong with that request. Please try again.