diff options
Diffstat (limited to 'deps/npm/html/doc/cli/npm-view.html')
| -rw-r--r-- | deps/npm/html/doc/cli/npm-view.html | 124 |
1 files changed, 124 insertions, 0 deletions
diff --git a/deps/npm/html/doc/cli/npm-view.html b/deps/npm/html/doc/cli/npm-view.html new file mode 100644 index 0000000000..43c3e7fd3e --- /dev/null +++ b/deps/npm/html/doc/cli/npm-view.html @@ -0,0 +1,124 @@ +<!doctype html> +<html> + <title>npm-view</title> + <meta http-equiv="content-type" value="text/html;utf-8"> + <link rel="stylesheet" type="text/css" href="../../static/style.css"> + + <body> + <div id="wrapper"> +<h1><a href="../cli/npm-view.html">npm-view</a></h1> <p>View registry info</p> + +<h2 id="SYNOPSIS">SYNOPSIS</h2> + +<pre><code>npm view <name>[@<version>] [<field>[.<subfield>]...]</code></pre> + +<h2 id="DESCRIPTION">DESCRIPTION</h2> + +<p>This command shows data about a package and prints it to the stream +referenced by the <code>outfd</code> config, which defaults to stdout.</p> + +<p>To show the package registry entry for the <code>connect</code> package, you can do +this:</p> + +<pre><code>npm view connect</code></pre> + +<p>The default version is "latest" if unspecified.</p> + +<p>Field names can be specified after the package descriptor. +For example, to show the dependencies of the <code>ronn</code> package at version +0.3.5, you could do the following:</p> + +<pre><code>npm view ronn@0.3.5 dependencies</code></pre> + +<p>You can view child field by separating them with a period. +To view the git repository URL for the latest version of npm, you could +do this:</p> + +<pre><code>npm view npm repository.url</code></pre> + +<p>This makes it easy to view information about a dependency with a bit of +shell scripting. For example, to view all the data about the version of +opts that ronn depends on, you can do this:</p> + +<pre><code>npm view opts@$(npm view ronn dependencies.opts)</code></pre> + +<p>For fields that are arrays, requesting a non-numeric field will return +all of the values from the objects in the list. For example, to get all +the contributor names for the "express" project, you can do this:</p> + +<pre><code>npm view express contributors.email</code></pre> + +<p>You may also use numeric indices in square braces to specifically select +an item in an array field. To just get the email address of the first +contributor in the list, you can do this:</p> + +<pre><code>npm view express contributors[0].email</code></pre> + +<p>Multiple fields may be specified, and will be printed one after another. +For exampls, to get all the contributor names and email addresses, you +can do this:</p> + +<pre><code>npm view express contributors.name contributors.email</code></pre> + +<p>"Person" fields are shown as a string if they would be shown as an +object. So, for example, this will show the list of npm contributors in +the shortened string format. (See <code><a href="../files/package.json.html">package.json(5)</a></code> for more on this.)</p> + +<pre><code>npm view npm contributors</code></pre> + +<p>If a version range is provided, then data will be printed for every +matching version of the package. This will show which version of jsdom +was required by each matching version of yui3:</p> + +<pre><code>npm view yui3@'>0.5.4' dependencies.jsdom</code></pre> + +<h2 id="OUTPUT">OUTPUT</h2> + +<p>If only a single string field for a single version is output, then it +will not be colorized or quoted, so as to enable piping the output to +another command. If the field is an object, it will be output as a JavaScript object literal.</p> + +<p>If the --json flag is given, the outputted fields will be JSON.</p> + +<p>If the version range matches multiple versions, than each printed value +will be prefixed with the version it applies to.</p> + +<p>If multiple fields are requested, than each of them are prefixed with +the field name.</p> + +<h2 id="SEE-ALSO">SEE ALSO</h2> + +<ul><li><a href="../cli/npm-search.html">npm-search(1)</a></li><li><a href="../misc/npm-registry.html">npm-registry(7)</a></li><li><a href="../cli/npm-config.html">npm-config(1)</a></li><li><a href="../misc/npm-config.html">npm-config(7)</a></li><li><a href="../files/npmrc.html">npmrc(5)</a></li><li><a href="../cli/npm-docs.html">npm-docs(1)</a></li></ul> +</div> +<p id="footer">npm-view — npm@1.3.3</p> +<script> +;(function () { +var wrapper = document.getElementById("wrapper") +var els = Array.prototype.slice.call(wrapper.getElementsByTagName("*"), 0) + .filter(function (el) { + return el.parentNode === wrapper + && el.tagName.match(/H[1-6]/) + && el.id + }) +var l = 2 + , toc = document.createElement("ul") +toc.innerHTML = els.map(function (el) { + var i = el.tagName.charAt(1) + , out = "" + while (i > l) { + out += "<ul>" + l ++ + } + while (i < l) { + out += "</ul>" + l -- + } + out += "<li><a href='#" + el.id + "'>" + + ( el.innerText || el.text || el.innerHTML) + + "</a>" + return out +}).join("\n") +toc.id = "toc" +document.body.appendChild(toc) +})() +</script> |