diff --git a/man/man1/fisher-help.1 b/man/man1/fisher-help.1 index 3ca9994..f6d4e44 100644 --- a/man/man1/fisher-help.1 +++ b/man/man1/fisher-help.1 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "FISHER\-HELP" "1" "January 2016" "" "fisherman" +.TH "FISHER\-HELP" "1" "February 2016" "" "fisherman" . .SH "NAME" \fBfisher\-help\fR \- Show Help @@ -43,7 +43,7 @@ my_plugin .IP "" 0 . .P -This will allow you to access help for my_plugin using \fBman(1)\fR\. To add documentation to a \fBfisher(1)\fR command, prepend the keyword \fBfisher\-\fR to the man file, e\.g\., \fBfisher\-\fRmy\-command\.1\. This will allow you to access the man page by \fBfisher help my\-command\fR\. +Help for my_plugin is now available via \fBman(1)\fR\. To add documentation to a \fBfisher\fR command, prepend the keyword \fBfisher\-\fR to the man file, e\.g\., \fBfisher\-my\-command\.1\fR\. This will teach Fisherman how to access the man page using \fBfisher help my\-command\fR\. . .P There are utilities that can help you generate man pages from other text formats, such as Markdown\. One example is \fBronn(1)\fR\. For an example without using external utilities, see \fIExample\fR in \fBfisher help plugins\fR\. @@ -52,7 +52,7 @@ There are utilities that can help you generate man pages from other text formats . .TP \fB\-a \-\-all\fR -List both commands and guides\. This shows all the available documentation\. +List all available commands and guides\. . .TP \fB\-g \-\-guides[=*bare*]\fR @@ -64,7 +64,7 @@ List commands\. This is the default behavior of \fBfisher help\fR\. Use \fIbare\ . .TP \fB\-u \-\-usage[=*command*]\fR -Display usage help for \fIcommand\fR\. To supply usage help with a command, \fIcommand\fR must implement a \fB\-h\fR flag\. +Display usage help for \fIcommand\fR\. To teach Fisherman how to display help for your command, \fIcommand\fR must implement a \fB\-h\fR flag\. . .TP \fB\-h \-\-help\fR diff --git a/man/man1/fisher-help.md b/man/man1/fisher-help.md index f119621..6cfbc44 100644 --- a/man/man1/fisher-help.md +++ b/man/man1/fisher-help.md @@ -25,14 +25,14 @@ my_plugin |-- my_plugin.1 ``` -This will allow you to access help for my_plugin using `man(1)`. To add documentation to a `fisher(1)` command, prepend the keyword `fisher-` to the man file, e.g., `fisher-`my-command.1. This will allow you to access the man page by `fisher help my-command`. +Help for my_plugin is now available via `man(1)`. To add documentation to a `fisher` command, prepend the keyword `fisher-` to the man file, e.g., `fisher-my-command.1`. This will teach Fisherman how to access the man page using `fisher help my-command`. There are utilities that can help you generate man pages from other text formats, such as Markdown. One example is `ronn(1)`. For an example without using external utilities, see *Example* in `fisher help plugins`. ## OPTIONS * `-a --all`: - List both commands and guides. This shows all the available documentation. + List all available commands and guides. * `-g --guides[=*bare*]`: List guides / tutorials. Use *bare* to generate easy to parse output. @@ -41,7 +41,7 @@ There are utilities that can help you generate man pages from other text formats List commands. This is the default behavior of `fisher help`. Use *bare* to generate easy to parse output. * `-u --usage[=*command*]`: - Display usage help for *command*. To supply usage help with a command, *command* must implement a `-h` flag. + Display usage help for *command*. To teach Fisherman how to display help for your command, *command* must implement a `-h` flag. * `-h --help`: Show usage help. @@ -66,7 +66,6 @@ fisher help help fisher help --commands=bare | fisher help --usage ``` - ## SEE ALSO man(1)
diff --git a/man/man1/fisher-install.1 b/man/man1/fisher-install.1 index 0f04b3a..811f6ee 100644 --- a/man/man1/fisher-install.1 +++ b/man/man1/fisher-install.1 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "FISHER\-INSTALL" "1" "January 2016" "" "fisherman" +.TH "FISHER\-INSTALL" "1" "February 2016" "" "fisherman" . .SH "NAME" \fBfisher\-install\fR \- Install Plugins @@ -24,10 +24,7 @@ fisher \fBinstall\fR \fIowner/repo\fR \.\.\. .br . .SH "DESCRIPTION" -Install one or more plugins, by name, URL or local path\. If no arguments are given, read the standard input\. -. -.P -If the Git host is not provided, Fisherman will use https://github\.com by default\. +Install one or more plugins, by name, URL or a local path\. If no arguments are given, read the standard input\. . .P In addition, all of the following \fBowner/repo\fR variations are accepted: @@ -76,16 +73,16 @@ Shortcuts to other common Git repository hosting services are also available: .IP "" 0 . .P -If a URL is given, the repository is cloned to \fB$fisher_cache\fR the first time and any relevant plugin files are copied to \fB$fisher_config\fR functions, completions, conf\.d and man directories\. +If a URL is given, the repository is cloned to \fB$fisher_cache\fR the first time and any relevant plugin files are copied to \fB$fisher_config\fR functions, completions, conf\.d, scripts and man directories\. . .P -If the plugin already exists in \fB$fisher_cache\fR, the files are copied to \fB$fisher_config\fR\. To update a plugin use \fBfisher update\fR\. +If the plugin already exists in \fB$fisher_cache\fR, the files are only copied to \fB$fisher_config\fR\. To update a plugin use \fBfisher update\fR\. . .P If the plugin declares dependencies, these will be installed too\. If any of the dependencies are already enabled or downloaded to the cache, they will not be updated to prevent version issues\. See \fIPlugins\fR in \fBfisher help fishfile\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/functions\fR and then the new ones are copied\. +If a plugin includes either a \fBfish_prompt\.fish\fR or \fBfish_right_prompt\.fish\fR, both files are first removed from \fB$fisher_config/functions\fR and then the new ones are copied\. . .SH "OPTIONS" . @@ -101,31 +98,8 @@ Enable quiet mode\. \fB\-h\fR \fB\-\-help\fR Show usage help\. . -.SH "INSTALL PROCESS" -Here is the 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 not there already\. -. -.IP "3." 4 -Copy all \fB*\.fish\fR and \fBfunctions/*\.fish\fR files to \fB$fisher_config/functions\fR\. -. -.IP "4." 4 -Copy all \fBcompletions/*\.fish\fR to \fB$fisher_config/completions\fR\. -. -.IP "5." 4 -Copy all \fBinit\.fish\fR and \fB*\.config\.fish\fR files to \fB$fisher_config/conf\.d\fR\. -. -.IP "6." 4 -Copy all man/man% to \fB$fisher_config/man/man%\fR\. -. -.IP "" 0 -. .SH "EXAMPLES" -Here is the directory tree of \fImy_plugin\fR somewhere deep under the sea: +Here is the directory tree of \fImy_plugin\fR: . .IP "" 4 . @@ -173,10 +147,27 @@ $fisher_config .IP "" 0 . .P -In addition, any \fBinit\.fish\fR or \fB*\.config\.fish\fR files, are copied to \fB$fisher_config/conf\.d\fR and evaluated during the start of the shell\. +In addition, any \fBinit\.fish\fR and \fB*\.config\.fish\fR files, are copied to \fB$fisher_config/conf\.d\fR and evaluated during the start of the shell\. . .P -Notes: \fBinit\.fish\fR files are renamed to \fBmy_plugin\.init\.fish\fR to prevent name collisions\. +To prevent name collisions, \fBinit\.fish\fR files are renamed to \fBmy_plugin\.init\.fish\fR\. +. +.SH "EXAMPLES" +. +.IP "\(bu" 4 +Install plugins from multiple sources\. +. +.IP "" 0 +. +.IP "" 4 +. +.nf + +fisher install fishtape simnalamburt/shellder ~/plugins/my_plugin +. +.fi +. +.IP "" 0 . .SH "SEE ALSO" fisher(1) diff --git a/man/man1/fisher-install.md b/man/man1/fisher-install.md index a3b05a7..d703302 100644 --- a/man/man1/fisher-install.md +++ b/man/man1/fisher-install.md @@ -14,9 +14,7 @@ fisher `install` *owner/repo* ...
## DESCRIPTION -Install one or more plugins, by name, URL or local path. If no arguments are given, read the standard input. - -If the Git host is not provided, Fisherman will use https://github.com by default. +Install one or more plugins, by name, URL or a local path. If no arguments are given, read the standard input. In addition, all of the following `owner/repo` variations are accepted: @@ -30,13 +28,13 @@ Shortcuts to other common Git repository hosting services are also available: * *gl*/owner/repo `>` https://gitlab.com/owner/repo
* *omf*/owner/repo `>` https://github.com/oh-my-fish/repo
-If a URL is given, the repository is cloned to `$fisher_cache` the first time and any relevant plugin files are copied to `$fisher_config` functions, completions, conf.d and man directories. +If a URL is given, the repository is cloned to `$fisher_cache` the first time and any relevant plugin files are copied to `$fisher_config` functions, completions, conf.d, scripts and man directories. -If the plugin already exists in `$fisher_cache`, the files are copied to `$fisher_config`. To update a plugin use `fisher update`. +If the plugin already exists in `$fisher_cache`, the files are only copied to `$fisher_config`. To update a plugin use `fisher update`. If the plugin declares dependencies, these will be installed too. If any of the dependencies are already enabled or downloaded to the cache, they will not be updated to prevent version issues. See *Plugins* in `fisher help fishfile`. -If a plugin includes either a fish_prompt.fish or fish_right_prompt.fish, both files are first removed from `$fisher_config/functions` and then the new ones are copied. +If a plugin includes either a `fish_prompt.fish` or `fish_right_prompt.fish`, both files are first removed from `$fisher_config/functions` and then the new ones are copied. ## OPTIONS @@ -49,20 +47,9 @@ If a plugin includes either a fish_prompt.fish or fish_right_prompt.fish, both f * `-h` `--help`: Show usage help. -## INSTALL PROCESS - -Here is the typical install process breakdown for *plugin*: - -1. Check if *plugin* exists in `$fisher_index`. Fail otherwise. -2. Download *plugin* to `$fisher_cache` if not there already. -3. Copy all `*.fish` and `functions/*.fish` files to `$fisher_config/functions`. -4. Copy all `completions/*.fish` to `$fisher_config/completions`. -5. Copy all `init.fish` and `*.config.fish` files to `$fisher_config/conf.d`. -5. Copy all man/man% to `$fisher_config/man/man%`. - ## EXAMPLES -Here is the directory tree of *my_plugin* somewhere deep under the sea: +Here is the directory tree of *my_plugin*: ``` my_plugin @@ -96,9 +83,17 @@ $fisher_config |-- my_plugin/... ``` -In addition, any `init.fish` or `*.config.fish` files, are copied to `$fisher_config/conf.d` and evaluated during the start of the shell. +In addition, any `init.fish` and `*.config.fish` files, are copied to `$fisher_config/conf.d` and evaluated during the start of the shell. -Notes: `init.fish` files are renamed to `my_plugin.init.fish` to prevent name collisions. +To prevent name collisions, `init.fish` files are renamed to `my_plugin.init.fish`. + +## EXAMPLES + +* Install plugins from multiple sources. + +```fisher +fisher install fishtape simnalamburt/shellder ~/plugins/my_plugin +``` ## SEE ALSO diff --git a/man/man1/fisher-search.1 b/man/man1/fisher-search.1 index 214132f..44ea85b 100644 --- a/man/man1/fisher-search.1 +++ b/man/man1/fisher-search.1 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "FISHER\-SEARCH" "1" "January 2016" "" "fisherman" +.TH "FISHER\-SEARCH" "1" "February 2016" "" "fisherman" . .SH "NAME" \fBfisher\-search\fR \- Search Plugin Index @@ -64,11 +64,11 @@ See \fIIndex\fR in \fBfisher help tour\fR for more information about the index\. . .TP \fB\-\-[=match]\fR -Display index records where \fB\fR==\fImatch\fR\. \fIfield\fR can be any of \fBname\fR, \fBurl\fR, \fBinfo\fR, \fBtag/s\fR or \fBauthor\fR\. If \fImatch\fR is not given, display only the given \fIfield\fR from every record in the index\. Use \fB!=\fR to negate the query\. +Display index records where \fIfield\fR equals \fImatch\fR\. \fIfield\fR can be any of \fBname\fR, \fBurl\fR, \fBinfo\fR, \fBtag/s\fR or \fBauthor\fR\. If \fImatch\fR is not given, display only the given \fIfield\fR from every record in the index\. Use \fB!=\fR to negate the query\. . .TP \fB\-\-[~/regex/]\fR -Same as \fB\-\-[=regex]\fR, but with a Regular Expression instead of an exact match\. Use \fB!~\fR to negate the query\. +Same as \fB\-\-[=regex]\fR, but using Regular Expressions instead of exact matching\. Use \fB!~\fR to negate the query\. . .TP \fB\-a \-\-and\fR @@ -87,7 +87,7 @@ Enable quiet mode\. Show help\. . .SH "OUTPUT" -The default behavior is to print the result set to standard output in their original format\. +Search prints the result records in their original format by default\. . .IP "" 4 . @@ -105,27 +105,27 @@ bucaran .IP "" 0 . .P -Search is designed for easy parsing when using the filters: \fB\-\-name\fR, \fB\-\-url\fR, \fB\-\-info\fR, \fB\-\-tags\fR, \fB\-\-author\fR\. +To allow for easier parsing, Search will print results records in the same line when using one or more of the following options: \fB\-\-name\fR, \fB\-\-url\fR, \fB\-\-info\fR, \fB\-\-tags\fR, \fB\-\-author\fR\. . .IP "" 4 . .nf -fisher search shark \-\-name \-\-url +fisher search shark \-\-name \-\-url \-\-author -shark;https://github\.com/bucaran/shark +shark;https://github\.com/fishery/shark;bucaran . .fi . .IP "" 0 . .P -The result set above consists of single line per record, and each record consists of one or more of the given fields separated by a semicolon \fB\';\'\fR\. +The result set above consists of single line per record, and each record consists of one or more of the specified fields separated by semicolons \fB\';\'\fR\. . .SH "EXAMPLES" . .IP "\(bu" 4 -Display plugins by name and format into multiple columns\. +Display plugins by name and format the result into multiple columns\. . .IP "" 0 . diff --git a/man/man1/fisher-search.md b/man/man1/fisher-search.md index bef0a60..b4b565f 100644 --- a/man/man1/fisher-search.md +++ b/man/man1/fisher-search.md @@ -1,13 +1,5 @@ -usage: fisher search [] [--and|--or] [--quiet] [--help] - - --field[=value] Filter by url, name, info, author or tags - -o --or Join query with OR operator - -a --and Join query with AND operator - -q --quiet Enable quiet mode - -h --help Show usage help - fisher-search(1) -- Search Plugin Index -========================================== +======================================= ## SYNOPSIS @@ -41,14 +33,13 @@ author See *Index* in `fisher help tour` for more information about the index. - ## OPTIONS * `--[=match]`: - Display index records where ``==*match*. *field* can be any of `name`, `url`, `info`, `tag/s` or `author`. If *match* is not given, display only the given *field* from every record in the index. Use `!=` to negate the query. + Display index records where *field* equals *match*. *field* can be any of `name`, `url`, `info`, `tag/s` or `author`. If *match* is not given, display only the given *field* from every record in the index. Use `!=` to negate the query. * `--[~/regex/]`: - Same as `--[=regex]`, but with a Regular Expression instead of an exact match. Use `!~` to negate the query. + Same as `--[=regex]`, but using Regular Expressions instead of exact matching. Use `!~` to negate the query. * `-a --and`: Join the query with a logical AND operator. @@ -64,9 +55,9 @@ See *Index* in `fisher help tour` for more information about the index. ## OUTPUT -The default behavior is to print the result set to standard output in their original format. +Search prints the result records in their original format by default. -``` +```fish fisher search shark shark https://github.com/bucaran/shark @@ -75,39 +66,39 @@ chart tool graph sparkline bucaran ``` -Search is designed for easy parsing when using the filters: `--name`, `--url`, `--info`, `--tags`, `--author`. +To allow for easier parsing, Search will print results records in the same line when using one or more of the following options: `--name`, `--url`, `--info`, `--tags`, `--author`. -``` -fisher search shark --name --url +```fish +fisher search shark --name --url --author -shark;https://github.com/bucaran/shark +shark;https://github.com/fishery/shark;bucaran ``` -The result set above consists of single line per record, and each record consists of one or more of the given fields separated by a semicolon `';'`. +The result set above consists of single line per record, and each record consists of one or more of the specified fields separated by semicolons `';'`. ## EXAMPLES -* Display plugins by name and format into multiple columns. +* Display plugins by name and format the result into multiple columns. -``` +```fish fisher search --name | column ``` * Display plugins by URL, sans *https://github.com/* and format into multiple columns. -``` +```fish fisher search --field=url | sed 's|https://github.com/||' | column ``` * Display remote plugins, i.e, those in the index, but *not* in the cache. -``` +```fis fisher_search --and --name!=(fisher --list=bare) ``` * Search all plugins whose name does not start with the letter `s`. -``` +```fish fisher search --name!~/^s/ ``` diff --git a/man/man1/fisher-uninstall.1 b/man/man1/fisher-uninstall.1 index 70b7544..3c3634d 100644 --- a/man/man1/fisher-uninstall.1 +++ b/man/man1/fisher-uninstall.1 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "FISHER\-UNINSTALL" "1" "January 2016" "" "fisherman" +.TH "FISHER\-UNINSTALL" "1" "February 2016" "" "fisherman" . .SH "NAME" \fBfisher\-uninstall\fR \- Uninstall Plugins @@ -29,7 +29,7 @@ fisher \fBuninstall\fR \fIowner/repo\fR \.\.\. .br . .SH "DESCRIPTION" -Uninstall one or more plugins, by name, URL or local path\. If no arguments are given, read the standard input\. This process is the inverse of Install\. See \fBfisher help install\fR\. +Uninstall one or more plugins, by name, URL or a local path\. If no arguments are given, read the standard input\. This process is the inverse of Install\. See \fBfisher help install\fR\. . .P Uninstall does not remove any copies of the given plugin in \fB$fisher_cache\fR\. To erase the copy from the cache, use the \fB\-\-force\fR option\. diff --git a/man/man1/fisher-uninstall.md b/man/man1/fisher-uninstall.md index 0f5d758..ab525d1 100644 --- a/man/man1/fisher-uninstall.md +++ b/man/man1/fisher-uninstall.md @@ -1,5 +1,5 @@ fisher-uninstall(1) -- Uninstall Plugins -================================================== +======================================== ## SYNOPSIS @@ -15,7 +15,7 @@ fisher `uninstall` *owner/repo* ...
## DESCRIPTION -Uninstall one or more plugins, by name, URL or local path. If no arguments are given, read the standard input. This process is the inverse of Install. See `fisher help install`. +Uninstall one or more plugins, by name, URL or a local path. If no arguments are given, read the standard input. This process is the inverse of Install. See `fisher help install`. Uninstall does not remove any copies of the given plugin in `$fisher_cache`. To erase the copy from the cache, use the `--force` option. @@ -36,7 +36,7 @@ Uninstall does not remove any dependencies installed with other plugins. This be * Uninstall all plugins and flush the cache. -``` +```fish fisher --list | fisher uninstall --force ``` diff --git a/man/man1/fisher-update.1 b/man/man1/fisher-update.1 index ec461df..500b155 100644 --- a/man/man1/fisher-update.1 +++ b/man/man1/fisher-update.1 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "FISHER\-UPDATE" "1" "January 2016" "" "fisherman" +.TH "FISHER\-UPDATE" "1" "February 2016" "" "fisherman" . .SH "NAME" \fBfisher\-update\fR \- Update Fisherman and Plugins @@ -26,7 +26,10 @@ fisher \fBupdate\fR \fIowner/repo\fR \.\.\. .br . .SH "DESCRIPTION" -Update one or more plugins, by name, URL or local path\. If no arguments are given, update Fisherman itself\. If you try to update a plugin that is currently disabled, but in the cache, it will be updated and then enabled\. Use a dash \fB\-\fR to read from the standard input\. +Update one or more plugins, by name, URL or a local path\. If no arguments are given, update Fisherman to the latest release\. If you try to update a plugin that is currently disabled, but present in the cache, it will be updated and then enabled\. Use a dash \fB\-\fR to read from the standard input\. +. +.P +One exception to the process described above is updating a prompt which is not the current one\. In this case the repository is updated, but it will not be activated as that is probably not what the user wants\. . .P If a plugin is missing dependencies, they will be installed\. If any dependencies are already installed they will not be updated\. See \fBPlugins\fR in \fBfisher help fishfile\fR\. @@ -59,7 +62,7 @@ fisher update .IP "" 0 . .IP "\(bu" 4 -Update all plugins in the cache\. +Update all the plugins in the cache\. . .IP "" 0 . diff --git a/man/man1/fisher-update.md b/man/man1/fisher-update.md index e7249c6..47c0e0c 100644 --- a/man/man1/fisher-update.md +++ b/man/man1/fisher-update.md @@ -14,7 +14,9 @@ fisher `update` *owner/repo* ...
## DESCRIPTION -Update one or more plugins, by name, URL or local path. If no arguments are given, update Fisherman itself. If you try to update a plugin that is currently disabled, but in the cache, it will be updated and then enabled. Use a dash `-` to read from the standard input. +Update one or more plugins, by name, URL or a local path. If no arguments are given, update Fisherman to the latest release. If you try to update a plugin that is currently disabled, but present in the cache, it will be updated and then enabled. Use a dash `-` to read from the standard input. + +One exception to the process described above is updating a prompt which is not the current one. In this case the repository is updated, but it will not be activated as that is probably not what the user wants. If a plugin is missing dependencies, they will be installed. If any dependencies are already installed they will not be updated. See `Plugins` in `fisher help fishfile`. @@ -34,7 +36,7 @@ If a plugin is missing dependencies, they will be installed. If any dependencies fisher update ``` -* Update all plugins in the cache. +* Update all the plugins in the cache. ``` fisher --list | fisher update - diff --git a/man/man1/fisher.1 b/man/man1/fisher.1 index 608fd7e..eebc95c 100644 --- a/man/man1/fisher.1 +++ b/man/man1/fisher.1 @@ -18,31 +18,27 @@ .br . .SH "DESCRIPTION" -Fisherman is a plugin manager and CLI toolkit for \fBfish(1)\fR to help you build powerful utilities and share your code easily\. +Fisherman is a blazing fast, modern plugin manager for \fBfish(1)\fR\. . .P -The following commands are available out of the box: \fIinstall\fR, \fIuninstall\fR, \fIupdate\fR, \fIsearch\fR and \fIhelp\fR\. See \fBfisher help \fR for information about each command\. +The following commands are available: \fIinstall\fR, \fIuninstall\fR, \fIupdate\fR, \fIsearch\fR and \fIhelp\fR\. See \fBfisher help \fR for information about each command\. . .SH "OPTIONS" . .TP -\fB\-\-list[=bare|enabled|disabled]\fR -List plugins according to the given category\. List plugins in the cache by default\. Enabled plugins are prepended with a \fB*\fR character\. To list plugins without the \fB*\fR character use \fB\-\-list=bare\fR\. -. -.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\. +\fB\-\-list[=bare|url|all|enabled|disabled|theme|file]\fR +List local plugins according to a given option\. Plugins are prepended with a legend character to indicate their kind\. \fB*\fR for enabled plugins, \fB>\fR for the currently enabled prompt and \fB|\fR for symbolic links\. To list plugins without the legend use \fB\-\-list=bare\fR\. Use a dash \fB\-\fR to read from the standard input\. . .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\. +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 each release\. . .TP \fB\-h \-\-help\fR Show usage help\. . .SH "CUSTOM COMMANDS" -A Fisherman command is a function that you invoke using the \fBfisher\fR CLI utility\. By convention, any function like \fBfisher_\fR is recognized 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\. +A Fisherman command is a regular function that can be invoked using the \fBfisher\fR command\. By convention, any function like \fBfisher_\fR is recognized 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" . @@ -55,21 +51,37 @@ Install plugins\. . .nf -fisher install fishtape shark +fisher install fishtape shark get . .fi . .IP "" 0 . -.TP -Install plugins from a \fIfishfile\fR or bundle: - +.IP "\(bu" 4 +Install plugins from a \fIfishfile\fR or bundle\. +. +.IP "" 0 . .IP "" 4 . .nf -fisher \-\-file=path/to/bundle | fisher install +fisher \-\-list=path/to/bundle | fisher install +. +.fi +. +.IP "" 0 +. +.IP "\(bu" 4 +Install a plugin if inside a plugin project\. +. +.IP "" 0 +. +.IP "" 4 +. +.nf + +fisher install \. . .fi . diff --git a/man/man1/fisher.md b/man/man1/fisher.md index 30108ea..8aef3c3 100644 --- a/man/man1/fisher.md +++ b/man/man1/fisher.md @@ -9,40 +9,43 @@ fisher(1) -- Fish Plugin Manager ## DESCRIPTION -Fisherman is a plugin manager and CLI toolkit for `fish(1)` to help you build powerful utilities and share your code easily. +Fisherman is a blazing fast, modern plugin manager for `fish(1)`. -The following commands are available out of the box: *install*, *uninstall*, *update*, *search* and *help*. See `fisher help ` for information about each command. +The following commands are available: *install*, *uninstall*, *update*, *search* and *help*. See `fisher help ` for information about each command. ## OPTIONS -* `--list[=bare|enabled|disabled]`: - 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. +* `--list[=bare|url|all|enabled|disabled|theme|file]`: + List local plugins according to a given option. Plugins are prepended with a legend character to indicate their kind. `*` for enabled plugins, `>` for the currently enabled prompt and `|` for symbolic links. To list plugins without the legend use `--list=bare`. Use a dash `-` to read from the standard input. * `-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. + 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 each release. * `-h --help`: Show usage help. ## CUSTOM COMMANDS -A Fisherman command is a function that you invoke using the `fisher` CLI utility. By convention, any function like `fisher_` is recognized as a Fisherman command. You can create plugins that add new commands this way. See `fisher help commands` and `fisher help plugins` for more information. +A Fisherman command is a regular function that can be invoked using the `fisher` command. By convention, any function like `fisher_` is recognized as a Fisherman command. You can create plugins that add new commands this way. See `fisher help commands` and `fisher help plugins` for more information. ## EXAMPLES * Install plugins. -``` -fisher install fishtape shark +```fish +fisher install fishtape shark get ``` -* Install plugins from a *fishfile* or bundle: +* Install plugins from a *fishfile* or bundle. +```fish +fisher --list=path/to/bundle | fisher install ``` -fisher --file=path/to/bundle | fisher install + +* Install a plugin if inside a plugin project. + +```fish +fisher install . ``` ## AUTHORS diff --git a/man/man1/getopts.1 b/man/man1/getopts.1 index 0ab27bc..c602d5e 100644 --- a/man/man1/getopts.1 +++ b/man/man1/getopts.1 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "GETOPTS" "1" "January 2016" "" "fisherman" +.TH "GETOPTS" "1" "February 2016" "" "fisherman" . .SH "NAME" \fBgetopts\fR \- Parse CLI options @@ -15,10 +15,10 @@ .br . .SH "DESCRIPTION" -getopts is a command line parser, designed to process command line arguments based in the POSIX Utility Syntax Guidelines\. If no arguments are given getopts returns \fB1\fR\. +\fBGetopts\fR is a command line parser implemented in \fBawk(1)\fR, designed to process command line arguments in the easiest way possible\. . .SH "USAGE" -In the following example: +The best way to understand how \fBgetopts\fR work is by studying a simple example\. . .IP "" 4 . @@ -31,7 +31,7 @@ getopts \-ab1 \-\-foo=bar baz .IP "" 0 . .P -And its output: +And its output\. . .IP "" 4 . @@ -137,9 +137,3 @@ The getopts described in this document is \fInot\fR equivalent to the getopts \f . .SH "AUTHORS" Jorge Bucaran \fIj@bucaran\.me\fR\. -. -.SH "SEE ALSO" -POSIX Utility Syntax Guidelines [goo\.gl/yrgQn9] -. -.br - diff --git a/man/man1/getopts.md b/man/man1/getopts.md index 344fb6f..28cd095 100644 --- a/man/man1/getopts.md +++ b/man/man1/getopts.md @@ -8,17 +8,17 @@ getopts(1) -- Parse CLI options ## DESCRIPTION -getopts is a command line parser, designed to process command line arguments based in the POSIX Utility Syntax Guidelines. If no arguments are given getopts returns `1`. +`Getopts` is a command line parser implemented in `awk(1)`, designed to process command line arguments in the easiest way possible. ## USAGE -In the following example: +The best way to understand how `getopts` work is by studying a simple example. ``` getopts -ab1 --foo=bar baz ``` -And its output: +And its output. ``` a @@ -102,7 +102,3 @@ end ## AUTHORS Jorge Bucaran . - -## SEE ALSO - -POSIX Utility Syntax Guidelines [goo.gl/yrgQn9]
diff --git a/man/man1/wait.1 b/man/man1/wait.1 index 5228b60..1b89cdc 100644 --- a/man/man1/wait.1 +++ b/man/man1/wait.1 @@ -13,25 +13,25 @@ \fBwait\fR \fIcommands\fR [\fB\-\-time\fR=interval] [\fB\-\-log\fR=file] [\fB\-\-format\fR=format] [\fB\-\-help\fR] . .SH "DESCRIPTION" -Run \fIcommands\fR as a background process and wait until the job has finished\. Any output to standard error indicates \fBwait\fR to return \fB1\fR once is done\. While it waits, a customizable spinner is displayed in the command line\. +Run \fIcommands\fR in the background and wait until the job has finished\. Any output to standard error indicates \fBwait\fR to return \fB1\fR\. While it waits, a customizable spinner is displayed in the command line\. . .SH "OPTIONS" . .TP \fB\-s \-\-spin=style|string\fR -Set spinner style\. See \fBStyles\fR for styles and details to customize the spinner characters\. +Set the spinner style\. See \fBStyles\fR for styles and details on how to customize the spinner tokens\. . .TP \fB\-t \-\-time=interval\fR -Set spinner transition time delay in \fIseconds\fR\. A large value will refresh the spinner more slowly\. You may use decimal numbers to represent smaller numbers\. +Set spinner transition time delay in \fIseconds\fR\. A large value will refresh the spinner more slowly\. You may use decimal numbers to represent smaller numbers\. The default interval is \fB0\.02\fR\. . .TP \fB\-l \-\-log=file\fR -Output standard error to given \fIfile\fR\. +Write the standard error output to a given \fIfile\fR\. . .TP \fB\-f \-\-format=format\fR -Use given \fIformat\fR to display the spinner\. The default format is \fB"\er@"\fR where \fB@\fR represents the spinner token and \fB\er\fR a carriage return, used to refresh / erase the line\. +Use the given \fIformat\fR to display the spinner\. The default format is \fB"\er@"\fR where \fB@\fR represents the spinner token and \fB\er\fR a carriage return, used to refresh (erase) the line\. . .TP \fB\-h \-\-help\fR @@ -48,13 +48,13 @@ bar1~3 .IP "" 0 . .P -If no style is given in \fB\-\-spin=