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:
Diffstat (limited to 'docs/content/commands/npm-help.md')
-rw-r--r--docs/content/commands/npm-help.md40
1 files changed, 40 insertions, 0 deletions
diff --git a/docs/content/commands/npm-help.md b/docs/content/commands/npm-help.md
new file mode 100644
index 000000000..2da1724fb
--- /dev/null
+++ b/docs/content/commands/npm-help.md
@@ -0,0 +1,40 @@
+---
+title: npm-help
+section: 1
+description: Get help on npm
+---
+
+### Synopsis
+
+```bash
+npm help <term> [<terms..>]
+```
+
+### Description
+
+If supplied a topic, then show the appropriate documentation page.
+
+If the topic does not exist, or if multiple terms are provided, then npm
+will run the `help-search` command to find a match. Note that, if
+`help-search` finds a single subject, then it will run `help` on that
+topic, so unique matches are equivalent to specifying a topic name.
+
+### Configuration
+
+#### viewer
+
+* Default: "man" on Posix, "browser" on Windows
+* Type: path
+
+The program to use to view help content.
+
+Set to `"browser"` to view html help content in the default web browser.
+
+### See Also
+
+* [npm](/cli-commands/npm)
+* [npm folders](/configuring-npm/folders)
+* [npm config](/cli-commands/config)
+* [npmrc](/configuring-npm/npmrc)
+* [package.json](/configuring-npm/package-json)
+* [npm help-search](/cli-commands/help-search)