github-mirror/fish-shell
github-mirror/fish-shell
2
0
Fork 0
mirror of https://github.com/fish-shell/fish-shell.git synced 2025-03-15 15:05:27 +08:00
Code Issues Actions 4 Packages Projects Releases Wiki Activity

docs: string pad doc update

Browse Source
This commit is contained in:
Andrew Prokhorenkov 2020-07-10 21:26:06 -05:00 committed by ridiculousfish
parent 52b0d356ff
commit ac8482113c
1 changed files with 17 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -17,7 +17,23 @@ Description
.. BEGIN DESCRIPTION
``string pad`` pads before and after the string specified character for each STRING. If ``-l`` or ``--left`` is given, only padded before string. Left only is the default padding. If ``-r`` or ``--right`` is given, only padded after string. The ``-c`` or ``--char`` switch causes the characters in CHAR to be padded instead of whitespace. The ``-n`` or ``--count`` integer specifies the amount of characters to be padded. The default padding count is 0. The ``-m` or ``--max`` integer specifies the resulting length of the after after adding pad characters. Note, that the ``-n`` and ``-m`` flags are mutually exclusive, you can only use one of them. Exit status: 0 if string was padded, or 1 otherwise.
``string pad`` pads before and after the string specified character for each STRING.
The default behaviour is left padding with spaces and default count or max is zero.
If ``-l`` or ``--left`` is given, only padded before string.
If ``-r`` or ``--right`` is given, only padded after string.
The ``-c`` or ``--char`` switch causes the characters in CHAR to be padded instead of default whitespace character.
The ``-n`` or ``--count`` integer specifies the amount of characters to be padded.
The ``-m`` or ``--max`` integer specifies the resulting length of the after after adding pad characters.
Note, that the ``-n`` and ``-m`` flags are mutually exclusive, you can only use one of them.
Exit status: 0 if string was padded, or 1 otherwise.
.. END DESCRIPTION