mirror of https://github.com/jorgebucaran/fisher synced 2024-07-02 23:11:48 +02:00

* 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 23:13:29 +09:00

1.7 KiB

Raw Blame History

fisher-help(1) -- Show help about Fisherman

SYNOPSIS

fisher help [keyword] [--all] [--guides] [--usage[=command]] [--help]

USAGE

fisher help command
fisher help guide
fisher help --usage=[command]

DESCRIPTION

Help displays command documentation, usage, guides and tutorials.

Help is based in man(1) 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.

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

Help for my_plugin is available via man(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

-a, --all: List all available commands and guides.
-g, --guides[=bare]: List guides / tutorials. Use bare to generate easy to parse output.
--commands[=bare]: List commands. This is the default behavior of fisher help. Use bare to generate easy to parse output.
--usage[=command]: Display usage help for command. To teach Fisherman how to display help for your command, command must implement a -h flag.
-h, --help: Show usage help.

EXAMPLES

Show all the existing documentation.

fisher help --all

Show help about help.

fisher help help

Show usage help for all available commands.

fisher help --commands=bare | fisher help --usage

1.7 KiB Raw Blame History