fisher/man/man7/fisher-config.md
Jorge Bucaran 4b15cf374f
Ahoy! We are getting close to 0.8.0
* Move AUTHORS -> THANKS and remove automatic generation.

THANKS is more sensible than AUTHORS. CREDITS was second best.
Also, after perusing similar files in other projects I noticed
some entries lacking a valid email address and decided fow now
this file should be curated manually to make sure each entry
contains a useful link. This allows users who have contributed
to the project ways other than committing code to be added to
the list as well.

* Rename wait -> spin.

* Remove extra padding in links. (Cosmetic)

* Update to reflect API refactorings.

* Fix bug causing brackets to show up in description.

* Implement using spin function.

* __fisher_gist_to_name uses curl to query the GitHub API which will
return a JSON stream even if the Gist could not be found. So, it's
not possible to determine whether we failed or not using our spin
function and actually need to check the returned string to see if
it contains a valid name or not.

* Let git pull write errors to stderr.

* Use new internal __fisher_spin.

* Extract spin to independent / external module and tweak Makefile
to better integrate with new install process.
2016-02-14 13:17:47 +09:00

2 KiB

fisher-config(7) -- Fisherman Configuration

SYNOPSIS

This document describes how to use Fisherman configuration variables.

DESCRIPTION

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.

Using the following variables, you can customize the locations of the cache, index URL, fishfile, create command aliases, etc.

VARIABLES

  • $fisher_home: The home directory. If you installed Fisherman using the recommended method curl -sL install.fisherman.sh | fish, the location will be $XDG_DATA_HOME/fisherman. If you clone Fisherman and run make yourself, $fisher_home will the current working directory.

  • $fisher_config: The user configuration directory. This is default location of your user fishfile, Fisherman key_bindings.fish file and the cache, functions, completions, conf.d and scripts directories. $XDG_CONFIG_HOME/fisherman by default.

  • $fisher_file: This file keeps a list of what plugins you have installed and are currently enabled. $fisher_config/fishfile by default. See fisher help fishfile for details.

  • $fisher_cache: 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).

  • $fisher_alias command=alias[,...] [command2=alias[,...]]: Use this variable to define custom aliases for fisher commands. See Examples below.

EXAMPLES

  • Create aliases for fisher install to i, in and inst; and for fisher update to up.
set fisher_alias install=i,in,inst update=up

SEE ALSO

fisher help tour