github-mirror/fish-shell
2
0
Fork 0
mirror of https://github.com/fish-shell/fish-shell.git synced 2025-02-17 04:52:45 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs synopses: use parenthesis to indicate that short/long option pairs take same args

Browse Source 
Matches Git, see for example the -O option in git-grep(1).
This commit is contained in:
Johannes Altmanninger 2022-01-09 09:01:51 +01:00
parent 4a4905aaa5
commit f8e8c23ac3
8 changed files with 17 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc_src/cmds/bind.rst
View File

@ -6,11 +6,11 @@ Synopsis
--------
| ``bind`` [(**-M** | **--mode**) *MODE*] [(*-m* | *--sets-mode*) **NEW_MODE**] [*--preset* | *--user*] [*-s* | *--silent*] [**-k** | **--key**] *SEQUENCE* *COMMAND* ...
| ``bind`` [**-M** | **--mode** *MODE*] [**-k** | **--key**] [**--preset**] [**--user**] *SEQUENCE*
| ``bind`` **-K** | **--key-names** [**-a** | **--all**] [**--preset**] [**--user**]
| ``bind`` **-f** | **--function-names**
| ``bind`` **-L** | **--list-modes**
| ``bind`` **-e** | **--erase** [**-M** | **--mode** *MODE*] [**--preset**] [**--user**] [**-a** | **--all**] | [**-k** | **--key**] *SEQUENCE* ...
| ``bind`` [(**-M** | **--mode**) *MODE*] [**-k** | **--key**] [**--preset**] [**--user**] *SEQUENCE*
| ``bind`` (**-K** | **--key-names**) [**-a** | **--all**] [**--preset**] [**--user**]
| ``bind`` (**-f** | **--function-names**)
| ``bind`` (**-L** | **--list-modes**)
| ``bind`` (**-e** | **--erase**) [(**-M** | **--mode**) *MODE*] [**--preset**] [**--user**] [**-a** | **--all**] | [**-k** | **--key**] *SEQUENCE* ...
Description
-----------

2
doc_src/cmds/math.rst
View File

@ -6,7 +6,7 @@ math - perform mathematics calculations
Synopsis
--------
``math`` [**-s** | **--scale** *N*] [**-b** | **--base** *BASE*] *EXPRESSION...*
``math`` [(**-s** | **--scale**) *N*] [(**-b** | **--base**) *BASE*] *EXPRESSION...*
Description

2
doc_src/cmds/string-pad.rst
View File

@ -6,7 +6,7 @@ Synopsis
.. BEGIN SYNOPSIS
``string`` pad [**-r** | **--right**] [**-c** | **--char** *CHAR*] [**-w** | **--width** *INTEGER*]
``string`` pad [**-r** | **--right**] [(**-c** | **--char**) *CHAR*] [(**-w** | **--width**) *INTEGER*]
\ \ [*STRING*...]
.. END SYNOPSIS

2
doc_src/cmds/string-repeat.rst
View File

@ -6,7 +6,7 @@ Synopsis
.. BEGIN SYNOPSIS
``string`` repeat [**-n** | **--count** *COUNT*] [**-m** | **--max** *MAX*] [**-N** | **--no-newline**]
``string`` repeat [(**-n** | **--count**) *COUNT*] [(**-m** | **--max**) *MAX*] [**-N** | **--no-newline**]
\ \ [**-q** | **--quiet**] [*STRING*...]
.. END SYNOPSIS

4
doc_src/cmds/string-split.rst
View File

@ -6,9 +6,9 @@ Synopsis
.. BEGIN SYNOPSIS
| ``string`` split [**-m** | **--max** *MAX*] [**-n** | **--no-empty**] [**-q** | **--quiet**]
| ``string`` split [(**-m** | **--max**) *MAX*] [**-n** | **--no-empty**] [**-q** | **--quiet**]
\ \ [**-r** | **--right**] *SEP* [*STRING*...]
| ``string`` split0 [**-m** | **--max** *MAX*] [**-n** | **--no-empty**] [**-q** | **--quiet**]
| ``string`` split0 [(**-m** | **--max**) *MAX*] [**-n** | **--no-empty**] [**-q** | **--quiet**]
\ \ [**-r** | **--right**] [*STRING*...]
.. END SYNOPSIS

2
doc_src/cmds/string-sub.rst
View File

@ -6,7 +6,7 @@ Synopsis
.. BEGIN SYNOPSIS
``string`` sub [**-s** | **--start** *START*] [**-l** | **--length** *LENGTH*]
``string`` sub [(**-s** | **--start**) *START*] [(**-l** | **--length**) *LENGTH*]
\ [**-q** | **--quiet**] [*STRING*...]
.. END SYNOPSIS

2
doc_src/cmds/string-trim.rst
View File

@ -6,7 +6,7 @@ Synopsis
.. BEGIN SYNOPSIS
``string`` trim [**-l** | **--left**] [**-r** | **--right**] [**-c** | **--chars** *CHARS*]
``string`` trim [**-l** | **--left**] [**-r** | **--right**] [(**-c** | **--chars**) *CHARS*]
\ \ [**-q** | **--quiet**] [*STRING*...]
.. END SYNOPSIS

10
doc_src/cmds/string.rst
View File

@ -17,17 +17,17 @@ Synopsis
\ \ *PATTERN* [*STRING*...]
| ``string`` pad [**-r** | **--right**] [**-c** | **--char** *CHAR*] [**-w** | **--width** *INTEGER*]
\ \ [*STRING*...]
| ``string`` repeat [**-n** | **--count** *COUNT*] [**-m** | **--max** *MAX*] [**-N** | **--no-newline**]
| ``string`` repeat [(**-n** | **--count**) *COUNT*] [(**-m** | **--max**) *MAX*] [**-N** | **--no-newline**]
\ \ [**-q** | **--quiet**] [*STRING*...]
| ``string`` replace [**-a** | **--all**] [**-f** | **--filter**] [**-i** | **--ignore-case**]
\ \ [**-r** | **--regex**] [**-q** | **--quiet**] *PATTERN* *REPLACE* [*STRING*...]
| ``string`` split [**-m** | **--max** *MAX*] [**-n** | **--no-empty**] [**-q** | **--quiet**]
| ``string`` split [(**-m** | **--max**) *MAX*] [**-n** | **--no-empty**] [**-q** | **--quiet**]
\ \ [**-r** | **--right**] *SEP* [*STRING*...]
| ``string`` split0 [**-m** | **--max** *MAX*] [**-n** | **--no-empty**] [**-q** | **--quiet**]
| ``string`` split0 [(**-m** | **--max**) *MAX*] [**-n** | **--no-empty**] [**-q** | **--quiet**]
\ \ [**-r** | **--right**] [*STRING*...]
| ``string`` sub [**-s** | **--start** *START*] [**-l** | **--length** *LENGTH*]
| ``string`` sub [(**-s** | **--start**) *START*] [(**-l** | **--length**) *LENGTH*]
\ [**-q** | **--quiet**] [*STRING*...]
| ``string`` trim [**-l** | **--left**] [**-r** | **--right**] [**-c** | **--chars** *CHARS*]
| ``string`` trim [**-l** | **--left**] [**-r** | **--right**] [(**-c** | **--chars**) *CHARS*]
\ \ [**-q** | **--quiet**] [*STRING*...]
| ``string`` unescape [**--style=**] [*STRING*...]
| ``string`` upper [**-q** | **--quiet**] [*STRING*...]