summaryrefslogtreecommitdiff
path: root/deps/npm/man/man3
diff options
context:
space:
mode:
authorisaacs <i@izs.me>2012-02-24 18:52:17 -0800
committerisaacs <i@izs.me>2012-02-24 18:52:17 -0800
commitca0986fbd1a8ade47f3160853a257b6ae83a2151 (patch)
tree7a86f9b6ff5b046d800fab15d51d220b2b3b476e /deps/npm/man/man3
parente004721b482198fb9558f920f8101b27fb0bcb7c (diff)
downloadnode-new-ca0986fbd1a8ade47f3160853a257b6ae83a2151.tar.gz
Update npm to 1.1.2
Diffstat (limited to 'deps/npm/man/man3')
-rw-r--r--deps/npm/man/man3/ls.37
-rw-r--r--deps/npm/man/man3/npm.32
-rw-r--r--deps/npm/man/man3/shrinkwrap.330
3 files changed, 38 insertions, 1 deletions
diff --git a/deps/npm/man/man3/ls.3 b/deps/npm/man/man3/ls.3
index 5796d7c6f3..6b597edb89 100644
--- a/deps/npm/man/man3/ls.3
+++ b/deps/npm/man/man3/ls.3
@@ -31,6 +31,13 @@ It will print out extraneous, missing, and invalid packages\.
If the silent parameter is set to true, nothing will be output to the screen,
but the data will still be returned\.
.
+.P
+Callback is provided an error if one occurred, the full data about which
+packages are installed and which dependencies they will receive, and a
+"lite" data object which just shows which versions are installed where\.
+Note that the full data object is a circular structure, so care must be
+taken if it is serialized to JSON\.
+.
.SH "CONFIGURATION"
.
.SS "long"
diff --git a/deps/npm/man/man3/npm.3 b/deps/npm/man/man3/npm.3
index eaaed85a11..01e63293f0 100644
--- a/deps/npm/man/man3/npm.3
+++ b/deps/npm/man/man3/npm.3
@@ -21,7 +21,7 @@ npm\.load(configObject, function (er, npm) {
.fi
.
.SH "VERSION"
-1.1.1
+1.1.2
.
.SH "DESCRIPTION"
This is the API documentation for npm\.
diff --git a/deps/npm/man/man3/shrinkwrap.3 b/deps/npm/man/man3/shrinkwrap.3
new file mode 100644
index 0000000000..34112f8d5a
--- /dev/null
+++ b/deps/npm/man/man3/shrinkwrap.3
@@ -0,0 +1,30 @@
+.\" Generated with Ronnjs/v0.1
+.\" http://github.com/kapouer/ronnjs/
+.
+.TH "NPM\-SHRINKWRAP" "3" "February 2012" "" ""
+.
+.SH "NAME"
+\fBnpm-shrinkwrap\fR \-\- programmatically generate package shrinkwrap file
+.
+.SH "SYNOPSIS"
+.
+.nf
+npm\.commands\.shrinkwrap(args, [silent,] callback)
+.
+.fi
+.
+.SH "DESCRIPTION"
+This acts much the same ways as shrinkwrapping on the command\-line\.
+.
+.P
+This command does not take any arguments, but \'args\' must be defined\.
+Beyond that, if any arguments are passed in, npm will politely warn that it
+does not take positional arguments\.
+.
+.P
+If the \'silent\' parameter is set to true, nothing will be output to the screen,
+but the shrinkwrap file will still be written\.
+.
+.P
+Finally, \'callback\' is a function that will be called when the shrinkwrap has
+been saved\.