make doc

man1/changelog.1

@@ -1,7 +1,7 @@
 .\" Generated with Ronnjs/v0.1
 .\" http://github.com/kapouer/ronnjs/
 .
-.TH "NPM\-CHANGELOG" "1" "November 2010" "" ""
+.TH "NPM\-CHANGELOG" "1" "December 2010" "" ""
 .
 .SH "NAME"
 \fBnpm-changelog\fR \-\- Changes
@@ -432,5 +432,28 @@ Much beefed up bundle command
 .br
 Deep view command
 .
+.IP "\(bu" 4
+0\.2\.10:
+npm edit command
+.
+.br
+various stability bugfixes\.
+.
+.IP "\(bu" 4
+0\.2\.11:
+~> and 1\.2\.x style version ranges
+.
+.br
+complete tab completion: see \fBnpm help completion\fR (Evan Meagher)
+.
+.br
+explore command: see \fBnpm help explore\fR
+.
+.br
+docs command: see \fBnpm help docs\fR
+.
+.br
+keywords and description in \fBnpm ls\fR
+.
 .IP "" 0
 

man1/developers.1

@@ -1,7 +1,7 @@
 .\" Generated with Ronnjs/v0.1
 .\" http://github.com/kapouer/ronnjs/
 .
-.TH "NPM\-DEVELOPERS" "1" "November 2010" "" ""
+.TH "NPM\-DEVELOPERS" "1" "December 2010" "" ""
 .
 .SH "NAME"
 \fBnpm-developers\fR \-\- Developer Guide
@@ -71,13 +71,19 @@ If you have a single module that serves as the entry point to your
 program (like what the "foo" package gives you at require("foo")),
 then you need to specify that in the "main" field\.
 .
+.IP "\(bu" 4
+directories:
+This is a hash of folders\.  The best ones to include are "lib" and
+"doc", but if you specify a folder full of man pages in "man", then
+they\'ll get installed just like these ones\.
+.
 .IP "" 0
 .
 .SH "Make Sure Your Package Installs and Works"
 \fBThis is important\.\fR
 .
 .P
-If you can not install it locally, you\'ll have 
+If you can not install it locally, you\'ll have
 problems trying to publish it\.  Or, worse yet, you\'ll be able to
 publish it, but you\'ll be publishing a broken or pointless package\.
 So don\'t do that\.
@@ -88,7 +94,7 @@ In the root of your package, do this:
 .IP "" 4
 .
 .nf
-npm install \.
+npm install
 .
 .fi
 .
@@ -101,7 +107,7 @@ package that points to your working directory, then do this:
 .IP "" 4
 .
 .nf
-npm link \.
+npm link
 .
 .fi
 .
@@ -174,12 +180,12 @@ npm help adduser
 .IP "" 0
 .
 .SH "Publish your package"
-This part\'s easy\.
+This part\'s easy\.  IN the root of your folder, do this:
 .
 .IP "" 4
 .
 .nf
-npm publish /path/to/my\-package
+npm publish
 .
 .fi
 .
@@ -189,21 +195,6 @@ npm publish /path/to/my\-package
 You can give publish a url to a tarball, or a filename of a tarball,
 or a path to a folder\.
 .
-.P
-If you\'re in the root of your folder, then you can just do:
-.
-.IP "" 4
-.
-.nf
-npm publish
-.
-.fi
-.
-.IP "" 0
-.
-.P
-since the default argument is "\."\.
-.
 .SH "Brag about it"
 Send emails, write blogs, blab in IRC\.
 .

man1/faq.1

