h/fish-shell
1
Fork 0
mirror of https://github.com/fish-shell/fish-shell.git synced 2026-04-21 00:31:15 -03:00
Code Issues Packages Projects Releases Wiki Activity

docs: standardise on definition lists for options

Browse Source 
Harmonizes the option listing including formatting in a similar manner to the
synopsis of each entry.
This commit is contained in:
David Adam
2022-03-11 23:56:20 +08:00
parent cf85bf9be3
commit e23e52a8e9
30 changed files with 470 additions and 240 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
doc_src/cmds/fish_key_reader.rst
View File

@@ -19,13 +19,17 @@ If the character sequence matches a special key name (see ``bind --key-names``),
The following options are available:
- ``-c`` or ``--continuous`` begins a session where multiple key sequences can be inspected. By default the program exits after capturing a single key sequence.
**-c** or **--continuous**
Begins a session where multiple key sequences can be inspected. By default the program exits after capturing a single key sequence.
- ``-V`` or ``--verbose`` tells fish_key_reader to output timing information and explain the sequence in more detail.
**-V** or **--verbose**
Tells fish_key_reader to output timing information and explain the sequence in more detail.
- ``-h`` or ``--help`` prints usage information.
**-h** or **--help**
Displays help about using this command.
- ``-v`` or ``--version`` prints fish_key_reader's version and exits.
**-v** or **--version**
Displays the current :program:`fish` version and then exits.
Usage Notes
-----------