2016-01-01 21:12:40 +00:00
. \" generated with Ronn/v0.7.3
. \" http://github.com/rtomayko/ronn/tree/0.7.3
.
2016-02-03 00:11:34 +00:00
.TH "FISHER\-TOUR" "7" "February 2016" "" "fisherman"
2016-01-01 21:12:40 +00:00
.
.SH "NAME"
Ahoy! Fisherman 0.5.0
=====================
Add user key bindings support.
Recall $fisher_home/functions are always before user
functions in $fish_function_path. This was an early design
decision in order to prevent users from redefining core
functions by mistake or by means other than using plugins
(recommended). In other words, you are free to create a
plugin that modifies a Fisherman core function, but you
can't redefine a Fisherman function privately by saving it
to your user config fish. If you found a bug in a Fisherman
function, instead of creating a private patch send it
upstream. If you created a function that overrides a
Fisherman core feature, create a plugin. This way the
community can benefit from your code whenever you are ready
to publish it.
By default, Fisherman provides no fish_user_key_bindings,
so if the user has already defined their own
fish_user_key_bindings that one will not be affected.
Now, plugins can define their own key bindings inside a
fish_user_key_bindings.fish or key_bindings.fish at the root
of their repository or inside a functions directory. You can
put your key bindings inside a function or not. If you put
it inside a function, the function name must be the same as
the file without the .fish extension.
$fisher_config/bindings.fish When a plugin with key
bindings is installed for the first time or the only
one with bindings is uninstalled, Fisherman will modify
~/.config/functions/fish_user_key_bindings.fish (or create
it for the first time) and add a single line at the top
of the fish_user_key_bindings function to source the new
$fisher_config/bindings.fish. All the key bindings defined
by the enabled/installed plugins are concatenated and saved
to this file.
This mechanism has the following advantages:
Does not slow down shell start. Does not require Fisherman
to provide his own fish_user_key_bindings by default.
Honors any previously existing user key bindings. Allows
plugin to define their own key bindings and coexist
with the user's key bindings. If the user updates his
fish_user_key_bindings, re-running the function does update
the key bindings. Mega Refactoring
The entire source code of Fisherman received a
major revision and refactoring. The validation and
install/uninstall mechanisms were thoroughly revised and and
broken down into smaller functions easier to test as well as
several other sub parts of the system.
Rewrite fisher search and remove features that are mostly
already covered by fisher --list and remove the ability to
generate information about plugins of unknown origin. The
decision to remove this feature was based in performance
concerns and the result of thinking about the usability
and whether it was really worth the speed tradeoff. The
conclusion is I would rather have better performance and if
I need to query a plugins origin I can always use fisher
--list or fisher --list=url or fisher --list=author.
Add $fisher_update_interval to determine if the index should
update or not when a search query is taking place. The
default value is 10 seconds. This means the index will not
be updated if less than 10 seconds have elapsed since the
last action that triggered an update in the first place. See
Improve Install/Uninstall/Update status output. If a plugin
fails to install decrease the total. If any plugins are
skipped because they are already installed in the case of
fisher install or available in the cache, but disabled in
the case of fisher uninstall they are collected into an
array and displayed in a new section n plugin/s skipped (a,
b, c) at the bottom of the report.
Improve test coverage.
Tightly coupled functions were making testing increasingly
difficult. Most of the test effort was basically testing
whether git clone or git pull. New separation of concerns
makes tests run faster and the difficult install/uninstall
algorithms has better coverage now. Other
Now __fisher_list can list plugins from the cache, a
fishfile/bundle and plugins that are installed/enabled or
disabled. This removes __fisher_file and combines it with
__fisher_list. This also removes fisher -f and replaces it
with fisher -l <file> or fisher --list=<file>.
Rename __fisher_parse_help to __fisher_complete and have the
function create the completions automatically. This allows
you to complete your commands with parseable usage help
faster. The original design was fine, but this change
improves auto-complete performance so it was preferred.
Use __fisher_index_update when building file with Make. This
helps prevent an error when using a fish version < 2.2.0.
See #55 #50 #48.
Add __fisher_index_update to update the index and remove
previously undocumented fisher update --index. This
function is designed to bypass GitHub's server network
cache passing an arbitrary query string to curl like
$fisher_index?RANDOM_NUMBER. This means index updates are
immediately available now.
Add fisher --list=url option to display local plugin url or
path.
Add fisher --list=bare option to display local plugins in
the cache without the * enabled symbol.
Prepend > to the currently enabled theme when using fisher
--list[=cache]. Related #49.
Prepend * to plugin names to indicate they are currently
enabled when using fisher --list[=cache]. See #49.
2016-02-01 19:29:01 +00:00
\fB fisher\- tour\fR \- Fisherman Tour
2016-01-01 21:12:40 +00:00
.
.SH "DESCRIPTION"
2016-02-07 11:06:04 +00:00
Fisherman is a blazing fast, modern plugin manager for \fB fish(1)\fR \.
2016-01-01 21:12:40 +00:00
.
.P
2016-02-07 11:06:04 +00:00
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\.
2016-01-01 21:12:40 +00:00
.
.P
2016-02-07 11:06:04 +00:00
Other features include dependency management, excellent test coverage, plugin search capabilities and full compatibility with Tackle, Oh My Fish! and Wahoo themes and plugins\.
2016-01-10 19:55:59 +00:00
.
.P
This document describes Fisherman features and their implementation details\. For usage and command help see \fB fisher(1)\fR \.
2016-01-01 21:12:40 +00:00
.
.SH "FLAT TREE"
2016-02-07 11:06:04 +00:00
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\.
2016-01-01 21:12:40 +00:00
.
.P
To explain how this is possible, we need to make a digression and discuss function scope first\. In fish, all functions share the same scope and you can use only one name per function\.
.
.P
In the following example:
.
.IP "" 4
.
.nf
function foo
echo $_
function bar
end
end
function bar
echo $_
end
.
.fi
.
.IP "" 0
.
.P
\fI foo\fR and \fI bar\fR are available immediately at the command line prompt and both print their names\. But there is a catch, calling \fI foo\fR at least once will create a new \fI bar\fR function, effectively erasing the previous \fI bar\fR definition\. Subsequent calls to \fI bar\fR will print nothing\.
.
.P
2016-02-07 11:06:04 +00:00
By convention, functions that start with any number of underscores are \fI intentionally\fR private, but there is no mechanism that prevents you from calling them once they are loaded\.
2016-01-01 21:12:40 +00:00
.
.P
With this in mind, it\' s possible to improve the slow shell start problem using a \fI flat\fR tree structure whose path is loaded only once\.
.
.P
2016-02-07 11:06:04 +00:00
The overhead of juggling multiple path hierarchies in a per\- plugin basis yields no benefits as everything is shared inside the same scope\.
2016-01-01 21:12:40 +00:00
.
.P
2016-01-10 07:01:07 +00:00
Loading a path simply means adding the desired location to the \fB $fish_function_path\fR array\. See also \fB functions(1)\fR \.
2016-01-01 21:12:40 +00:00
.
.P
2016-02-07 11:06:04 +00:00
Here is a snapshot of an example Fisherman configuration path with a single plugin and prompt:
2016-01-01 21:12:40 +00:00
.
.IP "" 4
.
.nf
$fisher_config
|\- \- cache/
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 03:35:56 +00:00
|\- \- conf\. d/
|\- \- |\- \- my_plugin\. config\. fish
2016-01-01 21:12:40 +00:00
|\- \- functions/
| |\- \- my_plugin\. fish
| |\- \- fish_prompt\. fish
| |\- \- fish_right_prompt\. fish
|\- \- completions/
| |\- \- my_plugin\. fish
|\- \- man/
|\- \- man1/
|\- \- my_plugin\. 1
.
.fi
.
.IP "" 0
.
.P
2016-02-07 11:06:04 +00:00
If you are already familiar in the way Fish handles your user configuration, you will find the above structure similar to \fB $XDG_CONFIG_HOME/fish\fR \. See \fB Initialization Files\fR in \fB help fish\fR to learn more about fish configuration\.
2016-01-01 21:12:40 +00: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 03:35:56 +00:00
.P
2016-02-07 11:06:04 +00:00
\fB conf\. d\fR , short for configuration directory, is used for initialization files, i\. e\. , files that should run at the start of the shell\. Files that follow the naming convention \fB <my_plugin>\. config\. fish\fR are added there\. If a file does not follow the \fB <my_plugin>\. config\. fish\fR convention, \fB <my_plugin>\fR will be added during the installation process\.
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 03:35:56 +00:00
.
2016-01-01 21:12:40 +00:00
.SS "PLUGINS"
2016-01-10 19:55:59 +00:00
Plugins are components that extend and add features to your shell\. To see what plugins are available use \fB fisher search\fR \. You can also type \fB fisher install\fR and hit \fI tab\fR once to get formatted plugin information\. The same works for \fB fisher update\fR and \fB fisher uninstall\fR \.
2016-01-01 21:12:40 +00:00
.
.P
To learn how to create plugins, see \fB fisher help plugins\fR \.
.
.P
2016-02-07 11:06:04 +00:00
You can install a plugin by their name, URL or by indicating the path to a local plugin project\.
2016-01-10 19:55:59 +00:00
.
.P
2016-02-07 11:06:04 +00:00
In order to install a plugin by \fI name\fR , it must be already published in the index database\. See \fB Index\fR \.
2016-01-01 21:12:40 +00:00
.
.IP "" 4
.
.nf
fisher install shark
.
.fi
.
.IP "" 0
.
.P
2016-01-10 19:55:59 +00:00
You can use an URL too if you have one\.
2016-01-01 21:12:40 +00:00
.
.IP "" 4
.
.nf
2016-01-10 07:01:07 +00:00
fisher install simnalamburt/shellder
2016-01-01 21:12:40 +00:00
.
.fi
.
.IP "" 0
.
.P
Ahoy! Fisherman 0.5.0
=====================
Add user key bindings support.
Recall $fisher_home/functions are always before user
functions in $fish_function_path. This was an early design
decision in order to prevent users from redefining core
functions by mistake or by means other than using plugins
(recommended). In other words, you are free to create a
plugin that modifies a Fisherman core function, but you
can't redefine a Fisherman function privately by saving it
to your user config fish. If you found a bug in a Fisherman
function, instead of creating a private patch send it
upstream. If you created a function that overrides a
Fisherman core feature, create a plugin. This way the
community can benefit from your code whenever you are ready
to publish it.
By default, Fisherman provides no fish_user_key_bindings,
so if the user has already defined their own
fish_user_key_bindings that one will not be affected.
Now, plugins can define their own key bindings inside a
fish_user_key_bindings.fish or key_bindings.fish at the root
of their repository or inside a functions directory. You can
put your key bindings inside a function or not. If you put
it inside a function, the function name must be the same as
the file without the .fish extension.
$fisher_config/bindings.fish When a plugin with key
bindings is installed for the first time or the only
one with bindings is uninstalled, Fisherman will modify
~/.config/functions/fish_user_key_bindings.fish (or create
it for the first time) and add a single line at the top
of the fish_user_key_bindings function to source the new
$fisher_config/bindings.fish. All the key bindings defined
by the enabled/installed plugins are concatenated and saved
to this file.
This mechanism has the following advantages:
Does not slow down shell start. Does not require Fisherman
to provide his own fish_user_key_bindings by default.
Honors any previously existing user key bindings. Allows
plugin to define their own key bindings and coexist
with the user's key bindings. If the user updates his
fish_user_key_bindings, re-running the function does update
the key bindings. Mega Refactoring
The entire source code of Fisherman received a
major revision and refactoring. The validation and
install/uninstall mechanisms were thoroughly revised and and
broken down into smaller functions easier to test as well as
several other sub parts of the system.
Rewrite fisher search and remove features that are mostly
already covered by fisher --list and remove the ability to
generate information about plugins of unknown origin. The
decision to remove this feature was based in performance
concerns and the result of thinking about the usability
and whether it was really worth the speed tradeoff. The
conclusion is I would rather have better performance and if
I need to query a plugins origin I can always use fisher
--list or fisher --list=url or fisher --list=author.
Add $fisher_update_interval to determine if the index should
update or not when a search query is taking place. The
default value is 10 seconds. This means the index will not
be updated if less than 10 seconds have elapsed since the
last action that triggered an update in the first place. See
Improve Install/Uninstall/Update status output. If a plugin
fails to install decrease the total. If any plugins are
skipped because they are already installed in the case of
fisher install or available in the cache, but disabled in
the case of fisher uninstall they are collected into an
array and displayed in a new section n plugin/s skipped (a,
b, c) at the bottom of the report.
Improve test coverage.
Tightly coupled functions were making testing increasingly
difficult. Most of the test effort was basically testing
whether git clone or git pull. New separation of concerns
makes tests run faster and the difficult install/uninstall
algorithms has better coverage now. Other
Now __fisher_list can list plugins from the cache, a
fishfile/bundle and plugins that are installed/enabled or
disabled. This removes __fisher_file and combines it with
__fisher_list. This also removes fisher -f and replaces it
with fisher -l <file> or fisher --list=<file>.
Rename __fisher_parse_help to __fisher_complete and have the
function create the completions automatically. This allows
you to complete your commands with parseable usage help
faster. The original design was fine, but this change
improves auto-complete performance so it was preferred.
Use __fisher_index_update when building file with Make. This
helps prevent an error when using a fish version < 2.2.0.
See #55 #50 #48.
Add __fisher_index_update to update the index and remove
previously undocumented fisher update --index. This
function is designed to bypass GitHub's server network
cache passing an arbitrary query string to curl like
$fisher_index?RANDOM_NUMBER. This means index updates are
immediately available now.
Add fisher --list=url option to display local plugin url or
path.
Add fisher --list=bare option to display local plugins in
the cache without the * enabled symbol.
Prepend > to the currently enabled theme when using fisher
--list[=cache]. Related #49.
Prepend * to plugin names to indicate they are currently
enabled when using fisher --list[=cache]. See #49.
2016-02-01 19:29:01 +00:00
If the domain or host is not provided, Fisherman will use \fB https://github\. com\fR by default\.
2016-01-01 21:12:40 +00:00
.
.P
2016-01-10 07:01:07 +00:00
In addition, all of the following \fB owner/repo\fR variations are accepted:
2016-01-01 21:12:40 +00:00
.
.IP "\(bu" 4
2016-01-10 07:01:07 +00:00
owner/repo \fB >\fR https://github\. com/owner/repo
2016-01-01 21:12:40 +00:00
.
.br
.
.IP "\(bu" 4
2016-01-10 07:01:07 +00:00
\fI github\fR /owner/repo \fB >\fR https://github\. com/owner/repo
.
.br
.
.IP "\(bu" 4
\fI gh\fR /owner/repo \fB >\fR https://github\. com/owner/repo
2016-01-01 21:12:40 +00:00
.
.br
.
.IP "" 0
.
.P
2016-01-10 07:01:07 +00:00
Shortcuts to other common Git repository hosting services are also available:
2016-01-01 21:12:40 +00:00
.
.IP "\(bu" 4
2016-01-10 07:01:07 +00:00
\fI bb\fR /owner/repo \fB >\fR https://bitbucket\. org/owner/repo
2016-01-01 21:12:40 +00:00
.
.br
.
.IP "\(bu" 4
2016-01-10 07:01:07 +00:00
\fI gl\fR /owner/repo \fB >\fR https://gitlab\. com/owner/repo
2016-01-01 21:12:40 +00:00
.
.br
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 03:35:56 +00:00
.
.IP "\(bu" 4
2016-01-10 07:01:07 +00:00
\fI omf\fR /owner/repo \fB >\fR https://github\. com/oh\- my\- fish/repo
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 03:35:56 +00:00
.
.br
2016-01-01 21:12:40 +00:00
.
.IP "" 0
.
.P
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 03:35:56 +00:00
Because of Fisherman\' s flat tree model, there is no technical distinction between plugins or prompts\. Installing a prompt is equivalent to switching themes in other systems\. The interface is always \fI install\fR , \fI update\fR or \fI uninstall\fR \.
2016-01-01 21:12:40 +00:00
.
.P
2016-02-07 11:06:04 +00:00
Throughout this document and other Fisherman manuals you will find the term prompt when referring to the \fI concept\fR of a theme, i\. e\. , a plugin that defines a \fB fish_prompt\fR / \fB fish_right_prompt\fR function/s\.
2016-01-01 21:12:40 +00:00
.
.SS "INDEX"
2016-02-07 11:06:04 +00:00
You can install, update and uninstall plugins by their name, querying the Fisherman index\. The index is a plain text flat database independently managed\. You can use a custom index file by setting \fB $fisher_index\fR to your own file or URL\. Redirection URLs are currently not supported due to security and performance concerns\. See \fB fisher help config\fR \.
2016-01-01 21:12:40 +00:00
.
.P
2016-02-07 11:06:04 +00:00
A copy of the index is downloaded each time a search query takes place, \fB $fisher_update_interval\fR seconds since the last update\. \fB $fisher_update_interval\fR is 10 seconds by default if not set\. This helps keeping the index up to date and allows you to search the database offline\.
2016-01-01 21:12:40 +00:00
.
.P
2016-02-07 11:06:04 +00:00
The index itself is a list of records, each consisting of the following fields:
2016-01-01 21:12:40 +00:00
.
.IP "\(bu" 4
2016-02-07 11:06:04 +00:00
\fB name\fR , \fB url\fR , \fB info\fR , one or more \fB tags\fR and \fB author\fR \.
2016-01-01 21:12:40 +00:00
.
.IP "" 0
.
.P
Fields are separated by a new line \fB \' \e n\' \fR \. Tags are separated by one \fI space\fR \. Here is a sample record:
.
.IP "" 4
.
.nf
shark
https://github\. com/bucaran/shark
2016-02-07 11:06:04 +00:00
Fantastic Sparkline Generator
chart tool report sparkline graph
2016-01-01 21:12:40 +00:00
bucaran
.
.fi
.
.IP "" 0
.
.P
To submit a new plugin for registration install the \fB submit\fR plugin:
.
.IP "" 4
.
.nf
fisher install submit
.
.fi
.
.IP "" 0
.
.P
For usage see the bundled documentation \fB fisher help submit\fR \.
.
.P
2016-02-07 11:06:04 +00:00
You can also submit a new plugin manually and create a pull request in the index repository (github\. com/fisherman/fisher\- index):
2016-01-01 21:12:40 +00:00
.
.IP "" 4
.
.nf
git clone https://github\. com/fisherman/fisher\- index
cd index
2016-01-10 07:01:07 +00:00
echo "$name\e n$URL\e n$info\e n$author\e n$tags\e n\e n" >> index
2016-01-01 21:12:40 +00:00
git push origin master
open http://github\. com
.
.fi
.
.IP "" 0
.
.SS "CACHE"
2016-02-07 11:06:04 +00:00
Downloaded plugins are stored as Git repositories under \fB $fisher_cache\fR \. See \fB fisher help config\fR to find out about other Fisherman configuration variables\.
2016-01-01 21:12:40 +00:00
.
.P
2016-02-07 11:06:04 +00:00
When you install or uninstall a plugin, Fisherman downloads the repository to the cache and copies only the relevant files from the cache to the loaded function and / or completion path\. In this sense, this location works also like an intermediate \fB stage\fR \. In addition, manual pages are added to the corresponding man directory and if a Makefile is also detected, the command \fB make\fR is run\.
2016-01-01 21:12:40 +00:00
.
.SS "FISHFILES"
2016-02-07 11:06:04 +00:00
Fishfiles let you share plugin configurations across multiple installations, let plugins declare dependencies and teach Fisherman what plugins are currently enabled / disabled when using \fB fisher \- \- list\fR \.
.
.P
Your fishfile is stored in \fB $fisher_config/fishfile\fR by default, but you can customize its location setting \fB $fisher_file\fR in your user fish configuration file\.
2016-01-01 21:12:40 +00:00
.
.P
Here is an example fishfile inside \fB $fisher_config\fR :
.
.IP "" 4
.
.nf
2016-02-07 11:06:04 +00:00
# Ahoy! This is my Fishfile
2016-01-01 21:12:40 +00:00
gitio
fishtape
2016-02-07 11:06:04 +00:00
shark
get
2016-01-01 21:12:40 +00:00
.
.fi
.
.IP "" 0
.
.P
The fishfile updates as you install / uninstall plugins\. See also \fB fisher help install\fR or \fB fisher help uninstall\fR \.
.
.SS "CONFIGURATION"
2016-02-07 11:06:04 +00:00
Fisherman allows a high level of configuration using \fB $fisher_*\fR variables\. You can customize the home and configuration directories, cache and fishfile location, index source URL, command aliases, etc\. See \fB fisher help config\fR \.
2016-01-01 21:12:40 +00:00
.
.P
2016-02-07 11:06:04 +00:00
You can also extend Fisherman by adding new commands and ship them as plugins\. Fisherman automatically adds completions to \fI commands\fR based in the function \fI description\fR and usage help if provided\. See \fB fisher help help\fR and \fB fisher help commands\fR \.
2016-01-01 21:12:40 +00:00
.
.P
2016-01-10 07:01:07 +00:00
To add completions to standalone utility plugins, use \fB complete(1)\fR \.
2016-01-01 21:12:40 +00:00
.
.SS "CLI"
If you are already familiar with other UNIX tools, you\' ll find Fisherman commands behave intuitively\.
.
.P
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
2016-02-13 11:37:49 +00:00
Fisherman also ships with a CLI options parser and a background job spinner that you can use to implement your own commands CLI\. See \fB getopts(1)\fR and \fB spin(1)\fR \.
2016-01-01 21:12:40 +00:00
.
.SH "COMPATIBILITY"
2016-02-07 11:06:04 +00:00
Fisherman supports Oh My Fish! themes and plugins, but some features are turned off by default for performance reasons\.
2016-01-01 21:12:40 +00:00
.
.P
2016-02-07 11:06:04 +00:00
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 \fB init\fR event functions and immediately invoke them using fish \fB emit(1)\fR \.
2016-01-01 21:12:40 +00:00
.
.P
2016-02-03 00:11:34 +00:00
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\.
2016-01-01 21:12:40 +00:00
.
.P
2016-02-07 11:06:04 +00:00
Not all plugins opt in the initialization mechanism, therefore support for this behavior is turned off by default\. If you would like Fisherman to behave like Oh My Fish! at the start of the shell session, install the \fB legacy\fR compatibility plugin\.
2016-01-01 21:12:40 +00:00
.
.IP "" 4
.
.nf
2016-02-07 11:06:04 +00:00
fisher install legacy
2016-01-01 21:12:40 +00:00
.
.fi
.
.IP "" 0
.
.P
2016-02-03 00:11:34 +00:00
This plugin also adds definitions for some of Oh My Fish! Core Library functions\.
2016-01-01 21:12:40 +00:00
.
.SH "SEE ALSO"
2016-01-10 07:01:07 +00:00
fisher(1)
2016-01-01 21:12:40 +00:00
.
.br
2016-01-10 07:01:07 +00:00
fisher help
2016-01-01 21:12:40 +00:00
.
.br
2016-01-10 07:01:07 +00:00
fisher help config
2016-01-01 21:12:40 +00:00
.
.br
2016-01-10 07:01:07 +00:00
fisher help plugins
2016-01-01 21:12:40 +00:00
.
.br
2016-01-10 07:01:07 +00:00
fisher help commands
2016-01-01 21:12:40 +00:00
.
.br
2016-02-13 11:37:49 +00:00
spin(1)
2016-01-01 21:12:40 +00:00
.
.br
2016-01-10 07:01:07 +00:00
getopts(1)
2016-01-01 21:12:40 +00:00
.
.br
