Permalink
Browse files

Update all man pages using new version of ronn

  • Loading branch information...
1 parent c4aea02 commit e937a72f38f359a47977d7e9ade1a2e3bf75fa4a @isaacs isaacs committed Jul 4, 2010
Showing with 325 additions and 409 deletions.
  1. +5 −4 man/activate.1
  2. +12 −18 man/adduser.1
  3. +8 −9 man/build.1
  4. +18 −24 man/cache.1
  5. +34 −52 man/coding-style.1
  6. +31 −40 man/config.1
  7. +5 −5 man/deactivate.1
  8. +51 −68 man/developers.1
  9. +14 −17 man/folders.1
  10. +7 −6 man/help.1
  11. +28 −34 man/install.1
  12. +6 −8 man/link.1
  13. +6 −8 man/ln.1
  14. +8 −9 man/publish.1
  15. +9 −15 man/registry.1
  16. +8 −6 man/restart.1
  17. +6 −7 man/rm.1
  18. +33 −43 man/scripts.1
  19. +6 −5 man/start.1
  20. +6 −5 man/stop.1
  21. +7 −9 man/tag.1
  22. +6 −5 man/test.1
  23. +6 −7 man/uninstall.1
  24. +5 −5 man/unpublish.1
View
@@ -1,20 +1,21 @@
-.\" generated with Ronn/v0.4.1
-.\" http://github.com/rtomayko/ronn/
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "ACTIVATE" "1" "May 2010" "" ""
.
.SH "NAME"
-\fBactivate\fR \-\- Activate an installed version of a package
+\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.
+This "activates" a specific version of a package, so that you can just do \fBrequire("foo")\fR without having to specify the version\.
.
.SH "SEE ALSO"
npm\-deactivate(1)
View
@@ -1,46 +1,40 @@
-.\" generated with Ronn/v0.4.1
-.\" http://github.com/rtomayko/ronn/
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
-.TH "NPM\-ADDUSER" "1" "May 2010" "" ""
+.TH "NPM\-ADDUSER" "1" "July 2010" "" ""
.
.SH "NAME"
-\fBnpm\-adduser\fR \-\- Add a registry user account
+\fBnpm\-adduser\fR \- Add a registry user account
.
.SH "SYNOPSIS"
.
.nf
+
npm adduser <username> <password> <email>
.
.fi
.
.SH "DESCRIPTION"
-Create a user named \fB<username>\fR 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.
+Create a user named \fB<username>\fR 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. Send an email to i@izs.me and I'll delete the
-record from the registry so that you can re\-add it.
+For now, if you somehow break your \fB\.npmrc\fR file, and have forgotten your password, you\'re boned\. Send an email to i@izs\.me and I\'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:
+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 )
+
+npm config set auth $( echo \-n user:pass | base64 )
.
.fi
.
.IP "" 0
.
.P
-Install base64 using whichever method you normally use to put programs on
-your computer. (apt\-get, homebrew, macports, yum, or just download the
-code and build it yourself.)
+Install base64 using whichever method you normally use to put programs on your computer\. (apt\-get, homebrew, macports, yum, or just download the code and build it yourself\.)
.
.P
-Or bug me to to remove your account, and then recreate it.
+Or bug me to to remove your account, and then recreate it\.
View
@@ -1,30 +1,28 @@
-.\" generated with Ronn/v0.4.1
-.\" http://github.com/rtomayko/ronn/
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "NPM\-BUILD" "1" "May 2010" "" ""
.
.SH "NAME"
-\fBnpm\-build\fR \-\- Build a package
+\fBnpm\-build\fR \- Build a package
.
.SH "SYNOPSIS"
.
.nf
+
npm build <package\-folder>
.
.fi
.
.TP
\fB<package\-folder>\fR
-A folder containing a \fBpackage.json\fR file in its root.
+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).
+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.
+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"
.
@@ -41,3 +39,4 @@ npm\-scripts(1)
npm\-json(1)
.
.IP "" 0
+
View
@@ -1,19 +1,22 @@
-.\" generated with Ronn/v0.4.1
-.\" http://github.com/rtomayko/ronn/
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "NPM\-CACHE" "1" "May 2010" "" ""
.
.SH "NAME"
-\fBnpm\-cache\fR \-\- install a package
+\fBnpm\-cache\fR \- install a package
.
.SH "SYNOPSIS"
.
.nf
+
npm cache add <tarball file>
npm cache add <folder>
npm cache add <tarball url>
npm cache add <name> <version>
+
npm cache ls [<path>]
+
npm cache clean [<pkg> [<version>]]
.
.fi
@@ -22,45 +25,36 @@ npm cache clean [<pkg> [<version>]]
.
.TP
add
-Access the local cache of package data. This command is primarily
-intended to be used internally by npm, but it can provide a way to
-add data to the local installation cache explicitly.
+Access the local cache of package data\. This command is primarily intended to be used internally by npm, but it can provide a way to add data to the local installation cache explicitly\.
.
.IP
-If two arguments are provided, then npm will fetch the data from the
-registry. This allows npm to use the filesystem as a local proxy to
-the registry.
+If two arguments are provided, then npm will fetch the data from the registry\. This allows npm to use the filesystem as a local proxy to the registry\.
.
.TP
ls
-Show the data in the cache. Additional arguments are joined together
-in a path\-like fashion, but something like \fBnpm cache ls npm/0.1.5\fR is
-acceptable as well.
+Show the data in the cache\. Additional arguments are joined together in a path\-like fashion, but something like \fBnpm cache ls npm/0\.1\.5\fR is acceptable as well\.
.
.TP
clean
-Delete data out of the cache for a specific package and version, all
-versions of a package, or all data for all packages, depending on the
-arguments supplied.
+Delete data out of the cache for a specific package and version, all versions of a package, or all data for all packages, depending on the arguments supplied\.
.
.IP
-This can be used if invalid data gets into the cache.
+This can be used if invalid data gets into the cache\.
.
.SH "DETAILS"
-npm stores data for a version of a package in\fB$ROOT/.npm/.cache/<name>/<version>\fR. Three pieces of data are stored
-in this folder:
+npm stores data for a version of a package in \fB$ROOT/\.npm/\.cache/<name>/<version>\fR\. Three pieces of data are stored in this folder:
.
.TP
package/
-A folder containing the package contents as they appear in the tarball.
+A folder containing the package contents as they appear in the tarball\.
.
.TP
-package.json
-The package.json file, as npm sees it, with overlays applied and a _id attribute.
+package\.json
+The package\.json file, as npm sees it, with overlays applied and a _id attribute\.
.
.TP
-package.tgz
-The tarball for that version.
+package\.tgz
+The tarball for that version\.
.
.SH "HISTORY"
-Added in npm version 0.1.6
+Added in npm version 0\.1\.6
Oops, something went wrong.

0 comments on commit e937a72

Please sign in to comment.