ac780a0333e10c1b1a9b6ce7e9b9a9aeee31dbf3
[platform/upstream/nodejs.git] / deps / npm / html / doc / misc / npm-index.html
1 <!doctype html>
2 <html>
3   <title>npm-index</title>
4   <meta http-equiv="content-type" value="text/html;utf-8">
5   <link rel="stylesheet" type="text/css" href="../../static/style.css">
6
7   <body>
8     <div id="wrapper">
9 <h1><a href="../misc/npm-index.html">npm-index</a></h1> <p>Index of all npm documentation</p>
10
11 <h2 id="README-1"><a href="../../doc/README.html">README</a></h2>
12
13 <p>node package manager</p>
14
15 <h1>Command Line Documentation</h1>
16
17 <h2 id="npm-1"><a href="../cli/npm.html">npm(1)</a></h2>
18
19 <p>node package manager</p>
20
21 <h2 id="npm-adduser-1"><a href="../cli/npm-adduser.html">npm-adduser(1)</a></h2>
22
23 <p>Add a registry user account</p>
24
25 <h2 id="npm-bin-1"><a href="../cli/npm-bin.html">npm-bin(1)</a></h2>
26
27 <p>Display npm bin folder</p>
28
29 <h2 id="npm-bugs-1"><a href="../cli/npm-bugs.html">npm-bugs(1)</a></h2>
30
31 <p>Bugs for a package in a web browser maybe</p>
32
33 <h2 id="npm-build-1"><a href="../cli/npm-build.html">npm-build(1)</a></h2>
34
35 <p>Build a package</p>
36
37 <h2 id="npm-bundle-1"><a href="../cli/npm-bundle.html">npm-bundle(1)</a></h2>
38
39 <p>REMOVED</p>
40
41 <h2 id="npm-cache-1"><a href="../cli/npm-cache.html">npm-cache(1)</a></h2>
42
43 <p>Manipulates packages cache</p>
44
45 <h2 id="npm-completion-1"><a href="../cli/npm-completion.html">npm-completion(1)</a></h2>
46
47 <p>Tab Completion for npm</p>
48
49 <h2 id="npm-config-1"><a href="../cli/npm-config.html">npm-config(1)</a></h2>
50
51 <p>Manage the npm configuration files</p>
52
53 <h2 id="npm-dedupe-1"><a href="../cli/npm-dedupe.html">npm-dedupe(1)</a></h2>
54
55 <p>Reduce duplication</p>
56
57 <h2 id="npm-deprecate-1"><a href="../cli/npm-deprecate.html">npm-deprecate(1)</a></h2>
58
59 <p>Deprecate a version of a package</p>
60
61 <h2 id="npm-docs-1"><a href="../cli/npm-docs.html">npm-docs(1)</a></h2>
62
63 <p>Docs for a package in a web browser maybe</p>
64
65 <h2 id="npm-edit-1"><a href="../cli/npm-edit.html">npm-edit(1)</a></h2>
66
67 <p>Edit an installed package</p>
68
69 <h2 id="npm-explore-1"><a href="../cli/npm-explore.html">npm-explore(1)</a></h2>
70
71 <p>Browse an installed package</p>
72
73 <h2 id="npm-help-search-1"><a href="../cli/npm-help-search.html">npm-help-search(1)</a></h2>
74
75 <p>Search npm help documentation</p>
76
77 <h2 id="npm-help-1"><a href="../cli/npm-help.html">npm-help(1)</a></h2>
78
79 <p>Get help on npm</p>
80
81 <h2 id="npm-init-1"><a href="../cli/npm-init.html">npm-init(1)</a></h2>
82
83 <p>Interactively create a package.json file</p>
84
85 <h2 id="npm-install-1"><a href="../cli/npm-install.html">npm-install(1)</a></h2>
86
87 <p>Install a package</p>
88
89 <h2 id="npm-link-1"><a href="../cli/npm-link.html">npm-link(1)</a></h2>
90
91 <p>Symlink a package folder</p>
92
93 <h2 id="npm-ls-1"><a href="../cli/npm-ls.html">npm-ls(1)</a></h2>
94
95 <p>List installed packages</p>
96
97 <h2 id="npm-outdated-1"><a href="../cli/npm-outdated.html">npm-outdated(1)</a></h2>
98
99 <p>Check for outdated packages</p>
100
101 <h2 id="npm-owner-1"><a href="../cli/npm-owner.html">npm-owner(1)</a></h2>
102
103 <p>Manage package owners</p>
104
105 <h2 id="npm-pack-1"><a href="../cli/npm-pack.html">npm-pack(1)</a></h2>
106
107 <p>Create a tarball from a package</p>
108
109 <h2 id="npm-prefix-1"><a href="../cli/npm-prefix.html">npm-prefix(1)</a></h2>
110
111 <p>Display prefix</p>
112
113 <h2 id="npm-prune-1"><a href="../cli/npm-prune.html">npm-prune(1)</a></h2>
114
115 <p>Remove extraneous packages</p>
116
117 <h2 id="npm-publish-1"><a href="../cli/npm-publish.html">npm-publish(1)</a></h2>
118
119 <p>Publish a package</p>
120
121 <h2 id="npm-rebuild-1"><a href="../cli/npm-rebuild.html">npm-rebuild(1)</a></h2>
122
123 <p>Rebuild a package</p>
124
125 <h2 id="npm-restart-1"><a href="../cli/npm-restart.html">npm-restart(1)</a></h2>
126
127 <p>Start a package</p>
128
129 <h2 id="npm-rm-1"><a href="../cli/npm-rm.html">npm-rm(1)</a></h2>
130
131 <p>Remove a package</p>
132
133 <h2 id="npm-root-1"><a href="../cli/npm-root.html">npm-root(1)</a></h2>
134
135 <p>Display npm root</p>
136
137 <h2 id="npm-run-script-1"><a href="../cli/npm-run-script.html">npm-run-script(1)</a></h2>
138
139 <p>Run arbitrary package scripts</p>
140
141 <h2 id="npm-search-1"><a href="../cli/npm-search.html">npm-search(1)</a></h2>
142
143 <p>Search for packages</p>
144
145 <h2 id="npm-shrinkwrap-1"><a href="../cli/npm-shrinkwrap.html">npm-shrinkwrap(1)</a></h2>
146
147 <p>Lock down dependency versions</p>
148
149 <h2 id="npm-star-1"><a href="../cli/npm-star.html">npm-star(1)</a></h2>
150
151 <p>Mark your favorite packages</p>
152
153 <h2 id="npm-stars-1"><a href="../cli/npm-stars.html">npm-stars(1)</a></h2>
154
155 <p>View packages marked as favorites</p>
156
157 <h2 id="npm-start-1"><a href="../cli/npm-start.html">npm-start(1)</a></h2>
158
159 <p>Start a package</p>
160
161 <h2 id="npm-stop-1"><a href="../cli/npm-stop.html">npm-stop(1)</a></h2>
162
163 <p>Stop a package</p>
164
165 <h2 id="npm-submodule-1"><a href="../cli/npm-submodule.html">npm-submodule(1)</a></h2>
166
167 <p>Add a package as a git submodule</p>
168
169 <h2 id="npm-tag-1"><a href="../cli/npm-tag.html">npm-tag(1)</a></h2>
170
171 <p>Tag a published version</p>
172
173 <h2 id="npm-test-1"><a href="../cli/npm-test.html">npm-test(1)</a></h2>
174
175 <p>Test a package</p>
176
177 <h2 id="npm-uninstall-1"><a href="../cli/npm-uninstall.html">npm-uninstall(1)</a></h2>
178
179 <p>Remove a package</p>
180
181 <h2 id="npm-unpublish-1"><a href="../cli/npm-unpublish.html">npm-unpublish(1)</a></h2>
182
183 <p>Remove a package from the registry</p>
184
185 <h2 id="npm-update-1"><a href="../cli/npm-update.html">npm-update(1)</a></h2>
186
187 <p>Update a package</p>
188
189 <h2 id="npm-version-1"><a href="../cli/npm-version.html">npm-version(1)</a></h2>
190
191 <p>Bump a package version</p>
192
193 <h2 id="npm-view-1"><a href="../cli/npm-view.html">npm-view(1)</a></h2>
194
195 <p>View registry info</p>
196
197 <h2 id="npm-whoami-1"><a href="../cli/npm-whoami.html">npm-whoami(1)</a></h2>
198
199 <p>Display npm username</p>
200
201 <h2 id="repo-1"><a href="../cli/repo.html">repo(1)</a></h2>
202
203 <p>Open package repository page in the browser</p>
204
205 <h1>API Documentation</h1>
206
207 <h2 id="npm-3"><a href="../api/npm.html">npm(3)</a></h2>
208
209 <p>node package manager</p>
210
211 <h2 id="npm-bin-3"><a href="../api/npm-bin.html">npm-bin(3)</a></h2>
212
213 <p>Display npm bin folder</p>
214
215 <h2 id="npm-bugs-3"><a href="../api/npm-bugs.html">npm-bugs(3)</a></h2>
216
217 <p>Bugs for a package in a web browser maybe</p>
218
219 <h2 id="npm-commands-3"><a href="../api/npm-commands.html">npm-commands(3)</a></h2>
220
221 <p>npm commands</p>
222
223 <h2 id="npm-config-3"><a href="../api/npm-config.html">npm-config(3)</a></h2>
224
225 <p>Manage the npm configuration files</p>
226
227 <h2 id="npm-deprecate-3"><a href="../api/npm-deprecate.html">npm-deprecate(3)</a></h2>
228
229 <p>Deprecate a version of a package</p>
230
231 <h2 id="npm-docs-3"><a href="../api/npm-docs.html">npm-docs(3)</a></h2>
232
233 <p>Docs for a package in a web browser maybe</p>
234
235 <h2 id="npm-edit-3"><a href="../api/npm-edit.html">npm-edit(3)</a></h2>
236
237 <p>Edit an installed package</p>
238
239 <h2 id="npm-explore-3"><a href="../api/npm-explore.html">npm-explore(3)</a></h2>
240
241 <p>Browse an installed package</p>
242
243 <h2 id="npm-help-search-3"><a href="../api/npm-help-search.html">npm-help-search(3)</a></h2>
244
245 <p>Search the help pages</p>
246
247 <h2 id="npm-init-3"><a href="../api/npm-init.html">npm-init(3)</a></h2>
248
249 <p>Interactively create a package.json file</p>
250
251 <h2 id="npm-install-3"><a href="../api/npm-install.html">npm-install(3)</a></h2>
252
253 <p>install a package programmatically</p>
254
255 <h2 id="npm-link-3"><a href="../api/npm-link.html">npm-link(3)</a></h2>
256
257 <p>Symlink a package folder</p>
258
259 <h2 id="npm-load-3"><a href="../api/npm-load.html">npm-load(3)</a></h2>
260
261 <p>Load config settings</p>
262
263 <h2 id="npm-ls-3"><a href="../api/npm-ls.html">npm-ls(3)</a></h2>
264
265 <p>List installed packages</p>
266
267 <h2 id="npm-outdated-3"><a href="../api/npm-outdated.html">npm-outdated(3)</a></h2>
268
269 <p>Check for outdated packages</p>
270
271 <h2 id="npm-owner-3"><a href="../api/npm-owner.html">npm-owner(3)</a></h2>
272
273 <p>Manage package owners</p>
274
275 <h2 id="npm-pack-3"><a href="../api/npm-pack.html">npm-pack(3)</a></h2>
276
277 <p>Create a tarball from a package</p>
278
279 <h2 id="npm-prefix-3"><a href="../api/npm-prefix.html">npm-prefix(3)</a></h2>
280
281 <p>Display prefix</p>
282
283 <h2 id="npm-prune-3"><a href="../api/npm-prune.html">npm-prune(3)</a></h2>
284
285 <p>Remove extraneous packages</p>
286
287 <h2 id="npm-publish-3"><a href="../api/npm-publish.html">npm-publish(3)</a></h2>
288
289 <p>Publish a package</p>
290
291 <h2 id="npm-rebuild-3"><a href="../api/npm-rebuild.html">npm-rebuild(3)</a></h2>
292
293 <p>Rebuild a package</p>
294
295 <h2 id="npm-restart-3"><a href="../api/npm-restart.html">npm-restart(3)</a></h2>
296
297 <p>Start a package</p>
298
299 <h2 id="npm-root-3"><a href="../api/npm-root.html">npm-root(3)</a></h2>
300
301 <p>Display npm root</p>
302
303 <h2 id="npm-run-script-3"><a href="../api/npm-run-script.html">npm-run-script(3)</a></h2>
304
305 <p>Run arbitrary package scripts</p>
306
307 <h2 id="npm-search-3"><a href="../api/npm-search.html">npm-search(3)</a></h2>
308
309 <p>Search for packages</p>
310
311 <h2 id="npm-shrinkwrap-3"><a href="../api/npm-shrinkwrap.html">npm-shrinkwrap(3)</a></h2>
312
313 <p>programmatically generate package shrinkwrap file</p>
314
315 <h2 id="npm-start-3"><a href="../api/npm-start.html">npm-start(3)</a></h2>
316
317 <p>Start a package</p>
318
319 <h2 id="npm-stop-3"><a href="../api/npm-stop.html">npm-stop(3)</a></h2>
320
321 <p>Stop a package</p>
322
323 <h2 id="npm-submodule-3"><a href="../api/npm-submodule.html">npm-submodule(3)</a></h2>
324
325 <p>Add a package as a git submodule</p>
326
327 <h2 id="npm-tag-3"><a href="../api/npm-tag.html">npm-tag(3)</a></h2>
328
329 <p>Tag a published version</p>
330
331 <h2 id="npm-test-3"><a href="../api/npm-test.html">npm-test(3)</a></h2>
332
333 <p>Test a package</p>
334
335 <h2 id="npm-uninstall-3"><a href="../api/npm-uninstall.html">npm-uninstall(3)</a></h2>
336
337 <p>uninstall a package programmatically</p>
338
339 <h2 id="npm-unpublish-3"><a href="../api/npm-unpublish.html">npm-unpublish(3)</a></h2>
340
341 <p>Remove a package from the registry</p>
342
343 <h2 id="npm-update-3"><a href="../api/npm-update.html">npm-update(3)</a></h2>
344
345 <p>Update a package</p>
346
347 <h2 id="npm-version-3"><a href="../api/npm-version.html">npm-version(3)</a></h2>
348
349 <p>Bump a package version</p>
350
351 <h2 id="npm-view-3"><a href="../api/npm-view.html">npm-view(3)</a></h2>
352
353 <p>View registry info</p>
354
355 <h2 id="npm-whoami-3"><a href="../api/npm-whoami.html">npm-whoami(3)</a></h2>
356
357 <p>Display npm username</p>
358
359 <h2 id="repo-3"><a href="../api/repo.html">repo(3)</a></h2>
360
361 <p>Open package repository page in the browser</p>
362
363 <h1>Files</h1>
364
365 <h2 id="npm-folders-5"><a href="../files/npm-folders.html">npm-folders(5)</a></h2>
366
367 <p>Folder Structures Used by npm</p>
368
369 <h2 id="npmrc-5"><a href="../files/npmrc.html">npmrc(5)</a></h2>
370
371 <p>The npm config files</p>
372
373 <h2 id="package-json-5"><a href="../files/package.json.html">package.json(5)</a></h2>
374
375 <p>Specifics of npm&#39;s package.json handling</p>
376
377 <h1>Misc</h1>
378
379 <h2 id="npm-coding-style-7"><a href="../misc/npm-coding-style.html">npm-coding-style(7)</a></h2>
380
381 <p>npm&#39;s &quot;funny&quot; coding style</p>
382
383 <h2 id="npm-config-7"><a href="../misc/npm-config.html">npm-config(7)</a></h2>
384
385 <p>More than you probably want to know about npm configuration</p>
386
387 <h2 id="npm-developers-7"><a href="../misc/npm-developers.html">npm-developers(7)</a></h2>
388
389 <p>Developer Guide</p>
390
391 <h2 id="npm-disputes-7"><a href="../misc/npm-disputes.html">npm-disputes(7)</a></h2>
392
393 <p>Handling Module Name Disputes</p>
394
395 <h2 id="npm-faq-7"><a href="../misc/npm-faq.html">npm-faq(7)</a></h2>
396
397 <p>Frequently Asked Questions</p>
398
399 <h2 id="npm-index-7"><a href="../misc/npm-index.html">npm-index(7)</a></h2>
400
401 <p>Index of all npm documentation</p>
402
403 <h2 id="npm-registry-7"><a href="../misc/npm-registry.html">npm-registry(7)</a></h2>
404
405 <p>The JavaScript Package Registry</p>
406
407 <h2 id="npm-scripts-7"><a href="../misc/npm-scripts.html">npm-scripts(7)</a></h2>
408
409 <p>How npm handles the &quot;scripts&quot; field</p>
410
411 <h2 id="removing-npm-7"><a href="../misc/removing-npm.html">removing-npm(7)</a></h2>
412
413 <p>Cleaning the Slate</p>
414
415 <h2 id="semver-7"><a href="../misc/semver.html">semver(7)</a></h2>
416
417 <p>The semantic versioner for npm</p>
418 </div>
419 <p id="footer">npm-index &mdash; npm@1.3.17</p>
420 <script>
421 ;(function () {
422 var wrapper = document.getElementById("wrapper")
423 var els = Array.prototype.slice.call(wrapper.getElementsByTagName("*"), 0)
424   .filter(function (el) {
425     return el.parentNode === wrapper
426         && el.tagName.match(/H[1-6]/)
427         && el.id
428   })
429 var l = 2
430   , toc = document.createElement("ul")
431 toc.innerHTML = els.map(function (el) {
432   var i = el.tagName.charAt(1)
433     , out = ""
434   while (i > l) {
435     out += "<ul>"
436     l ++
437   }
438   while (i < l) {
439     out += "</ul>"
440     l --
441   }
442   out += "<li><a href='#" + el.id + "'>" +
443     ( el.innerText || el.text || el.innerHTML)
444     + "</a>"
445   return out
446 }).join("\n")
447 toc.id = "toc"
448 document.body.appendChild(toc)
449 })()
450 </script>