Skip to content
This repository has been archived by the owner on Aug 11, 2022. It is now read-only.

Commit

Permalink
make doc
Browse files Browse the repository at this point in the history
  • Loading branch information
isaacs committed Feb 15, 2011
1 parent 038dbb3 commit 2bb9ceb
Show file tree
Hide file tree
Showing 8 changed files with 120 additions and 86 deletions.
63 changes: 0 additions & 63 deletions man1/adduser.1
@@ -1,63 +0,0 @@
.\" Generated with Ronnjs/v0.1
.\" http://github.com/kapouer/ronnjs/
.
.TH "NPM\-ADDUSER" "1" "January 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 "_authCrypt"
If crypto\.Cipher is available, and you have some private keys in \fB$HOME/\.ssh\fR,
then npm will encrypt your "\fIauth" config before saving to the \.npmrc file,
and will decrypt the "\fRauthCrypt" config when it reads the \.npmrc file\.
.
.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 ":"
6 changes: 6 additions & 0 deletions man1/changelog.1
Expand Up @@ -517,5 +517,11 @@ Read package defaults when reading json
0\.3\.0:
More correct permission/uid handling\. (Sudo is now ok!)
.
.br
Require node 0\.4\.0
.
.br
Separate semver out into a separate utility\.
.
.IP "" 0

7 changes: 1 addition & 6 deletions man1/config.1
@@ -1,7 +1,7 @@
.\" Generated with Ronnjs/v0.1
.\" http://github.com/kapouer/ronnjs/
.
.TH "NPM\-CONFIG" "1" "January 2011" "" ""
.TH "NPM\-CONFIG" "1" "February 2011" "" ""
.
.SH "NAME"
\fBnpm-config\fR \-\- Manage the npm configuration file
Expand Down Expand Up @@ -274,11 +274,6 @@ npm adduser
.
.IP "" 0
.
.SS "_authCrypt"
If crypto\.Cipher is available, and you have some private keys in \fB$HOME/\.ssh\fR,
then npm will encrypt your "\fIauth" config before saving to the \.npmrc file,
and will decrypt the "\fRauthCrypt" config when it reads the \.npmrc file\.
.
.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 ":"
.
Expand Down
7 changes: 1 addition & 6 deletions man1/get.1
@@ -1,7 +1,7 @@
.\" Generated with Ronnjs/v0.1
.\" http://github.com/kapouer/ronnjs/
.
.TH "NPM\-CONFIG" "1" "January 2011" "" ""
.TH "NPM\-CONFIG" "1" "February 2011" "" ""
.
.SH "NAME"
\fBnpm-config\fR \-\- Manage the npm configuration file
Expand Down Expand Up @@ -274,11 +274,6 @@ npm adduser
.
.IP "" 0
.
.SS "_authCrypt"
If crypto\.Cipher is available, and you have some private keys in \fB$HOME/\.ssh\fR,
then npm will encrypt your "\fIauth" config before saving to the \.npmrc file,
and will decrypt the "\fRauthCrypt" config when it reads the \.npmrc file\.
.
.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 ":"
.
Expand Down
9 changes: 6 additions & 3 deletions man1/json.1
Expand Up @@ -49,9 +49,12 @@ already, before you get too attached to it\. http://registry\.npmjs\.org/
The \fImost\fR important things in your package\.json are the name and version fields\.
.
.P
Version must be semver \fIhttp://semver\.org\fR\-compliant\. npm assumes that you\'ve
read the semver page, and that you comply with it\. Here\'s how it deviates from
what\'s on semver\.org:
Version must be semver \fIhttps://github\.com/isaacs/semver\fR\-compliant\.
npm assumes that you\'ve
read the semver page, and that you comply with it\.
.
.P
Here\'s how it deviates from what\'s on semver\.org:
.
.IP "\(bu" 4
Versions can start with "v"
Expand Down
51 changes: 50 additions & 1 deletion man1/owner.1
@@ -1,7 +1,7 @@
.\" Generated with Ronnjs/v0.1
.\" http://github.com/kapouer/ronnjs/
.
.TH "NPM\-OWNER" "1" "January 2011" "" ""
.TH "NPM\-OWNER" "1" "February 2011" "" ""
.
.SH "NAME"
\fBnpm-owner\fR \-\- Manage package owners
Expand Down Expand Up @@ -38,3 +38,52 @@ privileges\.
Note that there is only one level of access\. Either you can modify a package,
or you can\'t\. Future versions may contain more fine\-grained access levels, but
that is not implemented at this time\.
.
.SH "CONFIGURATION"
.
.SS "outfd"
Default: Standard Output FD (1)
.
.P
The file descriptor (integer) or stream object where npm will write
"normal" output\. For instance, the \fBls\fR and \fBview\fR commands write their
output here\.
.
.P
When using npm programmatically, you may want to provide a
FileWriteStream, or some other form of WritableStream\.
.
.SS "registry"
Default: https://registry\.npmjs\.org/
.
.P
The base URL of the npm package registry\.
.
.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 "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 ":"
.
.SH "SEE ALSO"
.
.IP "\(bu" 4
npm\-publish(1)
.
.IP "\(bu" 4
npm\-registry(1)
.
.IP "" 0

56 changes: 55 additions & 1 deletion man1/registry.1
@@ -1,7 +1,7 @@
.\" Generated with Ronnjs/v0.1
.\" http://github.com/kapouer/ronnjs/
.
.TH "NPM\-REGISTRY" "1" "January 2011" "" ""
.TH "NPM\-REGISTRY" "1" "February 2011" "" ""
.
.SH "NAME"
\fBnpm-registry\fR \-\- The JavaScript Package Registry
Expand Down Expand Up @@ -86,3 +86,57 @@ No, but such a thing is planned, and a tiny bit developed\.
.
.P
Stay tuned!
.
.SH "CONFIGURATION"
.
.SS "registry"
Default: https://registry\.npmjs\.org/
.
.P
The base URL of the npm package registry\.
.
.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 "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 ":"
.
.SS "proxy"
If proxy is available, then npm will access the registry via
the proxy server\.
.
.P
Example:
.
.IP "" 4
.
.nf
proxy = http://user:password@proxy\-server:8080
.
.fi
.
.IP "" 0
.
.SS "tar"
Default: env\.TAR or "tar"
.
.P
The name of a GNU\-compatible tar program on your system\.
.
.SS "gzip"
Default: env\.GZIPBIN or "gzip"
.
.P
The name of a GNU\-compatible gzip program on your system\.
7 changes: 1 addition & 6 deletions man1/set.1
@@ -1,7 +1,7 @@
.\" Generated with Ronnjs/v0.1
.\" http://github.com/kapouer/ronnjs/
.
.TH "NPM\-CONFIG" "1" "January 2011" "" ""
.TH "NPM\-CONFIG" "1" "February 2011" "" ""
.
.SH "NAME"
\fBnpm-config\fR \-\- Manage the npm configuration file
Expand Down Expand Up @@ -274,11 +274,6 @@ npm adduser
.
.IP "" 0
.
.SS "_authCrypt"
If crypto\.Cipher is available, and you have some private keys in \fB$HOME/\.ssh\fR,
then npm will encrypt your "\fIauth" config before saving to the \.npmrc file,
and will decrypt the "\fRauthCrypt" config when it reads the \.npmrc file\.
.
.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 ":"
.
Expand Down

0 comments on commit 2bb9ceb

Please sign in to comment.