The data contained in this repository can be downloaded to your computer using one of several clients.
Please see the documentation of your version control software client for more information.
Please select the desired protocol below to get the URL.
This URL has Read-Only access.
main_repo / deps / npm / man / man3 / ls.3 @ 5aef65a9
History | View | Annotate | Download (1.86 KB)
| 1 |
.\" Generated with Ronnjs 0.3.8 |
|---|---|
| 2 |
.\" http://github.com/kapouer/ronnjs/ |
| 3 |
. |
| 4 |
.TH "NPM\-LS" "3" "February 2013" "" "" |
| 5 |
. |
| 6 |
.SH "NAME" |
| 7 |
\fBnpm-ls\fR \-\- List installed packages |
| 8 |
. |
| 9 |
.SH "SYNOPSIS" |
| 10 |
. |
| 11 |
.nf |
| 12 |
npm\.commands\.ls(args, [silent,] callback) |
| 13 |
. |
| 14 |
.fi |
| 15 |
. |
| 16 |
.SH "DESCRIPTION" |
| 17 |
This command will print to stdout all the versions of packages that are |
| 18 |
installed, as well as their dependencies, in a tree\-structure\. It will also |
| 19 |
return that data using the callback\. |
| 20 |
. |
| 21 |
.P |
| 22 |
This command does not take any arguments, but args must be defined\. |
| 23 |
Beyond that, if any arguments are passed in, npm will politely warn that it |
| 24 |
does not take positional arguments, though you may set config flags |
| 25 |
like with any other command, such as \fBglobal\fR to list global packages\. |
| 26 |
. |
| 27 |
.P |
| 28 |
It will print out extraneous, missing, and invalid packages\. |
| 29 |
. |
| 30 |
.P |
| 31 |
If the silent parameter is set to true, nothing will be output to the screen, |
| 32 |
but the data will still be returned\. |
| 33 |
. |
| 34 |
.P |
| 35 |
Callback is provided an error if one occurred, the full data about which |
| 36 |
packages are installed and which dependencies they will receive, and a |
| 37 |
"lite" data object which just shows which versions are installed where\. |
| 38 |
Note that the full data object is a circular structure, so care must be |
| 39 |
taken if it is serialized to JSON\. |
| 40 |
. |
| 41 |
.SH "CONFIGURATION" |
| 42 |
. |
| 43 |
.SS "long" |
| 44 |
. |
| 45 |
.IP "\(bu" 4 |
| 46 |
Default: false |
| 47 |
. |
| 48 |
.IP "\(bu" 4 |
| 49 |
Type: Boolean |
| 50 |
. |
| 51 |
.IP "" 0 |
| 52 |
. |
| 53 |
.P |
| 54 |
Show extended information\. |
| 55 |
. |
| 56 |
.SS "parseable" |
| 57 |
. |
| 58 |
.IP "\(bu" 4 |
| 59 |
Default: false |
| 60 |
. |
| 61 |
.IP "\(bu" 4 |
| 62 |
Type: Boolean |
| 63 |
. |
| 64 |
.IP "" 0 |
| 65 |
. |
| 66 |
.P |
| 67 |
Show parseable output instead of tree view\. |
| 68 |
. |
| 69 |
.SS "global" |
| 70 |
. |
| 71 |
.IP "\(bu" 4 |
| 72 |
Default: false |
| 73 |
. |
| 74 |
.IP "\(bu" 4 |
| 75 |
Type: Boolean |
| 76 |
. |
| 77 |
.IP "" 0 |
| 78 |
. |
| 79 |
.P |
| 80 |
List packages in the global install prefix instead of in the current |
| 81 |
project\. |
| 82 |
. |
| 83 |
.P |
| 84 |
Note, if parseable is set or long isn\'t set, then duplicates will be trimmed\. |
| 85 |
This means that if a submodule a same dependency as a parent module, then the |
| 86 |
dependency will only be output once\. |