Help displays \fIcommand\fR documentation, usage, guides and tutorials\.
.
.P
Help is based in \fBman(1)\fR 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\.
Help is based in \fBman\fR(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\.
.
.IP""4
.
@ -34,19 +34,19 @@ Help is based in \fBman(1)\fR pages\. To supply help with your own plugin or com
my_plugin
|\-\- my_plugin\.fish
|\-\- man
|\-\- man1
|\-\- my_plugin\.1
`\-\- man
`\-\- man1
`\-\- my_plugin\.1
.
.fi
.
.IP""0
.
.P
Help for my_plugin is now available via \fBman(1)\fR\. To add documentation to a \fBfisher\fR command, prepend the keyword \fBfisher\-\fR to the man file, e\.g\., \fBfisher\-my\-command\.1\fR\. This will teach Fisherman how to access the man page using \fBfisher help my\-command\fR\.
Help for my_plugin is now available via \fBman\fR(1)\. To add documentation to a \fBfisher\fR command, prepend the keyword \fBfisher\-\fR to the man file, e\.g\., \fBfisher\-my\-command\.1\fR\. This will teach Fisherman how to access the man page using \fBfisher help my\-command\fR\.
.
.P
There are utilities that can help you generate man pages from other text formats, such as Markdown\. One example is \fBronn(1)\fR\. For an example without using external utilities, see \fIExample\fR in \fBfisher help plugins\fR\.
There are utilities that can help you generate man pages from other text formats, such as Markdown\. One example is \fBronn\fR(1)\. For an example without using external utilities, see \fIExample\fR in \fBfisher help plugins\fR\.
.
.SH"OPTIONS"
.
@ -63,7 +63,7 @@ List guides / tutorials\. Use \fIbare\fR to generate easy to parse output\.
List commands\. This is the default behavior of \fBfisher help\fR\. Use \fIbare\fR to generate easy to parse output\.
.
.TP
\fB\-u \-\-usage[=*command*]\fR
\fB\-\-usage[=*command*]\fR
Display usage help for \fIcommand\fR\. To teach Fisherman how to display help for your command, \fIcommand\fR must implement a \fB\-h\fR flag\.
.
.TP
@ -118,10 +118,4 @@ fisher help \-\-commands=bare | fisher help \-\-usage
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.
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
`-- man
`-- man1
`-- my_plugin.1
```
Help for my_plugin is now 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`.
Help for my_plugin is now 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`.
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`.
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
@ -40,7 +40,7 @@ There are utilities that can help you generate man pages from other text formats
* `--commands[=*bare*]`:
List commands. This is the default behavior of `fisher help`. Use *bare* to generate easy to parse output.
* `-u --usage[=*command*]`:
* `--usage[=*command*]`:
Display usage help for *command*. To teach Fisherman how to display help for your command, *command* must implement a `-h` flag.
* `-h --help`:
@ -68,5 +68,4 @@ fisher help --commands=bare | fisher help --usage
The index file consists of records separated by blank lines \fB\'\en\en\'\fR and each record consists of fields separated by a single line \fB\'\en\'\fR\.
The index file consists of records plugin name and info\.\fB*\fR is shown if plugin is installed\.
Fisherman is a blazing fast, modern plugin manager for \fBfish(1)\fR\.
Fisherman is a blazing fast, modern plugin manager for \fBfish\fR(1)\.
.
.P
The following commands are available: \fIinstall\fR, \fIuninstall\fR, \fIupdate\fR, \fIsearch\fR and \fIhelp\fR\. See \fBfisher help <command>\fR for information about each command\.
@ -23,7 +23,7 @@ The following commands are available: \fIinstall\fR, \fIuninstall\fR, \fIupdate\
List local plugins according to a given option\. Plugins are prepended with a legend character to indicate their kind\.\fB*\fR for enabled plugins, \fB>\fR for the currently enabled prompt and \fB|\fR for symbolic links\. To list plugins without the legend use \fB\-\-list=bare\fR\. Use a dash \fB\-\fR to read from the standard input\.
.
.TP
@ -88,10 +88,10 @@ fisher install \.
Fisherman was created by Jorge Bucaran \fIj@bucaran\.me\fR\.
.
.P
See THANKS file for the complete list of contributors\.
See THANKS\.md file for the complete list of contributors\.
Fisherman is a blazing fast, modern plugin manager for `fish(1)`.
Fisherman is a blazing fast, modern plugin manager for `fish`(1).
The following commands are available: *install*, *uninstall*, *update*, *search* and *help*. See `fisher help <command>` for information about each command.
List local plugins according to a given option. Plugins are prepended with a legend character to indicate their kind. `*` for enabled plugins, `>` for the currently enabled prompt and `|` for symbolic links. To list plugins without the legend use `--list=bare`. Use a dash `-` to read from the standard input.
* `-v --version`:
@ -51,8 +51,8 @@ fisher install .
Fisherman was created by Jorge Bucaran *j@bucaran.me*.
See THANKS file for the complete list of contributors.
See THANKS.md file for the complete list of contributors.
@ -50,10 +50,10 @@ When a plugin is installed, its dependencies are downloaded for the first time\.
To understand this behavior, it helps to recall the shell\'s single scope for functions\. The lack of private functions means that, it is \fInot\fR possible to single\-lock a specific dependency version\. See also \fBFlat Tree\fR in \fBfisher help tour\fR\.
@ -35,7 +35,7 @@ The cache directory\. Plugins are downloaded first here and installed to \fB$fis
.
.TP
\fB$fisher_index\fR
The URL to the index database\. To use a different index set this to a file or URL\. Redirect URLs are currently not supported due to security and performance concerns\. The underlying request and fetch mechanism is based in \fBcurl(1)\fR\.
The URL to the index database\. To use a different index set this to a file or URL\. Redirect URLs are currently not supported due to security and performance concerns\. The underlying request and fetch mechanism is based in \fBcurl\fR(1)\.
@ -26,7 +26,7 @@ Using the following variables, you can customize the locations of the cache, ind
The cache directory. Plugins are downloaded first here and installed to `$fisher_config/functions` afterwards. The cache is `$fisher_config/cache` by default.
* `$fisher_index`:
The URL to the index database. To use a different index set this to a file or URL. Redirect URLs are currently not supported due to security and performance concerns. The underlying request and fetch mechanism is based in `curl(1)`.
The URL to the index database. To use a different index set this to a file or URL. Redirect URLs are currently not supported due to security and performance concerns. The underlying request and fetch mechanism is based in `curl`(1).
This document attempts to answer some of Fisherman most frequently asked questions\. Feel free to create a new issue in the Fisherman issue tracker if your question is not answered here\.
.
.SS"What is Fisherman?"
Fisherman is a plugin manager for fish that lets you share and reuse code, prompts and configurations easily\.
Fisherman is a fish plugin manager that lets you share and reuse code, prompts and configurations easily\.
.
.SS"What do I need to know to use Fisherman?"
Nothing\. You can continue using your shell as usual\. When you are ready to learn more just type \fBfisher help\fR or \fBfisher help tour\fR\.
Nothing, continue to use fish as usual\. Ready to learn more? Type \fBfisher help\fR or \fBfisher help tour\fR\.
.
.SS"How do I access the documentation?"
Fisherman documentation is based in UNIX \fBman(1)\fR pages\. For basic usage and command enter \fBfisher help\fR\. For help about a specific \fIcommand\fR, enter \fBfisher help <command>\fR\. The following guides are also available:
Fisherman documentation is based in UNIX \fBman\fR(1) pages\. For basic usage and command enter \fBfisher help\fR\. For help about a specific \fIcommand\fR, enter \fBfisher help <command>\fR\. The following guides are also available:
.
.P
fisher help \fBfaq\fR: Fisherman FAQ
@ -45,7 +45,7 @@ Plugins are written in fish and extend the shell core functionality, run initial
Plugins may list any number of dependencies to other plugins using a \fIfishfile\fR\.
.
.SS"What is a Fishfile?"
A plain text file that lists what plugins you have installed or a plugin\'s dependencies to other plugins\.
A plain text file consists of a lists of installed plugins or dependencies to other plugins\.
.
.P
Fishfiles let you share plugin configurations across multiple installations, allow plugins to declare dependencies, and prevent information loss in case of system failure\. See also \fBfisher help fishfile\fR\.
@ -7,15 +7,15 @@ This document attempts to answer some of Fisherman most frequently asked questio
### What is Fisherman?
Fisherman is a plugin manager for fish that lets you share and reuse code, prompts and configurations easily.
Fisherman is a fish plugin manager that lets you share and reuse code, prompts and configurations easily.
### What do I need to know to use Fisherman?
Nothing. You can continue using your shell as usual. When you are ready to learn more just type `fisher help` or `fisher help tour`.
Nothing, continue to use fish as usual. Ready to learn more? Type `fisher help` or `fisher help tour`.
### How do I access the documentation?
Fisherman documentation is based in UNIX `man(1)` pages. For basic usage and command enter `fisher help`. For help about a specific *command*, enter `fisher help <command>`. The following guides are also available:
Fisherman documentation is based in UNIX `man`(1) pages. For basic usage and command enter `fisher help`. For help about a specific *command*, enter `fisher help <command>`. The following guides are also available:
fisher help `faq`: Fisherman FAQ<br>
fisher help `tour`: Fisherman Tour<br>
@ -32,7 +32,7 @@ Plugins may list any number of dependencies to other plugins using a *fishfile*.
### What is a Fishfile?
A plain text file that lists what plugins you have installed or a plugin's dependencies to other plugins.
A plain text file consists of a lists of installed plugins or dependencies to other plugins.
Fishfiles let you share plugin configurations across multiple installations, allow plugins to declare dependencies, and prevent information loss in case of system failure. See also `fisher help fishfile`.
Plugins may also define completions using \fBcomplete(1)\fR and provide documentation in the form of \fBman(1)\fR pages\.
Plugins may also define completions using \fBcomplete\fR(1) and provide documentation in the form of \fBman\fR(1) pages\.
.
.SH"EXAMPLE"
This section walks you through creating \fIwtc\fR, a stand\-alone plugin based in \fIgithub\.com/ngerakines/commitment\fR random commit message generator\.
@ -144,7 +144,7 @@ end
.IP""0
.
.TP
Add basic documentation\. Fisherman uses standard manual pages for displaying help information\. There are utilities that can help you generate man pages from other text formats, such as Markdown\. One example is \fBronn(1)\fR\. For this example, type will do:
Add basic documentation\. Fisherman uses standard manual pages for displaying help information\. There are utilities that can help you generate man pages from other text formats, such as Markdown\. One example is \fBronn\fR(1)\. For this example, type will do:
Plugins may also define completions using `complete(1)` and provide documentation in the form of `man(1)` pages.
Plugins may also define completions using `complete`(1) and provide documentation in the form of `man`(1) pages.
## EXAMPLE
@ -93,7 +93,7 @@ end
^C
```
* Add basic documentation. Fisherman uses standard manual pages for displaying help information. There are utilities that can help you generate man pages from other text formats, such as Markdown. One example is `ronn(1)`. For this example, type will do:
* Add basic documentation. Fisherman uses standard manual pages for displaying help information. There are utilities that can help you generate man pages from other text formats, such as Markdown. One example is `ronn`(1). For this example, type will do:
Fisherman is a blazing fast, modern plugin manager for \fBfish(1)\fR\.
Fisherman is a blazing fast, modern plugin manager for \fBfish\fR(1)\.
.
.P
Fisherman runs virtually no initialization code, making it as fast as no Fisherman\. The cache mechanism lets you query the index offline and enable or disable plugins as you wish\.
Fisherman runs virtually no initialization code, making it \fBas fast as no Fisherman\fR\. The cache mechanism lets you query the index offline and enable or disable plugins as you wish\.
.
.P
Other features include dependency management, excellent test coverage, plugin search capabilities and full compatibility with Tackle, Oh My Fish! and Wahoo themes and plugins\.
.
.P
This document describes Fisherman features and their implementation details\. For usage and command help see \fBfisher(1)\fR\.
This document describes Fisherman features and their implementation details\. For usage and command help see \fBfisher\fR(1)\.
.
.SH"FLAT TREE"
The configuration directory structure is optimized to help your shell start new sessions as quickly as possible, regardless of the numbers of plugins or prompts enabled at any given time\.
@ -58,7 +58,7 @@ With this in mind, it\'s possible to improve the slow shell start problem using
The overhead of juggling multiple path hierarchies in a per\-plugin basis yields no benefits as everything is shared inside the same scope\.
.
.P
Loading a path simply means adding the desired location to the \fB$fish_function_path\fR array\. See also \fBfunctions(1)\fR\.
Loading a path simply means adding the desired location to the \fB$fish_function_path\fR array\. See also \fBfunctions\fR(1)\.
.
.P
Here is a snapshot of an example Fisherman configuration path with a single plugin and prompt:
@ -70,16 +70,17 @@ Here is a snapshot of an example Fisherman configuration path with a single plug
$fisher_config
|\-\- cache/
|\-\- conf\.d/
|\-\- |\-\- my_plugin\.config\.fish
| `\-\- <my_plugin>\.config\.fish
|\-\- fishfile
|\-\- functions/
| |\-\- my_plugin\.fish
| |\-\-<my_plugin>\.fish
| |\-\- fish_prompt\.fish
| |\-\- fish_right_prompt\.fish
| `\-\- fish_right_prompt\.fish
|\-\- completions/
| |\-\- my_plugin\.fish
|\-\- man/
|\-\- man1/
|\-\- my_plugin\.1
| `\-\- <my_plugin>\.fish
`\-\- man/
`\-\- man1/
`\-\- <my_plugin>\.1
.
.fi
.
@ -284,7 +285,7 @@ Fisherman allows a high level of configuration using \fB$fisher_*\fR variables\.
You can also extend Fisherman by adding new commands and ship them as plugins\. Fisherman automatically adds completions to \fIcommands\fR based in the function \fIdescription\fR and usage help if provided\. See \fBfisher help help\fR and \fBfisher help commands\fR\.
.
.P
To add completions to standalone utility plugins, use \fBcomplete(1)\fR\.
To add completions to standalone utility plugins, use \fBcomplete\fR(1)\.
.
.SS"CLI"
If you are already familiar with other UNIX tools, you\'ll find Fisherman commands behave intuitively\.
@ -293,13 +294,13 @@ If you are already familiar with other UNIX tools, you\'ll find Fisherman comman
Most commands read the standard input by default when no options are given and produce easy to parse output, making Fisherman commands ideal for plumbing and building upon each other\.
.
.P
Fisherman also ships with a CLI options parser and a background job spinner that you can use to implement your own commands CLI\. See \fBgetopts(1)\fR and \fBspin(1)\fR\.
Fisherman also ships with a CLI options parser and a job spinner you can use to implement your own CLIs\. See \fBgetopts\fR(1) and \fBspin\fR(1)\.
.
.SH"COMPATIBILITY"
Fisherman supports Oh My Fish! themes and plugins, but some features are turned off by default for performance reasons\.
.
.P
Oh My Fish! evaluates every \fI\.fish\fR file inside the root directory for every plugin installed during shell start\. This is necessary in order to load any existing \fBinit\fR event functions and immediately invoke them using fish \fBemit(1)\fR\.
Oh My Fish! evaluates every \fI\.fish\fR file inside the root directory for every plugin installed during shell start\. This is necessary in order to load any existing \fBinit\fR event functions and immediately invoke them using fish \fBemit\fR(1)\.
.
.P
Since it is not possible to determine whether a file defines an initialization event without evaluating its contents first, Oh My Fish! sources all \fB*\.fish\fR files and then emits events for each plugin\.
@ -321,24 +322,19 @@ fisher install legacy
This plugin also adds definitions for some of Oh My Fish! Core Library functions\.
Fisherman is a blazing fast, modern plugin manager for `fish(1)`.
Fisherman is a blazing fast, modern plugin manager for `fish`(1).
Fisherman runs virtually no initialization code, making it as fast as no Fisherman. The cache mechanism lets you query the index offline and enable or disable plugins as you wish.
Fisherman runs virtually no initialization code, making it **as fast as no Fisherman**. The cache mechanism lets you query the index offline and enable or disable plugins as you wish.
Other features include dependency management, excellent test coverage, plugin search capabilities and full compatibility with Tackle, Oh My Fish! and Wahoo themes and plugins.
This document describes Fisherman features and their implementation details. For usage and command help see `fisher(1)`.
This document describes Fisherman features and their implementation details. For usage and command help see `fisher`(1).
## FLAT TREE
@ -39,7 +39,7 @@ With this in mind, it's possible to improve the slow shell start problem using a
The overhead of juggling multiple path hierarchies in a per-plugin basis yields no benefits as everything is shared inside the same scope.
Loading a path simply means adding the desired location to the `$fish_function_path` array. See also `functions(1)`.
Loading a path simply means adding the desired location to the `$fish_function_path` array. See also `functions`(1).
Here is a snapshot of an example Fisherman configuration path with a single plugin and prompt:
@ -47,16 +47,17 @@ Here is a snapshot of an example Fisherman configuration path with a single plug
$fisher_config
|-- cache/
|-- conf.d/
|-- |-- my_plugin.config.fish
| `-- <my_plugin>.config.fish
|-- fishfile
|-- functions/
| |-- my_plugin.fish
| |-- <my_plugin>.fish
| |-- fish_prompt.fish
| |-- fish_right_prompt.fish
| `-- fish_right_prompt.fish
|-- completions/
| |-- my_plugin.fish
|-- man/
|-- man1/
|-- my_plugin.1
| `-- <my_plugin>.fish
`-- man/
`-- man1/
`-- <my_plugin>.1
```
If you are already familiar in the way Fish handles your user configuration, you will find the above structure similar to `$XDG_CONFIG_HOME/fish`. See `Initialization Files` in `help fish` to learn more about fish configuration.
@ -170,7 +171,7 @@ Fisherman allows a high level of configuration using `$fisher_*` variables. You
You can also extend Fisherman by adding new commands and ship them as plugins. Fisherman automatically adds completions to *commands* based in the function *description* and usage help if provided. See `fisher help help` and `fisher help commands`.
To add completions to standalone utility plugins, use `complete(1)`.
To add completions to standalone utility plugins, use `complete`(1).
### CLI
@ -178,13 +179,13 @@ If you are already familiar with other UNIX tools, you'll find Fisherman command
Most commands read the standard input by default when no options are given and produce easy to parse output, making Fisherman commands ideal for plumbing and building upon each other.
Fisherman also ships with a CLI options parser and a job spinner you can use to implement your own CLIs. See `getopts(1)` and `spin(1)`.
Fisherman also ships with a CLI options parser and a job spinner you can use to implement your own CLIs. See `getopts`(1) and `spin`(1).
## COMPATIBILITY
Fisherman supports Oh My Fish! themes and plugins, but some features are turned off by default for performance reasons.
Oh My Fish! evaluates every *.fish* file inside the root directory for every plugin installed during shell start. This is necessary in order to load any existing `init` event functions and immediately invoke them using fish `emit(1)`.
Oh My Fish! evaluates every *.fish* file inside the root directory for every plugin installed during shell start. This is necessary in order to load any existing `init` event functions and immediately invoke them using fish `emit`(1).
Since it is not possible to determine whether a file defines an initialization event without evaluating its contents first, Oh My Fish! sources all `*.fish` files and then emits events for each plugin.
@ -198,10 +199,8 @@ This plugin also adds definitions for some of Oh My Fish! Core Library functions
Jorge Bucaran
8 years ago