mirror of https://github.com/jorgebucaran/fisher
You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
228 lines
4.9 KiB
Groff
228 lines
4.9 KiB
Groff
.\" generated with Ronn/v0.7.3
|
|
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
|
.
|
|
.TH "FISHER\-SEARCH" "1" "January 2016" "" "fisherman"
|
|
.
|
|
.SH "NAME"
|
|
\fBfisher\-search\fR \- Search Plugin Index
|
|
.
|
|
.SH "SYNOPSIS"
|
|
fisher \fBsearch\fR [\fIplugins\fR \.\.\.]
|
|
.
|
|
.br
|
|
fisher \fBsearch\fR [\fB\-\-select\fR=\fIall\fR|\fIcache\fR|\fIremote\fR]
|
|
.
|
|
.br
|
|
fisher \fBsearch\fR [\fB\-\-field\fR=\fIname\fR|\fIurl\fR|\fIinfo\fR|\fItag\fR|\fIauthor\fR]
|
|
.
|
|
.br
|
|
fisher \fBsearch\fR [\fB\-\-\fR\fIfield[\fR=\fImatch\fR]]
|
|
.
|
|
.br
|
|
fisher \fBsearch\fR [\fB\-\-\fR\fIfield\fR~\fB/\fR\fIregex\fR\fB/\fR]
|
|
.
|
|
.br
|
|
fisher \fBsearch\fR [\fB\-\-query\fR=\fIfield\fR[\fB&&\fR,\fB||\fR]\fIfield\fR\.\.\.]
|
|
.
|
|
.br
|
|
fisher \fBsearch\fR [\fB\-\-and\fR] [\fB\-\-or\fR] [\fB\-\-quiet\fR] [\fB\-\-help\fR]
|
|
.
|
|
.br
|
|
.
|
|
.SH "USAGE"
|
|
fisher \fBsearch\fR \fIplugin\fR
|
|
.
|
|
.br
|
|
fisher \fBsearch\fR \fIowner/repo\fR
|
|
.
|
|
.br
|
|
.
|
|
.SH "DESCRIPTION"
|
|
Search the Fisherman index database\. You can use a custom index file by setting \fB$fisher_index\fR to your preferred URL or file\. See \fBfisher help config\fR and \fIIndex\fR in \fBfisher help tour\fR\.
|
|
.
|
|
.P
|
|
A copy of the index is downloaded every time a search query happens, keeping the index up to date all the time\.
|
|
.
|
|
.P
|
|
The index file consists of records separated by blank lines \fB\'\en\en\'\fR and each record consists of fields separated by a single line \fB\'\en\'\fR\.
|
|
.
|
|
.P
|
|
For example:
|
|
.
|
|
.IP "" 4
|
|
.
|
|
.nf
|
|
|
|
name
|
|
url
|
|
info
|
|
tag1 tag2 tag3 \.\.\.
|
|
author
|
|
.
|
|
.fi
|
|
.
|
|
.IP "" 0
|
|
.
|
|
.P
|
|
See \fIOutput\fR for more information\.
|
|
.
|
|
.SH "OPTIONS"
|
|
.
|
|
.TP
|
|
\fB\-s \-\-select[=all|cache|remote]\fR
|
|
Select the record source\. \-\-select=\fIcache\fR queries only local plugins, i\.e\., those inside \fB$fisher_cache\fR\. \-\-select=\fIremote\fR queries all plugins not in the cache, i\.e, those available to install\. \-\-select=\fIall\fR queries everything\.
|
|
.
|
|
.TP
|
|
\fB\-f \-\-field=name|url|info|tag|author\fR
|
|
Display only the given fields from the selected records\. Use \-\-\fIfield\fR as a shortcut for \-\-field=\fIfield\fR\. For example \fBfisher search \-\-url\fR will display only the URLs for
|
|
.
|
|
.TP
|
|
\fB\-\-field[=match]\fR
|
|
Filter the result set by \fIfield\fR=\fImatch\fR, where \fIfield\fR can be one or more of \fBname\fR, \fBurl\fR, \fBinfo\fR, \fBtag\fR or \fBauthor\fR\. If \fImatch\fR is not given, this is equivalent to \-\-select=\fIfield\fR\. Use \fB!=\fR to negate the query\.
|
|
.
|
|
.TP
|
|
\fB\-\-field[~/regex/]\fR
|
|
Essentially the same as \-\-\fIfield\fR=\fImatch\fR, but with Regular Expression support\. \-\-\fIfield\fR~/\fIregex\fR/ filters the result set using the given /\fIregex\fR/\. For example, \-\-name=/^\fImatch\fR$/ is the same as \-\-\fIfield\fR=\fImatch\fR and \-\-url~/oh\-my\-fish/ selects only oh\-my\-fish plugins\. Use \fB!~\fR to negate the query\.
|
|
.
|
|
.TP
|
|
\fB\-a \-\-and\fR
|
|
Join query with the logical AND operator\.
|
|
.
|
|
.TP
|
|
\fB\-o \-\-or\fR
|
|
Join query with the logical OR operator\. This the default operator for each query\.
|
|
.
|
|
.TP
|
|
\fB\-Q \-\-query=field[&&,||]field\.\.\.\fR
|
|
Use a custom search expression\. For example, \fB\-\-query=name~/[0\-9]/||name~/^[xyz]/\fR selects all plugins that contain numbers in their name \fIor\fR begin with the characters \fIx\fR, \fIy\fR or \fIz\fR\.
|
|
.
|
|
.TP
|
|
\fB\-q \-\-quiet\fR
|
|
Enable quiet mode\.
|
|
.
|
|
.TP
|
|
\fB\-h \-\-search\fR
|
|
Show help\.
|
|
.
|
|
.SH "OUTPUT"
|
|
The default behavior is to print the result set to standard output in their original format\.
|
|
.
|
|
.IP "" 4
|
|
.
|
|
.nf
|
|
|
|
fisher search shark
|
|
shark
|
|
https://github\.com/bucaran/shark
|
|
Sparkline Generator
|
|
chart tool
|
|
bucaran
|
|
.
|
|
.fi
|
|
.
|
|
.IP "" 0
|
|
.
|
|
.P
|
|
Search is optimized for parsing when using the filters: \fB\-\-name\fR, \fB\-\-url\fR, \fB\-\-info\fR, \fB\-\-tags\fR, \fB\-\-author\fR or \fB\-\-field=name|url|info|tag|author\fR\.
|
|
.
|
|
.IP "" 4
|
|
.
|
|
.nf
|
|
|
|
fisher search shark \-\-name \-\-url
|
|
|
|
shark;https://github\.com/bucaran/shark
|
|
.
|
|
.fi
|
|
.
|
|
.IP "" 0
|
|
.
|
|
.P
|
|
The result set above consists of single line \fB\'\en\'\fR separated records, and each record consists of one or more of the given fields separated by a semicolon \fB\';\'\fR\.
|
|
.
|
|
.SH "EXAMPLES"
|
|
.
|
|
.IP "\(bu" 4
|
|
Display all plugins by name and format into multiple columns\.
|
|
.
|
|
.IP "" 0
|
|
.
|
|
.IP "" 4
|
|
.
|
|
.nf
|
|
|
|
fisher search \-\-name | column
|
|
.
|
|
.fi
|
|
.
|
|
.IP "" 0
|
|
.
|
|
.IP "\(bu" 4
|
|
Display all plugins by URL, sans \fIhttps://github\.com/\fR and format into multiple columns\.
|
|
.
|
|
.IP "" 0
|
|
.
|
|
.IP "" 4
|
|
.
|
|
.nf
|
|
|
|
fisher search \-\-field=url \-\-select=all | sed \'s|https://github\.com/||\' | column
|
|
.
|
|
.fi
|
|
.
|
|
.IP "" 0
|
|
.
|
|
.IP "\(bu" 4
|
|
Display all remote plugins by name tagged as \fIa\fR or \fIb\fR\.
|
|
.
|
|
.IP "" 0
|
|
.
|
|
.IP "" 4
|
|
.
|
|
.nf
|
|
|
|
fisher search \-\-select=remote \-\-name \-\-tag=github \-\-or \-\-tag=tool
|
|
.
|
|
.fi
|
|
.
|
|
.IP "" 0
|
|
.
|
|
.IP "\(bu" 4
|
|
Search plugins from a list of one or more urls and / or names and display their authors\.
|
|
.
|
|
.IP "" 0
|
|
.
|
|
.IP "" 4
|
|
.
|
|
.nf
|
|
|
|
fisher search $urls $names \-\-url
|
|
.
|
|
.fi
|
|
.
|
|
.IP "" 0
|
|
.
|
|
.IP "\(bu" 4
|
|
Search all plugins in the cache whose name does not start with the letter \fBs\fR\.
|
|
.
|
|
.IP "" 0
|
|
.
|
|
.IP "" 4
|
|
.
|
|
.nf
|
|
|
|
fisher search \-\-select=cache \-\-name~/^[^s]/
|
|
.
|
|
.fi
|
|
.
|
|
.IP "" 0
|
|
.
|
|
.SH "SEE ALSO"
|
|
fisher(1)
|
|
.
|
|
.br
|
|
fisher help plugins
|
|
.
|
|
.br
|
|
|