fish-shell/doc_src/abbr.txt

\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. Calling `abbr -a` in config.fish will lead to slightly worse startup performance.

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.

Note: fish version 2.1 supported `-a WORD=PHRASE`. This syntax is now deprecated but will still be converted.

\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.
abbr.fish: add abbr, a command to manipulate abbreviations Work on #731. 2014-10-05 12:17:46 +08:00			`\section abbr abbr - manage fish abbreviations`

			`\subsection abbr-synopsis Synopsis`
			`\fish{synopsis}`
Migrate abbrs from =-separated to space-separated We silently upgrade existing abbreviations and change the separator when saving. This does not yet warn when the user is using the old syntax. Resolves #2051 2016-03-02 03:22:21 +08:00			`abbr -a word phrase...`
abbr.fish: add abbr, a command to manipulate abbreviations Work on #731. 2014-10-05 12:17:46 +08:00			`abbr -s`
			`abbr -l`
abbr: rename --remove to --erase for consistency with other fish commands Closes #2071. 2015-05-22 09:48:39 +08:00			`abbr -e word`
abbr.fish: add abbr, a command to manipulate abbreviations Work on #731. 2014-10-05 12:17:46 +08:00			`\endfish`

			`\subsection abbr-description Description`

			`abbr` manipulates the list of abbreviations that fish will expand.

Fix typo in abbr documentation [skip ci] 2014-10-08 07:48:22 +08:00			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.
abbr.fish: add abbr, a command to manipulate abbreviations Work on #731. 2014-10-05 12:17:46 +08:00
Soften abbr-in-config.fish wording This isn't as necessary anymore and having abbrs in config.fish is nice for e.g. storing it in git. 2016-02-13 22:08:54 +08:00			Abbreviations are stored using universal variables. You can create abbreviations directly on the command line, and they will be saved automatically. Calling `abbr -a` in config.fish will lead to slightly worse startup performance.
abbr.fish: add abbr, a command to manipulate abbreviations Work on #731. 2014-10-05 12:17:46 +08:00
			`The following parameters are available:`

abbr/web_config: support space-delimited abbreviations Support for space-delimited abbreviations was added to the expansion parser in fbade198; this commit extends that support to the user-facing tools, and documents the space-separated behaviour. Equals-delimited abbreviations are expected to be removed before the next release. Work on #731. 2014-11-15 23:48:40 +08:00			- `-a WORD PHRASE` or `--add WORD PHRASE` Adds a new abbreviation, where WORD will be expanded to PHRASE.
abbr.fish: add abbr, a command to manipulate abbreviations Work on #731. 2014-10-05 12:17:46 +08:00
			- `-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.

abbr: rename --remove to --erase for consistency with other fish commands Closes #2071. 2015-05-22 09:48:39 +08:00			- `-e WORD` or `--erase WORD` Erase the abbreviation WORD.
abbr.fish: add abbr, a command to manipulate abbreviations Work on #731. 2014-10-05 12:17:46 +08:00
Migrate abbrs from =-separated to space-separated We silently upgrade existing abbreviations and change the separator when saving. This does not yet warn when the user is using the old syntax. Resolves #2051 2016-03-02 03:22:21 +08:00			Note: fish version 2.1 supported `-a WORD=PHRASE`. This syntax is now deprecated but will still be converted.

abbr.fish: add abbr, a command to manipulate abbreviations Work on #731. 2014-10-05 12:17:46 +08:00			`\subsection abbr-example Examples`

			`\fish`
abbr/web_config: support space-delimited abbreviations Support for space-delimited abbreviations was added to the expansion parser in fbade198; this commit extends that support to the user-facing tools, and documents the space-separated behaviour. Equals-delimited abbreviations are expected to be removed before the next release. Work on #731. 2014-11-15 23:48:40 +08:00			`abbr -a gco git checkout`
abbr.fish: add abbr, a command to manipulate abbreviations Work on #731. 2014-10-05 12:17:46 +08:00			`\endfish`
			Add a new abbreviation where `gco` will be replaced with `git checkout`.

			`\fish`
abbr: rename --remove to --erase for consistency with other fish commands Closes #2071. 2015-05-22 09:48:39 +08:00			`abbr -e gco`
abbr.fish: add abbr, a command to manipulate abbreviations Work on #731. 2014-10-05 12:17:46 +08:00			`\endfish`
abbr: rename --remove to --erase for consistency with other fish commands Closes #2071. 2015-05-22 09:48:39 +08:00			Erase the `gco` abbreviation.
abbr.fish: add abbr, a command to manipulate abbreviations Work on #731. 2014-10-05 12:17:46 +08:00
			`\fish`
			`ssh another_host abbr -s \| source`
			`\endfish`
			`Import the abbreviations defined on another_host over SSH.`