Archives/fisher
2
0
Fork 0
mirror of https://github.com/jorgebucaran/fisher synced 2024-11-09 07:10:27 +00:00
Code Issues Projects Releases Wiki Activity
cdb9a097b1
fisher/man/man1/fisher-help.1

53 lines
1.2 KiB
Groff
Raw Normal View History

Ahoy! Fisherman and Happy New Year 2016.
2016-01-01 21:12:40 +00:00
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
Simplify fisher_help, update docs.
2016-03-09 09:40:59 +00:00
.TH "FISHER\-HELP" "1" "March 2016" "" "fisherman"
Ahoy! Fisherman and Happy New Year 2016.
2016-01-01 21:12:40 +00:00
.
.SH "NAME"
Fisherman 1.0 RC * 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 14:13:29 +00:00
\fBfisher\-help\fR \- Show help about Fisherman
Ahoy! Fisherman and Happy New Year 2016.
2016-01-01 21:12:40 +00:00
.
.SH "SYNOPSIS"
Simplify fisher_help, update docs.
2016-03-09 09:40:59 +00:00
fisher help [\fIcommand\fR] [\-\-help]
Ahoy! Fisherman and Happy New Year 2016.
2016-01-01 21:12:40 +00:00
.
.br
.
.SH "USAGE"
Fisherman 1.0 RC * 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 14:13:29 +00:00
fisher help \fIcommand\fR
Ahoy! Fisherman and Happy New Year 2016.
2016-01-01 21:12:40 +00:00
.
.br
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 07:01:07 +00:00
.
Ahoy! Fisherman and Happy New Year 2016.
2016-01-01 21:12:40 +00:00
.SH "DESCRIPTION"
Help displays \fIcommand\fR documentation, usage, guides and tutorials\.
.
.P
Fisherman 1.0 RC * 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 14:13:29 +00: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\.
Ahoy! Fisherman and Happy New Year 2016.
2016-01-01 21:12:40 +00:00
.
.IP "" 4
.
.nf
my_plugin
|\-\- my_plugin\.fish
Merge branch 'master' of https://github.com/pickfire/fisherman into pickfire-master
2016-02-27 06:31:11 +00:00
`\-\- man
`\-\- man1
`\-\- my_plugin\.1
Ahoy! Fisherman and Happy New Year 2016.
2016-01-01 21:12:40 +00:00
.
.fi
.
.IP "" 0
.
.P
Fisherman 1.0 RC * 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 14:13:29 +00: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\.
Ahoy! Fisherman and Happy New Year 2016.
2016-01-01 21:12:40 +00:00
.
.P
Fisherman 1.0 RC * 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 14:13:29 +00: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)\.
Ahoy! Fisherman and Happy New Year 2016.
2016-01-01 21:12:40 +00:00
.
.SH "OPTIONS"
.
.TP
Fisherman 1.0 RC * 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 14:13:29 +00:00
\-h, \-\-help
Ahoy! Fisherman and Happy New Year 2016.
2016-01-01 21:12:40 +00:00
Show usage help\.
.
.SH "SEE ALSO"
Fisherman 1.0 RC * 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 14:13:29 +00:00
man(1), fisher(1)
Reference in New Issue Copy Permalink