Permalink
Browse files

make doc

  • Loading branch information...
isaacs committed Mar 4, 2011
1 parent 9a1b71e commit 0ce985389ee214961c5bbbb3d82d51a1349681d3
View
@@ -1,7 +1,7 @@
.\" Generated with Ronnjs/v0.1
.\" http://github.com/kapouer/ronnjs/
.
-.TH "ACTIVATE" "1" "January 2011" "" ""
+.TH "ACTIVATE" "1" "March 2011" "" ""
.
.SH "NAME"
\fBactivate\fR \-\- Activate an installed version of a package
View
@@ -0,0 +1,58 @@
+.\" Generated with Ronnjs/v0.1
+.\" http://github.com/kapouer/ronnjs/
+.
+.TH "NPM\-ADDUSER" "1" "March 2011" "" ""
+.
+.SH "NAME"
+\fBnpm-adduser\fR \-\- Add a registry user account
+.
+.SH "SYNOPSIS"
+.
+.nf
+npm adduser
+.
+.fi
+.
+.SH "DESCRIPTION"
+Create or verify a user named \fB<username>\fR in the npm registry, and
+save the credentials to the \fB\|\.npmrc\fR file\.
+.
+.P
+The username, password, and email are read in from prompts\. This command
+cannot be scripted\. If you think you need to script the creation of new
+users, or the authorization of existing ones, without human intervention,
+please rethink your use case\. That\'s a very bad idea\.
+.
+.P
+You may use this command to change your email address, but not username
+or password\.
+.
+.P
+You may use this command multiple times with the same user account to
+authorize on a new machine\.
+.
+.SH "CONFIGURATION"
+.
+.SS "_auth"
+A base\-64 encoded "user:pass" pair\. This is created by npm\-adduser(1)\.
+.
+.P
+If your config file is ever corrupted, you can set this manually by doing:
+.
+.IP "" 4
+.
+.nf
+npm adduser
+.
+.fi
+.
+.IP "" 0
+.
+.SS "registry"
+Default: https://registry\.npmjs\.org/
+.
+.P
+The base URL of the npm package registry\.
+.
+.SS "username, _password"
+Once the configuration is parsed, the \fB_auth\fR config is split into \fBusername\fR and \fB_password\fR\|\. This is the part before the ":"
View
@@ -1,7 +1,7 @@
.\" Generated with Ronnjs/v0.1
.\" http://github.com/kapouer/ronnjs/
.
-.TH "NPM\-BUILD" "1" "January 2011" "" ""
+.TH "NPM\-BUILD" "1" "March 2011" "" ""
.
.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" "January 2011" "" ""
+.TH "NPM\-BUNDLE" "1" "March 2011" "" ""
.
.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" "January 2011" "" ""
+.TH "NPM\-CACHE" "1" "March 2011" "" ""
.
.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\-CHANGELOG" "1" "February 2011" "" ""
+.TH "NPM\-CHANGELOG" "1" "March 2011" "" ""
.
.SH "NAME"
\fBnpm-changelog\fR \-\- Changes
View
@@ -1,7 +1,7 @@
.\" Generated with Ronnjs/v0.1
.\" http://github.com/kapouer/ronnjs/
.
-.TH "NPM\-CODING\-STYLE" "1" "January 2011" "" ""
+.TH "NPM\-CODING\-STYLE" "1" "March 2011" "" ""
.
.SH "NAME"
\fBnpm-coding-style\fR \-\- npm\'s "funny" coding style
@@ -240,3 +240,16 @@ and are rarely used\.
Use a single uppercase letter for function names where the function
would normally be anonymous, but needs to call itself recursively\. It
makes it clear that it\'s a "throwaway" function\.
+.
+.SH "null, undefined, false, 0"
+Boolean variables and functions should always be either \fBtrue\fR or \fBfalse\fR\|\. Don\'t set it to 0 unless it\'s supposed to be a number\.
+.
+.P
+When something is intentionally missing or removed, set it to \fBnull\fR\|\.
+.
+.P
+Don\'t set things to \fBundefined\fR\|\. Reserve that value to mean "not yet
+set to anything\."
+.
+.P
+Boolean objects are verboten\.
View
@@ -1,7 +1,7 @@
.\" Generated with Ronnjs/v0.1
.\" http://github.com/kapouer/ronnjs/
.
-.TH "NPM\-COMPLETION" "1" "December 2010" "" ""
+.TH "NPM\-COMPLETION" "1" "March 2011" "" ""
.
.SH "NAME"
\fBnpm-completion\fR \-\- Tab Completion for npm
View
@@ -1,7 +1,7 @@
.\" Generated with Ronnjs/v0.1
.\" http://github.com/kapouer/ronnjs/
.
-.TH "NPM\-CONFIG" "1" "February 2011" "" ""
+.TH "NPM\-CONFIG" "1" "March 2011" "" ""
.
.SH "NAME"
\fBnpm-config\fR \-\- Manage the npm configuration file
View
@@ -1,7 +1,7 @@
.\" Generated with Ronnjs/v0.1
.\" http://github.com/kapouer/ronnjs/
.
-.TH "NPM\-DEACTIVATE" "1" "January 2011" "" ""
+.TH "NPM\-DEACTIVATE" "1" "March 2011" "" ""
.
.SH "NAME"
\fBnpm-deactivate\fR \-\- Deactivate the active version of a package
View
@@ -1,7 +1,7 @@
.\" Generated with Ronnjs/v0.1
.\" http://github.com/kapouer/ronnjs/
.
-.TH "NPM\-DEPRECATE" "1" "January 2011" "" ""
+.TH "NPM\-DEPRECATE" "1" "March 2011" "" ""
.
.SH "NAME"
\fBnpm-deprecate\fR \-\- Deprecate a version of a package
View
@@ -1,7 +1,7 @@
.\" Generated with Ronnjs/v0.1
.\" http://github.com/kapouer/ronnjs/
.
-.TH "NPM\-DEVELOPERS" "1" "January 2011" "" ""
+.TH "NPM\-DEVELOPERS" "1" "March 2011" "" ""
.
.SH "NAME"
\fBnpm-developers\fR \-\- Developer Guide
@@ -263,6 +263,12 @@ npm publish
You can give publish a url to a tarball, or a filename of a tarball,
or a path to a folder\.
.
+.P
+Note that pretty much \fBeverything in that folder will be exposed\fR
+by default\. So, if you have secret stuff in there, use a \fB\|\.npminclude\fR
+or \fB\|\.npmignore\fR file to list out the globs to include/ignore, or publish
+from a fresh checkout\.
+.
.SH "Brag about it"
Send emails, write blogs, blab in IRC\.
.
View
@@ -1,7 +1,7 @@
.\" Generated with Ronnjs/v0.1
.\" http://github.com/kapouer/ronnjs/
.
-.TH "NPM\-DOCS" "1" "December 2010" "" ""
+.TH "NPM\-DOCS" "1" "March 2011" "" ""
.
.SH "NAME"
\fBnpm-docs\fR \-\- Docs for a package in a web browser maybe
View
@@ -1,7 +1,7 @@
.\" Generated with Ronnjs/v0.1
.\" http://github.com/kapouer/ronnjs/
.
-.TH "NPM\-EDIT" "1" "January 2011" "" ""
+.TH "NPM\-EDIT" "1" "March 2011" "" ""
.
.SH "NAME"
\fBnpm-edit\fR \-\- Edit an installed package
View
@@ -1,7 +1,7 @@
.\" Generated with Ronnjs/v0.1
.\" http://github.com/kapouer/ronnjs/
.
-.TH "NPM\-EXPLORE" "1" "January 2011" "" ""
+.TH "NPM\-EXPLORE" "1" "March 2011" "" ""
.
.SH "NAME"
\fBnpm-explore\fR \-\- Browse an installed package
View
@@ -1,7 +1,7 @@
.\" Generated with Ronnjs/v0.1
.\" http://github.com/kapouer/ronnjs/
.
-.TH "NPM\-FAQ" "1" "February 2011" "" ""
+.TH "NPM\-FAQ" "1" "March 2011" "" ""
.
.SH "NAME"
\fBnpm-faq\fR \-\- Frequently Asked Questions
View
@@ -1,7 +1,7 @@
.\" Generated with Ronnjs/v0.1
.\" http://github.com/kapouer/ronnjs/
.
-.TH "NPM\-LIST" "1" "January 2011" "" ""
+.TH "NPM\-LIST" "1" "March 2011" "" ""
.
.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\-FOLDERS" "1" "January 2011" "" ""
+.TH "NPM\-FOLDERS" "1" "March 2011" "" ""
.
.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" "November 2010" "" ""
+.TH "NPM\-DEPLOY" "1" "March 2011" "" ""
.
.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\-FOLDERS" "1" "January 2011" "" ""
+.TH "NPM\-FOLDERS" "1" "March 2011" "" ""
.
.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\-REMOTE" "1" "November 2010" "" ""
+.TH "NPM\-REMOTE" "1" "March 2011" "" ""
.
.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" "November 2010" "" ""
+.TH "NPM\-SITE" "1" "March 2011" "" ""
.
.SH "NAME"
\fBnpm-site\fR \-\- Run the npm web site
View
@@ -1,7 +1,7 @@
.\" Generated with Ronnjs/v0.1
.\" http://github.com/kapouer/ronnjs/
.
-.TH "NPM\-CONFIG" "1" "February 2011" "" ""
+.TH "NPM\-CONFIG" "1" "March 2011" "" ""
.
.SH "NAME"
\fBnpm-config\fR \-\- Manage the npm configuration file
View
@@ -1,7 +1,7 @@
.\" Generated with Ronnjs/v0.1
.\" http://github.com/kapouer/ronnjs/
.
-.TH "INIT" "1" "January 2011" "" ""
+.TH "INIT" "1" "March 2011" "" ""
.
.SH "NAME"
\fBinit\fR \-\- Interactively create a package\.json file
View
@@ -1,7 +1,7 @@
.\" Generated with Ronnjs/v0.1
.\" http://github.com/kapouer/ronnjs/
.
-.TH "NPM\-INSTALL" "1" "January 2011" "" ""
+.TH "NPM\-INSTALL" "1" "March 2011" "" ""
.
.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\-LINK" "1" "January 2011" "" ""
+.TH "NPM\-LINK" "1" "March 2011" "" ""
.
.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" "January 2011" "" ""
+.TH "NPM\-LIST" "1" "March 2011" "" ""
.
.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" "January 2011" "" ""
+.TH "NPM\-LINK" "1" "March 2011" "" ""
.
.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" "January 2011" "" ""
+.TH "NPM\-LIST" "1" "March 2011" "" ""
.
.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" "January 2011" "" ""
+.TH "NPM" "1" "March 2011" "" ""
.
.SH "NAME"
\fBnpm\fR \-\- node package manager
@@ -111,7 +111,7 @@ lib/utils/default\-config\.js\. These should not be changed\.
.IP "" 0
.
.P
-See \fBnpm help config\fR for more information\.
+See \fBnpm help config\fR for much much more information\.
.
.SH "CONTRIBUTIONS"
Patches welcome!
Oops, something went wrong.

0 comments on commit 0ce9853

Please sign in to comment.