Switch \fish sections to rst format

This commit is contained in:
ridiculousfish
2018-12-18 19:14:04 -08:00
parent c33d1a217c
commit 2a002a4ba1
53 changed files with 993 additions and 693 deletions

View File

@@ -42,29 +42,44 @@ See the "Internals" section for more on them.
Examples
------------
\fish
abbr -a -g gco git checkout
\endfish
::
abbr -a -g gco git checkout
Add a new abbreviation where `gco` will be replaced with `git checkout` global to the current shell. This abbreviation will not be automatically visible to other shells unless the same command is run in those shells (such as when executing the commands in config.fish).
\fish
abbr -a -U l less
\endfish
::
abbr -a -U l less
Add a new abbreviation where `l` will be replaced with `less` universal so all shells. Note that you omit the `-U` since it is the default.
\fish
abbr -r gco gch
\endfish
::
abbr -r gco gch
Renames an existing abbreviation from `gco` to `gch`.
\fish
abbr -e gco
\endfish
::
abbr -e gco
Erase the `gco` abbreviation.
\fish
ssh another_host abbr -s | source
\endfish
::
ssh another_host abbr -s | source
Import the abbreviations defined on another_host over SSH.
Internals
@@ -73,13 +88,16 @@ Each abbreviation is stored in its own global or universal variable. The name co
Defining an abbreviation with global scope is slightly faster than universal scope (which is the default). But in general you'll only want to use the global scope when defining abbreviations in a startup script like `~/.config/fish/config.fish` like this:
\fish
if status --is-interactive
abbr --add --global first 'echo my first abbreviation'
abbr --add --global second 'echo my second abbreviation'
abbr --add --global gco git checkout
# etcetera
end
\endfish
::
if status --is-interactive
abbr --add --global first 'echo my first abbreviation'
abbr --add --global second 'echo my second abbreviation'
abbr --add --global gco git checkout
# etcetera
end
You can create abbreviations interactively and they will be visible to other fish sessions if you use the `-U` or `--universal` flag or don't explicitly specify the scope and the abbreviation isn't already defined with global scope. If you want it to be visible only to the current shell use the `-g` or `--global` flag.