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 2881227e0b2688f9a72c8fcf09bceaab2d233f5c 1 parent c24e212
@isaacs isaacs authored
Showing with 198 additions and 35 deletions.
  1. +1 −1  man1/activate.1
  2. +1 −1  man1/adduser.1
  3. +1 −1  man1/build.1
  4. +1 −1  man1/bundle.1
  5. +1 −1  man1/cache.1
  6. +1 −1  man1/coding-style.1
  7. +88 −1 man1/config.1
  8. +1 −1  man1/deactivate.1
  9. +34 −0 man1/deprecate.1
  10. +1 −1  man1/developers.1
  11. +1 −1  man1/folders.1
  12. +1 −1  man1/future-ideas/deploy.1
  13. +1 −1  man1/future-ideas/remote.1
  14. +1 −1  man1/future-ideas/site.1
  15. +32 −0 man1/init.1
  16. +1 −1  man1/install.1
  17. +1 −1  man1/json.1
  18. +1 −1  man1/link.1
  19. +1 −1  man1/list.1
  20. +1 −1  man1/ln.1
  21. +1 −1  man1/ls.1
  22. +11 −1 man1/npm.1
  23. +1 −1  man1/outdated.1
  24. +1 −1  man1/owner.1
  25. +1 −1  man1/publish.1
  26. +1 −1  man1/rebuild.1
  27. +1 −1  man1/restart.1
  28. +1 −1  man1/rm.1
  29. +1 −1  man1/scripts.1
  30. +1 −1  man1/start.1
  31. +1 −1  man1/stop.1
  32. +1 −1  man1/tag.1
  33. +1 −1  man1/test.1
  34. +1 −1  man1/uninstall.1
  35. +1 −1  man1/unpublish.1
  36. +1 −1  man1/update.1
  37. +1 −1  man1/view.1
View
2  man1/activate.1
@@ -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
2  man1/adduser.1
@@ -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
2  man1/build.1
@@ -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
2  man1/bundle.1
@@ -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
2  man1/cache.1
@@ -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
2  man1/coding-style.1
@@ -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
89 man1/config.1
@@ -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
2  man1/deactivate.1
@@ -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
34 man1/deprecate.1
@@ -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
2  man1/developers.1
@@ -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
2  man1/folders.1
@@ -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
View
2  man1/future-ideas/deploy.1
@@ -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
View
2  man1/future-ideas/remote.1
@@ -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
2  man1/future-ideas/site.1
@@ -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
32 man1/init.1
@@ -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
2  man1/install.1
@@ -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
2  man1/json.1
@@ -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
2  man1/link.1
@@ -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
2  man1/list.1
@@ -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
2  man1/ln.1
@@ -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
2  man1/ls.1
@@ -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
12 man1/npm.1
@@ -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
2  man1/outdated.1
@@ -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
2  man1/owner.1
@@ -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
2  man1/publish.1
@@ -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
2  man1/rebuild.1
@@ -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
View
2  man1/restart.1
@@ -1,7 +1,7 @@
.\" Generated with Ronnjs/v0.1
.\" http://github.com/kapouer/ronnjs/
.
-.TH "NPM\-RESTART" "1" "September 2010" "" ""
+.TH "NPM\-RESTART" "1" "November 2010" "" ""
.
.SH "NAME"
\fBnpm-restart\fR \-\- Start a package
View
2  man1/rm.1
@@ -1,7 +1,7 @@
.\" Generated with Ronnjs/v0.1
.\" http://github.com/kapouer/ronnjs/
.
-.TH "NPM\-UNINSTALL" "1" "September 2010" "" ""
+.TH "NPM\-UNINSTALL" "1" "November 2010" "" ""
.
.SH "NAME"
\fBnpm-uninstall\fR \-\- Remove a package
View
2  man1/scripts.1
@@ -1,7 +1,7 @@
.\" Generated with Ronnjs/v0.1
.\" http://github.com/kapouer/ronnjs/
.
-.TH "NPM\-SCRIPTS" "1" "September 2010" "" ""
+.TH "NPM\-SCRIPTS" "1" "November 2010" "" ""
.
.SH "NAME"
\fBnpm-scripts\fR \-\- How npm handles the "scripts" field
View
2  man1/start.1
@@ -1,7 +1,7 @@
.\" Generated with Ronnjs/v0.1
.\" http://github.com/kapouer/ronnjs/
.
-.TH "NPM\-START" "1" "September 2010" "" ""
+.TH "NPM\-START" "1" "November 2010" "" ""
.
.SH "NAME"
\fBnpm-start\fR \-\- Start a package
View
2  man1/stop.1
@@ -1,7 +1,7 @@
.\" Generated with Ronnjs/v0.1
.\" http://github.com/kapouer/ronnjs/
.
-.TH "NPM\-STOP" "1" "September 2010" "" ""
+.TH "NPM\-STOP" "1" "November 2010" "" ""
.
.SH "NAME"
\fBnpm-stop\fR \-\- Stop a package
View
2  man1/tag.1
@@ -1,7 +1,7 @@
.\" Generated with Ronnjs/v0.1
.\" http://github.com/kapouer/ronnjs/
.
-.TH "NPM\-TAG" "1" "September 2010" "" ""
+.TH "NPM\-TAG" "1" "November 2010" "" ""
.
.SH "NAME"
\fBnpm-tag\fR \-\- Tag a published version
View
2  man1/test.1
@@ -1,7 +1,7 @@
.\" Generated with Ronnjs/v0.1
.\" http://github.com/kapouer/ronnjs/
.
-.TH "NPM\-TEST" "1" "September 2010" "" ""
+.TH "NPM\-TEST" "1" "November 2010" "" ""
.
.SH "NAME"
\fBnpm-test\fR \-\- Test a package
View
2  man1/uninstall.1
@@ -1,7 +1,7 @@
.\" Generated with Ronnjs/v0.1
.\" http://github.com/kapouer/ronnjs/
.
-.TH "NPM\-UNINSTALL" "1" "September 2010" "" ""
+.TH "NPM\-UNINSTALL" "1" "November 2010" "" ""
.
.SH "NAME"
\fBnpm-uninstall\fR \-\- Remove a package
View
2  man1/unpublish.1
@@ -1,7 +1,7 @@
.\" Generated with Ronnjs/v0.1
.\" http://github.com/kapouer/ronnjs/
.
-.TH "NPM\-UNPUBLISH" "1" "September 2010" "" ""
+.TH "NPM\-UNPUBLISH" "1" "November 2010" "" ""
.
.SH "NAME"
\fBnpm-unpublish\fR \-\- Remove a package from the registry
View
2  man1/update.1
@@ -1,7 +1,7 @@
.\" Generated with Ronnjs/v0.1
.\" http://github.com/kapouer/ronnjs/
.
-.TH "NPM\-UPDATE" "1" "September 2010" "" ""
+.TH "NPM\-UPDATE" "1" "November 2010" "" ""
.
.SH "NAME"
\fBnpm-update\fR \-\- Update a package
View
2  man1/view.1
@@ -1,7 +1,7 @@
.\" Generated with Ronnjs/v0.1
.\" http://github.com/kapouer/ronnjs/
.
-.TH "NPM\-VIEW" "1" "September 2010" "" ""
+.TH "NPM\-VIEW" "1" "November 2010" "" ""
.
.SH "NAME"
\fBnpm-view\fR \-\- View registry info
Please sign in to comment.
Something went wrong with that request. Please try again.