fisher/man/man1/fisher-help.md

fisher-help(1) -- Show command help
===================================

## SYNOPSIS

fisher help [*command*] [--help]<br>

## USAGE

fisher help *command*<br>

## 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)
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-11 22:45:17 +01:00			`fisher-help(1) -- Show command help`
			`===================================`
Ahoy! Fisherman and Happy New Year 2016. 2016-01-01 22:12:40 +01:00
			`## SYNOPSIS`

Simplify fisher_help, update docs. 2016-03-09 10:40:59 +01:00			`fisher help [command] [--help]<br>`
Ahoy! Fisherman and Happy New Year 2016. 2016-01-01 22:12:40 +01:00
			`## USAGE`

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 15:13:29 +01:00			`fisher help command<br>`
Ahoy! Fisherman and Happy New Year 2016. 2016-01-01 22:12:40 +01:00
			`## DESCRIPTION`

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-11 22:45:17 +01:00			`Help displays command documentation.`
Ahoy! Fisherman and Happy New Year 2016. 2016-01-01 22:12:40 +01:00
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-11 22:45:17 +01:00			`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.`
Ahoy! Fisherman and Happy New Year 2016. 2016-01-01 22:12:40 +01:00
			```
			`my_plugin`
			`\|-- my_plugin.fish`
[#129] Beautify man pages 2016-02-27 03:08:32 +01:00			`-- man
			`-- man1
			`-- my_plugin.1
Ahoy! Fisherman and Happy New Year 2016. 2016-01-01 22:12:40 +01:00			```

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-11 22:45:17 +01:00			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`.
Ahoy! Fisherman and Happy New Year 2016. 2016-01-01 22:12:40 +01:00
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 15:13:29 +01:00			`There are utilities that can help you generate man pages from other text formats, such as Markdown. For example pandoc(1) or ronn(1).`
Ahoy! Fisherman and Happy New Year 2016. 2016-01-01 22:12:40 +01:00
			`## OPTIONS`

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 15:13:29 +01:00			`* -h, --help:`
Ahoy! Fisherman and Happy New Year 2016. 2016-01-01 22:12:40 +01:00			`Show usage help.`

			`## SEE ALSO`

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 15:13:29 +01:00			`man(1), fisher(1)`