2016-01-01 21:12:40 +00:00
fisher-config(7) -- Fisherman Configuration
===========================================
## SYNOPSIS
This document describes how to use the available configuration options to customize Fisherman.
## DESCRIPTION
2016-01-10 07:01:07 +00:00
Your fish user configuration, usually located in `$XDG_CONFIG_HOME/fish/config.fish` is updated after installing Fisherman to add the global variables `$fisher_home` and `$fisher_config` .
2016-01-01 21:12:40 +00:00
2016-01-10 07:01:07 +00:00
`$fisher_home` is the directory where you downloaded Fisherman. This location can be anywhere you like. If you changed this location after installing Fisherman, you need to update `$fisher_home` as well.
2016-01-01 21:12:40 +00:00
2016-01-10 07:01:07 +00:00
`$fisher_config` is the user configuration directory and the location of your user *fishfile* , *cache* directory and where plugins get installed to. This location must be different from `$fisher_home` . The default location is `$XDG_CONFIG_HOME/fisherman` .
2016-01-01 21:12:40 +00:00
2016-01-10 07:01:07 +00:00
You can also customize the debug log path, cache location, index source URL, command aliases, and other options via `$fisher_*` variables.
2016-01-01 21:12:40 +00:00
## VARIABLES
* `$fisher_home` :
The home directory. This is the path where you downloaded Fisherman.
* `$fisher_config` :
2016-01-10 07:01:07 +00:00
The user configuration directory. `$XDG_CONFIG_HOME/fisherman` by default. This directory is where the *cache* , *functions* and *completions* directories are located.
2016-01-01 21:12:40 +00:00
* `$fisher_cache` :
2016-01-10 07:01:07 +00:00
The cache directory. Plugins are first downloaded here and installed to `$fisher_config/functions` afterwards. The cache is `$fisher_config/cache` by default.
2016-01-01 21:12:40 +00:00
* `$fisher_index` :
2016-01-10 19:55:59 +00:00
Index source URL or file. To use a different index set this to a file or URL. Redirect urls are not supported due to security and performance concerns. The underlying request and fetch mechanism is based in `curl(1)` . See also `Index` in `fisher help tour` .
2016-01-01 21:12:40 +00:00
* `$fisher_error_log` :
2016-01-10 07:01:07 +00:00
This file keeps a log of the most recent crash stack trace. `$fisher_cache/.debug_log` by default.
2016-01-01 21:12:40 +00:00
2016-01-10 07:01:07 +00:00
* `$fisher_alias command=alias[,...] [command2=alias[,...]]` :
Use this variable to define custom aliases for fisher commands. See `Examples` below.
2016-01-01 21:12:40 +00:00
2016-01-10 07:01:07 +00:00
* `$fisher_default_host` :
2016-01-01 21:12:40 +00:00
Use this variable to define your preferred git host. Fisherman uses this value to convert short urls like `owner/repo` to `https://host/owner/repo` . The default host is *github.com* .
2016-01-10 19:55:59 +00:00
* `$fisher_share` :
Used to share scripts other than `.fish` files between plugins. Use `$fisher_share_extensions` to customize what extensions are used.
* `$fisher_share_extensions` :
Customize what file extensions are copied to `$fisher_config` when sharing scripts. By default `py rb php pl awk sed` are used.
2016-01-01 21:12:40 +00:00
## 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 03:35:56 +00:00
* Create aliases for fisher `install` to *i* , *in* and *inst* ; and for fisher `update` to *up* .
2016-01-01 21:12:40 +00:00
```
set fisher_alias install=i,in,inst update=up
```
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
* Set `$fisher_index` and `$fisher_default_host` .
2016-01-01 21:12:40 +00:00
```
set fisher_index https://raw.../owner/repo/master/index2.txt
set fisher_default_host bitbucket.org
```
## SEE ALSO
2016-01-10 19:55:59 +00:00
fisher help tour
