docs for pack

2 files changed, 47 insertions, 0 deletions

diff --git a/doc/pack.md b/doc/pack.md
new file mode 100644
index 000000000..1a5920b4d
--- /dev/null
+++ b/doc/pack.md
@@ -0,0 +1,19 @@
+npm-pack(1) -- Create a tarball from a package
+==============================================
+
+## SYNOPSIS
+
+    npm pack [<pkg> [<pkg> ...]]
+
+## DESCRIPTION
+
+For anything that's installable (that is, a package folder, tarball,
+tarball url, name@tag, name@version, or name), this command will fetch
+it to the cache, and then copy the tarball to the current working
+directory as `<name>-<version>.tgz`, and then write the filenames out to
+stdout.
+
+If the same package is specified multiple times, then the file will be
+overwritten the second time.
+
+If no arguments are supplied, then npm packs the current package folder.
diff --git a/man1/pack.1 b/man1/pack.1
new file mode 100644
index 000000000..39c9b3cb3
--- /dev/null
+++ b/man1/pack.1
@@ -0,0 +1,28 @@
+.\" Generated with Ronnjs/v0.1
+.\" http://github.com/kapouer/ronnjs/
+.
+.TH "NPM\-PACK" "1" "July 2011" "" ""
+.
+.SH "NAME"
+\fBnpm-pack\fR \-\- Create a tarball from a package
+.
+.SH "SYNOPSIS"
+.
+.nf
+npm pack [<pkg> [<pkg> \.\.\.]]
+.
+.fi
+.
+.SH "DESCRIPTION"
+For anything that\'s installable (that is, a package folder, tarball,
+tarball url, name@tag, name@version, or name), this command will fetch
+it to the cache, and then copy the tarball to the current working
+directory as \fB<name>\-<version>\.tgz\fR, and then write the filenames out to
+stdout\.
+.
+.P
+If the same package is specified multiple times, then the file will be
+overwritten the second time\.
+.
+.P
+If no arguments are supplied, then npm packs the current package folder\.