Permalink
Browse files

Use ronnjs instead of the ronn rubygem to build docs

  • Loading branch information...
isaacs committed Aug 18, 2010
1 parent 9e87e14 commit f2ccd1783065d471c891c83082eab9c76361c4c3
Showing with 863 additions and 617 deletions.
  1. +1 −0 Makefile
  2. +1 −21 man/activate.1
  3. +14 −9 man/adduser.1
  4. +13 −9 man/build.1
  5. +36 −26 man/cache.1
  6. +48 −29 man/coding-style.1
  7. +62 −39 man/config.1
  8. +6 −6 man/deactivate.1
  9. +65 −46 man/developers.1
  10. +16 −10 man/folders.1
  11. +8 −8 man/future-ideas/deploy.1
  12. +7 −6 man/future-ideas/remote.1
  13. +41 −25 man/future-ideas/site.1
  14. +89 −41 man/help.1
  15. +45 −48 man/install.1
  16. +83 −40 man/json.1
  17. +8 −6 man/link.1
  18. +14 −10 man/list.1
  19. +8 −6 man/ln.1
  20. +14 −10 man/ls.1
  21. +84 −85 man/npm.1
  22. +21 −15 man/owner.1
  23. +14 −11 man/publish.1
  24. +6 −7 man/restart.1
  25. +25 −8 man/rm.1
  26. +62 −47 man/scripts.1
  27. +4 −5 man/start.1
  28. +4 −5 man/stop.1
  29. +8 −6 man/tag.1
  30. +4 −5 man/test.1
  31. +25 −8 man/uninstall.1
  32. +6 −6 man/unpublish.1
  33. +14 −8 man/update.1
  34. +7 −6 man/view.1
