2019-03-31 17:05:09 +08:00
.. _cmd-abbr:
2018-12-17 09:39:33 +08:00
abbr - manage fish abbreviations
2019-01-03 12:10:47 +08:00
================================
2018-12-17 09:39:33 +08:00
2018-12-18 09:58:24 +08:00
Synopsis
--------
2018-12-17 05:08:41 +08:00
docs synopsis: add HTML highlighing and automate manpage markup
Recent synopsis changes move from literal code blocks to
[RST line blocks]. This does not translate well to HTML: it's not
rendered in monospace, so aligment is lost. Additionally, we don't
get syntax highlighting in HTML, which adds differences to our code
samples which are highlighted.
We hard-wrap synopsis lines (like code blocks). To align continuation
lines in manpages we need [backslashes in weird places]. Combined with
the **, *, and `` markup, it's a bit hard to get the alignment right.
Fix these by moving synopsis sources back to code blocks and compute
HTML syntax highlighting and manpage markup with a custom Sphinx
extension.
The new Pygments lexer can tokenize a synopsis and assign the various
highlighting roles, which closely matches fish's syntax highlighing:
- command/keyword (dark blue)
- parameter (light blue)
- operator like and/or/not/&&/|| (cyan)
- grammar metacharacter (black)
For manpage output, we don't project the fish syntax highlighting
but follow the markup convention in GNU's man(1):
bold text type exactly as shown.
italic text replace with appropriate argument.
To make it easy to separate these two automatically, formalize that
(italic) placeholders must be uppercase; while all lowercase text is
interpreted literally (so rendered bold).
This makes manpages more consistent, see string-join(1) and and(1).
Implementation notes:
Since we want manpage formatting but Sphinx's Pygments highlighing
plugin does not support manpage output, add our custom "synopsis"
directive. This directive parses differently when manpage output is
specified. This means that the HTML and manpage build processes must
not share a cache, because the parsed doctrees are cached. Work around
this by using separate cache locations for build targets "sphinx-docs"
(which creates HTML) and "sphinx-manpages". A better solution would
be to only override Sphinx's ManualPageBuilder but that would take a
bit more code (ideally we could override ManualPageWriter but Sphinx
4.3.2 doesn't really support that).
---
Alternative solution: stick with line blocks but use roles like
:command: or :option: (or custom ones). While this would make it
possible to produce HTML that is consistent with code blocks (by adding
a bit of CSS), the source would look uglier and is harder to maintain.
(Let's say we want to add custom formatting to the [|] metacharacters
in HTML. This is much easier with the proposed patch.)
---
[RST line blocks]: https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#line-blocks
[backslashes in weird places]: https://github.com/fish-shell/fish-shell/pull/8626#discussion_r782837750
2022-01-09 22:09:46 +08:00
.. synopsis ::
abbr --add [SCOPE] WORD EXPANSION
abbr --erase WORD ...
abbr --rename [SCOPE] OLD_WORD NEW_WORD
abbr --show
abbr --list
abbr --query WORD ...
2018-12-17 05:08:41 +08:00
2018-12-19 10:44:30 +08:00
Description
2019-01-03 12:10:47 +08:00
-----------
2018-12-17 05:08:41 +08:00
2018-12-20 04:02:45 +08:00
`` abbr `` manages abbreviations - user-defined words that are replaced with longer phrases after they are entered.
2018-12-17 05:08:41 +08:00
2021-12-09 19:33:33 +08:00
For example, a frequently-run command like `` git checkout `` can be abbreviated to `` gco `` .
After entering `` gco `` and pressing :kbd: `Space` or :kbd: `Enter` , the full text `` git checkout `` will appear in the command line.
2018-12-17 05:08:41 +08:00
2018-12-19 10:44:30 +08:00
Options
2019-01-03 12:10:47 +08:00
-------
2018-12-17 05:08:41 +08:00
The following options are available:
2021-12-09 19:33:33 +08:00
**-a** *WORD* *EXPANSION* or **--add** *WORD* *EXPANSION*
Adds a new abbreviation, causing *WORD* to be expanded to *EXPANSION*
2018-12-17 05:08:41 +08:00
2021-12-09 19:33:33 +08:00
**-r** *OLD_WORD* *NEW_WORD* or **--rename** *OLD_WORD* *NEW_WORD*
Renames an abbreviation, from *OLD_WORD* to *NEW_WORD*
2018-12-17 05:08:41 +08:00
2021-12-09 19:33:33 +08:00
**-s** or **--show**
Show all abbreviations in a manner suitable for import and export
2018-12-17 05:08:41 +08:00
2021-12-09 19:33:33 +08:00
**-l** or **--list**
Lists all abbreviated words
2018-12-17 05:08:41 +08:00
2022-01-09 16:49:51 +08:00
**-e** *WORD* or **--erase** *WORD* ...
2021-12-09 19:33:33 +08:00
Erase the given abbreviations
2018-12-17 05:08:41 +08:00
2021-12-09 19:33:33 +08:00
**-q** or **--query**
Return 0 (true) if one of the *WORD* is an abbreviation.
2019-02-25 07:01:16 +08:00
2022-03-12 00:18:41 +08:00
**-h** or **--help**
Displays help about using this command.
In addition, when adding or renaming abbreviations, one of the following **SCOPE** options can be used:
2018-12-17 05:08:41 +08:00
2021-12-09 19:33:33 +08:00
**-g** or **--global**
Use a global variable
**-U** or **--universal**
Use a universal variable (default)
2018-12-17 05:08:41 +08:00
See the "Internals" section for more on them.
2018-12-19 10:44:30 +08:00
Examples
2019-01-03 12:10:47 +08:00
--------
2018-12-17 05:08:41 +08:00
2018-12-19 11:14:04 +08:00
::
abbr -a -g gco git checkout
2021-12-09 19:33:33 +08:00
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).
2018-12-19 11:14:04 +08:00
::
abbr -a -U l less
2021-12-09 19:33:33 +08:00
Add a new abbreviation where `` l `` will be replaced with `` less `` universal to all shells.
Note that you omit the **-U** since it is the default.
2018-12-19 11:14:04 +08:00
::
abbr -r gco gch
2018-12-20 04:02:45 +08:00
Renames an existing abbreviation from `` gco `` to `` gch `` .
2018-12-17 05:08:41 +08:00
2018-12-19 11:14:04 +08:00
::
abbr -e gco
2018-12-20 04:02:45 +08:00
Erase the `` gco `` abbreviation.
2018-12-17 05:08:41 +08:00
2018-12-19 11:14:04 +08:00
::
ssh another_host abbr -s | source
2018-12-17 05:08:41 +08:00
Import the abbreviations defined on another_host over SSH.
2018-12-19 10:44:30 +08:00
Internals
2019-01-03 12:10:47 +08:00
---------
2021-12-09 19:33:33 +08:00
Each abbreviation is stored in its own global or universal variable.
The name consists of the prefix `` _fish_abbr_ `` followed by the WORD after being transformed by `` string escape style=var `` .
The WORD cannot contain a space but all other characters are legal.
2018-12-17 05:08:41 +08:00
2021-12-09 19:33:33 +08:00
Abbreviations created with the **--universal** flag will be visible to other fish sessions, whilst **--global** will be limited to the current session.
