fisher/man/man1/fisher.1

128 lines
2.5 KiB
Groff

.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "FISHER" "1" "February 2016" "" "fisherman"
.
.SH "NAME"
\fBfisher\fR \- Fish Plugin Manager
.
.SH "SYNOPSIS"
\fBfisher\fR \fIcommand\fR [\fIoptions\fR] [\fB\-\-version\fR] [\fB\-\-help\fR]
.
.br
\fBfisher\fR \fB\-\-list=cache|enabled|disabled\fR
.
.br
\fBfisher\fR \fB\-\-file\fR=\fIfishfile\fR
.
.br
.
.SH "DESCRIPTION"
Fisherman is a blazing fast, modern plugin manager for \fBfish(1)\fR\.
.
.P
The following commands are available: \fIinstall\fR, \fIuninstall\fR, \fIupdate\fR, \fIsearch\fR and \fIhelp\fR\. See \fBfisher help <command>\fR for information about each command\.
.
.SH "OPTIONS"
.
.TP
\fB\-\-list[=bare|url|all|enabled|disabled|theme|file]\fR
List local plugins according to a given option\. Plugins are prepended with a legend character to indicate their kind\. \fB*\fR for enabled plugins, \fB>\fR for the currently enabled prompt and \fB|\fR for symbolic links\. To list plugins without the legend use \fB\-\-list=bare\fR\. Use a dash \fB\-\fR to read from the standard input\.
.
.TP
\fB\-v \-\-version\fR
Show version information\. Fisherman\'s current version can be found in the VERSION file at the root of the project\. The version scheme is based in \fBSemantic Versioning\fR and uses Git annotated tags to track each release\.
.
.TP
\fB\-h \-\-help\fR
Show usage help\.
.
.SH "CUSTOM COMMANDS"
A Fisherman command is a regular function that can be invoked using the \fBfisher\fR command\. By convention, any function like \fBfisher_<my_command>\fR is recognized as a Fisherman command\. You can create plugins that add new commands this way\. See \fBfisher help commands\fR and \fBfisher help plugins\fR for more information\.
.
.SH "EXAMPLES"
.
.IP "\(bu" 4
Install plugins\.
.
.IP "" 0
.
.IP "" 4
.
.nf
fisher install fishtape shark get
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
Install plugins from a \fIfishfile\fR or bundle\.
.
.IP "" 0
.
.IP "" 4
.
.nf
fisher \-\-list=path/to/bundle | fisher install
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
Install a plugin if inside a plugin project\.
.
.IP "" 0
.
.IP "" 4
.
.nf
fisher install \.
.
.fi
.
.IP "" 0
.
.SH "AUTHORS"
Fisherman was created by Jorge Bucaran \fIj@bucaran\.me\fR\.
.
.P
See AUTHORS file for the complete list of contributors\.
.
.SH "SEE ALSO"
fisher help tour
.
.br
fisher help help
.
.br
fisher help update
.
.br
fisher help search
.
.br
fisher help config
.
.br
fisher help install
.
.br
fisher help plugins
.
.br
fisher help commands
.
.br
fisher help fishfile
.
.br
fisher help uninstall
.
.br