mirror of
https://github.com/jorgebucaran/fisher
synced 2024-11-09 07:10:27 +00:00
707855203a
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.
83 lines
1.5 KiB
Groff
83 lines
1.5 KiB
Groff
.\" generated with Ronn/v0.7.3
|
|
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
|
.
|
|
.TH "FISHER\-COMMANDS" "7" "January 2016" "" "fisherman"
|
|
.
|
|
.SH "NAME"
|
|
\fBfisher\-commands\fR \- Creating Fisherman Commands
|
|
.
|
|
.SH "SYNOPSIS"
|
|
This document describes how to add new commands to Fisherman\. A Fisherman command is a function that you can invoke like \fBfisher command\fR [\fIoptions\fR]\.
|
|
.
|
|
.SH "DESCRIPTION"
|
|
To add a command, create a function \fBfisher_<my_command>\fR:
|
|
.
|
|
.IP "" 4
|
|
.
|
|
.nf
|
|
|
|
function fisher_hello \-d "Friendly command"
|
|
echo hello
|
|
end
|
|
.
|
|
.fi
|
|
.
|
|
.IP "" 0
|
|
.
|
|
.P
|
|
Make sure it works: \fBfisher hello\fR\.
|
|
.
|
|
.P
|
|
To make this function available to the current and future fish sessions, add it to \fB$XDG_CONFIG_HOME/fish/functions\fR:
|
|
.
|
|
.IP "" 4
|
|
.
|
|
.nf
|
|
|
|
funcsave fisher_hello
|
|
.
|
|
.fi
|
|
.
|
|
.IP "" 0
|
|
.
|
|
.P
|
|
You may also choose to save this function to \fB$fisher_config/functions\fR\.
|
|
.
|
|
.SH "EXAMPLES"
|
|
The following example implements a command to retrieve plugin information and format the output into columns\.
|
|
.
|
|
.IP "" 4
|
|
.
|
|
.nf
|
|
|
|
function fisher_info \-d "Display information about plugins"
|
|
switch "$argv"
|
|
case \-h \-\-help
|
|
printf "usage: fisher info name | URL [\.\.\.]\en\en"
|
|
printf " \-h \-\-help Show usage help\en"
|
|
return
|
|
end
|
|
for item in $argv
|
|
fisher search $item \-\-name \-\-info
|
|
end | sed \-E \'s/;/: /\' | column
|
|
end
|
|
.
|
|
.fi
|
|
.
|
|
.IP "" 0
|
|
.
|
|
.SH "SEE ALSO"
|
|
fisher(1)
|
|
.
|
|
.br
|
|
fisher(7)
|
|
.
|
|
.br
|
|
funcsave(1)
|
|
.
|
|
.br
|
|
fisher help plugins
|
|
.
|
|
.br
|
|
|