make doc

2 files changed, 45 insertions, 53 deletions

diff --git a/man1/bin.1 b/man1/bin.1
new file mode 100644
index 000000000..026485ffb
--- /dev/null
+++ b/man1/bin.1
@@ -0,0 +1,17 @@
+.\" Generated with Ronnjs/v0.1
+.\" http://github.com/kapouer/ronnjs/
+.
+.TH "NPM\-BIN" "1" "March 2011" "" ""
+.
+.SH "NAME"
+\fBnpm-bin\fR \-\- Display npm bin folder
+.
+.SH "SYNOPSIS"
+.
+.nf
+npm bin
+.
+.fi
+.
+.SH "DESCRIPTION"
+Print the folder where npm will install executables\.
diff --git a/man1/json.1 b/man1/json.1
index 3fb3e3506..7fd2766a7 100644
--- a/man1/json.1
+++ b/man1/json.1
@@ -131,19 +131,13 @@ npm also sets a top\-level "maintainers" field with your npm user info\.
 .SH "files"
 The "files" field is an array of files to include in your project\.  If
 you name a folder in the array, then it will also include the files
-inside that folder\.  The default is just \fB[""]\fR which includes the
-entire package folder in the tarball, but you may want to only include
-specific things\.
-.
-.P
-If you specify bins or man pages, then those will be
-automatically added to the files array, even if they would not
-ordinarily be included\.
+inside that folder\. (Unless they would be ignored by another rule\.)
 .
 .P
 You can also provide a "\.npmignore" file in the root of your package,
 which will keep files from being included, even if they would be picked
-up by the files array\.
+up by the files array\.  The "\.npmignore" file works just like a
+"\.gitignore"\.
 .
 .SH "main"
 The main field is a module ID that is the primary entry point to your program\.
@@ -284,34 +278,31 @@ you\'ll see that it has directories for doc, lib, and man\.
 In the future, this information may be used in other creative ways\.
 .
 .SS "directories\.lib"
-If you specify a "lib" directory, then the lib
-folder will be walked and any \fI\|\.js or \fR\|\.node files found will be exposed as a
-default module hash\.
-.
-.P
-\fBThe lib directory mapping will be deprecated soon\. Please do not rely
-on it\.\fR
+Tell people where the bulk of your library is\.  Nothing special is done
+with the lib folder in any way, but it\'s useful meta info\.
 .
 .SS "directories\.bin"
-If you specify a "bin" directory, then all the files in that folder will be used
-as the "bin" hash\.
+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\.
 .
 .SS "directories\.man"
-A folder that is full of man pages\.  Sugar to generate a "man" array by walking the folder\.
+A folder that is full of man pages\.  Sugar to generate a "man" array by
+walking the folder\.
 .
 .SS "directories\.doc"
-Put markdown files in here\.  Eventually, these will be displayed nicely, maybe, someday\.
+Put markdown files in here\.  Eventually, these will be displayed nicely,
+maybe, someday\.
 .
 .SS "directories\.example"
 Put example scripts in here\.  Someday, it might be exposed in some clever way\.
 .
 .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
-this package on git" feature someday maybe if somebody wants to write it ever\.
+Specify the place where your code lives\. This is helpful for people who
+want to contribute\.  If the git repo is on github, then the \fBnpm docs\fR
+command will be able to find you\.
 .
 .P
 Do it like this:
@@ -337,34 +328,6 @@ The URL should be a publicly available (perhaps read\-only) url that can be hand
 directly to a VCS program without any modification\.  It should not be a url to an
 html project page that you put in your browser\.  It\'s for computers\.
 .
-.P
-Here are some examples of Doing It Wrong:
-.
-.IP "" 4
-.
-.nf
-WRONG!
-"repository" :
-  { "type" : "git"
-  , "url" : "git@github\.com:isaacs/npm\.git" <\-\- THIS IS PRIVATE!
-  }
-ALSO WRONG!
-"repository" :
-  { "type" : "git"
-  , "url" : "http://github\.com/isaacs/npm" <\-\- THIS IS WEBPAGE!
-  }
-This is ok, but completely unnecessary:
-"repository" :
-  { "type" : "git"
-  , "url" : "http://github\.com/isaacs/npm\.git"
-  , "private" : "git@github\.com:isaacs/npm\.git"
-  , "web" : "http://github\.com/isaacs/npm"
-  }
-.
-.fi
-.
-.IP "" 0
-.
 .SH "scripts"
 The "scripts" member is an object hash of script commands that are run
 at various times in the lifecycle of your package\.  The key is the lifecycle
@@ -532,8 +495,8 @@ Starting with npm version 0\.2\.14, you may specify a tarball URL in place
 of a version range\.
 .
 .P
-This tarball will be downloaded and installed as a bundle at install
-time\.  See \fBnpm help bundle\fR
+This tarball will be downloaded and installed locally to your package at
+install time\.
 .
 .SH "devDependencies"
 If someone is planning on downloading and using your module in their
@@ -590,3 +553,15 @@ specify "*" as the version), then any version of node will do\.
 If you specify an "engines" field, then npm will require that "node" be
 somewhere on that list\. If "engines" is omitted, then npm will just assume
 that it works on node\.
+.
+.SH "tag"
+By default, when a package is published, it gets tagged with the value
+of the \fBtag\fR config, or \fB"latest"\fR if nothing is specified\.  By setting
+a "tag" member in the package\.json, the package will get tagged
+differently\.  This enabled limited releases with a "beta" or "rc" tag,
+so that users can do \fBnpm install foo@beta\fR to get the package version
+tagged "beta"\.
+.
+.P
+To update it to latest, either remove the "tag" member and re\-publish,
+or do \fBnpm tag foo@1\.2\.3 latest\fR\|\.