mirror of
https://github.com/jorgebucaran/fisher
synced 2024-07-02 23:11:48 +02:00
ed335bf270
* Fix bug in fisher_config_color_reset not declaring path variable. * Silence Git checkout standard error to prevent update failures in some edge cases. * Revise and correct errors in the documentation and README. * Add more instrumentation to fisher_plugin_disable. * Minor doc updates.
53 lines
1.1 KiB
Groff
53 lines
1.1 KiB
Groff
.\" generated with Ronn/v0.7.3
|
|
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
|
.
|
|
.TH "FISHER\-HELP" "1" "March 2016" "" "fisherman"
|
|
.
|
|
.SH "NAME"
|
|
\fBfisher\-help\fR \- Show command help
|
|
.
|
|
.SH "SYNOPSIS"
|
|
fisher help [\fIcommand\fR] [\-\-help]
|
|
.
|
|
.br
|
|
.
|
|
.SH "USAGE"
|
|
fisher help \fIcommand\fR
|
|
.
|
|
.br
|
|
.
|
|
.SH "DESCRIPTION"
|
|
Help displays \fIcommand\fR documentation\.
|
|
.
|
|
.P
|
|
Help is based in man(1) pages\. To supply help with your own plugin or command, create one or more man 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
|
|
To add documentation to a fisher command, prepend the keyword fisher\- to the man file, e\.g\., fisher\-my\-command\.1\. This will teach Fisherman how to access the man page using \fBfisher help my\-command\fR\.
|
|
.
|
|
.P
|
|
There are utilities that can help you generate man pages from other text formats, such as Markdown\. For example pandoc(1) or ronn(1)\.
|
|
.
|
|
.SH "OPTIONS"
|
|
.
|
|
.TP
|
|
\-h, \-\-help
|
|
Show usage help\.
|
|
.
|
|
.SH "SEE ALSO"
|
|
man(1), fisher(1)
|