X-Git-Url: https://gerrit.simantics.org/r/gitweb?a=blobdiff_plain;f=org.simantics.maps.server%2Fnode%2Fnode-v4.8.0-win-x64%2Fnode_modules%2Fnpm%2Fman%2Fman3%2Fnpm-help-search.3;fp=org.simantics.maps.server%2Fnode%2Fnode-v4.8.0-win-x64%2Fnode_modules%2Fnpm%2Fman%2Fman3%2Fnpm-help-search.3;h=d9ff3c21f5a09ef237b5f4a42fa3028c9daa5776;hb=2529be6d456deeb07c128603ce4971f1dc29b695;hp=0000000000000000000000000000000000000000;hpb=2636fc31c16c23711cf2b06a4ae8537bba9c1d35;p=simantics%2Fdistrict.git diff --git a/org.simantics.maps.server/node/node-v4.8.0-win-x64/node_modules/npm/man/man3/npm-help-search.3 b/org.simantics.maps.server/node/node-v4.8.0-win-x64/node_modules/npm/man/man3/npm-help-search.3 new file mode 100644 index 00000000..d9ff3c21 --- /dev/null +++ b/org.simantics.maps.server/node/node-v4.8.0-win-x64/node_modules/npm/man/man3/npm-help-search.3 @@ -0,0 +1,41 @@ +.TH "NPM\-HELP\-SEARCH" "3" "October 2016" "" "" +.SH "NAME" +\fBnpm-help-search\fR \- Search the help pages +.SH SYNOPSIS +.P +.RS 2 +.nf +npm\.commands\.helpSearch(args, [silent,] callback) +.fi +.RE +.SH DESCRIPTION +.P +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: +.RS 0 +.IP \(bu 2 +hits: +A map of args to number of hits on that arg\. For example, {"npm": 3} +.IP \(bu 2 +found: +Total number of unique args that matched\. +.IP \(bu 2 +totalHits: +Total number of hits\. +.IP \(bu 2 +lines: +An array of all matching lines (and some adjacent lines)\. +.IP \(bu 2 +file: +Name of the file that matched + +.RE +.P +The silent parameter is not necessary not used, but it may in the future\. +