mirror of
https://github.com/fish-shell/fish-shell
synced 2024-12-27 05:13:10 +00:00
8081e9f189
While abbrs are still stored in a universal variable, it's much quicker to just add them once and not just put `abbr --add key value` in config.fish.
52 lines
1.7 KiB
Text
52 lines
1.7 KiB
Text
\section abbr abbr - manage fish abbreviations
|
|
|
|
\subsection abbr-synopsis Synopsis
|
|
\fish{synopsis}
|
|
abbr -a word="phrase"
|
|
abbr -s
|
|
abbr -l
|
|
abbr -e word
|
|
\endfish
|
|
|
|
\subsection abbr-description Description
|
|
|
|
`abbr` manipulates the list of abbreviations that fish will expand.
|
|
|
|
Abbreviations are user-defined character sequences or words that are replaced with longer phrases after they are entered. For example, a frequently-run command such as `git checkout` can be abbreviated to `gco`. After entering `gco` and pressing @key{Space} or @key{Enter}, the full text `git checkout` will appear in the command line.
|
|
|
|
Abbreviations are stored using universal variables. You can create abbreviations directly on the command line, and they will be saved automatically. Do not place them in config.fish, because this will lead to worse startup performance. Alternatively, guard the assignment with another universal variable, like:
|
|
|
|
\fish
|
|
if not set -q my_fish_abbreviations
|
|
abbr gco='git checkout'
|
|
abbr abr='another abbreviation expansion'
|
|
set -U my_fish_abbreviations 1
|
|
end
|
|
\endfish
|
|
|
|
The following parameters are available:
|
|
|
|
- `-a WORD PHRASE` or `--add WORD PHRASE` Adds a new abbreviation, where WORD will be expanded to PHRASE.
|
|
|
|
- `-s` or `--show` Show all abbreviated words and their expanded phrases in a manner suitable for export and import.
|
|
|
|
- `-l` or `--list` Lists all abbreviated words.
|
|
|
|
- `-e WORD` or `--erase WORD` Erase the abbreviation WORD.
|
|
|
|
\subsection abbr-example Examples
|
|
|
|
\fish
|
|
abbr -a gco git checkout
|
|
\endfish
|
|
Add a new abbreviation where `gco` will be replaced with `git checkout`.
|
|
|
|
\fish
|
|
abbr -e gco
|
|
\endfish
|
|
Erase the `gco` abbreviation.
|
|
|
|
\fish
|
|
ssh another_host abbr -s | source
|
|
\endfish
|
|
Import the abbreviations defined on another_host over SSH.
|