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-05-05 11:49:43 +0400
committerisaacs <i@izs.me>2010-05-05 11:49:56 +0400
commit56e4f8f2fe2c38814a09f4a69a717d92ae6b6595 (patch)
treefff8dbe183ba2dc773d6435e72a79d3f27bf0ca6
parentd049393548ed19034399a749c3fed2f52ee4f3e9 (diff)
documentation updates and cleanup
-rw-r--r--doc/build.md2
-rw-r--r--doc/help.md2
-rw-r--r--doc/install.md14
-rw-r--r--doc/npm.md5
-rw-r--r--man/build.12
-rw-r--r--man/help.12
-rw-r--r--man/install.114
-rw-r--r--man/npm.110
8 files changed, 33 insertions, 18 deletions
diff --git a/doc/build.md b/doc/build.md
index c374e80b2..4e11efb77 100644
--- a/doc/build.md
+++ b/doc/build.md
@@ -5,7 +5,7 @@ npm-build(1) -- Build a package
npm build <package-folder>
-* <package-folder>:
+* `<package-folder>`:
A folder containing a `package.json` file in its root.
## DESCRIPTION
diff --git a/doc/help.md b/doc/help.md
index 4712430df..024ba3101 100644
--- a/doc/help.md
+++ b/doc/help.md
@@ -5,7 +5,7 @@ npm-help(1) -- Get help about npm commands
npm help <section>
-Where <section> is one of:
+Where `<section>` is one of:
`activate`, `adduser`, `build`, `config`, `deactivate`, `folders`, `help`
(this page), `install`, `json`, `link` (or `ln`), `list` (or `ls`), `npm`,
`publish`, `registry`, `scripts`, `tag`, `uninstall` (or `rm`)
diff --git a/doc/install.md b/doc/install.md
index e749b4440..657334ebb 100644
--- a/doc/install.md
+++ b/doc/install.md
@@ -15,7 +15,7 @@ npm-install(1) -- install a package
This command installs a package, and any packages that it depends on. It
resolves circular dependencies by talking to the npm registry.
-* npm install <tarball file>:
+* npm install `<tarball file>`:
Install a package that is sitting on the filesystem. Note: if you just want
to link a dev directory into your npm root, you can do this more easily by
using `npm link`.
@@ -27,7 +27,7 @@ resolves circular dependencies by talking to the npm registry.
npm install ./package.tgz
-* npm install <tarball url>:
+* npm install `<tarball url>`:
Fetch the tarball url, and then install it. In order to distinguish between
this and other options, the argument must start with "http://" or "https://"
@@ -35,15 +35,15 @@ resolves circular dependencies by talking to the npm registry.
npm install http://github.com/waveto/node-crypto/tarball/v0.0.5
-* npm install <pkg>:
- Do a <pkg>@<tag> install, where <tag> is the "tag" config from either your
+* npm install `<pkg>`:
+ Do a `<pkg>@<tag>` install, where `<tag>` is the "tag" config from either your
.npmrc file, or the --tag argument on the command line.
Example:
npm install sax
-* npm install <pkg>@<tag>:
+* npm install `<pkg>@<tag>`:
Install the version of the package that is referenced by the specified tag.
If the tag does not exist in the registry data for that package, then this
will fail.
@@ -52,7 +52,7 @@ resolves circular dependencies by talking to the npm registry.
npm install sax@stable
-* npm install <pkg>@<version>:
+* npm install `<pkg>@<version>`:
Install the specified version of the package. This will fail if the version
has not been published to the registry.
@@ -60,7 +60,7 @@ resolves circular dependencies by talking to the npm registry.
npm install sax@0.1.1
-* npm install <pkg>@<version range>:
+* npm install `<pkg>@<version range>`:
Install a version of the package matching the specified version range. This
will follow the same rules for resolving dependencies described in `npm help json`.
diff --git a/doc/npm.md b/doc/npm.md
index ca7ec5962..426edb4a8 100644
--- a/doc/npm.md
+++ b/doc/npm.md
@@ -139,6 +139,11 @@ i@izs.me.
Fixed DOA bugs
Removed dependence on ronn
+* 0.1.3:
+ Changed a few details with configs (fix #5)
+ Update adduser and publish to put author info in the data
+ Use buffer api for file writes, hopefully fix #4
+
## SEE ALSO
npm-help(1)
diff --git a/man/build.1 b/man/build.1
index e1bb6cf8a..47bd77542 100644
--- a/man/build.1
+++ b/man/build.1
@@ -14,7 +14,7 @@ npm build <package\-folder>
.fi
.
.TP
-\fIpackage\-folder\fR
+\fB<package\-folder>\fR
A folder containing a \fBpackage.json\fR file in its root.
.
.SH "DESCRIPTION"
diff --git a/man/help.1 b/man/help.1
index 0539f7c0e..d80cf1e5f 100644
--- a/man/help.1
+++ b/man/help.1
@@ -14,7 +14,7 @@ npm help <section>
.fi
.
.P
-Where \fIsection\fR is one of:
+Where \fB<section>\fR is one of:
.
.br
\fBactivate\fR, \fBadduser\fR, \fBbuild\fR, \fBconfig\fR, \fBdeactivate\fR, \fBfolders\fR, \fBhelp\fR
diff --git a/man/install.1 b/man/install.1
index 4455c2734..494f330a1 100644
--- a/man/install.1
+++ b/man/install.1
@@ -23,7 +23,7 @@ This command installs a package, and any packages that it depends on. It
resolves circular dependencies by talking to the npm registry.
.
.TP
-npm install \fItarball file\fR
+npm install \fB<tarball file>\fR
Install a package that is sitting on the filesystem. Note: if you just want
to link a dev directory into your npm root, you can do this more easily by
using \fBnpm link\fR.
@@ -45,7 +45,7 @@ must start with either "file:", ".", or "/"
.IP "" 0
.
.TP
-npm install \fItarball url\fR
+npm install \fB<tarball url>\fR
Fetch the tarball url, and then install it. In order to distinguish between
this and other options, the argument must start with "http://" or "https://"
.
@@ -56,8 +56,8 @@ Example:
npm install http://github.com/waveto/node\-crypto/tarball/v0.0.5
.
.TP
-npm install \fIpkg\fR
-Do a \fIpkg\fR@\fItag\fR install, where \fItag\fR is the "tag" config from either your
+npm install \fB<pkg>\fR
+Do a \fB<pkg>@<tag>\fR install, where \fB<tag>\fR is the "tag" config from either your
.npmrc file, or the \-\-tag argument on the command line.
.
.IP
@@ -67,7 +67,7 @@ Example:
npm install sax
.
.TP
-npm install \fIpkg\fR@\fItag\fR
+npm install \fB<pkg>@<tag>\fR
Install the version of the package that is referenced by the specified tag.
If the tag does not exist in the registry data for that package, then this
will fail.
@@ -79,7 +79,7 @@ Example:
npm install sax@stable
.
.TP
-npm install \fIpkg\fR@\fIversion\fR
+npm install \fB<pkg>@<version>\fR
Install the specified version of the package. This will fail if the version
has not been published to the registry.
.
@@ -90,7 +90,7 @@ Example:
npm install sax@0.1.1
.
.TP
-npm install \fIpkg\fR@\fIversion range\fR
+npm install \fB<pkg>@<version range>\fR
Install a version of the package matching the specified version range. This
will follow the same rules for resolving dependencies described in \fBnpm help json\fR.
.
diff --git a/man/npm.1 b/man/npm.1
index b3aec6d1c..e92ea9559 100644
--- a/man/npm.1
+++ b/man/npm.1
@@ -241,6 +241,16 @@ Fixed DOA bugs
.br
Removed dependence on ronn
.
+.TP
+0.1.3
+Changed a few details with configs (fix #5)
+.
+.br
+Update adduser and publish to put author info in the data
+.
+.br
+Use buffer api for file writes, hopefully fix #4
+.
.SH "SEE ALSO"
npm\-help(1)
.