diff options
author | isaacs <i@izs.me> | 2011-11-26 09:21:03 -0800 |
---|---|---|
committer | isaacs <i@izs.me> | 2011-11-27 13:09:04 -0800 |
commit | e85a95dfa3469dd9cc6a3a15c8e686c14b3238a6 (patch) | |
tree | 85a3a6e0f45f4b6540dcb75af2e9383db0f6e4c3 /deps/npm/man/man3 | |
parent | fc0a4c2781b4b579d247a24393dada7f92663abe (diff) | |
download | node-new-e85a95dfa3469dd9cc6a3a15c8e686c14b3238a6.tar.gz |
Remove npm's .gitignore, add generated docs
Diffstat (limited to 'deps/npm/man/man3')
45 files changed, 2045 insertions, 0 deletions
diff --git a/deps/npm/man/man3/author.3 b/deps/npm/man/man3/author.3 new file mode 100644 index 0000000000..0f5d2c8c2f --- /dev/null +++ b/deps/npm/man/man3/author.3 @@ -0,0 +1,52 @@ +.\" Generated with Ronnjs/v0.1 +.\" http://github.com/kapouer/ronnjs/ +. +.TH "NPM\-OWNER" "3" "November 2011" "" "" +. +.SH "NAME" +\fBnpm-owner\fR \-\- Manage package owners +. +.SH "SYNOPSIS" +. +.nf +npm\.commands\.owner(args, callback) +. +.fi +. +.SH "DESCRIPTION" +The first element of the \'args\' parameter defines what to do, and the subsequent +elements depend on the action\. Possible values for the action are (order of +parameters are given in parenthesis): +. +.IP "\(bu" 4 +ls (package): +List all the users who have access to modify a package and push new versions\. +Handy when you need to know who to bug for help\. +. +.IP "\(bu" 4 +add (user, package): +Add a new user as a maintainer of a package\. This user is enabled to modify +metadata, publish new versions, and add other owners\. +. +.IP "\(bu" 4 +rm (user, package): +Remove a user from the package owner list\. This immediately revokes their +privileges\. +. +.IP "" 0 +. +.P +Note that there is only one level of access\. Either you can modify a package, +or you can\'t\. Future versions may contain more fine\-grained access levels, but +that is not implemented at this time\. +. +.SH "SEE ALSO" +. +.IP "\(bu" 4 +npm apihelp publish +. +.IP "\(bu" 4 +npm help registry +. +.IP "" 0 + diff --git a/deps/npm/man/man3/bin.3 b/deps/npm/man/man3/bin.3 new file mode 100644 index 0000000000..dc9eb9679f --- /dev/null +++ b/deps/npm/man/man3/bin.3 @@ -0,0 +1,21 @@ +.\" Generated with Ronnjs/v0.1 +.\" http://github.com/kapouer/ronnjs/ +. +.TH "NPM\-BIN" "3" "November 2011" "" "" +. +.SH "NAME" +\fBnpm-bin\fR \-\- Display npm bin folder +. +.SH "SYNOPSIS" +. +.nf +npm\.commands\.bin(args, cb) +. +.fi +. +.SH "DESCRIPTION" +Print the folder where npm will install executables\. +. +.P +This function should not be used programmatically\. Instead, just refer +to the \fBnpm\.bin\fR member\. diff --git a/deps/npm/man/man3/bugs.3 b/deps/npm/man/man3/bugs.3 new file mode 100644 index 0000000000..1ae96495a8 --- /dev/null +++ b/deps/npm/man/man3/bugs.3 @@ -0,0 +1,28 @@ +.\" Generated with Ronnjs/v0.1 +.\" http://github.com/kapouer/ronnjs/ +. +.TH "NPM\-BUGS" "3" "November 2011" "" "" +. +.SH "NAME" +\fBnpm-bugs\fR \-\- Bugs for a package in a web browser maybe +. +.SH "SYNOPSIS" +. +.nf +npm\.commands\.bugs(package, callback) +. +.fi +. +.SH "DESCRIPTION" +This command tries to guess at the likely location of a package\'s +bug tracker URL, and then tries to open it using the \fB\-\-browser\fR +config param\. +. +.P +Like other commands, the first parameter is an array\. This command only +uses the first element, which is expected to be a package name with an +optional version number\. +. +.P +This command will launch a browser, so this command may not be the most +friendly for programmatic use\. diff --git a/deps/npm/man/man3/commands.3 b/deps/npm/man/man3/commands.3 new file mode 100644 index 0000000000..c1f29def8d --- /dev/null +++ b/deps/npm/man/man3/commands.3 @@ -0,0 +1,35 @@ +.\" Generated with Ronnjs/v0.1 +.\" http://github.com/kapouer/ronnjs/ +. +.TH "NPM\-COMMANDS" "3" "November 2011" "" "" +. +.SH "NAME" +\fBnpm-commands\fR \-\- npm commands +. +.SH "SYNOPSIS" +. +.nf +npm\.commands[<command>](args, callback) +. +.fi +. +.SH "DESCRIPTION" +npm comes with a full set of commands, and each of the commands takes a +similar set of arguments\. +. +.P +In general, all commands on the command object take an \fBarray\fR of positional +argument \fBstrings\fR\|\. The last argument to any function is a callback\. Some +commands are special and take other optional arguments\. +. +.P +All commands have their own man page\. See \fBman npm\-<command>\fR for command\-line +usage, or \fBman 3 npm\-<command>\fR for programmatic usage\. +. +.SH "SEE ALSO" +. +.IP "\(bu" 4 +npm help index +. +.IP "" 0 + diff --git a/deps/npm/man/man3/config.3 b/deps/npm/man/man3/config.3 new file mode 100644 index 0000000000..548f4bb9c6 --- /dev/null +++ b/deps/npm/man/man3/config.3 @@ -0,0 +1,69 @@ +.\" Generated with Ronnjs/v0.1 +.\" http://github.com/kapouer/ronnjs/ +. +.TH "NPM\-CONFIG" "3" "November 2011" "" "" +. +.SH "NAME" +\fBnpm-config\fR \-\- Manage the npm configuration files +. +.SH "SYNOPSIS" +. +.nf +npm\.commands\.config(args, callback) +var val = npm\.config\.get(key) +npm\.config\.set(key, val) +. +.fi +. +.SH "DESCRIPTION" +This function acts much the same way as the command\-line version\. The first +element in the array tells config what to do\. Possible values are: +. +.IP "\(bu" 4 +\fBset\fR +. +.IP +Sets a config parameter\. The second element in \fBargs\fR is interpreted as the +key, and the third element is interpreted as the value\. +. +.IP "\(bu" 4 +\fBget\fR +. +.IP +Gets the value of a config parameter\. The second element in \fBargs\fR is the +key to get the value of\. +. +.IP "\(bu" 4 +\fBdelete\fR (\fBrm\fR or \fBdel\fR) +. +.IP +Deletes a parameter from the config\. The second element in \fBargs\fR is the +key to delete\. +. +.IP "\(bu" 4 +\fBlist\fR (\fBls\fR) +. +.IP +Show all configs that aren\'t secret\. No parameters necessary\. +. +.IP "\(bu" 4 +\fBedit\fR: +. +.IP +Opens the config file in the default editor\. This command isn\'t very useful +programmatically, but it is made available\. +. +.IP "" 0 +. +.P +To programmatically access npm configuration settings, or set them for +the duration of a program, use the \fBnpm\.config\.set\fR and \fBnpm\.config\.get\fR +functions instead\. +. +.SH "SEE ALSO" +. +.IP "\(bu" 4 +npm apihelp npm +. +.IP "" 0 + diff --git a/deps/npm/man/man3/deprecate.3 b/deps/npm/man/man3/deprecate.3 new file mode 100644 index 0000000000..2f1bbecb53 --- /dev/null +++ b/deps/npm/man/man3/deprecate.3 @@ -0,0 +1,54 @@ +.\" Generated with Ronnjs/v0.1 +.\" http://github.com/kapouer/ronnjs/ +. +.TH "NPM\-DEPRECATE" "3" "November 2011" "" "" +. +.SH "NAME" +\fBnpm-deprecate\fR \-\- Deprecate a version of a package +. +.SH "SYNOPSIS" +. +.nf +npm\.commands\.deprecate(args, callback) +. +.fi +. +.SH "DESCRIPTION" +This command will update the npm registry entry for a package, providing +a deprecation warning to all who attempt to install it\. +. +.P +The \'args\' parameter must have exactly two elements: +. +.IP "\(bu" 4 +\fBpackage[@version]\fR +. +.IP +The \fBversion\fR portion is optional, and may be either a range, or a +specific version, or a tag\. +. +.IP "\(bu" 4 +\fBmessage\fR +. +.IP +The warning message that will be printed whenever a user attempts to +install the package\. +. +.IP "" 0 +. +.P +Note that you must be the package owner to deprecate something\. See the \fBowner\fR and \fBadduser\fR help topics\. +. +.SH "SEE ALSO" +. +.IP "\(bu" 4 +npm apihelp publish +. +.IP "\(bu" 4 +npm apihelp unpublish +. +.IP "\(bu" 4 +npm help registry +. +.IP "" 0 + diff --git a/deps/npm/man/man3/docs.3 b/deps/npm/man/man3/docs.3 new file mode 100644 index 0000000000..3db059e0fa --- /dev/null +++ b/deps/npm/man/man3/docs.3 @@ -0,0 +1,28 @@ +.\" Generated with Ronnjs/v0.1 +.\" http://github.com/kapouer/ronnjs/ +. +.TH "NPM\-DOCS" "3" "November 2011" "" "" +. +.SH "NAME" +\fBnpm-docs\fR \-\- Docs for a package in a web browser maybe +. +.SH "SYNOPSIS" +. +.nf +npm\.commands\.docs(package, callback) +. +.fi +. +.SH "DESCRIPTION" +This command tries to guess at the likely location of a package\'s +documentation URL, and then tries to open it using the \fB\-\-browser\fR +config param\. +. +.P +Like other commands, the first parameter is an array\. This command only +uses the first element, which is expected to be a package name with an +optional version number\. +. +.P +This command will launch a browser, so this command may not be the most +friendly for programmatic use\. diff --git a/deps/npm/man/man3/edit.3 b/deps/npm/man/man3/edit.3 new file mode 100644 index 0000000000..084c893728 --- /dev/null +++ b/deps/npm/man/man3/edit.3 @@ -0,0 +1,35 @@ +.\" Generated with Ronnjs/v0.1 +.\" http://github.com/kapouer/ronnjs/ +. +.TH "NPM\-EDIT" "3" "November 2011" "" "" +. +.SH "NAME" +\fBnpm-edit\fR \-\- Edit an installed package +. +.SH "SYNOPSIS" +. +.nf +npm\.commands\.edit(package, callback) +. +.fi +. +.SH "DESCRIPTION" +Opens the package folder in the default editor (or whatever you\'ve +configured as the npm \fBeditor\fR config \-\- see \fBnpm help config\fR\|\.) +. +.P +After it has been edited, the package is rebuilt so as to pick up any +changes in compiled packages\. +. +.P +For instance, you can do \fBnpm install connect\fR to install connect +into your package, and then \fBnpm\.commands\.edit(["connect"], callback)\fR +to make a few changes to your locally installed copy\. +. +.P +The first parameter is a string array with a single element, the package +to open\. The package can optionally have a version number attached\. +. +.P +Since this command opens an editor in a new process, be careful about where +and how this is used\. diff --git a/deps/npm/man/man3/explore.3 b/deps/npm/man/man3/explore.3 new file mode 100644 index 0000000000..f7dc6ff219 --- /dev/null +++ b/deps/npm/man/man3/explore.3 @@ -0,0 +1,28 @@ +.\" Generated with Ronnjs/v0.1 +.\" http://github.com/kapouer/ronnjs/ +. +.TH "NPM\-EXPLORE" "3" "November 2011" "" "" +. +.SH "NAME" +\fBnpm-explore\fR \-\- Browse an installed package +. +.SH "SYNOPSIS" +. +.nf +npm\.commands\.explore(args, callback) +. +.fi +. +.SH "DESCRIPTION" +Spawn a subshell in the directory of the installed package specified\. +. +.P +If a command is specified, then it is run in the subshell, which then +immediately terminates\. +. +.P +Note that the package is \fInot\fR automatically rebuilt afterwards, so be +sure to use \fBnpm rebuild <pkg>\fR if you make any changes\. +. +.P +The first element in the \'args\' parameter must be a package name\. After that is the optional command, which can be any number of strings\. All of the strings will be combined into one, space\-delimited command\. diff --git a/deps/npm/man/man3/find.3 b/deps/npm/man/man3/find.3 new file mode 100644 index 0000000000..3c733c9ded --- /dev/null +++ b/deps/npm/man/man3/find.3 @@ -0,0 +1,79 @@ +.\" Generated with Ronnjs/v0.1 +.\" http://github.com/kapouer/ronnjs/ +. +.TH "NPM\-LS" "3" "November 2011" "" "" +. +.SH "NAME" +\fBnpm-ls\fR \-\- List installed packages +. +.SH "SYNOPSIS" +. +.nf +npm\.commands\.ls(args, [silent,] callback) +. +.fi +. +.SH "DESCRIPTION" +This command will print to stdout all the versions of packages that are +installed, as well as their dependencies, in a tree\-structure\. It will also +return that data using the callback\. +. +.P +This command does not take any arguments, but args must be defined\. +Beyond that, if any arguments are passed in, npm will politely warn that it +does not take positional arguments, though you may set config flags +like with any other command, such as \fBglobal\fR to list global packages\. +. +.P +It will print out extraneous, missing, and invalid packages\. +. +.P +If the silent parameter is set to true, nothing will be output to the screen, +but the data will still be returned\. +. +.SH "CONFIGURATION" +. +.SS "long" +. +.IP "\(bu" 4 +Default: false +. +.IP "\(bu" 4 +Type: Boolean +. +.IP "" 0 +. +.P +Show extended information\. +. +.SS "parseable" +. +.IP "\(bu" 4 +Default: false +. +.IP "\(bu" 4 +Type: Boolean +. +.IP "" 0 +. +.P +Show parseable output instead of tree view\. +. +.SS "global" +. +.IP "\(bu" 4 +Default: false +. +.IP "\(bu" 4 +Type: Boolean +. +.IP "" 0 +. +.P +List packages in the global install prefix instead of in the current +project\. +. +.P +Note, if parseable is set or long isn\'t set, then duplicates will be trimmed\. +This means that if a submodule a same dependency as a parent module, then the +dependency will only be output once\. diff --git a/deps/npm/man/man3/get.3 b/deps/npm/man/man3/get.3 new file mode 100644 index 0000000000..548f4bb9c6 --- /dev/null +++ b/deps/npm/man/man3/get.3 @@ -0,0 +1,69 @@ +.\" Generated with Ronnjs/v0.1 +.\" http://github.com/kapouer/ronnjs/ +. +.TH "NPM\-CONFIG" "3" "November 2011" "" "" +. +.SH "NAME" +\fBnpm-config\fR \-\- Manage the npm configuration files +. +.SH "SYNOPSIS" +. +.nf +npm\.commands\.config(args, callback) +var val = npm\.config\.get(key) +npm\.config\.set(key, val) +. +.fi +. +.SH "DESCRIPTION" +This function acts much the same way as the command\-line version\. The first +element in the array tells config what to do\. Possible values are: +. +.IP "\(bu" 4 +\fBset\fR +. +.IP +Sets a config parameter\. The second element in \fBargs\fR is interpreted as the +key, and the third element is interpreted as the value\. +. +.IP "\(bu" 4 +\fBget\fR +. +.IP +Gets the value of a config parameter\. The second element in \fBargs\fR is the +key to get the value of\. +. +.IP "\(bu" 4 +\fBdelete\fR (\fBrm\fR or \fBdel\fR) +. +.IP +Deletes a parameter from the config\. The second element in \fBargs\fR is the +key to delete\. +. +.IP "\(bu" 4 +\fBlist\fR (\fBls\fR) +. +.IP +Show all configs that aren\'t secret\. No parameters necessary\. +. +.IP "\(bu" 4 +\fBedit\fR: +. +.IP +Opens the config file in the default editor\. This command isn\'t very useful +programmatically, but it is made available\. +. +.IP "" 0 +. +.P +To programmatically access npm configuration settings, or set them for +the duration of a program, use the \fBnpm\.config\.set\fR and \fBnpm\.config\.get\fR +functions instead\. +. +.SH "SEE ALSO" +. +.IP "\(bu" 4 +npm apihelp npm +. +.IP "" 0 + diff --git a/deps/npm/man/man3/help-search.3 b/deps/npm/man/man3/help-search.3 new file mode 100644 index 0000000000..0ffb5e07df --- /dev/null +++ b/deps/npm/man/man3/help-search.3 @@ -0,0 +1,51 @@ +.\" Generated with Ronnjs/v0.1 +.\" http://github.com/kapouer/ronnjs/ +. +.TH "NPM\-HELP\-SEARCH" "3" "November 2011" "" "" +. +.SH "NAME" +\fBnpm-help-search\fR \-\- Search the help pages +. +.SH "SYNOPSIS" +. +.nf +npm\.commands\.helpSearch(args, [silent,] callback) +. +.fi +. +.SH "DESCRIPTION" +This command is rarely useful, but it exists in the rare case that it is\. +. +.P +This command takes an array of search terms and returns the help pages that +match in order of best match\. +. +.P +If there is only one match, then npm displays that help section\. If there +are multiple results, the results are printed to the screen formatted and the +array of results is returned\. Each result is an object with these properties: +. +.IP "\(bu" 4 +hits: +A map of args to number of hits on that arg\. For example, {"npm": 3} +. +.IP "\(bu" 4 +found: +Total number of unique args that matched\. +. +.IP "\(bu" 4 +totalHits: +Total number of hits\. +. +.IP "\(bu" 4 +lines: +An array of all matching lines (and some adjacent lines)\. +. +.IP "\(bu" 4 +file: +Name of the file that matched +. +.IP "" 0 +. +.P +The silent parameter is not neccessary not used, but it may in the future\. diff --git a/deps/npm/man/man3/home.3 b/deps/npm/man/man3/home.3 new file mode 100644 index 0000000000..3db059e0fa --- /dev/null +++ b/deps/npm/man/man3/home.3 @@ -0,0 +1,28 @@ +.\" Generated with Ronnjs/v0.1 +.\" http://github.com/kapouer/ronnjs/ +. +.TH "NPM\-DOCS" "3" "November 2011" "" "" +. +.SH "NAME" +\fBnpm-docs\fR \-\- Docs for a package in a web browser maybe +. +.SH "SYNOPSIS" +. +.nf +npm\.commands\.docs(package, callback) +. +.fi +. +.SH "DESCRIPTION" +This command tries to guess at the likely location of a package\'s +documentation URL, and then tries to open it using the \fB\-\-browser\fR +config param\. +. +.P +Like other commands, the first parameter is an array\. This command only +uses the first element, which is expected to be a package name with an +optional version number\. +. +.P +This command will launch a browser, so this command may not be the most +friendly for programmatic use\. diff --git a/deps/npm/man/man3/init.3 b/deps/npm/man/man3/init.3 new file mode 100644 index 0000000000..00326d5007 --- /dev/null +++ b/deps/npm/man/man3/init.3 @@ -0,0 +1,39 @@ +.\" Generated with Ronnjs/v0.1 +.\" http://github.com/kapouer/ronnjs/ +. +.TH "INIT" "3" "November 2011" "" "" +. +.SH "NAME" +\fBinit\fR \-\- Interactively create a package\.json file +. +.SH "SYNOPSIS" +. +.nf +npm\.commands\.init(args, callback) +. +.fi +. +.SH "DESCRIPTION" +This will ask you a bunch of questions, and then write a package\.json for you\. +. +.P +It attempts to make reasonable guesses about what you want things to be set to, +and then writes a package\.json file with the options you\'ve selected\. +. +.P +If you already have a package\.json file, it\'ll read that first, and default to +the options in there\. +. +.P +It is strictly additive, so it does not delete options from your package\.json +without a really good reason to do so\. +. +.P +Since this function expects to be run on the command\-line, it doesn\'t work very +well as a programmatically\. The best option is to roll your own, and since +JavaScript makes it stupid simple to output formatted JSON, that is the +preferred method\. If you\'re sure you want to handle command\-line prompting, +then go ahead and use this programmatically\. +. +.SH "SEE ALSO" +npm help json diff --git a/deps/npm/man/man3/install.3 b/deps/npm/man/man3/install.3 new file mode 100644 index 0000000000..9c43a465ae --- /dev/null +++ b/deps/npm/man/man3/install.3 @@ -0,0 +1,29 @@ +.\" Generated with Ronnjs/v0.1 +.\" http://github.com/kapouer/ronnjs/ +. +.TH "NPM\-INSTALL" "3" "November 2011" "" "" +. +.SH "NAME" +\fBnpm-install\fR \-\- install a package programmatically +. +.SH "SYNOPSIS" +. +.nf +npm\.commands\.install([where,] packages, callback) +. +.fi +. +.SH "DESCRIPTION" +This acts much the same ways as installing on the command\-line\. +. +.P +The \'where\' parameter is optional and only used internally, and it specifies +where the packages should be installed to\. +. +.P +The \'packages\' parameter is an array of strings\. Each element in the array is +the name of a package to be installed\. +. +.P +Finally, \'callback\' is a function that will be called when all packages have been +installed or when an error has been encountered\. diff --git a/deps/npm/man/man3/link.3 b/deps/npm/man/man3/link.3 new file mode 100644 index 0000000000..bbb7ff092f --- /dev/null +++ b/deps/npm/man/man3/link.3 @@ -0,0 +1,53 @@ +.\" Generated with Ronnjs/v0.1 +.\" http://github.com/kapouer/ronnjs/ +. +.TH "NPM\-LINK" "3" "November 2011" "" "" +. +.SH "NAME" +\fBnpm-link\fR \-\- Symlink a package folder +. +.SH "SYNOPSIS" +. +.nf +npm\.command\.link(callback) +npm\.command\.link(packages, callback) +. +.fi +. +.SH "DESCRIPTION" +Package linking is a two\-step process\. +. +.P +Without parameters, link will create a globally\-installed +symbolic link from \fBprefix/package\-name\fR to the current folder\. +. +.P +With a parameters, link will create a symlink from the local \fBnode_modules\fR +folder to the global symlink\. +. +.P +When creating tarballs for \fBnpm publish\fR, the linked packages are +"snapshotted" to their current state by resolving the symbolic links\. +. +.P +This is +handy for installing your own stuff, so that you can work on it and test it +iteratively without having to continually rebuild\. +. +.P +For example: +. +.IP "" 4 +. +.nf +npm\.commands\.link(cb) # creates global link from the cwd + # (say redis package) +npm\.commands\.link(\'redis\', cb) # link\-install the package +. +.fi +. +.IP "" 0 +. +.P +Now, any changes to the redis package will be reflected in +the package in the current working directory diff --git a/deps/npm/man/man3/list.3 b/deps/npm/man/man3/list.3 new file mode 100644 index 0000000000..3c733c9ded --- /dev/null +++ b/deps/npm/man/man3/list.3 @@ -0,0 +1,79 @@ +.\" Generated with Ronnjs/v0.1 +.\" http://github.com/kapouer/ronnjs/ +. +.TH "NPM\-LS" "3" "November 2011" "" "" +. +.SH "NAME" +\fBnpm-ls\fR \-\- List installed packages +. +.SH "SYNOPSIS" +. +.nf +npm\.commands\.ls(args, [silent,] callback) +. +.fi +. +.SH "DESCRIPTION" +This command will print to stdout all the versions of packages that are +installed, as well as their dependencies, in a tree\-structure\. It will also +return that data using the callback\. +. +.P +This command does not take any arguments, but args must be defined\. +Beyond that, if any arguments are passed in, npm will politely warn that it +does not take positional arguments, though you may set config flags +like with any other command, such as \fBglobal\fR to list global packages\. +. +.P +It will print out extraneous, missing, and invalid packages\. +. +.P +If the silent parameter is set to true, nothing will be output to the screen, +but the data will still be returned\. +. +.SH "CONFIGURATION" +. +.SS "long" +. +.IP "\(bu" 4 +Default: false +. +.IP "\(bu" 4 +Type: Boolean +. +.IP "" 0 +. +.P +Show extended information\. +. +.SS "parseable" +. +.IP "\(bu" 4 +Default: false +. +.IP "\(bu" 4 +Type: Boolean +. +.IP "" 0 +. +.P +Show parseable output instead of tree view\. +. +.SS "global" +. +.IP "\(bu" 4 +Default: false +. +.IP "\(bu" 4 +Type: Boolean +. +.IP "" 0 +. +.P +List packages in the global install prefix instead of in the current +project\. +. +.P +Note, if parseable is set or long isn\'t set, then duplicates will be trimmed\. +This means that if a submodule a same dependency as a parent module, then the +dependency will only be output once\. diff --git a/deps/npm/man/man3/ln.3 b/deps/npm/man/man3/ln.3 new file mode 100644 index 0000000000..bbb7ff092f --- /dev/null +++ b/deps/npm/man/man3/ln.3 @@ -0,0 +1,53 @@ +.\" Generated with Ronnjs/v0.1 +.\" http://github.com/kapouer/ronnjs/ +. +.TH "NPM\-LINK" "3" "November 2011" "" "" +. +.SH "NAME" +\fBnpm-link\fR \-\- Symlink a package folder +. +.SH "SYNOPSIS" +. +.nf +npm\.command\.link(callback) +npm\.command\.link(packages, callback) +. +.fi +. +.SH "DESCRIPTION" +Package linking is a two\-step process\. +. +.P +Without parameters, link will create a globally\-installed +symbolic link from \fBprefix/package\-name\fR to the current folder\. +. +.P +With a parameters, link will create a symlink from the local \fBnode_modules\fR +folder to the global symlink\. +. +.P +When creating tarballs for \fBnpm publish\fR, the linked packages are +"snapshotted" to their current state by resolving the symbolic links\. +. +.P +This is +handy for installing your own stuff, so that you can work on it and test it +iteratively without having to continually rebuild\. +. +.P +For example: +. +.IP "" 4 +. +.nf +npm\.commands\.link(cb) # creates global link from the cwd + # (say redis package) +npm\.commands\.link(\'redis\', cb) # link\-install the package +. +.fi +. +.IP "" 0 +. +.P +Now, any changes to the redis package will be reflected in +the package in the current working directory diff --git a/deps/npm/man/man3/load.3 b/deps/npm/man/man3/load.3 new file mode 100644 index 0000000000..bb0bb029d9 --- /dev/null +++ b/deps/npm/man/man3/load.3 @@ -0,0 +1,44 @@ +.\" Generated with Ronnjs/v0.1 +.\" http://github.com/kapouer/ronnjs/ +. +.TH "NPM\-LOAD" "3" "November 2011" "" "" +. +.SH "NAME" +\fBnpm-load\fR \-\- Load config settings +. +.SH "SYNOPSIS" +. +.nf +npm\.load(conf, cb) +. +.fi +. +.SH "DESCRIPTION" +npm\.load() must be called before any other function call\. Both parameters are +optional, but the second is recommended\. +. +.P +The first parameter is an object hash of command\-line config params, and the +second parameter is a callback that will be called when npm is loaded and +ready to serve\. +. +.P +The first parameter should follow a similar structure as the package\.json +config object\. +. +.P +For example, to emulate the \-\-dev flag, pass an object that looks like this: +. +.IP "" 4 +. +.nf +{ + "dev": true +} +. +.fi +. +.IP "" 0 +. +.P +For a list of all the available command\-line configs, see \fBnpm help config\fR diff --git a/deps/npm/man/man3/ls.3 b/deps/npm/man/man3/ls.3 new file mode 100644 index 0000000000..3c733c9ded --- /dev/null +++ b/deps/npm/man/man3/ls.3 @@ -0,0 +1,79 @@ +.\" Generated with Ronnjs/v0.1 +.\" http://github.com/kapouer/ronnjs/ +. +.TH "NPM\-LS" "3" "November 2011" "" "" +. +.SH "NAME" +\fBnpm-ls\fR \-\- List installed packages +. +.SH "SYNOPSIS" +. +.nf +npm\.commands\.ls(args, [silent,] callback) +. +.fi +. +.SH "DESCRIPTION" +This command will print to stdout all the versions of packages that are +installed, as well as their dependencies, in a tree\-structure\. It will also +return that data using the callback\. +. +.P +This command does not take any arguments, but args must be defined\. +Beyond that, if any arguments are passed in, npm will politely warn that it +does not take positional arguments, though you may set config flags +like with any other command, such as \fBglobal\fR to list global packages\. +. +.P +It will print out extraneous, missing, and invalid packages\. +. +.P +If the silent parameter is set to true, nothing will be output to the screen, +but the data will still be returned\. +. +.SH "CONFIGURATION" +. +.SS "long" +. +.IP "\(bu" 4 +Default: false +. +.IP "\(bu" 4 +Type: Boolean +. +.IP "" 0 +. +.P +Show extended information\. +. +.SS "parseable" +. +.IP "\(bu" 4 +Default: false +. +.IP "\(bu" 4 +Type: Boolean +. +.IP "" 0 +. +.P +Show parseable output instead of tree view\. +. +.SS "global" +. +.IP "\(bu" 4 +Default: false +. +.IP "\(bu" 4 +Type: Boolean +. +.IP "" 0 +. +.P +List packages in the global install prefix instead of in the current +project\. +. +.P +Note, if parseable is set or long isn\'t set, then duplicates will be trimmed\. +This means that if a submodule a same dependency as a parent module, then the +dependency will only be output once\. diff --git a/deps/npm/man/man3/npm.3 b/deps/npm/man/man3/npm.3 new file mode 100644 index 0000000000..0e824f0d49 --- /dev/null +++ b/deps/npm/man/man3/npm.3 @@ -0,0 +1,160 @@ +.\" Generated with Ronnjs/v0.1 +.\" http://github.com/kapouer/ronnjs/ +. +.TH "NPM" "3" "November 2011" "" "" +. +.SH "NAME" +\fBnpm\fR \-\- node package manager +. +.SH "SYNOPSIS" +. +.nf +var npm = require("npm") +npm\.load(configObject, function (er, npm) { + // use the npm object, now that it\'s loaded\. + npm\.config\.set(key, val) + val = npm\.config\.get(key) + console\.log("prefix = %s", npm\.prefix) + npm\.commands\.install(["package"], cb) +}) +. +.fi +. +.SH "VERSION" +1.1.0-alpha-2 +. +.SH "DESCRIPTION" +This is the API documentation for npm\. +To find documentation of the command line +client, see \fBnpm help npm\fR\|\. +. +.P +Prior to using npm\'s commands, \fBnpm\.load()\fR must be called with an object hash of +top\-level configs\. In the npm command line client, +this set of configs is parsed from the command line options\. Additional +configuration params are loaded from two configuration files\. See \fBnpm help config\fR for more information\. +. +.P +After that, each of the functions are accessible in the +commands object: \fBnpm\.commands\.<cmd>\fR\|\. See \fBnpm help index\fR for a list of +all possible commands\. +. +.P +All commands on the command object take an \fBarray\fR of positional argument \fBstrings\fR\|\. The last argument to any function is a callback\. Some +commands take other optional arguments\. +. +.P +Configs cannot currently be set on a per function basis, as each call to +npm\.config\.set will change the value for \fIall\fR npm commands in that process\. +. +.P +To find API documentation for a specific command, run the \fBnpm apihelp\fR +command\. +. +.SH "METHODS AND PROPERTIES" +. +.IP "\(bu" 4 +\fBnpm\.load(configs, cb)\fR +. +.IP +Load the configuration params, and call the \fBcb\fR function once the +globalconfig and userconfig files have been loaded as well, or on +nextTick if they\'ve already been loaded\. +. +.IP "\(bu" 4 +\fBnpm\.config\fR +. +.IP +An object for accessing npm configuration parameters\. +. +.IP "\(bu" 4 +\fBnpm\.config\.get(key)\fR +. +.IP "\(bu" 4 +\fBnpm\.config\.set(key, val)\fR +. +.IP "\(bu" 4 +\fBnpm\.config\.del(key)\fR +. +.IP "" 0 + +. +.IP "\(bu" 4 +\fBnpm\.dir\fR or \fBnpm\.root\fR +. +.IP +The \fBnode_modules\fR directory where npm will operate\. +. +.IP "\(bu" 4 +\fBnpm\.prefix\fR +. +.IP +The prefix where npm is operating\. (Most often the current working +directory\.) +. +.IP "\(bu" 4 +\fBnpm\.cache\fR +. +.IP +The place where npm keeps JSON and tarballs it fetches from the +registry (or uploads to the registry)\. +. +.IP "\(bu" 4 +\fBnpm\.tmp\fR +. +.IP +npm\'s temporary working directory\. +. +.IP "\(bu" 4 +\fBnpm\.deref\fR +. +.IP +Get the "real" name for a command that has either an alias or +abbreviation\. +. +.IP "" 0 +. +.SH "MAGIC" +For each of the methods in the \fBnpm\.commands\fR hash, a method is added to +the npm object, which takes a set of positional string arguments rather +than an array and a callback\. +. +.P +If the last argument is a callback, then it will use the supplied +callback\. However, if no callback is provided, then it will print out +the error or results\. +. +.P +For example, this would work in a node repl: +. +.IP "" 4 +. +.nf +> npm = require("npm") +> npm\.load() // wait a sec\.\.\. +> npm\.install("dnode", "express") +. +.fi +. +.IP "" 0 +. +.P +Note that that \fIwon\'t\fR work in a node program, since the \fBinstall\fR +method will get called before the configuration load is completed\. +. +.SH "ABBREVS" +In order to support \fBnpm ins foo\fR instead of \fBnpm install foo\fR, the \fBnpm\.commands\fR object has a set of abbreviations as well as the full +method names\. Use the \fBnpm\.deref\fR method to find the real name\. +. +.P +For example: +. +.IP "" 4 +. +.nf +var cmd = npm\.deref("unp") // cmd === "unpublish" +. +.fi +. +.IP "" 0 + diff --git a/deps/npm/man/man3/outdated.3 b/deps/npm/man/man3/outdated.3 new file mode 100644 index 0000000000..adf0474f17 --- /dev/null +++ b/deps/npm/man/man3/outdated.3 @@ -0,0 +1,21 @@ +.\" Generated with Ronnjs/v0.1 +.\" http://github.com/kapouer/ronnjs/ +. +.TH "NPM\-OUTDATED" "3" "November 2011" "" "" +. +.SH "NAME" +\fBnpm-outdated\fR \-\- Check for outdated packages +. +.SH "SYNOPSIS" +. +.nf +npm\.commands\.outdated([packages,] callback) +. +.fi +. +.SH "DESCRIPTION" +This command will check the registry to see if the specified packages are +currently outdated\. +. +.P +If the \'packages\' parameter is left out, npm will check all packages\. diff --git a/deps/npm/man/man3/owner.3 b/deps/npm/man/man3/owner.3 new file mode 100644 index 0000000000..0f5d2c8c2f --- /dev/null +++ b/deps/npm/man/man3/owner.3 @@ -0,0 +1,52 @@ +.\" Generated with Ronnjs/v0.1 +.\" http://github.com/kapouer/ronnjs/ +. +.TH "NPM\-OWNER" "3" "November 2011" "" "" +. +.SH "NAME" +\fBnpm-owner\fR \-\- Manage package owners +. +.SH "SYNOPSIS" +. +.nf +npm\.commands\.owner(args, callback) +. +.fi +. +.SH "DESCRIPTION" +The first element of the \'args\' parameter defines what to do, and the subsequent +elements depend on the action\. Possible values for the action are (order of +parameters are given in parenthesis): +. +.IP "\(bu" 4 +ls (package): +List all the users who have access to modify a package and push new versions\. +Handy when you need to know who to bug for help\. +. +.IP "\(bu" 4 +add (user, package): +Add a new user as a maintainer of a package\. This user is enabled to modify +metadata, publish new versions, and add other owners\. +. +.IP "\(bu" 4 +rm (user, package): +Remove a user from the package owner list\. This immediately revokes their +privileges\. +. +.IP "" 0 +. +.P +Note that there is only one level of access\. Either you can modify a package, +or you can\'t\. Future versions may contain more fine\-grained access levels, but +that is not implemented at this time\. +. +.SH "SEE ALSO" +. +.IP "\(bu" 4 +npm apihelp publish +. +.IP "\(bu" 4 +npm help registry +. +.IP "" 0 + diff --git a/deps/npm/man/man3/pack.3 b/deps/npm/man/man3/pack.3 new file mode 100644 index 0000000000..2e0492c014 --- /dev/null +++ b/deps/npm/man/man3/pack.3 @@ -0,0 +1,28 @@ +.\" Generated with Ronnjs/v0.1 +.\" http://github.com/kapouer/ronnjs/ +. +.TH "NPM\-PACK" "3" "November 2011" "" "" +. +.SH "NAME" +\fBnpm-pack\fR \-\- Create a tarball from a package +. +.SH "SYNOPSIS" +. +.nf +npm\.commands\.pack([packages,] callback) +. +.fi +. +.SH "DESCRIPTION" +For anything that\'s installable (that is, a package folder, tarball, +tarball url, name@tag, name@version, or name), this command will fetch +it to the cache, and then copy the tarball to the current working +directory as \fB<name>\-<version>\.tgz\fR, and then write the filenames out to +stdout\. +. +.P +If the same package is specified multiple times, then the file will be +overwritten the second time\. +. +.P +If no arguments are supplied, then npm packs the current package folder\. diff --git a/deps/npm/man/man3/prefix.3 b/deps/npm/man/man3/prefix.3 new file mode 100644 index 0000000000..24b89ed587 --- /dev/null +++ b/deps/npm/man/man3/prefix.3 @@ -0,0 +1,24 @@ +.\" Generated with Ronnjs/v0.1 +.\" http://github.com/kapouer/ronnjs/ +. +.TH "NPM\-PREFIX" "3" "November 2011" "" "" +. +.SH "NAME" +\fBnpm-prefix\fR \-\- Display prefix +. +.SH "SYNOPSIS" +. +.nf +npm\.commands\.prefix(args, callback) +. +.fi +. +.SH "DESCRIPTION" +Print the prefix to standard out\. +. +.P +\'args\' is never used and callback is never called with data\. +\'args\' must be present or things will break\. +. +.P +This function is not useful programmatically diff --git a/deps/npm/man/man3/prune.3 b/deps/npm/man/man3/prune.3 new file mode 100644 index 0000000000..84f20e8e71 --- /dev/null +++ b/deps/npm/man/man3/prune.3 @@ -0,0 +1,27 @@ +.\" Generated with Ronnjs/v0.1 +.\" http://github.com/kapouer/ronnjs/ +. +.TH "NPM\-PRUNE" "3" "November 2011" "" "" +. +.SH "NAME" +\fBnpm-prune\fR \-\- Remove extraneous packages +. +.SH "SYNOPSIS" +. +.nf +npm\.commands\.prune([packages,] callback) +. +.fi +. +.SH "DESCRIPTION" +This command removes "extraneous" packages\. +. +.P +The first parameter is optional, and it specifies packages to be removed\. +. +.P +No packages are specified, then all packages will be checked\. +. +.P +Extraneous packages are packages that are not listed on the parent +package\'s dependencies list\. diff --git a/deps/npm/man/man3/publish.3 b/deps/npm/man/man3/publish.3 new file mode 100644 index 0000000000..ae8072851d --- /dev/null +++ b/deps/npm/man/man3/publish.3 @@ -0,0 +1,51 @@ +.\" Generated with Ronnjs/v0.1 +.\" http://github.com/kapouer/ronnjs/ +. +.TH "NPM\-PUBLISH" "3" "November 2011" "" "" +. +.SH "NAME" +\fBnpm-publish\fR \-\- Publish a package +. +.SH "SYNOPSIS" +. +.nf +npm\.commands\.publish([packages,] callback) +. +.fi +. +.SH "DESCRIPTION" +Publishes a package to the registry so that it can be installed by name\. +Possible values in the \'packages\' array are: +. +.IP "\(bu" 4 +\fB<folder>\fR: +A folder containing a package\.json file +. +.IP "\(bu" 4 +\fB<tarball>\fR: +A url or file path to a gzipped tar archive containing a single folder +with a package\.json file inside\. +. +.IP "" 0 +. +.P +If the package array is empty, npm will try to publish something in the +current working directory\. +. +.P +This command could fails if one of the packages specified already exists in +the registry\. Overwrites when the "force" environment variable is set\. +. +.SH "SEE ALSO" +. +.IP "\(bu" 4 +npm help registry +. +.IP "\(bu" 4 +npm help adduser +. +.IP "\(bu" 4 +npm apihelp owner +. +.IP "" 0 + diff --git a/deps/npm/man/man3/rebuild.3 b/deps/npm/man/man3/rebuild.3 new file mode 100644 index 0000000000..355924e7c2 --- /dev/null +++ b/deps/npm/man/man3/rebuild.3 @@ -0,0 +1,22 @@ +.\" Generated with Ronnjs/v0.1 +.\" http://github.com/kapouer/ronnjs/ +. +.TH "NPM\-REBUILD" "3" "November 2011" "" "" +. +.SH "NAME" +\fBnpm-rebuild\fR \-\- Rebuild a package +. +.SH "SYNOPSIS" +. +.nf +npm\.commands\.rebuild([packages,] callback) +. +.fi +. +.SH "DESCRIPTION" +This command runs the \fBnpm build\fR command on each of the matched packages\. This is useful +when you install a new version of node, and must recompile all your C++ addons with +the new binary\. If no \'packages\' parameter is specify, every package will be rebuilt\. +. +.SH "CONFIGURATION" +See \fBnpm help build\fR diff --git a/deps/npm/man/man3/restart.3 b/deps/npm/man/man3/restart.3 new file mode 100644 index 0000000000..78e53e2a95 --- /dev/null +++ b/deps/npm/man/man3/restart.3 @@ -0,0 +1,37 @@ +.\" Generated with Ronnjs/v0.1 +.\" http://github.com/kapouer/ronnjs/ +. +.TH "NPM\-RESTART" "3" "November 2011" "" "" +. +.SH "NAME" +\fBnpm-restart\fR \-\- Start a package +. +.SH "SYNOPSIS" +. +.nf +npm\.commands\.restart(packages, callback) +. +.fi +. +.SH "DESCRIPTION" +This runs a package\'s "restart" script, if one was provided\. +Otherwise it runs package\'s "stop" script, if one was provided, and then +the "start" script\. +. +.P +If no version is specified, then it restarts the "active" version\. +. +.P +npm can run tests on multiple packages\. Just specify multiple packages +in the \fBpackages\fR parameter\. +. +.SH "SEE ALSO" +. +.IP "\(bu" 4 +npm apihelp start +. +.IP "\(bu" 4 +npm apihelp stop +. +.IP "" 0 + diff --git a/deps/npm/man/man3/rm.3 b/deps/npm/man/man3/rm.3 new file mode 100644 index 0000000000..07baafa872 --- /dev/null +++ b/deps/npm/man/man3/rm.3 @@ -0,0 +1,25 @@ +.\" Generated with Ronnjs/v0.1 +.\" http://github.com/kapouer/ronnjs/ +. +.TH "NPM\-UNINSTALL" "3" "November 2011" "" "" +. +.SH "NAME" +\fBnpm-uninstall\fR \-\- uninstall a package programmatically +. +.SH "SYNOPSIS" +. +.nf +npm\.commands\.uninstall(packages, callback) +. +.fi +. +.SH "DESCRIPTION" +This acts much the same ways as uninstalling on the command\-line\. +. +.P +The \'packages\' parameter is an array of strings\. Each element in the array is +the name of a package to be uninstalled\. +. +.P +Finally, \'callback\' is a function that will be called when all packages have been +uninstalled or when an error has been encountered\. diff --git a/deps/npm/man/man3/root.3 b/deps/npm/man/man3/root.3 new file mode 100644 index 0000000000..b09b6feafd --- /dev/null +++ b/deps/npm/man/man3/root.3 @@ -0,0 +1,24 @@ +.\" Generated with Ronnjs/v0.1 +.\" http://github.com/kapouer/ronnjs/ +. +.TH "NPM\-ROOT" "3" "November 2011" "" "" +. +.SH "NAME" +\fBnpm-root\fR \-\- Display npm root +. +.SH "SYNOPSIS" +. +.nf +npm\.commands\.root(args, callback) +. +.fi +. +.SH "DESCRIPTION" +Print the effective \fBnode_modules\fR folder to standard out\. +. +.P +\'args\' is never used and callback is never called with data\. +\'args\' must be present or things will break\. +. +.P +This function is not useful programmatically\. diff --git a/deps/npm/man/man3/run-script.3 b/deps/npm/man/man3/run-script.3 new file mode 100644 index 0000000000..1810b6f107 --- /dev/null +++ b/deps/npm/man/man3/run-script.3 @@ -0,0 +1,48 @@ +.\" Generated with Ronnjs/v0.1 +.\" http://github.com/kapouer/ronnjs/ +. +.TH "NPM\-RUN\-SCRIPT" "3" "November 2011" "" "" +. +.SH "NAME" +\fBnpm-run-script\fR \-\- Run arbitrary package scripts +. +.SH "SYNOPSIS" +. +.nf +npm\.commands\.run\-script(args, callback) +. +.fi +. +.SH "DESCRIPTION" +This runs an arbitrary command from a package\'s "scripts" object\. +. +.P +It is used by the test, start, restart, and stop commands, but can be +called directly, as well\. +. +.P +The \'args\' parameter is an array of strings\. Behavior depends on the number +of elements\. If there is only one element, npm assumes that the element +represents a command to be run on the local repository\. If there is more than +one element, then the first is assumed to be the package and the second is +assumed to be the command to run\. All other elements are ignored\. +. +.SH "SEE ALSO" +. +.IP "\(bu" 4 +npm help scripts +. +.IP "\(bu" 4 +npm apihelp test +. +.IP "\(bu" 4 +npm apihelp start +. +.IP "\(bu" 4 +npm apihelp restart +. +.IP "\(bu" 4 +npm apihelp stop +. +.IP "" 0 + diff --git a/deps/npm/man/man3/search.3 b/deps/npm/man/man3/search.3 new file mode 100644 index 0000000000..eac7d20e3c --- /dev/null +++ b/deps/npm/man/man3/search.3 @@ -0,0 +1,64 @@ +.\" Generated with Ronnjs/v0.1 +.\" http://github.com/kapouer/ronnjs/ +. +.TH "NPM\-SEARCH" "3" "November 2011" "" "" +. +.SH "NAME" +\fBnpm-search\fR \-\- Search for packages +. +.SH "SYNOPSIS" +. +.nf +npm\.commands\.search(searchTerms, [silent,] [staleness,] callback) +. +.fi +. +.SH "DESCRIPTION" +Search the registry for packages matching the search terms\. The available parameters are: +. +.IP "\(bu" 4 +searchTerms: +Array of search terms\. These terms are case\-insensitive\. +. +.IP "\(bu" 4 +silent: +If true, npm will not log anything to the console\. +. +.IP "\(bu" 4 +staleness: +This is the threshold for stale packages\. "Fresh" packages are not refreshed +from the registry\. This value is measured in seconds\. +. +.IP "\(bu" 4 +callback: +Returns an object where each key is the name of a package, and the value +is information about that package along with a \'words\' property, which is +a space\-delimited string of all of the interesting words in that package\. +The only properties included are those that are searched, which generally include: +. +.IP "\(bu" 4 +name +. +.IP "\(bu" 4 +description +. +.IP "\(bu" 4 +maintainers +. +.IP "\(bu" 4 +url +. +.IP "\(bu" 4 +keywords +. +.IP "" 0 + +. +.IP "" 0 +. +.P +A search on the registry excludes any result that does not match all of the +search terms\. It also removes any items from the results that contain an +excluded term (the "searchexclude" config)\. The search is case insensitive +and doesn\'t try to read your mind (it doesn\'t do any verb tense matching or the +like)\. diff --git a/deps/npm/man/man3/set.3 b/deps/npm/man/man3/set.3 new file mode 100644 index 0000000000..548f4bb9c6 --- /dev/null +++ b/deps/npm/man/man3/set.3 @@ -0,0 +1,69 @@ +.\" Generated with Ronnjs/v0.1 +.\" http://github.com/kapouer/ronnjs/ +. +.TH "NPM\-CONFIG" "3" "November 2011" "" "" +. +.SH "NAME" +\fBnpm-config\fR \-\- Manage the npm configuration files +. +.SH "SYNOPSIS" +. +.nf +npm\.commands\.config(args, callback) +var val = npm\.config\.get(key) +npm\.config\.set(key, val) +. +.fi +. +.SH "DESCRIPTION" +This function acts much the same way as the command\-line version\. The first +element in the array tells config what to do\. Possible values are: +. +.IP "\(bu" 4 +\fBset\fR +. +.IP +Sets a config parameter\. The second element in \fBargs\fR is interpreted as the +key, and the third element is interpreted as the value\. +. +.IP "\(bu" 4 +\fBget\fR +. +.IP +Gets the value of a config parameter\. The second element in \fBargs\fR is the +key to get the value of\. +. +.IP "\(bu" 4 +\fBdelete\fR (\fBrm\fR or \fBdel\fR) +. +.IP +Deletes a parameter from the config\. The second element in \fBargs\fR is the +key to delete\. +. +.IP "\(bu" 4 +\fBlist\fR (\fBls\fR) +. +.IP +Show all configs that aren\'t secret\. No parameters necessary\. +. +.IP "\(bu" 4 +\fBedit\fR: +. +.IP +Opens the config file in the default editor\. This command isn\'t very useful +programmatically, but it is made available\. +. +.IP "" 0 +. +.P +To programmatically access npm configuration settings, or set them for +the duration of a program, use the \fBnpm\.config\.set\fR and \fBnpm\.config\.get\fR +functions instead\. +. +.SH "SEE ALSO" +. +.IP "\(bu" 4 +npm apihelp npm +. +.IP "" 0 + diff --git a/deps/npm/man/man3/start.3 b/deps/npm/man/man3/start.3 new file mode 100644 index 0000000000..333c956407 --- /dev/null +++ b/deps/npm/man/man3/start.3 @@ -0,0 +1,21 @@ +.\" Generated with Ronnjs/v0.1 +.\" http://github.com/kapouer/ronnjs/ +. +.TH "NPM\-START" "3" "November 2011" "" "" +. +.SH "NAME" +\fBnpm-start\fR \-\- Start a package +. +.SH "SYNOPSIS" +. +.nf +npm\.commands\.start(packages, callback) +. +.fi +. +.SH "DESCRIPTION" +This runs a package\'s "start" script, if one was provided\. +. +.P +npm can run tests on multiple packages\. Just specify multiple packages +in the \fBpackages\fR parameter\. diff --git a/deps/npm/man/man3/stop.3 b/deps/npm/man/man3/stop.3 new file mode 100644 index 0000000000..cd6be16f09 --- /dev/null +++ b/deps/npm/man/man3/stop.3 @@ -0,0 +1,21 @@ +.\" Generated with Ronnjs/v0.1 +.\" http://github.com/kapouer/ronnjs/ +. +.TH "NPM\-STOP" "3" "November 2011" "" "" +. +.SH "NAME" +\fBnpm-stop\fR \-\- Stop a package +. +.SH "SYNOPSIS" +. +.nf +npm\.commands\.stop(packages, callback) +. +.fi +. +.SH "DESCRIPTION" +This runs a package\'s "stop" script, if one was provided\. +. +.P +npm can run stop on multiple packages\. Just specify multiple packages +in the \fBpackages\fR parameter\. diff --git a/deps/npm/man/man3/submodule.3 b/deps/npm/man/man3/submodule.3 new file mode 100644 index 0000000000..06db2b7d8a --- /dev/null +++ b/deps/npm/man/man3/submodule.3 @@ -0,0 +1,42 @@ +.\" Generated with Ronnjs/v0.1 +.\" http://github.com/kapouer/ronnjs/ +. +.TH "NPM\-SUBMODULE" "3" "November 2011" "" "" +. +.SH "NAME" +\fBnpm-submodule\fR \-\- Add a package as a git submodule +. +.SH "SYNOPSIS" +. +.nf +npm\.commands\.submodule(packages, callback) +. +.fi +. +.SH "DESCRIPTION" +For each package specified, npm will check if it has a git repository url +in its package\.json description then add it as a git submodule at \fBnode_modules/<pkg name>\fR\|\. +. +.P +This is a convenience only\. From then on, it\'s up to you to manage +updates by using the appropriate git commands\. npm will stubbornly +refuse to update, modify, or remove anything with a \fB\|\.git\fR subfolder +in it\. +. +.P +This command also does not install missing dependencies, if the package +does not include them in its git repository\. If \fBnpm ls\fR reports that +things are missing, you can either install, link, or submodule them yourself, +or you can do \fBnpm explore <pkgname> \-\- npm install\fR to install the +dependencies into the submodule folder\. +. +.SH "SEE ALSO" +. +.IP "\(bu" 4 +npm help json +. +.IP "\(bu" 4 +git help submodule +. +.IP "" 0 + diff --git a/deps/npm/man/man3/tag.3 b/deps/npm/man/man3/tag.3 new file mode 100644 index 0000000000..ef1d80c563 --- /dev/null +++ b/deps/npm/man/man3/tag.3 @@ -0,0 +1,31 @@ +.\" Generated with Ronnjs/v0.1 +.\" http://github.com/kapouer/ronnjs/ +. +.TH "NPM\-TAG" "3" "November 2011" "" "" +. +.SH "NAME" +\fBnpm-tag\fR \-\- Tag a published version +. +.SH "SYNOPSIS" +. +.nf +npm\.commands\.tag(package@version, tag, callback) +. +.fi +. +.SH "DESCRIPTION" +Tags the specified version of the package with the specified tag, or the \fB\-\-tag\fR config if not specified\. +. +.P +The \'package@version\' is an array of strings, but only the first two elements are +currently used\. +. +.P +The first element must be in the form package@version, where package +is the package name and version is the version number (much like installing a +specific version)\. +. +.P +The second element is the name of the tag to tag this version with\. If this +parameter is missing or falsey (empty), the default froom the config will be +used\. For more information about how to set this config, check \fBman 3 npm\-config\fR for programmatic usage or \fBman npm\-config\fR for cli usage\. diff --git a/deps/npm/man/man3/test.3 b/deps/npm/man/man3/test.3 new file mode 100644 index 0000000000..a7dd970926 --- /dev/null +++ b/deps/npm/man/man3/test.3 @@ -0,0 +1,25 @@ +.\" Generated with Ronnjs/v0.1 +.\" http://github.com/kapouer/ronnjs/ +. +.TH "NPM\-TEST" "3" "November 2011" "" "" +. +.SH "NAME" +\fBnpm-test\fR \-\- Test a package +. +.SH "SYNOPSIS" +. +.nf + npm\.commands\.test(packages, callback) +. +.fi +. +.SH "DESCRIPTION" +This runs a package\'s "test" script, if one was provided\. +. +.P +To run tests as a condition of installation, set the \fBnpat\fR config to +true\. +. +.P +npm can run tests on multiple packages\. Just specify multiple packages +in the \fBpackages\fR parameter\. diff --git a/deps/npm/man/man3/uninstall.3 b/deps/npm/man/man3/uninstall.3 new file mode 100644 index 0000000000..07baafa872 --- /dev/null +++ b/deps/npm/man/man3/uninstall.3 @@ -0,0 +1,25 @@ +.\" Generated with Ronnjs/v0.1 +.\" http://github.com/kapouer/ronnjs/ +. +.TH "NPM\-UNINSTALL" "3" "November 2011" "" "" +. +.SH "NAME" +\fBnpm-uninstall\fR \-\- uninstall a package programmatically +. +.SH "SYNOPSIS" +. +.nf +npm\.commands\.uninstall(packages, callback) +. +.fi +. +.SH "DESCRIPTION" +This acts much the same ways as uninstalling on the command\-line\. +. +.P +The \'packages\' parameter is an array of strings\. Each element in the array is +the name of a package to be uninstalled\. +. +.P +Finally, \'callback\' is a function that will be called when all packages have been +uninstalled or when an error has been encountered\. diff --git a/deps/npm/man/man3/unpublish.3 b/deps/npm/man/man3/unpublish.3 new file mode 100644 index 0000000000..084023ebd8 --- /dev/null +++ b/deps/npm/man/man3/unpublish.3 @@ -0,0 +1,30 @@ +.\" Generated with Ronnjs/v0.1 +.\" http://github.com/kapouer/ronnjs/ +. +.TH "NPM\-UNPUBLISH" "3" "November 2011" "" "" +. +.SH "NAME" +\fBnpm-unpublish\fR \-\- Remove a package from the registry +. +.SH "SYNOPSIS" +. +.nf +npm\.commands\.unpublish(package, callback) +. +.fi +. +.SH "DESCRIPTION" +This removes a package version from the registry, deleting its +entry and removing the tarball\. +. +.P +The package parameter must be defined\. +. +.P +Only the first element in the package parameter is used\. If there is no first +element, then npm assumes that the package at the current working directory +is what is meant\. +. +.P +If no version is specified, or if all versions are removed then +the root package entry is removed from the registry entirely\. diff --git a/deps/npm/man/man3/update.3 b/deps/npm/man/man3/update.3 new file mode 100644 index 0000000000..7af18944dd --- /dev/null +++ b/deps/npm/man/man3/update.3 @@ -0,0 +1,18 @@ +.\" Generated with Ronnjs/v0.1 +.\" http://github.com/kapouer/ronnjs/ +. +.TH "NPM\-UPDATE" "3" "November 2011" "" "" +. +.SH "NAME" +\fBnpm-update\fR \-\- Update a package +. +.SH "SYNOPSIS" +. +.nf +npm\.commands\.update(packages, callback) +. +.fi +Updates a package, upgrading it to the latest version\. It also installs any missing packages\. +. +.P +The \'packages\' argument is an array of packages to update\. The \'callback\' parameter will be called when done or when an error occurs\. diff --git a/deps/npm/man/man3/version.3 b/deps/npm/man/man3/version.3 new file mode 100644 index 0000000000..a3df59f13a --- /dev/null +++ b/deps/npm/man/man3/version.3 @@ -0,0 +1,27 @@ +.\" Generated with Ronnjs/v0.1 +.\" http://github.com/kapouer/ronnjs/ +. +.TH "NPM\-VERSION" "3" "November 2011" "" "" +. +.SH "NAME" +\fBnpm-version\fR \-\- Bump a package version +. +.SH "SYNOPSIS" +. +.nf +npm\.commands\.version(newversion, callback) +. +.fi +. +.SH "DESCRIPTION" +Run this in a package directory to bump the version and write the new +data back to the package\.json file\. +. +.P +If run in a git repo, it will also create a version commit and tag, and +fail if the repo is not clean\. +. +.P +Like all other commands, this function takes a string array as its first +parameter\. The difference, however, is this function will fail if it does +not have exactly one element\. The only element should be a version number\. diff --git a/deps/npm/man/man3/view.3 b/deps/npm/man/man3/view.3 new file mode 100644 index 0000000000..fb33574c17 --- /dev/null +++ b/deps/npm/man/man3/view.3 @@ -0,0 +1,176 @@ +.\" Generated with Ronnjs/v0.1 +.\" http://github.com/kapouer/ronnjs/ +. +.TH "NPM\-VIEW" "3" "November 2011" "" "" +. +.SH "NAME" +\fBnpm-view\fR \-\- View registry info +. +.SH "SYNOPSIS" +. +.nf +npm\.commands\.view(args, [silent,] callback) +. +.fi +. +.SH "DESCRIPTION" +This command shows data about a package and prints it to the stream +referenced by the \fBoutfd\fR config, which defaults to stdout\. +. +.P +The "args" parameter is an ordered list that closely resembles the command\-line +usage\. The elements should be ordered such that the first element is +the package and version (package@version)\. The version is optional\. After that, +the rest of the parameters are fields with optional subfields ("field\.subfield") +which can be used to get only the information desired from the registry\. +. +.P +The callback will be passed all of the data returned by the query\. +. +.P +For example, to get the package registry entry for the \fBconnect\fR package, +you can do this: +. +.IP "" 4 +. +.nf +npm\.commands\.view(["connect"], callback) +. +.fi +. +.IP "" 0 +. +.P +If no version is specified, "latest" is assumed\. +. +.P +Field names can be specified after the package descriptor\. +For example, to show the dependencies of the \fBronn\fR package at version +0\.3\.5, you could do the following: +. +.IP "" 4 +. +.nf +npm\.commands\.view(["ronn@0\.3\.5", "dependencies"], callback) +. +.fi +. +.IP "" 0 +. +.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: +. +.IP "" 4 +. +.nf +npm\.commands\.view(["npm", "repository\.url"], callback) +. +.fi +. +.IP "" 0 +. +.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: +. +.IP "" 4 +. +.nf +npm\.commands\.view(["express", "contributors\.email"], callback) +. +.fi +. +.IP "" 0 +. +.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: +. +.IP "" 4 +. +.nf +npm\.commands\.view(["express", "contributors[0]\.email"], callback) +. +.fi +. +.IP "" 0 +. +.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: +. +.IP "" 4 +. +.nf +npm\.commands\.view(["express", "contributors\.name", "contributors\.email"], callback) +. +.fi +. +.IP "" 0 +. +.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 \fBnpm help json\fR for more on this\.) +. +.IP "" 4 +. +.nf +npm\.commands\.view(["npm", "contributors"], callback) +. +.fi +. +.IP "" 0 +. +.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: +. +.IP "" 4 +. +.nf +npm\.commands\.view(["yui3@\'>0\.5\.4\'", "dependencies\.jsdom"], callback) +. +.fi +. +.IP "" 0 +. +.SH "OUTPUT" +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\. +. +.P +If the version range matches multiple versions, than each printed value +will be prefixed with the version it applies to\. +. +.P +If multiple fields are requested, than each of them are prefixed with +the field name\. +. +.P +Console output can be disabled by setting the \'silent\' parameter to true\. +. +.SH "RETURN VALUE" +The data returned will be an object in this formation: +. +.IP "" 4 +. +.nf +{ <version>: + { <field>: <value> + , \.\.\. } +, \.\.\. } +. +.fi +. +.IP "" 0 +. +.P +corresponding to the list of fields selected\. diff --git a/deps/npm/man/man3/whoami.3 b/deps/npm/man/man3/whoami.3 new file mode 100644 index 0000000000..84b2813da5 --- /dev/null +++ b/deps/npm/man/man3/whoami.3 @@ -0,0 +1,24 @@ +.\" Generated with Ronnjs/v0.1 +.\" http://github.com/kapouer/ronnjs/ +. +.TH "NPM\-WHOAMI" "3" "November 2011" "" "" +. +.SH "NAME" +\fBnpm-whoami\fR \-\- Display npm username +. +.SH "SYNOPSIS" +. +.nf +npm\.commands\.whoami(args, callback) +. +.fi +. +.SH "DESCRIPTION" +Print the \fBusername\fR config to standard output\. +. +.P +\'args\' is never used and callback is never called with data\. +\'args\' must be present or things will break\. +. +.P +This function is not useful programmatically |