mirror of https://github.com/jorgebucaran/fisher synced 2024-11-05 12:00:17 +00:00

Jorge Bucaran 707855203a Ahoy! Fisherman gets a super patch v0.3.1

This patch contains several amends for 0.3.0 and
other minor documentation corrections.  Major
documentation revision and rewrite.

fisher help shows fisher(1) by default now.

Fix a critical bug that was causing fisher uninstall
--force to remove not the symbolic link, but the
actual files. Closes #24

Rename orphan tag to custom for plugins installed
using a custom URL.

warning Remove fisher --link flag and create symbolic
links by default for local paths. The user does not
have to worry about symbolic links or whether the
copy is as symbolic link or not anymore. If the user
tries to install a local path, then the best thing
to do is to create a symbolic link. This also
eliminates the need to call update.

warning Remove fisher --cache and fisher --validate.
Now, that these options are separated into their own
function and they are intentionally private, there
is no need for them.

2016-01-10 16:13:46 +09:00

1.9 KiB

Raw Blame History

fisher-help(1) -- Show Help

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

This will allow you to access help for my_plugin using man(1). To add documentation to a fisher(1) command, prepend the keyword fisher- to the man file, e.g., fisher-my-command.1. This will allow you to access the man page by 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 an example without using external utilities, see Example in fisher help plugins.

OPTIONS

-a --all: List both commands and guides. This shows all the available documentation.
-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.
-u --usage[=*command*]: Display usage help for command. To supply usage help with a command, command must implement a -h flag.
-h --help: Show usage help.

EXAMPLES

Show all the available documentation.

fisher help -a

Show documentation about help.

fisher help help

Show usage help for all Fisherman commands.

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

1.9 KiB Raw Blame History