<sub>If you don't have Fish, you need to install it too. Install instructions can be found <ahref="https://github.com/fisherman/fisherman/wiki/Installing-Fish">here</a>.</sub>
<sub>Install instructions for fish can be found <ahref="https://github.com/fisherman/fisherman/wiki/Installing-Fish">here</a>.</sub>
The home directory. If you installed Fisherman using the recommended method curl -sL install.fisherman.sh | fish, the location ought to be *XDG_DATA_HOME/fisherman*. If you clone Fisherman and run make yourself, the current working directory is used by default.
* $fisher_home:
The home directory. If you installed Fisherman using the recommended method, the location ought to be *XDG_DATA_HOME/fisherman*.
* *$fisher_config*<br>
The configuration directory. This is default location of the*fishfile*, *key_bindings.fish*, *cache*, *functions*, *completions* and *conf.d* directories. The default location is *XDG_CONFIG_HOME/fisherman*.
* $fisher_config:
The configuration directory. This is default location of your*fishfile*, *key_bindings.fish*, *cache*, *functions*, *completions* and *conf.d* directories. *XDG_CONFIG_HOME/fisherman* by default.
* *$fisher_file*<br>
See FISHFILE above.
* $fisher_file:
See [fishfile](#fishfile) above.
* *$fisher_cache*<br>
* $fisher_cache:
The cache directory. Plugins are downloaded to this location.
* *$fisher_alias**command*=*alias* ...<br>
* $fisher_alias *command*=*alias* ...:
Use this variable to create aliases of Fisherman commands.
## Plugins
@ -263,26 +269,18 @@ fisher install new
fisher new plugin <meta.yml
```
See the documentation of new for details.
See the documentation for [new] for details.
### Utilities
Utilities are plugins that define one or more functions.
This example walks you through creating *wtc*, a plugin based in [ngerakines/commitment](https://github/ngerakines/commitment) random commit message generator.
* Create a directory and initialize a Git repository.
Below is a plugin based in [ngerakines/commitment](https://github/ngerakines/commitment) random commit message generator.
echo "$name\en$url\en$info\en$tags\en$author\en\en" >> index
git push origin master
.
.fi
.
.IP""0
.
.SH"FISHFILE"
Fisherman keeps track of a special file known as \fIfishfile\fR to know what plugins are currently enabled\.
.
.IP""4
.
.nf
# My Fishfile
gitio
fishtape
shark
get
shellder
fisher submit my_plugin description tags url
.
.fi
.
.IP""0
.
.P
This file is automatically updated as you install and uninstall plugins\.
Or, submit the plugin manually by creating a pull request in the index \fIhttps://github\.com/fisherman/fisher\-index\fR repository\.
.
.SH"VARIABLES"
.
.TP
$fisher_home
The home directory\. If you installed Fisherman using the recommended method\fBcurl \-sL install\.fisherman\.sh | fish\fR, the location ought to be \fIXDG_DATA_HOME/fisherman\fR\. If you clone Fisherman and run make yourself, the current working directory is used by default\.
\fB$fisher_home\fR
The home directory\. If you installed Fisherman using the recommended method, the location ought to be \fIXDG_DATA_HOME/fisherman\fR\.
.
.TP
$fisher_config
The configuration directory\. This is default location of the\fIfishfile\fR, \fIkey_bindings\.fish\fR, \fIcache\fR, \fIfunctions\fR, \fIcompletions\fR and \fIconf\.d\fR directories\.The default location is \fIXDG_CONFIG_HOME/fisherman\fR\.
The configuration directory\. This is default location of your \fIfishfile\fR, \fIkey_bindings\.fish\fR, \fIcache\fR, \fIfunctions\fR, \fIcompletions\fR and \fIconf\.d\fR directories\.\fIXDG_CONFIG_HOME/fisherman\fR by default\.
.
.TP
$fisher_file
@ -468,10 +459,7 @@ See the documentation of new for details\.
Utilities are plugins that define one or more functions\.
.
.P
This example walks you through creating \fIwtc\fR, a plugin based in \fIgithub/ngerakines/commitment\fR random commit message generator\.
.
.P
Create a directory and initialize a Git repository\.
Below is a plugin based in ngerakines/commitment \fIhttps://github/ngerakines/commitment\fR random commit message generator\.
.
.IP""4
.
@ -479,19 +467,6 @@ Create a directory and initialize a Git repository\.
echo "$name\n$url\n$info\n$tags\n$author\n\n" >> index
git push origin master
```
## FISHFILE
Fisherman keeps track of a special file known as *fishfile* to know what plugins are currently enabled.
```
# My Fishfile
gitio
fishtape
shark
get
shellder
fisher submit my_plugin description tags url
```
This file is automatically updated as you install and uninstall plugins.
Or, submit the plugin manually by creating a pull request in the [index](https://github.com/fisherman/fisher-index) repository.
## VARIABLES
* $fisher_home:
The home directory. If you installed Fisherman using the recommended method`curl -sL install.fisherman.sh | fish`, the location ought to be *XDG_DATA_HOME/fisherman*. If you clone Fisherman and run make yourself, the current working directory is used by default.
The home directory. If you installed Fisherman using the recommended method, the location ought to be *XDG_DATA_HOME/fisherman*.
* $fisher_config:
The configuration directory. This is default location of the*fishfile*, *key_bindings.fish*, *cache*, *functions*, *completions* and *conf.d* directories. The default location is *XDG_CONFIG_HOME/fisherman*.
The configuration directory. This is default location of your *fishfile*, *key_bindings.fish*, *cache*, *functions*, *completions* and *conf.d* directories. *XDG_CONFIG_HOME/fisherman* by default.
* $fisher_file:
See FISHFILE above.
@ -283,20 +265,12 @@ See the documentation of new for details.
Utilities are plugins that define one or more functions.
This example walks you through creating *wtc*, a plugin based in *github/ngerakines/commitment* random commit message generator.
Create a directory and initialize a Git repository.
Below is a plugin based in [ngerakines/commitment](https://github/ngerakines/commitment) random commit message generator.