mirror of
https://github.com/jorgebucaran/fisher
synced 2024-07-02 23:11:48 +02:00
9a4f0f0650
* Improved README, added links to screencasts, updated documentation with new changes and fixed other typos and composition errors. * Removed `fisher update --cache` in favor of `fisher --cache | fisher update` and `fisher uninstall --all` in favor of `fisher --cache | fisher uninstall`. * Fisherman does not move initialization / configuration files following the convention `name`.config.fish to `$fisher_config/functions`, but to `$fisher_config/conf.d` now and evaluates each `*.config.fish` inside at shell start as usual. Closes #13. * Added `fisher --cache[=base]` option to retrieve contents in `$fisher_cache`, eliminating flaky usage of `find(1)`. Closes #11. * Fisherman now generates information about plugins installed via custom URLs. For the description, a shortened version of the URL is used. For the URL the full URL is used. For tags, the URL is fuzzily checked and tags such as _theme_, _plugin_, _config_ and _omf_ are added. The tag _orphan_ is added by default as well. Finally, the author is generated by retrieving the e-mail or username of the author of the first commit in the plugin's repository. Closes #9 and #14. * Changed `--path-in-cache` to `--translate.` This function translates an name or supported URL/URL variation into a path inside `$fisher_cache`. This allows you to treat plugins installed via custom URLs almost like regular plugins if they are installed. Closes #8. * Fixed a bug with `mktemp` failing on some systems. Closes #7. Thanks @tobywf. * Added [CODE_OF_CONDUCT][code_of_conduct]. Closes #6. * Fisherman can now unload themes within the same shell, without having to restart the session. Closes #5. * Fisherman can now load themes within the same shell, without having to restart the session using `exec fish`. Shoddy themes, for example those failing to declare global variables with the `-g` flag still require the session to be reset. See [**related**][bobthefish-19]. Closes #4. * Move `getopts` implementation to `share/getopts.awk`. Closes #3. * Support dots inside URIs in `fisher --validate`. Closes #2.
180 lines
3.6 KiB
Groff
180 lines
3.6 KiB
Groff
.\" generated with Ronn/v0.7.3
|
|
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
|
.
|
|
.TH "FISHER\-INSTALL" "1" "January 2016" "" "fisherman"
|
|
.
|
|
.SH "NAME"
|
|
\fBfisher\-install\fR \- Enable / Install plugins
|
|
.
|
|
.SH "SYNOPSIS"
|
|
fisher \fBinstall\fR [\fIname\fR or \fIurl\fR \.\.\.] [\fB\-\-quiet\fR] [\fB\-\-help\fR]
|
|
.
|
|
.SH "USAGE"
|
|
fisher \fBinstall\fR \fIplugin\fR \.\.\.
|
|
.
|
|
.br
|
|
fisher \fBinstall\fR \fIowner/repo\fR \.\.\.
|
|
.
|
|
.br
|
|
.
|
|
.SH "DESCRIPTION"
|
|
Install one or \fImore\fR plugins by \fIname\fR, searching \fB$fisher_index\fR or by \fIurl\fR\. If no arguments are given, read the standard input\.
|
|
.
|
|
.P
|
|
If the domain or host is not provided, Fisherman will use any value in \fB$fisher_default_host\fR\. The default is \fBhttps://github\.com\fR\.
|
|
.
|
|
.P
|
|
In addition, all of the following variations are accepted:
|
|
.
|
|
.IP "\(bu" 4
|
|
\fBgithub\fR/owner/repo \fB\->\fR https://github\.com/owner/repo
|
|
.
|
|
.br
|
|
|
|
.
|
|
.IP "\(bu" 4
|
|
\fBgh:\fRowner/repo \fB\->\fR https://github\.com/owner/repo
|
|
.
|
|
.br
|
|
|
|
.
|
|
.IP "" 0
|
|
.
|
|
.P
|
|
Shortcuts for other common Git repository hosting services are also available:
|
|
.
|
|
.IP "\(bu" 4
|
|
\fBbb:\fR/owner/repo \fB\->\fR https://bitbucket\.org/owner/repo
|
|
.
|
|
.br
|
|
|
|
.
|
|
.IP "\(bu" 4
|
|
\fBgl:\fR/owner/repo \fB\->\fR https://gitlab\.com/owner/repo
|
|
.
|
|
.br
|
|
|
|
.
|
|
.IP "\(bu" 4
|
|
\fBomf:\fR/owner/repo \fB\->\fR https://github\.com/oh\-my\-fish/repo
|
|
.
|
|
.br
|
|
|
|
.
|
|
.IP "" 0
|
|
.
|
|
.P
|
|
If a copy of the plugin already exists in \fB$fisher_cache\fR, the relevant files will be copied to \fB$fisher_config\fR/functions, otherwise the plugin repository is first downloaded\. If you wish to update a plugin, use \fBfisher update\fR \fIplugin\fR instead\.
|
|
.
|
|
.P
|
|
If the plugin declares dependencies, these will be installed as well\. If any dependencies are already installed they will not be updated in order to prevent version issues\. See \fBfisher help fishfile\fR#{\fBPlugins\fR}\.
|
|
.
|
|
.P
|
|
If a plugin includes either a fish_prompt\.fish or fish_right_prompt\.fish, both files are first removed from \fB$fisher_config\fR/functions and then the new ones are copied\.
|
|
.
|
|
.SH "OPTIONS"
|
|
.
|
|
.TP
|
|
\fB\-q\fR \fB\-\-quiet\fR
|
|
Enable quiet mode\.
|
|
.
|
|
.TP
|
|
\fB\-h\fR \fB\-\-help\fR
|
|
Show usage help\.
|
|
.
|
|
.SH "PROCESS"
|
|
Here is a typical install process breakdown for \fIplugin\fR:
|
|
.
|
|
.IP "1." 4
|
|
Check if \fIplugin\fR exists in \fB$fisher_index\fR\. Fail otherwise\.
|
|
.
|
|
.IP "2." 4
|
|
Download \fIplugin\fR to \fB$fisher_cache\fR if it is not there already\.
|
|
.
|
|
.IP "3." 4
|
|
Copy all \fB*\.fish\fR and functions/\fB*\.fish\fR files to \fB$fisher_config\fR/functions\.
|
|
.
|
|
.IP "4." 4
|
|
Copy all completions/\fB*\.fish\fR to \fB$fisher_config\fR/completions\.
|
|
.
|
|
.IP "5." 4
|
|
Copy all man/man[\fB1\-7\fR] to \fB$fisher_config\fR/man/man\fB%\fR
|
|
.
|
|
.IP "" 0
|
|
.
|
|
.P
|
|
Here is the \fIplugin\fR tree inside the cache:
|
|
.
|
|
.P
|
|
\fB$fisher_cache\fR/\fIplugin\fR
|
|
.
|
|
.br
|
|
|\-\- README\.md
|
|
.
|
|
.br
|
|
|\-\- \fIplugin\fR\.fish
|
|
.
|
|
.br
|
|
|\-\- functions
|
|
.
|
|
.br
|
|
| |\-\- plugin_helper\.fish
|
|
.
|
|
.br
|
|
|\-\- completions
|
|
.
|
|
.br
|
|
| |\-\- \fIplugin\fR\.fish
|
|
.
|
|
.br
|
|
|\-\- test
|
|
.
|
|
.br
|
|
| |\-\- \fIplugin\fR\.fish
|
|
.
|
|
.br
|
|
|\-\- man
|
|
.
|
|
.br
|
|
|\-\- man1
|
|
.
|
|
.br
|
|
|\-\- \fIplugin\fR\.1
|
|
.
|
|
.br
|
|
.
|
|
.P
|
|
And thisi is how the files are copied from \fB$fisher_cache\fR/plugin to \fB$fisher_config\fR:
|
|
.
|
|
.IP "1." 4
|
|
\fIplugin\fR\.fish \fB\->\fR $fisher_config/functions
|
|
.
|
|
.IP "2." 4
|
|
functions/plugin_helper\.fish \fB\->\fR $fisher_config/functions
|
|
.
|
|
.IP "3." 4
|
|
completions/\fIplugin\fR\.fish \fB\->\fR $fisher_config/completions
|
|
.
|
|
.IP "4." 4
|
|
man/man1/\fIplugin\fR\.1 \fB\->\fR $fisher_config/man/man1
|
|
.
|
|
.IP "" 0
|
|
.
|
|
.SH "SEE ALSO"
|
|
\fBfisher\fR(1)
|
|
.
|
|
.br
|
|
\fBfisher help config\fR
|
|
.
|
|
.br
|
|
\fBfisher help update\fR
|
|
.
|
|
.br
|
|
\fBfisher help uninstall\fR
|
|
.
|
|
.br
|
|
\fBfisher help fishfile\fR#{\fBPlugins\fR}
|
|
.
|
|
.br
|
|
|