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
190 lines
6 KiB
Groff
190 lines
6 KiB
Groff
.\" generated with Ronn/v0.7.3
|
|
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
|
.
|
|
.TH "FISHER\-FAQ" "7" "January 2016" "" "fisherman"
|
|
.
|
|
.SH "NAME"
|
|
\fBfisher\-faq\fR \- Frequently Asked Questions
|
|
.
|
|
.SH "SYNOPSIS"
|
|
This document attempts to answer some of Fisherman most frequently asked questions\. Feel free to create a new issue in the Fisherman issue tracker if your question is not answered here\.
|
|
.
|
|
.SS "What is Fisherman?"
|
|
Fisherman is a plugin manager for fish that lets you share and reuse code, prompts and configurations easily\.
|
|
.
|
|
.SS "What do I need to know to use Fisherman?"
|
|
Nothing\. You can continue using your shell as usual\. When you are ready to learn more just type \fBman fisher\fR or \fBman 7 fisher\fR\.
|
|
.
|
|
.SS "How do I access other Fisherman documentation?"
|
|
Fisherman documentation is based in UNIX \fBman(1)\fR pages\. See \fBman fisher\fR and \fBman 7 fisher\fR to get started\. You can also access any documentation using the \fBfisher help\fR command\.
|
|
.
|
|
.SS "What are Fisherman plugins?"
|
|
Plugins are written in fish and extend the shell core functionality, run initialization code, add completions or documentations to other commands, etc\. See \fBfisher help plugins\fR\.
|
|
.
|
|
.P
|
|
Plugins may list any number of dependencies to other plugins using a \fIfishfile\fR\.
|
|
.
|
|
.SS "What is a Fishfile?"
|
|
A plain text file that lists what plugins you have installed or a plugin\'s dependencies to other plugins\.
|
|
.
|
|
.P
|
|
Fishfiles let you share plugin configurations across multiple installations, allow plugins to declare dependencies, and prevent information loss in case of system failure\. See also \fBfisher help fishfile\fR\.
|
|
.
|
|
.SS "What kind of Fisherman plugins are there?"
|
|
There is no technical distinction between plugins, themes, commands, etc\., but there is a \fIconceptual\fR difference\.
|
|
.
|
|
.IP "\(bu" 4
|
|
\fBStandalone Utilities\fR: Plugins that define one or more functions, meant to be used at the command line\.
|
|
.
|
|
.IP "\(bu" 4
|
|
\fBPrompts / Themes\fR: Plugins that modify the appearance of the fish prompt by defining a \fBfish_prompt\fR and / or \fBfish_right_prompt\fR functions\.
|
|
.
|
|
.IP "\(bu" 4
|
|
\fBExtension Commands\fR: Plugins that extend Fisherman default commands\. An extension plugin must define one or more functions like \fBfisher_<my_command>\fR\. For specific information about commands, see \fBfisher help commands\fR and then return to this guide\.
|
|
.
|
|
.IP "\(bu" 4
|
|
\fBConfiguration Plugins\fR: Plugins that include one or more \fBmy_plugin\.config\.fish\fR files\. Files that follow this convention are evaluated at the start of the session\.
|
|
.
|
|
.IP "" 0
|
|
.
|
|
.P
|
|
See \fBfisher help plugins\fR and \fBfisher help commands\fR\.
|
|
.
|
|
.SS "Does Fisherman support oh\-my\-fish plugins and themes?"
|
|
Yes\. To install either a plugin or theme use their URL:
|
|
.
|
|
.IP "" 4
|
|
.
|
|
.nf
|
|
|
|
fisher install omf/plugin\-{rbenv,tab} omf/theme\-scorphish
|
|
.
|
|
.fi
|
|
.
|
|
.IP "" 0
|
|
.
|
|
.P
|
|
You can use the same mechanism to install any valid plugin from any given URL\. See also \fBCompatibility\fR in \fBfisher help tour\fR\.
|
|
.
|
|
.SS "What does Fisherman do exactly every time I create a new shell session?"
|
|
Essentially, add Fisherman functions and completions to the \fB$fish_{function,complete}_path\fR and evaluate files that follow the convention \fB*\.config\.fish\fR\.
|
|
.
|
|
.IP "" 4
|
|
.
|
|
.nf
|
|
|
|
set fish_function_path {$fisher_config,$fisher_home}/functions $fish_function_path
|
|
set fish_complete_path {$fisher_config,$fisher_home}/completions $fish_complete_path
|
|
|
|
for file in $fisher_config/conf\.d/*\.config\.fish
|
|
source $file
|
|
end
|
|
.
|
|
.fi
|
|
.
|
|
.IP "" 0
|
|
.
|
|
.P
|
|
See \fB$fisher_home/config\.fish\fR for the full code\.
|
|
.
|
|
.SS "How is Fisherman faster than oh\-my\-fish/Wahoo, etc?"
|
|
Fisherman ameliorates the slow shell start problem using a flat dependency tree instead of loading a directory hierarchy per plugin\. This also means that Fisherman performance does not decline depending on the number of plugins installed\. See also \fBFlat Tree\fR in \fBfisher help tour\fR\.
|
|
.
|
|
.SS "Why don\'t you contribute your improvements back to oh\-my\-fish instead of creating a new project?"
|
|
I have contributed back to oh\-my\-fish extensively\. See also oh\-my\-fish history for August 27, 2015 when another project, Wahoo, was entirely merged with oh\-my\-fish\.
|
|
.
|
|
.P
|
|
In addition, Fisherman was built from the ground up using a completely different design, implementation and set of principles\.
|
|
.
|
|
.P
|
|
Some features include: UNIX familiarity, minimalistic design, flat tree structure, unified plugin architecture, external self\-managed database, cache system, dependency manifest file and compatibility with oh\-my\-fish, etc\. See \fBfisher help tour\fR\.
|
|
.
|
|
.SS "How can I upgrade from an existing oh\-my\-fish or Wahoo installation?"
|
|
Install Fisherman\.
|
|
.
|
|
.IP "" 4
|
|
.
|
|
.nf
|
|
|
|
git clone https://github\.com/fisherman/fisherman
|
|
cd fisherman
|
|
make
|
|
.
|
|
.fi
|
|
.
|
|
.IP "" 0
|
|
.
|
|
.P
|
|
You can now safely remove oh\-my\-fish \fB$OMF_PATH\fR and \fB$OMF_CONFIG\fR\.
|
|
.
|
|
.P
|
|
Backup dotfiles and other sensitive data first\.
|
|
.
|
|
.IP "" 4
|
|
.
|
|
.nf
|
|
|
|
rm \-rf {$OMF_PATH,$OMF_CONFIG}
|
|
.
|
|
.fi
|
|
.
|
|
.IP "" 0
|
|
.
|
|
.SS "I changed my prompt with <code>fish_config</code> and now I can\'t use any Fisherman theme, what do I do?"
|
|
\fBfish_config\fR persists the prompt to \fBXDG_CONFIG_HOME/fish/functions/fish_prompt\.fish\fR\. That file takes precedence over Fisherman prompts that installs to \fB$fisher_config/functions\fR\. To use Fisherman prompts remove the \fBfish_promt\.fish\fR inside \fBXDG_CONFIG_HOME/fish/functions\fR\.
|
|
.
|
|
.P
|
|
Assuming \fBXDG_CONFIG_HOME\fR is \fB~/\.config\fR in your system:
|
|
.
|
|
.IP "" 4
|
|
.
|
|
.nf
|
|
|
|
rm ~/\.config/fish/functions/fish_prompt\.fish
|
|
.
|
|
.fi
|
|
.
|
|
.IP "" 0
|
|
.
|
|
.SS "How do I use fish as my default shell?"
|
|
Add Fish to \fB/etc/shells\fR:
|
|
.
|
|
.IP "" 4
|
|
.
|
|
.nf
|
|
|
|
echo "/usr/local/bin/fish" | sudo tee \-a /etc/shells
|
|
.
|
|
.fi
|
|
.
|
|
.IP "" 0
|
|
.
|
|
.P
|
|
Make Fish your default shell:
|
|
.
|
|
.IP "" 4
|
|
.
|
|
.nf
|
|
|
|
chsh \-s /usr/local/bin/fish
|
|
.
|
|
.fi
|
|
.
|
|
.IP "" 0
|
|
.
|
|
.P
|
|
To switch back to another shell\.
|
|
.
|
|
.IP "" 4
|
|
.
|
|
.nf
|
|
|
|
chsh \-s /bin/another/shell
|
|
.
|
|
.fi
|
|
.
|
|
.IP "" 0
|
|
.
|
|
.SS "Why is this FAQ similar to the oh\-my\-fish FAQ?"
|
|
Because it was written by the same author of Fisherman and Wahoo and some of the questions and answers simply overlap\.
|