Permalink
Browse files

make doc

  • Loading branch information...
1 parent c24e212 commit 2881227e0b2688f9a72c8fcf09bceaab2d233f5c @isaacs isaacs committed Nov 6, 2010
View
@@ -1,7 +1,7 @@
.\" Generated with Ronnjs/v0.1
.\" http://github.com/kapouer/ronnjs/
.
-.TH "ACTIVATE" "1" "September 2010" "" ""
+.TH "ACTIVATE" "1" "November 2010" "" ""
.
.SH "NAME"
\fBactivate\fR \-\- Activate an installed version of a package
View
@@ -1,7 +1,7 @@
.\" Generated with Ronnjs/v0.1
.\" http://github.com/kapouer/ronnjs/
.
-.TH "NPM\-ADDUSER" "1" "September 2010" "" ""
+.TH "NPM\-ADDUSER" "1" "November 2010" "" ""
.
.SH "NAME"
\fBnpm-adduser\fR \-\- Add a registry user account
View
@@ -1,7 +1,7 @@
.\" Generated with Ronnjs/v0.1
.\" http://github.com/kapouer/ronnjs/
.
-.TH "NPM\-BUILD" "1" "September 2010" "" ""
+.TH "NPM\-BUILD" "1" "November 2010" "" ""
.
.SH "NAME"
\fBnpm-build\fR \-\- Build a package
View
@@ -1,7 +1,7 @@
.\" Generated with Ronnjs/v0.1
.\" http://github.com/kapouer/ronnjs/
.
-.TH "NPM\-BUNDLE" "1" "October 2010" "" ""
+.TH "NPM\-BUNDLE" "1" "November 2010" "" ""
.
.SH "NAME"
\fBnpm-bundle\fR \-\- Bundle package dependencies
View
@@ -1,7 +1,7 @@
.\" Generated with Ronnjs/v0.1
.\" http://github.com/kapouer/ronnjs/
.
-.TH "NPM\-CACHE" "1" "September 2010" "" ""
+.TH "NPM\-CACHE" "1" "November 2010" "" ""
.
.SH "NAME"
\fBnpm-cache\fR \-\- install a package
View
@@ -1,7 +1,7 @@
.\" Generated with Ronnjs/v0.1
.\" http://github.com/kapouer/ronnjs/
.
-.TH "NPM\-CODING\-STYLE" "1" "September 2010" "" ""
+.TH "NPM\-CODING\-STYLE" "1" "November 2010" "" ""
.
.SH "NAME"
\fBnpm-coding-style\fR \-\- npm\'s "funny" coding style
View
@@ -1,7 +1,7 @@
.\" Generated with Ronnjs/v0.1
.\" http://github.com/kapouer/ronnjs/
.
-.TH "NPM\-CONFIG" "1" "October 2010" "" ""
+.TH "NPM\-CONFIG" "1" "November 2010" "" ""
.
.SH "NAME"
\fBnpm-config\fR \-\- Manage the npm configuration file
@@ -122,6 +122,25 @@ npm \-\-key val <command>
.P
Configurations defined on the command line are not saved to the \.npmrc file\.
.
+.SS "recursive"
+Default: false
+.
+.P
+Set to some truish value to recursively remove dependent packages\. For
+example if foo depends on bar, and bar depends on baz, then:
+.
+.IP "" 4
+.
+.nf
+npm uninstall baz \-\-recursive
+.
+.fi
+.
+.IP "" 0
+.
+.P
+will remove baz, bar, and foo\.
+.
.SS "loglevel"
Default: "info"
.
@@ -307,3 +326,71 @@ Default: "man"
.P
The program to use to view help content\. Set to "woman" to use the emacs troff viewer
by that name\.
+.
+.SS "exit"
+Default: true
+.
+.P
+Whether or not to exit the process when the command is finished\. When
+using npm programmatically, it\'s a good idea to set this to \fBfalse\fR
+explicitly\.
+.
+.SS "logfd"
+Default: Standard Error FD (2)
+.
+.P
+The file descriptor (integer) or stream object where npm will write log
+messages\.
+.
+.P
+When using npm programmatically, you may want to provide a
+FileWriteStream, or some other form of WritableStream\.
+.
+.SS "outfd"
+Default: Standard Output FD (1)
+.
+.P
+The file descriptor (integer) or stream object where npm will write
+"normal" output\. For instance, the \fBls\fR and \fBview\fR commands write their
+output here\.
+.
+.P
+When using npm programmatically, you may want to provide a
+FileWriteStream, or some other form of WritableStream\.
+.
+.SS "color"
+Default: true
+.
+.P
+Set to false to disable colorized output\.
+.
+.P
+In versions of node that expose the \fBisatty\fR function, npm will never
+write colorized output to a non\-terminal file descriptor\.
+.
+.SS "tmproot"
+Default: env\.TMPDIR or "/tmp"
+.
+.P
+The folder where temporary files should be placed\.
+.
+.P
+npm creates a subfolder whenever it is run, and attempts to delete it
+afterwards\.
+.
+.SS "force"
+Default: false
+.
+.P
+Set to a truish value to force uninstalling packages, even if they have
+dependents\.
+.
+.P
+Note that setting \fBrecursive\fR is safer, because forcing uninstall can
+create orphan packages that no longer function properly\.
+.
+.SS "editor"
+Default: env\.EDITOR
+.
+.P
+The program to use to edit files\.
View
@@ -1,7 +1,7 @@
.\" Generated with Ronnjs/v0.1
.\" http://github.com/kapouer/ronnjs/
.
-.TH "NPM\-DEACTIVATE" "1" "September 2010" "" ""
+.TH "NPM\-DEACTIVATE" "1" "November 2010" "" ""
.
.SH "NAME"
\fBnpm-deactivate\fR \-\- Deactivate the active version of a package
View
@@ -0,0 +1,34 @@
+.\" Generated with Ronnjs/v0.1
+.\" http://github.com/kapouer/ronnjs/
+.
+.TH "NPM\-DEPRECATE" "1" "November 2010" "" ""
+.
+.SH "NAME"
+\fBnpm-deprecate\fR \-\- Deprecate a version of a package
+.
+.SH "SYNOPSIS"
+.
+.nf
+npm deprecate <pkg>[@<version>] <message>
+.
+.fi
+.
+.SH "DESCRIPTION"
+This command will update the npm registry entry for a package, providing
+a deprecation warning to all who attempt to install it\.
+.
+.P
+It works on version ranges as well as specific versions, so you can do
+something like this:
+.
+.IP "" 4
+.
+.nf
+npm deprecate my\-thing@"< 0\.2\.3" "critical bug fixed in v0\.2\.3"
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Note that you must be the package owner to deprecate something\.
View
@@ -1,7 +1,7 @@
.\" Generated with Ronnjs/v0.1
.\" http://github.com/kapouer/ronnjs/
.
-.TH "NPM\-DEVELOPERS" "1" "October 2010" "" ""
+.TH "NPM\-DEVELOPERS" "1" "November 2010" "" ""
.
.SH "NAME"
\fBnpm-developers\fR \-\- Developer Guide
View
@@ -1,7 +1,7 @@
.\" Generated with Ronnjs/v0.1
.\" http://github.com/kapouer/ronnjs/
.
-.TH "NPM\-FOLDERS" "1" "September 2010" "" ""
+.TH "NPM\-FOLDERS" "1" "November 2010" "" ""
.
.SH "NAME"
\fBnpm-folders\fR \-\- Folder Structures Used by npm
@@ -1,7 +1,7 @@
.\" Generated with Ronnjs/v0.1
.\" http://github.com/kapouer/ronnjs/
.
-.TH "NPM\-DEPLOY" "1" "September 2010" "" ""
+.TH "NPM\-DEPLOY" "1" "November 2010" "" ""
.
.SH "NAME"
\fBnpm-deploy\fR \-\- Deploy a package to a remote host
@@ -1,7 +1,7 @@
.\" Generated with Ronnjs/v0.1
.\" http://github.com/kapouer/ronnjs/
.
-.TH "NPM\-REMOTE" "1" "September 2010" "" ""
+.TH "NPM\-REMOTE" "1" "November 2010" "" ""
.
.SH "NAME"
\fBnpm-remote\fR \-\- Execute commands on a remote machine
View
@@ -1,7 +1,7 @@
.\" Generated with Ronnjs/v0.1
.\" http://github.com/kapouer/ronnjs/
.
-.TH "NPM\-SITE" "1" "September 2010" "" ""
+.TH "NPM\-SITE" "1" "November 2010" "" ""
.
.SH "NAME"
\fBnpm-site\fR \-\- Run the npm web site
View
@@ -0,0 +1,32 @@
+.\" Generated with Ronnjs/v0.1
+.\" http://github.com/kapouer/ronnjs/
+.
+.TH "INIT" "1" "November 2010" "" ""
+.
+.SH "NAME"
+\fBinit\fR \-\- Interactively create a package\.json file
+.
+.SH "SYNOPSIS"
+.
+.nf
+npm init
+.
+.fi
+.
+.SH "DESCRIPTION"
+This will ask you a bunch of questions, and then write a package\.json for you\.
+.
+.P
+It attempts to make reasonable guesses about what you want things to be set to,
+and then writes a package\.json file with the options you\'ve selected\.
+.
+.P
+If you already have a package\.json file, it\'ll read that first, and default to
+the options in there\.
+.
+.P
+It is strictly additive, so it does not delete options from your package\.json
+without a really good reason to do so\.
+.
+.SH "SEE ALSO"
+npm\-json(1)
View
@@ -1,7 +1,7 @@
.\" Generated with Ronnjs/v0.1
.\" http://github.com/kapouer/ronnjs/
.
-.TH "NPM\-INSTALL" "1" "September 2010" "" ""
+.TH "NPM\-INSTALL" "1" "November 2010" "" ""
.
.SH "NAME"
\fBnpm-install\fR \-\- install a package
View
@@ -1,7 +1,7 @@
.\" Generated with Ronnjs/v0.1
.\" http://github.com/kapouer/ronnjs/
.
-.TH "NPM\-JSON" "1" "October 2010" "" ""
+.TH "NPM\-JSON" "1" "November 2010" "" ""
.
.SH "NAME"
\fBnpm-json\fR \-\- Specifics of npm\'s package\.json handling
View
@@ -1,7 +1,7 @@
.\" Generated with Ronnjs/v0.1
.\" http://github.com/kapouer/ronnjs/
.
-.TH "NPM\-LINK" "1" "September 2010" "" ""
+.TH "NPM\-LINK" "1" "November 2010" "" ""
.
.SH "NAME"
\fBnpm-link\fR \-\- Symlink a package folder
View
@@ -1,7 +1,7 @@
.\" Generated with Ronnjs/v0.1
.\" http://github.com/kapouer/ronnjs/
.
-.TH "NPM\-LIST" "1" "September 2010" "" ""
+.TH "NPM\-LIST" "1" "November 2010" "" ""
.
.SH "NAME"
\fBnpm-list\fR \-\- List installed packages
View
@@ -1,7 +1,7 @@
.\" Generated with Ronnjs/v0.1
.\" http://github.com/kapouer/ronnjs/
.
-.TH "NPM\-LINK" "1" "September 2010" "" ""
+.TH "NPM\-LINK" "1" "November 2010" "" ""
.
.SH "NAME"
\fBnpm-link\fR \-\- Symlink a package folder
View
@@ -1,7 +1,7 @@
.\" Generated with Ronnjs/v0.1
.\" http://github.com/kapouer/ronnjs/
.
-.TH "NPM\-LIST" "1" "September 2010" "" ""
+.TH "NPM\-LIST" "1" "November 2010" "" ""
.
.SH "NAME"
\fBnpm-list\fR \-\- List installed packages
View
@@ -1,7 +1,7 @@
.\" Generated with Ronnjs/v0.1
.\" http://github.com/kapouer/ronnjs/
.
-.TH "NPM" "1" "October 2010" "" ""
+.TH "NPM" "1" "November 2010" "" ""
.
.SH "NAME"
\fBnpm\fR \-\- node package manager
@@ -533,5 +533,15 @@ Better handling of "engines" field
0\.2\.5:
Make npm OK to use programmatically (Charlie Robbins)
.
+.IP "\(bu" 4
+0\.2\.6:
+More programmatic updates
+.
+.br
+recursive package removal
+.
+.br
+tab completion
+.
.IP "" 0
View
@@ -1,7 +1,7 @@
.\" Generated with Ronnjs/v0.1
.\" http://github.com/kapouer/ronnjs/
.
-.TH "NPM\-OUTDATED" "1" "October 2010" "" ""
+.TH "NPM\-OUTDATED" "1" "November 2010" "" ""
.
.SH "NAME"
\fBnpm-outdated\fR \-\- Check for outdated packages
View
@@ -1,7 +1,7 @@
.\" Generated with Ronnjs/v0.1
.\" http://github.com/kapouer/ronnjs/
.
-.TH "NPM\-OWNER" "1" "September 2010" "" ""
+.TH "NPM\-OWNER" "1" "November 2010" "" ""
.
.SH "NAME"
\fBnpm-owner\fR \-\- Manage package owners
View
@@ -1,7 +1,7 @@
.\" Generated with Ronnjs/v0.1
.\" http://github.com/kapouer/ronnjs/
.
-.TH "NPM\-PUBLISH" "1" "September 2010" "" ""
+.TH "NPM\-PUBLISH" "1" "November 2010" "" ""
.
.SH "NAME"
\fBnpm-publish\fR \-\- Publish a package
View
@@ -1,7 +1,7 @@
.\" Generated with Ronnjs/v0.1
.\" http://github.com/kapouer/ronnjs/
.
-.TH "NPM\-REBUILD" "1" "September 2010" "" ""
+.TH "NPM\-REBUILD" "1" "November 2010" "" ""
.
.SH "NAME"
\fBnpm-rebuild\fR \-\- Rebuild a package
Oops, something went wrong.

0 comments on commit 2881227

Please sign in to comment.