org.simantics.maps.server/node/node-v4.8.0-win-x64/node_modules/npm/man/man1/npm-docs.1

   1 .TH "NPM\-DOCS" "1" "October 2016" "" ""
   2 .SH "NAME"
   3 \fBnpm-docs\fR \- Docs for a package in a web browser maybe
   4 .SH SYNOPSIS
   5 .P
   6 .RS 2
   7 .nf
   8 npm docs [<pkgname> [<pkgname> \.\.\.]]
   9 npm docs (with no args in a package dir)
  10 npm home [<pkgname> [<pkgname> \.\.\.]]
  11 npm home (with no args in a package dir)
  12 .fi
  13 .RE
  14 .SH DESCRIPTION
  15 .P
  16 This command tries to guess at the likely location of a package's
  17 documentation URL, and then tries to open it using the \fB\-\-browser\fP
  18 config param\. You can pass multiple package names at once\. If no
  19 package name is provided, it will search for a \fBpackage\.json\fP in
  20 the current folder and use the \fBname\fP property\.
  21 .SH CONFIGURATION
  22 .SS browser
  23 .RS 0
  24 .IP \(bu 2
  25 Default: OS X: \fB"open"\fP, Windows: \fB"start"\fP, Others: \fB"xdg\-open"\fP
  26 .IP \(bu 2
  27 Type: String
  28
  29 .RE
  30 .P
  31 The browser that is called by the \fBnpm docs\fP command to open websites\.
  32 .SS registry
  33 .RS 0
  34 .IP \(bu 2
  35 Default: https://registry\.npmjs\.org/
  36 .IP \(bu 2
  37 Type: url
  38
  39 .RE
  40 .P
  41 The base URL of the npm package registry\.
  42 .SH SEE ALSO
  43 .RS 0
  44 .IP \(bu 2
  45 npm help view
  46 .IP \(bu 2
  47 npm help publish
  48 .IP \(bu 2
  49 npm help 7 registry
  50 .IP \(bu 2
  51 npm help config
  52 .IP \(bu 2
  53 npm help 7 config
  54 .IP \(bu 2
  55 npm help 5 npmrc
  56 .IP \(bu 2
  57 npm help 5 package\.json
  58
  59 .RE
  60