2016-01-01 22:12:40 +01:00
. \" generated with Ronn/v0.7.3
. \" http://github.com/rtomayko/ronn/tree/0.7.3
.
2016-02-07 12:06:04 +01:00
.TH "FISHER\-HELP" "1" "February 2016" "" "fisherman"
2016-01-01 22:12:40 +01:00
.
.SH "NAME"
2016-02-29 15:13:29 +01:00
\fB fisher\- help\fR \- Show help about Fisherman
2016-01-01 22:12:40 +01:00
.
.SH "SYNOPSIS"
2016-02-29 15:13:29 +01:00
fisher help [\fI keyword\fR ] [\- \- all] [\- \- guides] [\- \- usage[=\fI command\fR ]] [\- \- help]
2016-01-01 22:12:40 +01:00
.
.br
.
.SH "USAGE"
2016-02-29 15:13:29 +01:00
fisher help \fI command\fR
2016-01-01 22:12:40 +01:00
.
.br
2016-02-29 15:13:29 +01:00
fisher help \fI guide\fR
2016-01-01 22:12:40 +01:00
.
.br
2016-02-29 15:13:29 +01:00
fisher help \- \- usage=[\fI command\fR ]
2016-01-01 22:12:40 +01:00
.
2016-01-10 08:01:07 +01:00
.br
.
2016-01-01 22:12:40 +01:00
.SH "DESCRIPTION"
Help displays \fI command\fR documentation, usage, guides and tutorials\.
.
.P
2016-02-29 15:13:29 +01:00
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\.
2016-01-01 22:12:40 +01:00
.
.IP "" 4
.
.nf
my_plugin
|\- \- my_plugin\. fish
2016-02-27 07:31:11 +01:00
`\- \- man
`\- \- man1
`\- \- my_plugin\. 1
2016-01-01 22:12:40 +01:00
.
.fi
.
.IP "" 0
.
.P
2016-02-29 15:13:29 +01:00
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\.
2016-01-01 22:12:40 +01:00
.
.P
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)\.
2016-01-01 22:12:40 +01:00
.
.SH "OPTIONS"
.
.TP
2016-02-29 15:13:29 +01:00
\- a, \- \- all
2016-02-07 12:06:04 +01:00
List all available commands and guides\.
2016-01-01 22:12:40 +01:00
.
.TP
2016-02-29 15:13:29 +01:00
\- g, \- \- guides[=\fI bare\fR ]
2016-01-10 08:01:07 +01:00
List guides / tutorials\. Use \fI bare\fR to generate easy to parse output\.
2016-01-01 22:12:40 +01:00
.
.TP
2016-02-29 15:13:29 +01:00
\- \- commands[=\fI bare\fR ]
List commands\. This is the default behavior of fisher help\. Use \fI bare\fR to generate easy to parse output\.
2016-01-01 22:12:40 +01:00
.
.TP
2016-02-29 15:13:29 +01:00
\- \- usage[=\fI command\fR ]
Display usage help for \fI command\fR \. To teach Fisherman how to display help for your command, \fI command\fR must implement a \- h flag\.
2016-01-01 22:12:40 +01:00
.
.TP
2016-02-29 15:13:29 +01:00
\- h, \- \- help
2016-01-01 22:12:40 +01:00
Show usage help\.
.
.SH "EXAMPLES"
Fisherman v0.2.0
* 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-03 04:35:56 +01:00
.
.IP "\(bu" 4
2016-02-29 15:13:29 +01:00
Show all the existing documentation\.
2016-01-10 08:01:07 +01:00
.
.IP "" 0
.
.IP "" 4
.
.nf
2016-02-29 15:13:29 +01:00
fisher help \- \- all
2016-01-10 08:01:07 +01:00
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
2016-02-29 15:13:29 +01:00
Show help about help\.
2016-01-10 08:01:07 +01:00
.
.IP "" 0
.
.IP "" 4
.
.nf
fisher help help
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
2016-02-29 15:13:29 +01:00
Show usage help for all available commands\.
2016-01-01 22:12:40 +01:00
.
Fisherman v0.2.0
* 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-03 04:35:56 +01:00
.IP "" 0
.
2016-01-01 22:12:40 +01:00
.IP "" 4
.
.nf
fisher help \- \- commands=bare | fisher help \- \- usage
.
.fi
.
.IP "" 0
.
.SH "SEE ALSO"
2016-02-29 15:13:29 +01:00
man(1), fisher(1)