projects/fisher
1
0
Fork 0
mirror of https://github.com/jorgebucaran/fisher synced 2024-06-28 23:01:50 +02:00
Code Issues Packages Projects Releases Wiki Activity

Typos.

Browse source
This commit is contained in:
Jorge Bucaran 2016-02-03 09:11:34 +09:00
parent c0792ce386
commit d77ab51eec
No known key found for this signature in database
GPG key ID: E54BA3C0E646DB30
7 changed files with 23 additions and 23 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
CHANGELOG.md
View file

@ -77,7 +77,7 @@
* Refactor `fisher install` / `fisher uninstall` by extracting the logic to enable / disable plugins into `__fisher_plugin_enable`. 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/...`. See #45.
* Add support for legacy oh-my-fish! plugins using `.load` initialization files. See #35.
* Add support for legacy Oh My Fish! plugins using `.load` initialization files. See #35.
* Add support for [Tackle](https://github.com/justinmayer/tackle) Fish framework initialization modules. See #35.
@ -158,7 +158,7 @@
* Improve help message for failed installs. See ##24. @namandistro
* Improve `fisher --validate` to automatically correct common misspellings, for example when installing a oh-my-fish package, one often types ohmyifsh.
* Improve `fisher --validate` to automatically correct common misspellings, for example when installing a Oh My Fish! package, one often types ohmyifsh.
* :point_up: Improve auto-complete performance by extracting the implementation of the different `fisher` flags to `__fisher_*` functions. `completions/fisher.fish` relies heavily in `fisher_search` to query what plugins are available to install/update/uninstall. In this process, numerous calls to `fisher --list` and `fisher --validate`, etc., are made. Now, auto-complete does not have to pay the penalty of entering `fisher`, parsing options, etc. See #27. @namandistro

4
man/man1/fisher.1
View file

@ -1,7 +1,7 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "FISHER" "1" "January 2016" "" "fisherman"
.TH "FISHER" "1" "February 2016" "" "fisherman"
.
.SH "NAME"
\fBfisher\fR \- Fish Plugin Manager
@ -31,7 +31,7 @@ List plugins according to the given category\. List plugins in the cache by defa
.
.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_file\fR will be shown instead\. Use a dash \fB\-\fR to read from the standard input\. Other formats such as the oh\-my\-fish bundle files are supported as well\.
Read \fIfishfile\fR and display its contents\. If \fIfishfile\fR is null or an empty string, your user \fIfishfile\fR in \fB$fisher_file\fR will be shown instead\. Use a dash \fB\-\fR to read from the standard input\. Other formats such as the Oh My Fish! bundle files are supported as well\.
.
.TP
\fB\-v \-\-version\fR

2
man/man1/fisher.md
View file

@ -19,7 +19,7 @@ The following commands are available out of the box: *install*, *uninstall*, *up
List plugins according to the given category. List plugins in the cache by default. Enabled plugins are prepended with a `*` character. To list plugins without the `*` character use `--list=bare`.
* `-f --file=fishfile`:
Read *fishfile* and display its contents. If *fishfile* is null or an empty string, your user *fishfile* in `$fisher_file` will be shown instead. Use a dash `-` to read from the standard input. Other formats such as the oh-my-fish bundle files are supported as well.
Read *fishfile* and display its contents. If *fishfile* is null or an empty string, your user *fishfile* in `$fisher_file` will be shown instead. Use a dash `-` to read from the standard input. Other formats such as the Oh My Fish! bundle files are supported as well.
* `-v --version`:
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 `Semantic Versioning` and uses Git annotated tags to track releases.

4
man/man5/fisher-fishfile.5
View file

@ -1,7 +1,7 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "FISHER\-FISHFILE" "5" "January 2016" "" "fisherman"
.TH "FISHER\-FISHFILE" "5" "February 2016" "" "fisherman"
.
.SH "NAME"
\fBfisher\-fishfile\fR \- Fishfile Format
@ -34,7 +34,7 @@ oh\-my\-fish/bobthefish
.IP "" 0
.
.P
To read fishfiles use \fBfisher \-\-file=fishfile\fR\. This will read \fIfishfile\fR sequentially, writing its contents to the standard output\. oh\-my\-fish bundle files are supported as well\.
To read fishfiles use \fBfisher \-\-file=fishfile\fR\. This will read \fIfishfile\fR sequentially, writing its contents to the standard output\. Oh My Fish! bundle files are supported as well\.
.
.P
If \fIfishfile\fR is null or an empty string, the global \fIfishfile\fR in \fB$fisher_file\fR will be used\. Use a dash \fB\-\fR to force read from standard input\.

2
man/man5/fisher-fishfile.md
View file

@ -22,7 +22,7 @@ fishtape
oh-my-fish/bobthefish
```
To read fishfiles use `fisher --file=fishfile`. This will read *fishfile* sequentially, writing its contents to the standard output. oh-my-fish bundle files are supported as well.
To read fishfiles use `fisher --file=fishfile`. This will read *fishfile* sequentially, writing its contents to the standard output. Oh My Fish! bundle files are supported as well.
If *fishfile* is null or an empty string, the global *fishfile* in `$fisher_file` will be used. Use a dash `-` to force read from standard input.

16
man/man7/fisher-tour.7
View file

