.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "FISHER\-HELP" "1" "January 2016" "" "fisherman"
.
.SH "NAME"
\fBfisher\-help\fR \- Show Help
.
.SH "SYNOPSIS"
fisher \fBhelp\fR [\fIkeyword\fR] [\fB\-\-all\fR] [\fB\-\-guides\fR] [\fB\-\-usage\fR[=\fIcommand\fR]] [\fB\-\-help\fR]
.
.br
.
.SH "USAGE"
fisher \fBhelp\fR \fIcommand\fR
.
.br
fisher \fBhelp\fR \fIguide\fR
.
.br
fisher \fBhelp\fR \fB\-\-usage\fR=[\fIcommand\fR]
.
.br
.
.SH "DESCRIPTION"
Help displays \fIcommand\fR documentation, usage, guides and tutorials\.
.
.P
Help is based in \fBman(1)\fR pages\. To supply help with your own plugin or command, create one or more man\.1~7 pages and add them to your project under the corresponding man/man% directory\.
.
.IP "" 4
.
.nf

my_plugin
|\-\- my_plugin\.fish
|\-\- man
    |\-\- man1
        |\-\- my_plugin\.1
.
.fi
.
.IP "" 0
.
.P
This will allow you to access help for my_plugin using \fBman(1)\fR\. To add documentation to a \fBfisher(1)\fR command, prepend the keyword \fBfisher\-\fR to the man file, e\.g\., \fBfisher\-\fRmy\-command\.1\. This will allow you to access the man page by \fBfisher help my\-command\fR\.
.
.P
There are utilities that can help you generate man pages from other text formats, such as Markdown\. One example is \fBronn(1)\fR\. For an example without using external utilities, see \fIExample\fR in \fBfisher help plugins\fR\.
.
.SH "OPTIONS"
.
.TP
\fB\-a \-\-all\fR
List both commands and guides\. This shows all the available documentation\.
.
.TP
\fB\-g \-\-guides[=*bare*]\fR
List guides / tutorials\. Use \fIbare\fR to generate easy to parse output\.
.
.TP
\fB\-\-commands[=*bare*]\fR
List commands\. This is the default behavior of \fBfisher help\fR\. Use \fIbare\fR to generate easy to parse output\.
.
.TP
\fB\-u \-\-usage[=*command*]\fR
Display usage help for \fIcommand\fR\. To supply usage help with a command, \fIcommand\fR must implement a \fB\-h\fR flag\.
.
.TP
\fB\-h \-\-help\fR
Show usage help\.
.
.SH "EXAMPLES"
.
.IP "\(bu" 4
Show all the available documentation\.
.
.IP "" 0
.
.IP "" 4
.
.nf

fisher help \-a
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
Show documentation about help\.
.
.IP "" 0
.
.IP "" 4
.
.nf

fisher help help
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
Show usage help for all Fisherman commands\.
.
.IP "" 0
.
.IP "" 4
.
.nf

fisher help \-\-commands=bare | fisher help \-\-usage
.
.fi
.
.IP "" 0
.
.SH "SEE ALSO"
man(1)
.
.br
fisher(1)
.
.br