View
@@ -26,6 +26,7 @@ man: $(doc_subfolders)
doc: man $(docs)
@true
+# use `npm install ronn` for this to work.
man/%.1: doc/%.md
ronn --roff $< > $@
View
@@ -1,21 +1 @@
-.\" 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
-.
-.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\.
-.
-.SH "SEE ALSO"
-npm\-deactivate(1)
+Unknown option: --pipe
View
@@ -1,27 +1,32 @@
-.\" generated with Ronn/v0.7.3
-.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.\" Generated with Ronnjs/v0.1
+.\" http://github.com/kapouer/ronnjs/
.
-.TH "NPM\-ADDUSER" "1" "July 2010" "" ""
+.TH "NPM\-ADDUSER" "1" "August 2010" "" ""
.
.SH "NAME"
-\fBnpm\-adduser\fR \- Add a registry user account
+\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\.
+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\.
+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\.
+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\.
+You may use this command multiple times with the same user account to
+authorize on a new machine\.
View
@@ -1,28 +1,32 @@
-.\" generated with Ronn/v0.7.3
-.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.\" Generated with Ronnjs/v0.1
+.\" http://github.com/kapouer/ronnjs/
.
-.TH "NPM\-BUILD" "1" "May 2010" "" ""
+.TH "NPM\-BUILD" "1" "August 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
+.IP "\(bu" 4
+\fB<package\-folder>\fR:
A folder containing a \fBpackage\.json\fR file in its root\.
.
+.IP "" 0
+.
.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"
.
View
@@ -1,60 +1,70 @@
-.\" generated with Ronn/v0.7.3
-.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.\" Generated with Ronnjs/v0.1
+.\" http://github.com/kapouer/ronnjs/
.
-.TH "NPM\-CACHE" "1" "May 2010" "" ""
+.TH "NPM\-CACHE" "1" "August 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
.
.SH "DESCRIPTION"
.
-.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\.
+.IP "\(bu" 4
+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\.
.
.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\.
-.
-.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\.
-.
-.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\.
+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\.
+.
+.IP "\(bu" 4
+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\.
+.
+.IP "\(bu" 4
+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\.
.
.IP
This can be used if invalid data gets into the cache\.
.
+.IP "" 0
+.
.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/
+.IP "\(bu" 4
+package/:
A folder containing the package contents as they appear in the tarball\.
.
-.TP
-package\.json
+.IP "\(bu" 4
+package\.json:
The package\.json file, as npm sees it, with overlays applied and a _id attribute\.
.
-.TP
-package\.tgz
+.IP "\(bu" 4
+package\.tgz:
The tarball for that version\.
.
+.IP "" 0
+.
.SH "HISTORY"
Added in npm version 0\.1\.6
View
@@ -1,22 +1,28 @@
-.\" generated with Ronn/v0.7.3
-.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.\" Generated with Ronnjs/v0.1
+.\" http://github.com/kapouer/ronnjs/
.
-.TH "NPM\-CODING\-STYLE" "1" "July 2010" "" ""
+.TH "NPM\-CODING\-STYLE" "1" "August 2010" "" ""
.
.SH "NAME"
-\fBnpm\-coding\-style\fR \- npm\'s "funny" coding style
+\fBnpm-coding-style\fR \-\- npm\'s "funny" coding style
.
.SH "DESCRIPTION"
-npm\'s coding style is a bit unconventional\. It is not different for difference\'s sake, but rather a carefully crafted style that is designed to reduce visual clutter and make bugs more apparent\.
+npm\'s coding style is a bit unconventional\. It is not different for
+difference\'s sake, but rather a carefully crafted style that is
+designed to reduce visual clutter and make bugs more apparent\.
.
.P
-If you want to contribute to npm (which is very encouraged), you should make your code conform to npm\'s style\.
+If you want to contribute to npm (which is very encouraged), you should
+make your code conform to npm\'s style\.
.
.SH "Line Length"
-Keep lines shorter than 80 characters\. It\'s better for lines to be too short than to be too long\. Break up long lists, objects, and other statements onto multiple lines\.
+Keep lines shorter than 80 characters\. It\'s better for lines to be
+too short than to be too long\. Break up long lists, objects, and other
+statements onto multiple lines\.
.
.SH "Indentation"
-Two\-spaces\. Tabs are better, but they look like hell in web browsers (and on github), and node uses 2 spaces, so that\'s that\.
+Two\-spaces\. Tabs are better, but they look like hell in web browsers
+(and on github), and node uses 2 spaces, so that\'s that\.
.
.P
Configure your editor appropriately\.
@@ -30,7 +36,6 @@ Bad:
.IP "" 4
.
.nf
-
function ()
{
.
@@ -44,23 +49,22 @@ Good:
.IP "" 4
.
.nf
-
function () {
.
.fi
.
.IP "" 0
.
.P
-If a block needs to wrap to the next line, use a curly brace\. Don\'t use it if it doesn\'t\.
+If a block needs to wrap to the next line, use a curly brace\. Don\'t
+use it if it doesn\'t\.
.
.P
Bad:
.
.IP "" 4
.
.nf
-
if (foo) { bar() }
while (foo)
bar()
@@ -75,7 +79,6 @@ Good:
.IP "" 4
.
.nf
-
if (foo) bar()
while (foo) {
bar()
@@ -89,13 +92,15 @@ while (foo) {
Don\'t use them except in three situations:
.
.IP "\(bu" 4
-for (;;) loops\. They\'re actually required\.
+for (;;) loops\. They\'re actually required\.
.
.IP "\(bu" 4
case "foo": doSomething(); break
.
.IP "\(bu" 4
-In front of a leading ( or [ at the start of the line\. This prevents the expression from being interpreted as a function call or property access, respectively\.
+In front of a leading ( or [ at the start of the line\.
+This prevents the expression from being interpreted
+as a function call or property access, respectively\.
.
.IP "" 0
.
@@ -105,7 +110,6 @@ Some examples of good semicolon usage:
.IP "" 4
.
.nf
-
;(x || y)\.doSomething()
;[a, b, c]\.forEach(doSomething)
for (var i = 0; i < 10; i ++) {
@@ -122,15 +126,18 @@ for (var i = 0; i < 10; i ++) {
.IP "" 0
.
.P
-Note that starting lines with \fB\-\fR and \fB+\fR also should be prefixed with a semicolon, but this is much less common\.
+Note that starting lines with \fB\-\fR and \fB+\fR also should be prefixed
+with a semicolon, but this is much less common\.
.
.SH "Comma First"
-If there is a list of things separated by commas, and it wraps across multiple lines, put the comma at the start of the next line, directly below the token that starts the list\. Put the final token in the list on a line by itself\. For example:
+If there is a list of things separated by commas, and it wraps
+across multiple lines, put the comma at the start of the next
+line, directly below the token that starts the list\. Put the
+final token in the list on a line by itself\. For example:
.
.IP "" 4
.
.nf
-
var magicWords = [ "abracadabra"
, "gesundheit"
, "ventrilo"
@@ -148,33 +155,42 @@ var magicWords = [ "abracadabra"
.IP "" 0
.
.SH "Whitespace"
-Put a single space in front of ( for anything other than a function call\. Also use a single space wherever it makes things more readable\.
+Put a single space in front of ( for anything other than a function call\.
+Also use a single space wherever it makes things more readable\.
.
.P
-Don\'t leave trailing whitespace at the end of lines\. Don\'t indent empty lines\. Don\'t use more spaces than are helpful\.
+Don\'t leave trailing whitespace at the end of lines\. Don\'t indent empty
+lines\. Don\'t use more spaces than are helpful\.
.
.SH "Functions"
-Use named functions\. They make stack traces a lot easier to read\.
+Use named functions\. They make stack traces a lot easier to read\.
.
.SH "Callbacks, Sync/async Style"
-Use the asynchronous/non\-blocking versions of things as much as possible\. It might make more sense for npm to use the synchronous fs APIs, but this way, the fs and http and child process stuff all uses the same callback\-passing methodology\.
+Use the asynchronous/non\-blocking versions of things as much as possible\.
+It might make more sense for npm to use the synchronous fs APIs, but this
+way, the fs and http and child process stuff all uses the same callback\-passing
+methodology\.
.
.P
-The callback should always be the last argument in the list\. Its first argument is the Error or null\.
+The callback should always be the last argument in the list\. Its first
+argument is the Error or null\.
.
.P
-Be very careful never to ever ever throw anything\. It\'s worse than useless\. Just send the error message back as the first argument to the callback\.
+Be very careful never to ever ever throw anything\. It\'s worse than useless\.
+Just send the error message back as the first argument to the callback\.
.
.SH "Errors"
-Always create a new Error object with your message\. Don\'t just return a string message to the callback\. Stack traces are handy\.
+Always create a new Error object with your message\. Don\'t just return a
+string message to the callback\. Stack traces are handy\.
.
.P
-Use the \fBrequire("\./utils/log")\.er\fR function\. It takes a callback and an error message, and returns an object that will report the message in the event of a failure\. It\'s quite handy\.
+Use the \fBrequire("\./utils/log")\.er\fR function\. It takes a callback and an
+error message, and returns an object that will report the message in the
+event of a failure\. It\'s quite handy\.
.
.IP "" 4
.
.nf
-
function myThing (args, cb) {
getData(args, function (er, data) {
if (er) return log\.er(cb, "Couldn\'t get data")(er)
@@ -190,4 +206,7 @@ function justHasToWork (cb) {
.IP "" 0
.
.SH "Logging"
-Please clean up logs when they are no longer helpful\. In particular, logging the same object over and over again is not helpful\. Logs should report what\'s happening so that it\'s easier to track down where a fault occurs\.
+Please clean up logs when they are no longer helpful\. In particular,
+logging the same object over and over again is not helpful\. Logs should
+report what\'s happening so that it\'s easier to track down where a fault
+occurs\.
Oops, something went wrong.

0 comments on commit f2ccd17

Please sign in to comment.