mirror of https://github.com/jorgebucaran/fisher
You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
55 lines
2.3 KiB
Markdown
55 lines
2.3 KiB
Markdown
fisher-config(7) -- Fisherman Configuration
|
|
===========================================
|
|
|
|
## SYNOPSIS
|
|
|
|
This document describes how to use the available configuration options to customize Fisherman.
|
|
|
|
## 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`.
|
|
|
|
`$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.
|
|
|
|
`$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`.
|
|
|
|
You can also customize the debug log path, cache location, index source URL, command aliases, and other options via `$fisher_*` variables.
|
|
|
|
## VARIABLES
|
|
|
|
* `$fisher_home`:
|
|
The home directory. This is the path where you downloaded Fisherman.
|
|
|
|
* `$fisher_config`:
|
|
The user configuration directory. `$XDG_CONFIG_HOME/fisherman` by default. This directory is where the *cache*, *functions* and *completions* directories are located.
|
|
|
|
* `$fisher_cache`:
|
|
The cache directory. Plugins are first downloaded here and installed to `$fisher_config/functions` afterwards. The cache is `$fisher_config/cache` by default.
|
|
|
|
* `$fisher_index`:
|
|
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`.
|
|
|
|
* `$fisher_file`:
|
|
This file keeps a list of what plugins you have installed and are currently enabled. `$fisher_cofig/fishfile` by default.
|
|
|
|
* `$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
|
|
```
|
|
|
|
* Set `$fisher_index` to a custom database.
|
|
|
|
```
|
|
set fisher_index https://raw.../owner/repo/master/index2.txt
|
|
```
|
|
|
|
## SEE ALSO
|
|
|
|
fisher help tour
|