summaryrefslogtreecommitdiff
path: root/deps/npm/man/man3/search.3
diff options
context:
space:
mode:
authorisaacs <i@izs.me>2011-11-26 09:21:03 -0800
committerisaacs <i@izs.me>2011-11-27 13:09:04 -0800
commite85a95dfa3469dd9cc6a3a15c8e686c14b3238a6 (patch)
tree85a3a6e0f45f4b6540dcb75af2e9383db0f6e4c3 /deps/npm/man/man3/search.3
parentfc0a4c2781b4b579d247a24393dada7f92663abe (diff)
downloadnode-new-e85a95dfa3469dd9cc6a3a15c8e686c14b3238a6.tar.gz
Remove npm's .gitignore, add generated docs
Diffstat (limited to 'deps/npm/man/man3/search.3')
-rw-r--r--deps/npm/man/man3/search.364
1 files changed, 64 insertions, 0 deletions
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)\.