Make doc

4 files changed, 459 insertions, 404 deletions

diff --git a/man1/changelog.1 b/man1/changelog.1
new file mode 100644
index 000000000..333b975f9
--- /dev/null
+++ b/man1/changelog.1
@@ -0,0 +1,420 @@
+.\" Generated with Ronnjs/v0.1
+.\" http://github.com/kapouer/ronnjs/
+.
+.TH "NPM\-CHANGELOG" "1" "November 2010" "" ""
+.
+.SH "NAME"
+\fBnpm-changelog\fR \-\- Changes
+.
+.SH "HISTORY"
+.
+.IP "\(bu" 4
+0\.0\.1:
+Lots of sketches and false starts\.  Abandoned a few times\.
+.
+.IP "\(bu" 4
+0\.0\.2:
+Install worked mostly\.  Still promise\-based\.
+.
+.IP "\(bu" 4
+0\.0\.3:
+Converted to callbacks\.
+.
+.br
+Mikeal Rogers wrote a registry for it\.
+.
+.IP "\(bu" 4
+0\.0\.4:
+version dependencies
+.
+.br
+link packages
+.
+.br
+activation
+.
+.br
+lifecycle scripts
+.
+.br
+bin linking
+.
+.br
+uninstallation
+.
+.IP "\(bu" 4
+0\.0\.5:
+fix a few bugs in uninstall wrt dependent packages
+.
+.br
+fix relative require()for nodejs modules installed with the "bin" field\.
+.
+.br
+(issue #2)
+.
+.br
+update to work with node 0\.1\.33 (aka net2)
+.
+.br
+added publish and tag commands
+.
+.IP "\(bu" 4
+0\.0\.6:
+set up a public registry
+.
+.br
+send content\-length with registry PUTs
+.
+.br
+adduser command (Mikeal Rogers)
+.
+.br
+ini file stuff (Mikeal Rogers)
+.
+.br
+env\-specific package\.json
+.
+.br
+added more info to npm\'s the package\.json (bugs, contributors, etc\.)
+.
+.IP "\(bu" 4
+0\.0\.7:
+fixed a few bugs in semver
+.
+.br
+refactor documentation
+.
+.br
+add "help" command
+.
+.br
+add install from registry
+.
+.br
+everything else core
+.
+.br
+push to beta
+.
+.IP "\(bu" 4
+0\.1\.0 \- 0\.1\.2:
+push to beta, and announce
+.
+.br
+clean up some bugs around lifecycle scripts
+.
+.br
+reduce reliance on makefile
+.
+.br
+documentation updates
+.
+.br
+Fixed DOA bugs
+.
+.br
+Removed dependence on ronn
+.
+.IP "\(bu" 4
+0\.1\.3:
+Changed a few details with configs (fix #5)
+.
+.br
+Update adduser and publish to put author info in the data
+.
+.br
+Use buffer api for file writes, hopefully fix #4
+.
+.IP "\(bu" 4
+0\.1\.4 \- 0\.1\.5:
+Fixes for a few more bugs and fix some documentation\.
+.
+.IP "\(bu" 4
+0\.1\.6 \- 0\.1\.7:
+Add cache functionality
+.
+.br
+Use couchdb attachments to host tarballs
+.
+.br
+Handle odd require\.paths more appropriately
+.
+.br
+Don\'t break on install if the man path is missing
+.
+.br
+Support publishing or installing a folder or local tarball
+.
+.IP "\(bu" 4
+0\.1\.8:
+Bugfixes
+.
+.br
+Add start, stop, restart, and test commands
+.
+.IP "\(bu" 4
+0\.1\.9:
+npm list enhancements
+.
+.br
+fix the install bug
+.
+.IP "\(bu" 4
+0\.1\.10:
+More errors found by Ryan Dahl and Kris Zyp
+.
+.br
+Better uninstall and list behavior
+.
+.br
+Docs for new developers\.
+.
+.br
+Better tracking of ownership on the registry\.
+.
+.IP "\(bu" 4
+0\.1\.11:
+Martyn Smith found a whole lot of bugs\.
+.
+.br
+Make publish not die when the tarball is big\.
+.
+.br
+"make uninstall" support
+.
+.IP "\(bu" 4
+0\.1\.12 \- 0\.1\.13:
+Fix the downloading bug that was breaking the tarballs
+.
+.br
+Update some docs
+.
+.IP "\(bu" 4
+0\.1\.14 \- 0\.1\.16:
+Fix to stay in sync with node changes
+.
+.br
+Put a special tag on link installs
+.
+.br
+Modify semver comparison slightly
+.
+.br
+add unpublish command
+.
+.br
+Use the "drain" event properly for uploads
+.
+.br
+Handle thrown errors
+.
+.br
+Handle \.npmignore
+.
+.IP "\(bu" 4
+0\.1\.17:
+Stabilization\.
+.
+.IP "\(bu" 4
+0\.1\.18:
+Change a few default configurations
+.
+.br
+Add test harness
+.
+.br
+Default publish, install, and link to "\." if no arguments given  
+.
+.IP "\(bu" 4
+0\.1\.19 \- 0\.1\.20:
+Create a bunch of bugs
+.
+.br
+Fix a bunch of bugs
+.
+.br
+Some minor speed improvements 
+.
+.IP "\(bu" 4
+0\.1\.21 \- 0\.1\.22:
+Relative paths
+.
+.br
+Support comments in package\.json
+.
+.br
+Add owner name to ls output
+.
+.br
+Add "owner" command to manage package owners
+.
+.br
+Support hook scripts in \fB{root}/\.npm/\.hooks/\fR
+.
+.br
+Initial support for config file relative to node executable
+.
+.br
+Support for http proxies
+.
+.br
+Documentation updates
+.
+.IP "\(bu" 4
+0\.1\.23:
+update command \- This is huge\.
+.
+.br
+Rollback for failed installations
+.
+.br
+Install dependencies for link packages
+.
+.br
+Silently read passwords for adduser
+.
+.br
+Cascading configs: cli, env, user, global
+.
+.br
+First pass at \fBnpm view\fR command
+.
+.IP "\(bu" 4
+0\.1\.24, 0\.1\.25:
+Fix a bunch of things
+.
+.br
+Cleanup, etc\.
+.
+.br
+help via \-\-help, \-h, or \-?  
+.
+.IP "\(bu" 4
+0\.1\.26:
+"modules" hash in package\.json (Alex K\. Wolfe)
+.
+.br
+Better "restart" command (Alex K Wolfe)
+.
+.br
+Work on Cygwin
+.
+.br
+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
+.
+.br
+Split up the tar usage so it works on Solaris
+.
+.br
+bundle command
+.
+.br
+rebuild command
+.
+.IP "\(bu" 4
+0\.2\.0:
+Lots more bug killing
+.
+.br
+Various fixes found during the Node Knockout extravaganza
+.
+.br
+Change all "name\-version" things to be "name@version"
+.
+.br
+First allegedly "stable" release\.
+.
+.IP "\(bu" 4
+0\.2\.1:
+Minor updates and bugfixes
+.
+.IP "\(bu" 4
+0\.2\.2:
+Update "help" to work on Solaris
+.
+.br
+Remove updated packages that don\'t have dependencies\.
+.
+.br
+Allow implied suffixes on \.js bins
+.
+.br
+Fix an "adduser" bug
+.
+.IP "\(bu" 4
+0\.2\.3:
+Lots of documentation tweaks and cleanup
+.
+.br
+Support || in version ranges
+.
+.IP "\(bu" 4
+0\.2\.4:
+Contribution party!
+.
+.br
+Better list whitespace
+.
+.br
+Lots of config happiness
+.
+.br
+Ignore all major SCM folders by default
+.
+.br
+Handle proxies and hostnames with ports
+.
+.br
+Better Bundling
+.
+.br
+Add \'outdated\' command
+.
+.br
+Better handling of "engines" field
+.
+.IP "\(bu" 4
+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 "\(bu" 4
+0\.2\.7 \- 0\.2\.8:
+Bundle treated like a first\-class citizen, and simplified
+.
+.br
+Many bug fixes
+.
+.IP "" 0
+
diff --git a/man1/link.1 b/man1/link.1
index fd3027fa6..dcabc3d38 100644
--- a/man1/link.1
+++ b/man1/link.1
@@ -18,3 +18,22 @@ This will link a source folder into npm\'s registry using a symlink, and then
 build it according to the package\.json file in that folder\'s root\. This is
 handy for installing your own stuff, so that you can work on it and test it
 iteratively without having to continually rebuild\.
+.
+.SH "Linked Package Version"
+When linking a package folder, npm doesn\'t use the version in the
+package\.json file\.  Instead, it creates a "fake" version number of:
+.
+.IP "" 4
+.
+.nf
+"9999\.0\.0\-LINK\-" + hash(folder)
+.
+.fi
+.
+.IP "" 0
+.
+.P
+This way, linking the same folder will always result in the same version
+number, even if you bump the version in the package\.json file\.  The
+extremely high major version ensures that it will always be considered
+the "highest" version, since it is a development bleeding\-edge thing\.
diff --git a/man1/ln.1 b/man1/ln.1
index fd3027fa6..dcabc3d38 100644
--- a/man1/ln.1
+++ b/man1/ln.1
@@ -18,3 +18,22 @@ This will link a source folder into npm\'s registry using a symlink, and then
 build it according to the package\.json file in that folder\'s root\. This is
 handy for installing your own stuff, so that you can work on it and test it
 iteratively without having to continually rebuild\.
+.
+.SH "Linked Package Version"
+When linking a package folder, npm doesn\'t use the version in the
+package\.json file\.  Instead, it creates a "fake" version number of:
+.
+.IP "" 4
+.
+.nf
+"9999\.0\.0\-LINK\-" + hash(folder)
+.
+.fi
+.
+.IP "" 0
+.
+.P
+This way, linking the same folder will always result in the same version
+number, even if you bump the version in the package\.json file\.  The
+extremely high major version ensures that it will always be considered
+the "highest" version, since it is a development bleeding\-edge thing\.
diff --git a/man1/npm.1 b/man1/npm.1
index bea93a451..714b89986 100644
--- a/man1/npm.1
+++ b/man1/npm.1
@@ -141,407 +141,4 @@ as expected\.
 You can also look for isaacs in #node\.js on irc://irc\.freenode\.net\.
 .
 .SH "HISTORY"
-.
-.IP "\(bu" 4
-0\.0\.1:
-Lots of sketches and false starts\.  Abandoned a few times\.
-.
-.IP "\(bu" 4
-0\.0\.2:
-Install worked mostly\.  Still promise\-based\.
-.
-.IP "\(bu" 4
-0\.0\.3:
-Converted to callbacks\.
-.
-.br
-Mikeal Rogers wrote a registry for it\.
-.
-.IP "\(bu" 4
-0\.0\.4:
-version dependencies
-.
-.br
-link packages
-.
-.br
-activation
-.
-.br
-lifecycle scripts
-.
-.br
-bin linking
-.
-.br
-uninstallation
-.
-.IP "\(bu" 4
-0\.0\.5:
-fix a few bugs in uninstall wrt dependent packages
-.
-.br
-fix relative require()for nodejs modules installed with the "bin" field\.
-.
-.br
-(issue #2)
-.
-.br
-update to work with node 0\.1\.33 (aka net2)
-.
-.br
-added publish and tag commands
-.
-.IP "\(bu" 4
-0\.0\.6:
-set up a public registry
-.
-.br
-send content\-length with registry PUTs
-.
-.br
-adduser command (Mikeal Rogers)
-.
-.br
-ini file stuff (Mikeal Rogers)
-.
-.br
-env\-specific package\.json
-.
-.br
-added more info to npm\'s the package\.json (bugs, contributors, etc\.)
-.
-.IP "\(bu" 4
-0\.0\.7:
-fixed a few bugs in semver
-.
-.br
-refactor documentation
-.
-.br
-add "help" command
-.
-.br
-add install from registry
-.
-.br
-everything else core
-.
-.br
-push to beta
-.
-.IP "\(bu" 4
-0\.1\.0 \- 0\.1\.2:
-push to beta, and announce
-.
-.br
-clean up some bugs around lifecycle scripts
-.
-.br
-reduce reliance on makefile
-.
-.br
-documentation updates
-.
-.br
-Fixed DOA bugs
-.
-.br
-Removed dependence on ronn
-.
-.IP "\(bu" 4
-0\.1\.3:
-Changed a few details with configs (fix #5)
-.
-.br
-Update adduser and publish to put author info in the data
-.
-.br
-Use buffer api for file writes, hopefully fix #4
-.
-.IP "\(bu" 4
-0\.1\.4 \- 0\.1\.5:
-Fixes for a few more bugs and fix some documentation\.
-.
-.IP "\(bu" 4
-0\.1\.6 \- 0\.1\.7:
-Add cache functionality
-.
-.br
-Use couchdb attachments to host tarballs
-.
-.br
-Handle odd require\.paths more appropriately
-.
-.br
-Don\'t break on install if the man path is missing
-.
-.br
-Support publishing or installing a folder or local tarball
-.
-.IP "\(bu" 4
-0\.1\.8:
-Bugfixes
-.
-.br
-Add start, stop, restart, and test commands
-.
-.IP "\(bu" 4
-0\.1\.9:
-npm list enhancements
-.
-.br
-fix the install bug
-.
-.IP "\(bu" 4
-0\.1\.10:
-More errors found by Ryan Dahl and Kris Zyp
-.
-.br
-Better uninstall and list behavior
-.
-.br
-Docs for new developers\.
-.
-.br
-Better tracking of ownership on the registry\.
-.
-.IP "\(bu" 4
-0\.1\.11:
-Martyn Smith found a whole lot of bugs\.
-.
-.br
-Make publish not die when the tarball is big\.
-.
-.br
-"make uninstall" support
-.
-.IP "\(bu" 4
-0\.1\.12 \- 0\.1\.13:
-Fix the downloading bug that was breaking the tarballs
-.
-.br
-Update some docs
-.
-.IP "\(bu" 4
-0\.1\.14 \- 0\.1\.16:
-Fix to stay in sync with node changes
-.
-.br
-Put a special tag on link installs
-.
-.br
-Modify semver comparison slightly
-.
-.br
-add unpublish command
-.
-.br
-Use the "drain" event properly for uploads
-.
-.br
-Handle thrown errors
-.
-.br
-Handle \.npmignore
-.
-.IP "\(bu" 4
-0\.1\.17:
-Stabilization\.
-.
-.IP "\(bu" 4
-0\.1\.18:
-Change a few default configurations
-.
-.br
-Add test harness
-.
-.br
-Default publish, install, and link to "\." if no arguments given  
-.
-.IP "\(bu" 4
-0\.1\.19 \- 0\.1\.20:
-Create a bunch of bugs
-.
-.br
-Fix a bunch of bugs
-.
-.br
-Some minor speed improvements 
-.
-.IP "\(bu" 4
-0\.1\.21 \- 0\.1\.22:
-Relative paths
-.
-.br
-Support comments in package\.json
-.
-.br
-Add owner name to ls output
-.
-.br
-Add "owner" command to manage package owners
-.
-.br
-Support hook scripts in \fB{root}/\.npm/\.hooks/\fR
-.
-.br
-Initial support for config file relative to node executable
-.
-.br
-Support for http proxies
-.
-.br
-Documentation updates
-.
-.IP "\(bu" 4
-0\.1\.23:
-update command \- This is huge\.
-.
-.br
-Rollback for failed installations
-.
-.br
-Install dependencies for link packages
-.
-.br
-Silently read passwords for adduser
-.
-.br
-Cascading configs: cli, env, user, global
-.
-.br
-First pass at \fBnpm view\fR command
-.
-.IP "\(bu" 4
-0\.1\.24, 0\.1\.25:
-Fix a bunch of things
-.
-.br
-Cleanup, etc\.
-.
-.br
-help via \-\-help, \-h, or \-?  
-.
-.IP "\(bu" 4
-0\.1\.26:
-"modules" hash in package\.json (Alex K\. Wolfe)
-.
-.br
-Better "restart" command (Alex K Wolfe)
-.
-.br
-Work on Cygwin
-.
-.br
-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
-.
-.br
-Split up the tar usage so it works on Solaris
-.
-.br
-bundle command
-.
-.br
-rebuild command
-.
-.IP "\(bu" 4
-0\.2\.0:
-Lots more bug killing
-.
-.br
-Various fixes found during the Node Knockout extravaganza
-.
-.br
-Change all "name\-version" things to be "name@version"
-.
-.br
-First allegedly "stable" release\.
-.
-.IP "\(bu" 4
-0\.2\.1:
-Minor updates and bugfixes
-.
-.IP "\(bu" 4
-0\.2\.2:
-Update "help" to work on Solaris
-.
-.br
-Remove updated packages that don\'t have dependencies\.
-.
-.br
-Allow implied suffixes on \.js bins
-.
-.br
-Fix an "adduser" bug
-.
-.IP "\(bu" 4
-0\.2\.3:
-Lots of documentation tweaks and cleanup
-.
-.br
-Support || in version ranges
-.
-.IP "\(bu" 4
-0\.2\.4:
-Contribution party!
-.
-.br
-Better list whitespace
-.
-.br
-Lots of config happiness
-.
-.br
-Ignore all major SCM folders by default
-.
-.br
-Handle proxies and hostnames with ports
-.
-.br
-Better Bundling
-.
-.br
-Add \'outdated\' command
-.
-.br
-Better handling of "engines" field
-.
-.IP "\(bu" 4
-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
-
+See npm\-changelog(1)