mirror of
https://github.com/jorgebucaran/fisher
synced 2024-07-02 23:11:48 +02:00
ee0338d5b0
This patch contains several amends for 0.3.0 and other minor documentation corrections. Major documentation revision and rewrite. fisher help shows fisher(1) by default now. Fix a critical bug that was causing fisher uninstall --force to remove not the symbolic link, but the actual files. Closes #24 Rename orphan tag to custom for plugins installed using a custom URL. warning Remove fisher --link flag and create symbolic links by default for local paths. The user does not have to worry about symbolic links or whether the copy is as symbolic link or not anymore. If the user tries to install a local path, then the best thing to do is to create a symbolic link. This also eliminates the need to call update. warning Remove fisher --cache and fisher --validate. Now, that these options are separated into their own function and they are intentionally private, there is no need for them.
89 lines
3 KiB
Groff
89 lines
3 KiB
Groff
.\" generated with Ronn/v0.7.3
|
|
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
|
.
|
|
.TH "FISHER\-CONFIG" "7" "January 2016" "" "fisherman"
|
|
.
|
|
.SH "NAME"
|
|
\fBfisher\-config\fR \- Fisherman Configuration
|
|
.
|
|
.SH "SYNOPSIS"
|
|
This document describes how to use the available configuration options to customize Fisherman\.
|
|
.
|
|
.SH "DESCRIPTION"
|
|
Your fish user configuration, usually located in \fB$XDG_CONFIG_HOME/fish/config\.fish\fR is updated after installing Fisherman to add the global variables \fB$fisher_home\fR and \fB$fisher_config\fR\.
|
|
.
|
|
.P
|
|
\fB$fisher_home\fR 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 \fB$fisher_home\fR as well\.
|
|
.
|
|
.P
|
|
\fB$fisher_config\fR is the user configuration directory and the location of your user \fIfishfile\fR, \fIcache\fR directory and where plugins get installed to\. This location must be different from \fB$fisher_home\fR\. The default location is \fB$XDG_CONFIG_HOME/fisherman\fR\.
|
|
.
|
|
.P
|
|
You can also customize the debug log path, cache location, index source URL, command aliases, and other options via \fB$fisher_*\fR variables\.
|
|
.
|
|
.SH "VARIABLES"
|
|
.
|
|
.TP
|
|
\fB$fisher_home\fR
|
|
The home directory\. This is the path where you downloaded Fisherman\.
|
|
.
|
|
.TP
|
|
\fB$fisher_config\fR
|
|
The user configuration directory\. \fB$XDG_CONFIG_HOME/fisherman\fR by default\. This directory is where the \fIcache\fR, \fIfunctions\fR and \fIcompletions\fR directories are located\.
|
|
.
|
|
.TP
|
|
\fB$fisher_cache\fR
|
|
The cache directory\. Plugins are first downloaded here and installed to \fB$fisher_config/functions\fR afterwards\. The cache is \fB$fisher_config/cache\fR by default\.
|
|
.
|
|
.TP
|
|
\fB$fisher_index\fR
|
|
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 \fBcurl(1)\fR\. See also \fBIndex\fR in \fBfisher(7)\fR\.
|
|
.
|
|
.TP
|
|
\fB$fisher_error_log\fR
|
|
This file keeps a log of the most recent crash stack trace\. \fB$fisher_cache/\.debug_log\fR by default\.
|
|
.
|
|
.TP
|
|
\fB$fisher_alias command=alias[,\.\.\.] [command2=alias[,\.\.\.]]\fR
|
|
Use this variable to define custom aliases for fisher commands\. See \fBExamples\fR below\.
|
|
.
|
|
.TP
|
|
\fB$fisher_default_host\fR
|
|
Use this variable to define your preferred git host\. Fisherman uses this value to convert short urls like \fBowner/repo\fR to \fBhttps://host/owner/repo\fR\. The default host is \fIgithub\.com\fR\.
|
|
.
|
|
.SH "EXAMPLES"
|
|
.
|
|
.IP "\(bu" 4
|
|
Create aliases for fisher \fBinstall\fR to \fIi\fR, \fIin\fR and \fIinst\fR; and for fisher \fBupdate\fR to \fIup\fR\.
|
|
.
|
|
.IP "" 0
|
|
.
|
|
.IP "" 4
|
|
.
|
|
.nf
|
|
|
|
set fisher_alias install=i,in,inst update=up
|
|
.
|
|
.fi
|
|
.
|
|
.IP "" 0
|
|
.
|
|
.IP "\(bu" 4
|
|
Set \fB$fisher_index\fR and \fB$fisher_default_host\fR\.
|
|
.
|
|
.IP "" 0
|
|
.
|
|
.IP "" 4
|
|
.
|
|
.nf
|
|
|
|
set fisher_index https://raw\.\.\./owner/repo/master/index2\.txt
|
|
set fisher_default_host bitbucket\.org
|
|
.
|
|
.fi
|
|
.
|
|
.IP "" 0
|
|
.
|
|
.SH "SEE ALSO"
|
|
fisher(7)
|