Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/npm/cli.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorisaacs <i@izs.me>2010-08-18 21:58:59 +0400
committerisaacs <i@izs.me>2010-08-18 21:58:59 +0400
commitf2ccd1783065d471c891c83082eab9c76361c4c3 (patch)
tree837221b349cfe68a41aaf61dcde15d197b2f9657 /man/future-ideas
parent9e87e148e145ac46797ad41d02f9d41c9f1dfea1 (diff)
Use ronnjs instead of the ronn rubygem to build docs
Diffstat (limited to 'man/future-ideas')
-rw-r--r--man/future-ideas/deploy.116
-rw-r--r--man/future-ideas/remote.113
-rw-r--r--man/future-ideas/site.166
3 files changed, 56 insertions, 39 deletions
diff --git a/man/future-ideas/deploy.1 b/man/future-ideas/deploy.1
index 39f79e0cf..6c0f36631 100644
--- a/man/future-ideas/deploy.1
+++ b/man/future-ideas/deploy.1
@@ -1,10 +1,10 @@
-.\" 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\-DEPLOY" "1" "July 2010" "" ""
+.TH "NPM\-DEPLOY" "1" "August 2010" "" ""
.
.SH "NAME"
-\fBnpm\-deploy\fR \- Deploy a package to a remote host
+\fBnpm-deploy\fR \-\- Deploy a package to a remote host
.
.SH "FUTURE"
This functionality does not yet exist\.
@@ -12,18 +12,16 @@ This functionality does not yet exist\.
.SH "SUMMARY"
.
.nf
-
npm deploy <pkg> [\-\-host <hostname>]
.
.fi
.
.SH "DESCRIPTION"
-This is a porcelain command\. It is equivalent to doing:
+This is a porcelain command\. It is equivalent to doing:
.
.IP "" 4
.
.nf
-
npm publish \-\-registry $(npm config get host) <pkg>
npm remote install <pkg\-name>@<pkg\-version>
.
@@ -32,7 +30,9 @@ npm remote install <pkg\-name>@<pkg\-version>
.IP "" 0
.
.P
-That is, it first publishes the package to the server specified by the \fBhost\fR config, and then remotely installs that package on the host\.
+That is, it first publishes the package to the server specified
+by the \fBhost\fR config, and then remotely installs that package
+on the host\.
.
.SH "SEE ALSO"
.
diff --git a/man/future-ideas/remote.1 b/man/future-ideas/remote.1
index 52916ea51..9c1c50f98 100644
--- a/man/future-ideas/remote.1
+++ b/man/future-ideas/remote.1
@@ -1,10 +1,10 @@
-.\" 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\-REMOTE" "1" "July 2010" "" ""
+.TH "NPM\-REMOTE" "1" "August 2010" "" ""
.
.SH "NAME"
-\fBnpm\-remote\fR \- Execute commands on a remote machine
+\fBnpm-remote\fR \-\- Execute commands on a remote machine
.
.SH "FUTURE"
This functionality does not yet exist\.
@@ -12,7 +12,6 @@ This functionality does not yet exist\.
.SH "SYNOPSIS"
.
.nf
-
npm remote <commands>
.
.fi
@@ -21,7 +20,9 @@ npm remote <commands>
Run a command on a remote npm site instance\.
.
.P
-In order to do this, the current authenticated user must be in the "admin" list on the server, and it must be running with https support\.
+In order to do this, the current authenticated user must be in
+the "admin" list on the server, and it must be running with https
+support\.
.
.P
It uses the \fBhost\fR config to know where to do things\.
diff --git a/man/future-ideas/site.1 b/man/future-ideas/site.1
index 537f1b0ab..18052c7db 100644
--- a/man/future-ideas/site.1
+++ b/man/future-ideas/site.1
@@ -1,10 +1,10 @@
-.\" 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\-SITE" "1" "July 2010" "" ""
+.TH "NPM\-SITE" "1" "August 2010" "" ""
.
.SH "NAME"
-\fBnpm\-site\fR \- Run the npm web site
+\fBnpm-site\fR \-\- Run the npm web site
.
.SH "FUTURE"
This functionality does not yet exist\.
@@ -12,44 +12,60 @@ This functionality does not yet exist\.
.SH "SYNOPSIS"
.
.nf
-
npm site [ start | stop ]
.
.fi
.
.SH "DESCRIPTION"
-This starts up npm in "site" mode\. The following configs are relevant, and can either be specified in the \fB\.npmrc\fR file, or as command line options\.
-.
-.TP
-userfile
-A file containing the encrypted authorization info for all users\. If specified, then this is used for \fBnpm adduser\fR requests to this registry\.
+This starts up npm in "site" mode\. The following configs are relevant,
+and can either be specified in the \fB\|\.npmrc\fR file, or as command line
+options\.
.
-.br
-
+.IP "\(bu" 4
+userfile:
+A file containing the encrypted authorization info for all users\. If
+specified, then this is used for \fBnpm adduser\fR requests
+to this registry\.
.
-.TP
-admin
-A comma\-delimited list of admin users\. All of these must already be in the local adduser config\. If there is no admin, then the site will not allow remote management\. All admin usernames must already be in the userfile, and a userfile must be specified\.
+.IP "\(bu" 4
+admin:
+A comma\-delimited list of admin users\. All of these must already be
+in the local adduser config\. If there is no admin, then the site will
+not allow remote management\. All admin usernames must already be
+in the userfile, and a userfile must be specified\.
.
-.TP
-listen
-Ports to listen on for WS requests\. The first number is for http, the second for https, and the third for secure TCP\. Set any to "\-", or omit, to use the default\. Defaults to "80,443,15443"
+.IP "\(bu" 4
+listen:
+Ports to listen on for WS requests\. The first number is for http,
+the second for https, and the third for secure TCP\. Set any to "\-",
+or omit, to use the default\.
+Defaults to "80,443,15443"
.
-.TP
-registry
-If a package is not found, then its contents will be fetched from the upstream registry, and cached for future retrieval\.
+.IP "\(bu" 4
+registry:
+If a package is not found, then its contents will be fetched from the
+upstream registry, and cached for future retrieval\.
.
.IP
-isaacs: Make sure that this does loop\-detection, so that a "ring" of registries can work as a distributed network\. Also, once we have support for checking multiple registries, you could have a distribution ring that secondarily depends on some other upstream resource\.
+isaacs: Make sure that this does loop\-detection, so that a "ring" of
+registries can work as a distributed network\. Also, once we have
+support for checking multiple registries, you could have a distribution
+ring that secondarily depends on some other upstream resource\.
+.
+.IP "" 0
.
.P
-The content for the site is stored in the npm cache directory, which is inside the folder used for the \fBroot\fR setting, at \fB{root}/\.npm/\.cache\fR\. It is organized in a simple hierarchical folder structure corresponding to the web service URLs that npm uses\.
+The content for the site is stored in the npm cache directory, which is
+inside the folder used for the \fBroot\fR setting, at \fB{root}/\.npm/\.cache\fR\|\.
+It is organized in a simple hierarchical folder structure corresponding
+to the web service URLs that npm uses\.
.
.SH "TCP Server"
-The TCP server starts up to support the \fBnpm remote\fR command, if there is a valid admin userlist\.
+The TCP server starts up to support the \fBnpm remote\fR command, if there is
+a valid admin userlist\.
.
.SH "NOTE"
-This also is what happens when you do \fBnpm start npm\fR\.
+This also is what happens when you do \fBnpm start npm\fR\|\.
.
.SH "SEE ALSO"
.