@@ -0,0 +1,147 @@
+.\" Generated with Ronnjs/v0.1
+.\" http://github.com/kapouer/ronnjs/
+.
+.TH "NPM\-FAQ" "1" "December 2010" "" ""
+.
+.SH "NAME"
+\fBnpm-faq\fR \-\- Frequently Asked Questions
+.
+.SH "Where can I find these docs in HTML?"
+\fIhttps://github\.com/isaacs/npm/tree/master/doc\fR
+.
+.SH "It didn\'t work\."
+That\'s not really a question\.
+.
+.SH "Why didn\'t it work?"
+I don\'t know yet\.
+.
+.P
+Read the error output, and if you can\'t figure out what it means,
+do what it says and post a bug with all the information it asks for\.
+.
+.P
+If there doesn\'t seem to be enough output for your liking, run the
+command with \fB\-\-loglevel verbose\fR or if you\'re really brave, \fB\-\-loglevel
+silly\fR\|\.
+.
+.SH "How do I make npm less noisy?"
+\fBnpm config set loglevel error\fR
+.
+.P
+You can also set it to \fBwin\fR or \fBsilent\fR for even more quietness\.
+.
+.SH "How do I search for packages?"
+\fBnpm ls\fR
+.
+.P
+Arguments are greps\.  \fBnpm ls jsdom\fR shows jsdom packages\.
+.
+.SH "How do I update npm?"
+\fBnpm update npm\fR
+.
+.P
+You can also update all outdated packages by doing \fBnpm update\fR without
+any arguments\.
+.
+.SH "Why does it yell at me when I do `sudo npm install \.\.\.`?"
+Because you\'re not supposed to\.
+.
+.P
+It is not safe to install things with sudo at this time\.  See this
+bug for discussion on why this is and how it will be changed in an
+upcoming version:
+.
+.P
+\fIhttps://github\.com/isaacs/npm/issues/issue/294\fR
+.
+.SH "How do I install node with npm?"
+You don\'t\.  Try one of these:
+.
+.IP "\(bu" 4
+\fIhttp://github\.com/isaacs/nave\fR
+.
+.IP "\(bu" 4
+\fIhttp://github\.com/creationix/nvm\fR
+.
+.IP "" 0
+.
+.SH "Can I list a url as a dependency?"
+No\.
+.
+.P
+If you need to depend on something that isn\'t published, or a package
+that is published, but which you\'ve modified slightly, you can do this\.
+.
+.P
+The correct way is to do the following:
+.
+.IP "\(bu" 4
+add a \fB"name":"version"\fR entry to your package\.json file\.
+.
+.IP "\(bu" 4
+\fBnpm bundle install <pkg>\fR where \fB<pkg>\fR is a url or path to your
+custom unpublished package\.
+.
+.IP "" 0
+.
+.P
+When installing your package, npm will skip over any dependencies that
+are bundled\.
+.
+.SH "OK, but can I list a git repo as a dependency?"
+No\.
+.
+.P
+Source repositories change quickly\.  That is their purpose\.  Whatever
+you bundle into your package is your business, but having the registry
+refer to a git URL as a "dependency" defeats the whole purpose\.
+.
+.P
+It\'s possible that something a bit more snazzy will be developed at some
+point in the future, but not likely\.  The current system allows for a
+lot of use cases, and is very easy to maintain\.
+.
+.SH "How do I symlink to a dev folder so that I don\'t have to keep re\-installing?"
+\fBnpm link\fR
+.
+.SH "What\'s up with the insecure channel warnings?"
+As of this writing, node has problems uploading files over HTTPS\.  That
+means that publishes go over HTTP\.
+.
+.P
+Until the problem is solved, npm will complain about being insecure\.
+The warnings will disappear when node supports uploading tarballs over
+https reliably\.
+.
+.SH "I forgot my password, and can\'t publish\.  How do I reset it?"
+Email \fIi@izs\.me\fR from the email address that you signed up with\.  Then
+wait a day or two maybe\.
+.
+.SH "I get ECONNREFUSED a lot\.  What\'s up?"
+Either the registry is down, or node\'s DNS isn\'t able to reach out\.
+This happens a lot if you don\'t follow \fIall\fR the steps in the Cygwin
+setup doc\.
+.
+.P
+To check if the registry is down, open up \fIhttp://registry\.npmjs\.org/\fR
+in a web browser\.  This will also tell you if you are just unable to
+access the internet for some reason\.
+.
+.P
+If the registry IS down, let me know by emailing \fIi@izs\.me\fR\|\.  I\'ll have
+someone kick it or something\.
+.
+.SH "Who does npm?"
+\fBnpm view npm author\fR \fBnpm view npm contributors\fR
+.
+.SH "I have a question or request not addressed here\. Where should I put it?"
+Discuss it on the mailing list, or post an issue\.
+.
+.IP "\(bu" 4
+\fInpm\-@googlegroups\.com\fR
+.
+.IP "\(bu" 4
+\fIhttp://github\.com/isaacs/npm/issues\fR
+.
+.IP "" 0
+