fisher/man/man1/fisher-help.md
Jorge Bucaran 05ace93145 Ahoy! Fisherman 1.3.0
* 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.
2016-03-12 06:45:17 +09:00

896 B

fisher-help(1) -- Show command help

SYNOPSIS

fisher help [command] [--help]

USAGE

fisher help command

DESCRIPTION

Help displays command documentation.

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.

my_plugin
|-- my_plugin.fish
`-- man
    `-- man1
        `-- my_plugin.1

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 fisher help my-command.

There are utilities that can help you generate man pages from other text formats, such as Markdown. For example pandoc(1) or ronn(1).

OPTIONS

  • -h, --help: Show usage help.

SEE ALSO

man(1), fisher(1)