diff options
author | isaacs <i@izs.me> | 2011-11-26 09:21:03 -0800 |
---|---|---|
committer | isaacs <i@izs.me> | 2011-11-27 13:09:04 -0800 |
commit | e85a95dfa3469dd9cc6a3a15c8e686c14b3238a6 (patch) | |
tree | 85a3a6e0f45f4b6540dcb75af2e9383db0f6e4c3 /deps/npm/man/man3/config.3 | |
parent | fc0a4c2781b4b579d247a24393dada7f92663abe (diff) | |
download | node-new-e85a95dfa3469dd9cc6a3a15c8e686c14b3238a6.tar.gz |
Remove npm's .gitignore, add generated docs
Diffstat (limited to 'deps/npm/man/man3/config.3')
-rw-r--r-- | deps/npm/man/man3/config.3 | 69 |
1 files changed, 69 insertions, 0 deletions
diff --git a/deps/npm/man/man3/config.3 b/deps/npm/man/man3/config.3 new file mode 100644 index 0000000000..548f4bb9c6 --- /dev/null +++ b/deps/npm/man/man3/config.3 @@ -0,0 +1,69 @@ +.\" Generated with Ronnjs/v0.1 +.\" http://github.com/kapouer/ronnjs/ +. +.TH "NPM\-CONFIG" "3" "November 2011" "" "" +. +.SH "NAME" +\fBnpm-config\fR \-\- Manage the npm configuration files +. +.SH "SYNOPSIS" +. +.nf +npm\.commands\.config(args, callback) +var val = npm\.config\.get(key) +npm\.config\.set(key, val) +. +.fi +. +.SH "DESCRIPTION" +This function acts much the same way as the command\-line version\. The first +element in the array tells config what to do\. Possible values are: +. +.IP "\(bu" 4 +\fBset\fR +. +.IP +Sets a config parameter\. The second element in \fBargs\fR is interpreted as the +key, and the third element is interpreted as the value\. +. +.IP "\(bu" 4 +\fBget\fR +. +.IP +Gets the value of a config parameter\. The second element in \fBargs\fR is the +key to get the value of\. +. +.IP "\(bu" 4 +\fBdelete\fR (\fBrm\fR or \fBdel\fR) +. +.IP +Deletes a parameter from the config\. The second element in \fBargs\fR is the +key to delete\. +. +.IP "\(bu" 4 +\fBlist\fR (\fBls\fR) +. +.IP +Show all configs that aren\'t secret\. No parameters necessary\. +. +.IP "\(bu" 4 +\fBedit\fR: +. +.IP +Opens the config file in the default editor\. This command isn\'t very useful +programmatically, but it is made available\. +. +.IP "" 0 +. +.P +To programmatically access npm configuration settings, or set them for +the duration of a program, use the \fBnpm\.config\.set\fR and \fBnpm\.config\.get\fR +functions instead\. +. +.SH "SEE ALSO" +. +.IP "\(bu" 4 +npm apihelp npm +. +.IP "" 0 + |