mirror of
https://github.com/jorgebucaran/fisher
synced 2024-07-02 23:11:48 +02:00
ab43e5f804
www.fisherman.sh Still a WIP. Powered by Jekyll and hosted by GitHub pages. * Refactor fisher install / fisher uninstall by extracting the logic to enable / disable plugins into __fisher_plugin. The algorithm to enable/disable plugins is essentially the same. The only difference is enable, copies/symlinks files and disable removes them from $fisher_config/.... Closes #45. * Add support for legacy oh-my-fish! plugins using .load initialization files. Closes #35. * Add support for Tackle Fish framework initialization modules. Closes #35. * Add support for plugins that share scripts in languages like Python or Perl. For example oh-my-fish/plugin-vi-mode assumes there is a vi-mode-impl.py file in the same path of the running script. This opens the door for including code snippets in other languages. * Any files inside a share directory, except for *.md or *.fish files, are copied to $fisher_config/functions. This allows you to run legacy plugins that retrieve the currently running script path with (dirname (status -f)) out of the box. * A cleaner alternative is using the new $fisher_share variable like this: python $fisher_share/my_plugin_script.py. * $fisher_share points to $fisher_config/share by default, but you may change this in your user config.fish. This path contains copies (or symbolic links) to the same script files copied to $fisher_config/functions. * Introduce the $fisher_share_extensions variable to let you customize what extensions Fisherman is aware of. Only extensions in this array will be processed during the install process. The default is py rb php pl awk sed. * .fish and .md extensions are always ignored. * Remove ad-hoc debug d function created by mistake in the Fisherman config.fish file. Closes #34. * Remove almost useless fisher --alias. You can still create aliases using $fisher_alias. It's difficult to add auto-complete to this feature, and even if we do so, it is slow. * Fix bug introduced in the previous release caused by swapping the lines that calculate the index of the current plugin being installed/updated/uninstalled and the line that displays the value, causing the CLI to show incorrect values. Closes #36. Thanks @kballard * Add cache, enabled and disabled options to fisher --list. Now you can type fisher -l enabled to get a list of what plugins are currently enabled. * Add new $fisher_plugins universal variable to keep track of what plugins are enabled / disabled. * Update completions after a plugin is installed, updated or uninstalled. * Improve autocomplete speed by removing the descriptions from plugins installed with custom URLs. * fisher --list displays nothing and returns 1 when there are no plugins installed. Closes #38. * fisher uninstall does not attempt to uninstall plugins already disabled by looking at the $fisher_plugins array. --force will bypass this. Closes #40
97 lines
3.3 KiB
Groff
97 lines
3.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 help tour\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\.
|
|
.
|
|
.TP
|
|
\fB$fisher_share\fR
|
|
Used to share scripts other than \fB\.fish\fR files between plugins\. Use \fB$fisher_share_extensions\fR to customize what extensions are used\.
|
|
.
|
|
.TP
|
|
\fB$fisher_share_extensions\fR
|
|
Customize what file extensions are copied to \fB$fisher_config\fR when sharing scripts\. By default \fBpy rb php pl awk sed\fR are used\.
|
|
.
|
|
.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 help tour
|