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.
137 lines
2.7 KiB
Groff
137 lines
2.7 KiB
Groff
.\" generated with Ronn/v0.7.3
|
|
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
|
.
|
|
.TH "FISHER" "1" "January 2016" "" "fisherman"
|
|
.
|
|
.SH "NAME"
|
|
\fBfisher\fR \- Fish Plugin Manager
|
|
.
|
|
.SH "SYNOPSIS"
|
|
\fBfisher\fR \fIcommand\fR [\fIoptions\fR] [\fB\-\-version\fR] [\fB\-\-help\fR]
|
|
.
|
|
.br
|
|
\fBfisher\fR \fB\-\-list\fR
|
|
.
|
|
.br
|
|
\fBfisher\fR \fB\-\-alias\fR[=\fIcommand\fR=[\fIalias\fR[,\.\.\.]]]
|
|
.
|
|
.br
|
|
\fBfisher\fR \fB\-\-file\fR=\fIfishfile\fR
|
|
.
|
|
.br
|
|
.
|
|
.SH "DESCRIPTION"
|
|
Fisherman is a plugin manager for \fBfish(1)\fR that lets you share and reuse code, prompts and configurations easily\.
|
|
.
|
|
.P
|
|
The following commands are available: \fIinstall\fR, \fIuninstall\fR, \fIupdate\fR, \fIsearch\fR and \fIhelp\fR\. See \fBfisher\fR help \fIcommand\fR for information about each command\.
|
|
.
|
|
.SH "OPTIONS"
|
|
.
|
|
.TP
|
|
\fB\-\-list\fR
|
|
List plugins in the \fB$fisher_cache\fR\. Includes plugins installed using a custom URL\.
|
|
.
|
|
.TP
|
|
\fB\-a \-\-alias[=command=[alias[,\.\.\.]]]\fR
|
|
Define one or more comma\-separated \fIalias\fR for \fIcommand\fR using \fB$fisher_alias\fR\. If no value is given, lists all existing aliases\.
|
|
.
|
|
.TP
|
|
\fB\-f \-\-file=fishfile\fR
|
|
Read \fIfishfile\fR and display its contents\. If \fIfishfile\fR is null or an empty string, your user \fIfishfile\fR in \fB$fisher_config/fishfile\fR will be used instead\. Use a dash \fB\-\fR to force reading from the standard input\. oh\-my\-fish bundle files are supported as well\.
|
|
.
|
|
.TP
|
|
\fB\-v \-\-version\fR
|
|
Show version information\. Fisherman\'s current version can be found in the VERSION file at the root of the project\. The version scheme is based in \fBSemantic Versioning\fR and uses Git annotated tags to track releases\.
|
|
.
|
|
.TP
|
|
\fB\-h \-\-help\fR
|
|
Show usage help\.
|
|
.
|
|
.SH "CUSTOM COMMANDS"
|
|
A Fisherman command is a function that you can invoke using the \fBfisher\fR utility\. By convention, any function like \fBfisher_<my_command>\fR is registered as a Fisherman command\. You can create plugins that add new commands this way\. See \fBfisher help commands\fR and \fBfisher help plugins\fR for more information\.
|
|
.
|
|
.SH "EXAMPLES"
|
|
.
|
|
.IP "\(bu" 4
|
|
Install plugins\.
|
|
.
|
|
.IP "" 0
|
|
.
|
|
.IP "" 4
|
|
.
|
|
.nf
|
|
|
|
fisher install fishtape shark
|
|
.
|
|
.fi
|
|
.
|
|
.IP "" 0
|
|
.
|
|
.TP
|
|
Install plugins from a \fIfishfile\fR or bundle:
|
|
|
|
.
|
|
.IP "" 4
|
|
.
|
|
.nf
|
|
|
|
fisher \-\-file=path/to/shared/fishfile | fisher install
|
|
.
|
|
.fi
|
|
.
|
|
.IP "" 0
|
|
.
|
|
.TP
|
|
Define a few aliases:
|
|
|
|
.
|
|
.IP "" 4
|
|
.
|
|
.nf
|
|
|
|
fisher \-a uninstall=rm,u,del
|
|
.
|
|
.fi
|
|
.
|
|
.IP "" 0
|
|
.
|
|
.SH "AUTHORS"
|
|
Fisherman was created by Jorge Bucaran \fIj@bucaran\.me\fR\.
|
|
.
|
|
.P
|
|
See AUTHORS file for a more complete list of contributors\.
|
|
.
|
|
.SH "SEE ALSO"
|
|
fisher(7)
|
|
.
|
|
.br
|
|
fisher help
|
|
.
|
|
.br
|
|
fisher update
|
|
.
|
|
.br
|
|
fisher search
|
|
.
|
|
.br
|
|
fisher config
|
|
.
|
|
.br
|
|
fisher install
|
|
.
|
|
.br
|
|
fisher plugins
|
|
.
|
|
.br
|
|
fisher commands
|
|
.
|
|
.br
|
|
fisher fishfile
|
|
.
|
|
.br
|
|
fisher uninstall
|
|
.
|
|
.br
|
|
|