fisher/man/man1/fisher-search.1
Jorge Bucaran ebec1eaa01
Fisherman 1.0 RC
* Deprecate fisher --list in favor of a new command fisher list.
  The behavior is roughly the same. See fisher help list for
  usage. tl;dr: Use list to query the local system / cache and
  search to query the index.

* Teach fisher_plugin_walk about fish_postexec,
  fish_command_not_found and fish_preexec event emitters and
  erase them during uninstall if they were defined in a snippet.

* Fisherman now recognizes the following aliases by default:
  i for install, u for update, l for list, s for search and h
  for help.

* Large documentation rewrite. Better, simpler, more concise
  and more consistent.

* Fisherman now detects if users have modified their fish
  prompt using fish_config and if so, uninstalls $fisher_prompt.
2016-02-29 23:13:29 +09:00

228 lines
3.7 KiB
Groff

.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "FISHER\-SEARCH" "1" "February 2016" "" "fisherman"
.
.SH "NAME"
\fBfisher\-search\fR \- Search plugin index
.
.SH "SYNOPSIS"
fisher search [\fIplugins\fR \.\.\.]
.
.br
fisher search [\-\-name|\-\-url|\-\-info|\-\-tag|\-\-author]
.
.br
fisher search [\-\-and] [\-\-or] [\-\-quiet] [\-\-help]
.
.br
fisher search [\-\-long|\-\-full] [\-\-no\-color]
.
.br
fisher search [\-\-query=\fIfield\fR[&&,||]\fIfield\fR\.\.\.]
.
.br
.
.SH "USAGE"
fisher search \fIurl\fR
.
.br
fisher search \fIname\fR
.
.br
fisher search \fIowner/repo\fR
.
.br
fisher search \fIquery\fR
.
.br
.
.SH "DESCRIPTION"
Search plugins in the Fisherman index\.
.
.IP "" 4
.
.nf
fisher search
\.\.\.
* debug Conditional debug logger
errno POSIX error code/string translator
* fishtape TAP producing test runner
flash Flash\-inspired, thunder prompt
fzf Efficient keybindings for fzf
get Press any key to continue
\.\.\.
> shellder Powerline prompt optimized for speed
\.\.\.
.
.fi
.
.IP "" 0
.
.P
Get detailed information about a plugin\.
.
.IP "" 4
.
.nf
fisher search shellder
> shellder by simnalamburt
Powerline prompt optimized for speed
github\.com/simnalamburt/shellder
.
.fi
.
.IP "" 0
.
.P
Search plugins using tags\.
.
.IP "" 4
.
.nf
fisher search \-\-tag={git,test}
\.\.\.
* fishtape TAP producing test runner
git\-branch\-name Get the name of the current Git branch
git\-is\-repo Test if the current directory is a Git repo
git\-is\-dirty Test if there are changes not staged for commit
git\-is\-stashed Test if there are changes in the stash
\.\.\.
.
.fi
.
.IP "" 0
.
.P
The legend consists of:
.
.P
\fB*\fR Indicate the plugin is currently installed
.
.br
\fB>\fR Indicate the plugin is a prompt
.
.br
\fB@\fR Indicate the plugin is a symbolic link
.
.br
.
.SH "OPTIONS"
.
.TP
\-\-\fIfield\fR[=\fImatch\fR]
Display index records where \fIfield\fR equals \fImatch\fR\. \fIfield\fR can be any of name, url, info, tag/s or author\. If \fImatch\fR is not given, display only the given \fIfield\fR from every record in the index\. Use != to negate the query\.
.
.TP
\-\-\fIfield\fR[~/regex/]
Same as \-\-\fIfield\fR[=\fImatch\fR], but using Regular Expressions\. Use !~ to negate the query\.
.
.TP
\-\-long
Display results in long format\.
.
.TP
\-\-full
Display results in full format\.
.
.TP
\-\-no\-color
Turn off color display\.
.
.TP
\-a, \-\-and
Join the query with a logical AND operator\.
.
.TP
\-o, \-\-or
Join the query with a logical OR operator\. This is the default operator\.
.
.TP
\-q, \-\-quiet
Enable quiet mode\.
.
.TP
\-h, \-\-help
Show help\.
.
.SH "RESULTS"
Search prints results records in the same line, when using one or more of the following options: \-\-name, \-\-url, \-\-info, \-\-tags, \-\-author\. This allows you to parse search results easily\.
.
.IP "" 4
.
.nf
fisher search shark \-\-name \-\-url \-\-author
shark;https://github\.com/fishery/shark;bucaran
.
.fi
.
.IP "" 0
.
.SH "EXAMPLES"
.
.IP "\(bu" 4
Display plugins by name and format the result into multiple columns\.
.
.IP "" 0
.
.IP "" 4
.
.nf
fisher search \-\-name | column
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
Display plugins by URL, remove \fIhttps://github\.com/\fR and format into multiple columns\.
.
.IP "" 0
.
.IP "" 4
.
.nf
fisher search \-\-url | sed \'s|https://github\.com/||\' | column
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
Display remote plugins, i\.e, those in the index, but \fInot\fR in the cache\.
.
.IP "" 0
.
.IP "" 4
.
.nf
fisher search \-\-and \-\-name!=(fisher \-\-list=bare)
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
Search all plugins whose name does not start with the letter s\.
.
.IP "" 0
.
.IP "" 4
.
.nf
fisher search \-\-name!~/^s/
.
.fi
.
.IP "" 0