Archives
/
fisher
mirror of https://github.com/jorgebucaran/fisher
2
0
Fork 0
Code Issues Projects Releases Wiki Activity
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
main
event-args
comments
4.4.5
4.4.4
4.4.3
4.4.2
4.4.1
4.4.0
4.3.5
4.3.4
4.3.3
4.3.2
4.3.1
4.3.0
4.2.0
4.1.0
3.3.2
3.3.1
3.3.0
3.2.12
3.2.11
3.2.10
3.2.9
3.2.8
3.2.4
3.2.5
3.2.6
3.2.7
3.1.0
3.1.1
3.2.0
3.2.1
3.2.2
3.2.3
3.0.3
3.0.4
3.0.5
3.0.6
3.0.7
3.0.8
3.0.9
2.7.7
2.7.8
2.7.9
2.8.0
2.9.0
3.0.0
2.7.0
2.7.1
2.7.3
2.7.4
2.7.5
2.7.6
2.6.4
2.6.5
2.6.6
2.6.7
2.6.8
2.6.9
2.6.17
2.6.18
2.6.19
2.6.2
2.6.20
2.6.3
2.6.11
2.6.12
2.6.13
2.6.14
2.6.15
2.6.16
2.4.1
2.4.2
2.5.0
2.6.0
2.6.1
2.6.10
2.12.0
2.13.0
2.2.0
2.3.1
2.3.3
2.3.4
2.1.4
2.1.6
2.1.7
2.1.8
2.1.9
2.10.0
2.11.0
2.1.1
2.1.10
2.1.11
2.1.12
2.1.13
2.1.3
1.3.0
1.3.1
1.4.0
1.5.0
2.0.0
2.0.1
0.7.0
0.8.0
0.9.0
1.0.0
1.1.0
1.2.0
0.2.0
0.3.0
0.3.1
0.4.0
0.5.0
0.6.0
4.0.0
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'e813978fab'
${ noResults }
fisher/man/man1/fisher-help.md

896 B
Raw Blame History

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)