@ -1,19 +1,19 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "FISHER\-TOUR" "7" "January 2016" "" "fisherman"
.TH "FISHER\-TOUR" "7" "February 2016" "" "fisherman"
.
.SH "NAME"
\fBfisher\-tour\fR \- Fisherman Tour
.
.SH "DESCRIPTION"
Fisherman is a plugin manager and CLI toolkit for Fish to help you build powerful utilities and share your code easily\.
Fisherman is a blazing fast, modern plugin manager for Fish\.
.
.P
Fisherman uses a flat tree structure that adds no cruft to your shell, making it as fast as no Fisherman\. The cache mechanism lets you query the index offline and enable or disable plugins as you wish\.
.
.P
Other features include dependency management, great plugin search capabilities and full compatibility with Tackle, Wahoo and oh\-my\-fish themes and packages\.
Other features include dependency management, great plugin search capabilities and full compatibility with Tackle, Oh My Fish! and Wahoo themes and packages\.
.
.P
This document describes Fisherman features and their implementation details\. For usage and command help see \fBfisher(1)\fR\.
@ -303,16 +303,16 @@ Most commands read the standard input by default when no options are given and p
Fisherman also ships with a CLI options parser and a background job wait spinner that you can use to implement your own commands CLI\. See \fBgetopts(1)\fR and \fBwait(1)\fR\.
.
.SH "COMPATIBILITY"
Fisherman supports oh\-my\-fish (Wahoo) themes and plugins by default, but some features are turned off due to performance considerations\.
Fisherman supports Oh My Fish! (Wahoo) themes and plugins by default, but some features are turned off due to performance considerations\.
.
.P
oh\-my\-fish evaluates every \fI\.fish\fR file inside the root directory of every plugin during initialization\. This is necessary in order to register any existing \fBinit\fR events and invoke them using fish \fBemit(1)\fR\.
Oh My Fish! evaluates every \fI\.fish\fR file inside the root directory of every plugin during initialization\. This is necessary in order to register any existing \fBinit\fR events and invoke them using fish \fBemit(1)\fR\.
.
.P
Since it is not possible to determine whether a file defines an initialization event without evaluating its contents first, oh\-my\-fish sources all \fB*\.fish\fR files and then emits events for each plugin\.
Since it is not possible to determine whether a file defines an initialization event without evaluating its contents first, Oh My Fish! sources all \fB*\.fish\fR files and then emits events for each plugin\.
.
.P
Not all plugins opt in the initialization mechanism, therefore support for this behavior is turned off by default\. If you would like Fisherman to behave like oh\-my\-fish at the start of every session, install the \fBomf\fR compatibility plugin\.
Not all plugins opt in the initialization mechanism, therefore support for this behavior is turned off by default\. If you would like Fisherman to behave like Oh My Fish! at the start of every session, install the \fBomf\fR compatibility plugin\.
.
.IP "" 4
.
@ -325,7 +325,7 @@ fisher install omf
.IP "" 0
.
.P
This plugin also adds definitions for some of oh\-my\-fish Core Library functions\.
This plugin also adds definitions for some of Oh My Fish! Core Library functions\.
.
.SH "SEE ALSO"
fisher(1)

14
man/man7/fisher-tour.md
View file

@ -3,11 +3,11 @@ fisher-tour(7) -- Fisherman Tour
## DESCRIPTION
Fisherman is a plugin manager and CLI toolkit for Fish to help you build powerful utilities and share your code easily.
Fisherman is a blazing fast, modern plugin manager for Fish.
Fisherman uses a flat tree structure that adds no cruft to your shell, making it as fast as no Fisherman. The cache mechanism lets you query the index offline and enable or disable plugins as you wish.
Other features include dependency management, great plugin search capabilities and full compatibility with Tackle, Wahoo and oh-my-fish themes and packages.
Other features include dependency management, great plugin search capabilities and full compatibility with Tackle, Oh My Fish! and Wahoo themes and packages.
This document describes Fisherman features and their implementation details. For usage and command help see `fisher(1)`.
@ -185,19 +185,19 @@ Fisherman also ships with a CLI options parser and a background job wait spinner
## COMPATIBILITY
Fisherman supports oh-my-fish (Wahoo) themes and plugins by default, but some features are turned off due to performance considerations.
Fisherman supports Oh My Fish! (Wahoo) themes and plugins by default, but some features are turned off due to performance considerations.
oh-my-fish evaluates every *.fish* file inside the root directory of every plugin during initialization. This is necessary in order to register any existing `init` events and invoke them using fish `emit(1)`.
Oh My Fish! evaluates every *.fish* file inside the root directory of every plugin during initialization. This is necessary in order to register any existing `init` events and invoke them using fish `emit(1)`.
Since it is not possible to determine whether a file defines an initialization event without evaluating its contents first, oh-my-fish sources all `*.fish` files and then emits events for each plugin.
Since it is not possible to determine whether a file defines an initialization event without evaluating its contents first, Oh My Fish! sources all `*.fish` files and then emits events for each plugin.
Not all plugins opt in the initialization mechanism, therefore support for this behavior is turned off by default. If you would like Fisherman to behave like oh-my-fish at the start of every session, install the `omf` compatibility plugin.
Not all plugins opt in the initialization mechanism, therefore support for this behavior is turned off by default. If you would like Fisherman to behave like Oh My Fish! at the start of every session, install the `omf` compatibility plugin.
```
fisher install omf
```
This plugin also adds definitions for some of oh-my-fish Core Library functions.
This plugin also adds definitions for some of Oh My Fish! Core Library functions.
## SEE ALSO