Permalink
Browse files

Add built documentation to project, so that the install doesn't requi…

…re ronn
  • Loading branch information...
isaacs committed May 3, 2010
1 parent a3dec1a commit b70b2a09fa76f1cc3e3f9da7dd4f48ac073d6d0a
Showing with 1,348 additions and 1 deletion.
  1. +0 −1 .gitignore
  2. +20 −0 man/activate.1
  3. +37 −0 man/adduser.1
  4. +43 −0 man/build.1
  5. +107 −0 man/config.1
  6. +21 −0 man/deactivate.1
  7. +40 −0 man/folders.1
  8. +24 −0 man/help.1
  9. +148 −0 man/install.1
  10. +240 −0 man/json.1
  11. +20 −0 man/link.1
  12. +26 −0 man/list.1
  13. +20 −0 man/ln.1
  14. +26 −0 man/ls.1
  15. +305 −0 man/npm.1
  16. +21 −0 man/publish.1
  17. +55 −0 man/registry.1
  18. +20 −0 man/rm.1
  19. +131 −0 man/scripts.1
  20. +24 −0 man/tag.1
  21. +20 −0 man/uninstall.1
View
@@ -1 +0,0 @@
-man
View
@@ -0,0 +1,20 @@
+.\" generated with Ronn/v0.4.1
+.\" http://github.com/rtomayko/ronn/
+.
+.TH "ACTIVATE" "1" "April 2010" "" ""
+.
+.SH "NAME"
+\fBactivate\fR \-\- Activate an installed version of a package
+.
+.SH "SYNOPSIS"
+.
+.nf
+npm activate <name> <version>
+.
+.fi
+.
+.SH "DESCRIPTION"
+This "activates" a specific version of a package, so that you can just do\fBrequire("foo")\fR without having to specify the version.
+.
+.P
+See: deactivate
View
@@ -0,0 +1,37 @@
+.\" generated with Ronn/v0.4.1
+.\" http://github.com/rtomayko/ronn/
+.
+.TH "ADDUSER" "1" "April 2010" "" ""
+.
+.SH "NAME"
+\fBadduser\fR \-\- Add a registry user account
+.
+.SH "SYNOPSIS"
+.
+.nf
+npm adduser bob password bob@email.com
+.
+.fi
+.
+.SH "DESCRIPTION"
+Create a user named "bob" in the npm registry, and save the credentials to the\fB.npmrc\fR file. Note that this leaves the password in your \fB.bash_history\fR, and
+it is currently stored in the clear in the config file. So, don't use a
+password you care too much about.
+.
+.P
+For now, if you somehow break your \fB.npmrc\fR file, and have forgotten your
+password, you're boned. \fIEmail isaacs\fR and he'll delete the
+record from the registry so that you can re\-add it.
+.
+.P
+If you break your \fB.npmrc\fR file, but you remember your password, you can put your
+user auth back by using the \fBbase64\fR program like so:
+.
+.IP "" 4
+.
+.nf
+npm config set auth $( echo user:pass | base64 )
+.
+.fi
+.
+.IP "" 0
View
@@ -0,0 +1,43 @@
+.\" generated with Ronn/v0.4.1
+.\" http://github.com/rtomayko/ronn/
+.
+.TH "NPM\-BUILD" "1" "May 2010" "" ""
+.
+.SH "NAME"
+\fBnpm\-build\fR \-\- Build a package
+.
+.SH "SYNOPSIS"
+.
+.nf
+npm build <package\-folder>
+.
+.fi
+.
+.TP
+\fIpackage\-folder\fR
+A folder containing a \fBpackage.json\fR file in its root.
+.
+.SH "DESCRIPTION"
+This command should almost never need to be run directly. It is an abstraction
+of the functionality shared by both npm\-install(1) and npm\-link(1).
+.
+.P
+This command creates the various interwoven links that ensure a package's contents
+are available in the root appropriately, and that its dependencies are linked
+appropriately.
+.
+.SH "SEE ALSO"
+.
+.IP "\(bu" 4
+npm\-install(1)
+.
+.IP "\(bu" 4
+npm\-link(1)
+.
+.IP "\(bu" 4
+npm\-scripts(1)
+.
+.IP "\(bu" 4
+npm\-json(1)
+.
+.IP "" 0
View
@@ -0,0 +1,107 @@
+.\" generated with Ronn/v0.4.1
+.\" http://github.com/rtomayko/ronn/
+.
+.TH "NPM\-CONFIG" "1" "April 2010" "" ""
+.
+.SH "NAME"
+\fBnpm\-config\fR \-\- Manage the npm configuration file
+.
+.SH "SYNOPSIS"
+.
+.nf
+npm config set <key> <value>
+npm config get <key>
+npm config delete <key>
+npm config list
+.
+.fi
+.
+.SH "DESCRIPTION"
+The config command is a way to interact with the \fB.npmrc\fR file. This file is a
+JSON encoded list of values that npm is concerned with. The first time you run
+npm, it will create a conf file filled with default values.
+.
+.P
+On exit, the current state of the config is always saved, so that any changes
+will be recorded. You may safely modify the file (as long as it's still
+parseable JSON), but it is safer to use the npm config commands.
+.
+.SH "Sub\-commands"
+Config supports the following sub\-commands:
+.
+.SS "set"
+.
+.nf
+npm config set key value
+.
+.fi
+.
+.P
+Sets the config key to the value.
+.
+.SS "get"
+.
+.nf
+npm config get key
+.
+.fi
+.
+.P
+Echo the config value to stdout. (NOTE: All the other npm logging is done to
+stderr, so pipes should work properly, and you can do \fBnpm get key 2>/dev/null\fR
+to print out JUST the config value.)
+.
+.SS "list"
+.
+.nf
+npm config list
+.
+.fi
+.
+.P
+Show all the config settings.
+.
+.P
+\fBFIXME\fR: Prints to stderr, but should really be stdout, since the log is what
+you're after.
+.
+.SS "delete"
+.
+.nf
+npm config delete key
+.
+.fi
+.
+.P
+Deletes the key from the configuration file.
+.
+.SH "Config File Settings"
+.
+.SS "auto\-activate"
+Default: true
+.
+.P
+Automatically activate a package after installation, if there is not an active
+version already. Set to "always" to always activate when installing.
+.
+.SS "root"
+Default: ~/.node_libraries
+.
+.P
+The root folder where packages are installed and npm keeps its data.
+.
+.SS "registry"
+Default: http://registry.npmjs.org/
+.
+.P
+The base URL of the npm package registry.
+.
+.SS "auth"
+A base\-64 encoded "user:pass" pair.
+.
+.P
+\fBFIXME\fR: This is not encoded in any kind of security sense. It's just base\-64
+encoded strictly so that it can be sent along the wire with HTTP Basic
+authentication. An upcoming version of npm will encrypt this and save it back
+to the registry as \fBauth\-crypt\fR, which will be quite a bit more secure. Until
+then, use a unique password that you don't mind being compromised.
View
@@ -0,0 +1,21 @@
+.\" generated with Ronn/v0.4.1
+.\" http://github.com/rtomayko/ronn/
+.
+.TH "NPM\-DEACTIVATE" "1" "April 2010" "" ""
+.
+.SH "NAME"
+\fBnpm\-deactivate\fR \-\- Deactivate the active version of a package
+.
+.SH "SYNOPSIS"
+.
+.nf
+npm deactivate <name>
+.
+.fi
+.
+.SH "DESCRIPTION"
+If there's an active version of the package, this will unlink it from that
+preferential position.
+.
+.P
+See: activate
View
@@ -0,0 +1,40 @@
+.\" generated with Ronn/v0.4.1
+.\" http://github.com/rtomayko/ronn/
+.
+.TH "NPM\-FOLDERS" "1" "April 2010" "" ""
+.
+.SH "NAME"
+\fBnpm\-folders\fR \-\- Folder Structures Used by npm
+.
+.SH "DESCRIPTION"
+Everything lives in the \fBroot\fR setting. This defaults to \fB$HOME/.node_libraries/\fR. I'd like to be able to override it, but that's not
+possible yet.
+.
+.P
+\fBroot/.npm/foo\fR is where the stuff for package \fBfoo\fR would go.
+.
+.P
+\fBroot/.npm/foo/1.0.0/package\fR the contents of the tarball containing foo
+version 1.0.0
+.
+.P
+\fBroot/.npm/foo/1.0.0/main.js\fR Generated file that exports the \fBmain\fR module in
+foo.
+.
+.P
+\fBroot/.npm/foo/1.0.0/lib\fR symlink to the \fBlib\fR dir in foo.
+.
+.P
+\fBroot/.npm/foo/active\fR symlink to the active version.
+.
+.P
+\fBroot/foo\-1.0.0.js\fR symlink to \fB.npm/foo/1.0.0/main.js\fR
+.
+.P
+\fBroot/foo.js\fR symlink to \fB.npm/foo/active/main.js\fR
+.
+.P
+\fBroot/foo\fR symlink to \fB.npm/foo/active/lib\fR
+.
+.P
+\fBroot/foo\-1.0.0\fR symlink to \fB.npm/foo/1.0.0/lib\fR
View
@@ -0,0 +1,24 @@
+.\" generated with Ronn/v0.4.1
+.\" http://github.com/rtomayko/ronn/
+.
+.TH "NPM\-HELP" "1" "May 2010" "" ""
+.
+.SH "NAME"
+\fBnpm\-help\fR \-\- Get help about npm commands
+.
+.SH "SYNOPSIS"
+.
+.nf
+npm help <section>
+.
+.fi
+.
+.P
+Where \fIsection\fR is one of:
+.
+.br
+\fBnpm\fR, \fBactivate\fR, \fBadduser\fR, \fBconfig\fR, \fBdeactivate\fR, \fBfolders\fR, \fBhelp\fR (this
+page), \fBinstall\fR, \fBjson\fR, \fBlink\fR (or \fBln\fR), \fBlist\fR (or \fBls\fR), \fBpublish\fR, \fBregistry\fR, \fBtag\fR, \fBuninstall\fR (or \fBrm\fR), \fBbuild\fR, \fBnpm\fR, \fBscripts\fR, \fBjson\fR
+.
+.SH "Todo"
+It'd be nice if this page was automatically generated.
Oops, something went wrong.

0 comments on commit b70b2a0

Please sign in to comment.