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
path: root/doc
diff options
context:
space:
mode:
authorMartin Cooper <mfncooper@gmail.com>2011-10-03 03:48:13 +0400
committerisaacs <i@izs.me>2011-10-03 04:13:34 +0400
commit7814ae00806530f8c7180bc0ea88c22ceb1d5a64 (patch)
treebad63678a84f1a0f361db94298d8e3eb72fbb31e /doc
parent7ea7f2d6564d21c5a1703bbbc3bd33435b103153 (diff)
New 'bugs' command.
Diffstat (limited to 'doc')
-rw-r--r--doc/api/bugs.md19
-rw-r--r--doc/cli/bugs.md38
2 files changed, 57 insertions, 0 deletions
diff --git a/doc/api/bugs.md b/doc/api/bugs.md
new file mode 100644
index 000000000..cc4db8f9e
--- /dev/null
+++ b/doc/api/bugs.md
@@ -0,0 +1,19 @@
+npm-bugs(3) -- Bugs for a package in a web browser maybe
+========================================================
+
+## SYNOPSIS
+
+ npm.commands.bugs(package, callback)
+
+## DESCRIPTION
+
+This command tries to guess at the likely location of a package's
+bug tracker URL, and then tries to open it using the `--browser`
+config param.
+
+Like other commands, the first parameter is an array. This command only
+uses the first element, which is expected to be a package name with an
+optional version number.
+
+This command will launch a browser, so this command may not be the most
+friendly for programmatic use.
diff --git a/doc/cli/bugs.md b/doc/cli/bugs.md
new file mode 100644
index 000000000..2e57cc891
--- /dev/null
+++ b/doc/cli/bugs.md
@@ -0,0 +1,38 @@
+npm-bugs(1) -- Bugs for a package in a web browser maybe
+========================================================
+
+## SYNOPSIS
+
+ npm bugs <pkgname>
+
+## DESCRIPTION
+
+This command tries to guess at the likely location of a package's
+bug tracker URL, and then tries to open it using the `--browser`
+config param.
+
+## CONFIGURATION
+
+### browser
+
+* Default: OS X: `"open"`, others: `"google-chrome"`
+* Type: String
+
+The browser that is called by the `npm bugs` command to open websites.
+
+### registry
+
+* Default: https://registry.npmjs.org/
+* Type: url
+
+The base URL of the npm package registry.
+
+
+## SEE ALSO
+
+* npm-docs(1)
+* npm-view(1)
+* npm-publish(1)
+* npm-registry(1)
+* npm-config(1)
+* npm-json(1)