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

* Improved README, added links to screencasts, updated
documentation with new changes and fixed other typos and
composition errors.

* Removed `fisher update --cache` in favor of
`fisher --cache | fisher update` and
`fisher uninstall --all` in favor of
`fisher --cache | fisher uninstall`.

* Fisherman does not move initialization / configuration
files following the convention `name`.config.fish to
`$fisher_config/functions`, but to `$fisher_config/conf.d`
now and evaluates  each `*.config.fish` inside at shell
start as usual. Closes #13.

* Added `fisher --cache[=base]` option to retrieve contents
in `$fisher_cache`, eliminating flaky usage of `find(1)`.
Closes #11.

* Fisherman now generates information about plugins installed
via custom URLs. For the description, a shortened version of
the URL is used. For the URL the full URL is used. For tags,
the URL is fuzzily checked and tags such as _theme_, _plugin_,
_config_ and _omf_ are added. The tag _orphan_ is added by
default as well. Finally, the author is generated by
retrieving the e-mail or username of the author of the
first commit in the plugin's repository. Closes #9 and #14.

* Changed `--path-in-cache` to `--translate.` This function
translates an name or supported URL/URL variation into a path
inside `$fisher_cache`. This allows you to treat plugins
installed via custom URLs almost like regular plugins if they
are installed. Closes #8.

* Fixed a bug with `mktemp` failing on some systems.
Closes #7. Thanks @tobywf.

* Added [CODE_OF_CONDUCT][code_of_conduct]. Closes #6.

* Fisherman can now unload themes within the same shell,
without having to restart the session. Closes #5.

* Fisherman can now load themes within the same shell,
without having to restart the session using `exec fish`.
Shoddy themes, for example those failing to declare global
variables with the `-g` flag still require the session to
be reset. See [**related**][bobthefish-19]. Closes #4.

* Move `getopts` implementation to `share/getopts.awk`.
Closes #3.

* Support dots inside URIs in `fisher --validate`.
Closes #2.

2016-01-05 06:05:11 +09:00

1.7 KiB

Raw Blame History

fisher-help(1) -- Display Help Information

SYNOPSIS

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

USAGE

fisher help command
fisher help concept
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

This will allow you to invoke man my_plugin. To add documentation to a command, prepend the keyword fisher- to the man file, e.g., fisher-my-command.1. This will allow you to access the man page via fisher help my-command.

There are utilities that can help you generate man pages from other text formats, such as Markdown. One example is ronn(1). For a standalone example see fisher help plugins#{Example}.

OPTIONS

--commands[=bare]: List commands. This is the default behavior of fisher help. Use bare for easy to parse output.
-a --all: List commands and guides. Display all the available documentation.
-g --guides[=bare]: List guides / tutorials. Use bare for easy to parse output.
-u --usage[=command]: Display usage help for command. To supply usage help with a command, command must accept a --help option.
-h --help: Show usage help.

EXAMPLES

Display usage help for all Fisherman commands.

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

1.7 KiB Raw Blame History