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: update "string pad" to "width" argument

Browse Source
This commit is contained in:
Andrew Prokhorenkov 2020-09-18 23:00:02 -05:00 committed by ridiculousfish
parent 2afa354c14
commit 32f8b0c531
2 changed files with 15 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -8,7 +8,7 @@ Synopsis
::
string pad [(-l | --left)] [(-r | --right)] [(-c | --char) CHAR] [(-n | --count) INTEGER] [(-m | --max) INTEGER] [STRING...]
string pad [(-r | --right)] [(-c | --char) CHAR] [(-w | --width) INTEGER] [STRING...]
.. END SYNOPSIS
@ -17,23 +17,17 @@ Description
.. BEGIN DESCRIPTION
``string pad`` pads before and after the string specified character for each STRING.
``string pad`` pads specified character before and after the string for each STRING.
The default behaviour is left padding with spaces and default count or max is zero.
The default behaviour is left padding with spaces and default width is the length of string (hence, no padding).
If ``-l`` or ``--left`` is given, only padded before string.
If ``-r`` or ``--right`` is given, only pad after 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 ``-c`` or ``--char`` switch causes the characters in CHAR to be padded instead of default whitespace character.
If ``-w`` or ``--width`` is given, pad the string to given length. Width less than the string length will result in an unchanged string.
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.
Exit status: 0 if string was padded or haven't changed, or 1 otherwise.
.. END DESCRIPTION
@ -44,15 +38,15 @@ Examples
::
>_ string pad -l -n 10 -c ' ' 'abc'
abc
>_ string pad -w 10 -c ' ' 'abc'
abc
>_ string pad --right --count 5 --char=z foo bar
foozzzzz
barzzzzz
>_ string pad --right --width 12 --char=z foo barbaz
foozzzzzzzzz
barbazzzzzzz
>_ string pad --left --right -n 5 --char=- foo
-----foo-----
>_ string pad -w 6 --char=- foo | string pad --right -w 9 --char=-
---foo---
.. END EXAMPLES

2
doc_src/cmds/string.rst
View File

@ -15,7 +15,7 @@ Synopsis
string length [(-q | --quiet)] [STRING...]
string lower [(-q | --quiet)] [STRING...]
string match [(-a | --all)] [(-e | --entire)] [(-i | --ignore-case)] [(-r | --regex)] [(-n | --index)] [(-q | --quiet)] [(-v | --invert)] PATTERN [STRING...]
string pad [(-l | --left)] [(-r | --right)] [(-c | --char) CHAR] [(-n | --count) INTEGER] [(-m | --max) INTEGER] [STRING...]
string pad [(-r | --right)] [(-c | --char) CHAR] [(-w | --width) INTEGER] [STRING...]
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 REPLACEMENT [STRING...]
string split [(-m | --max) MAX] [(-n | --no-empty)] [(-q | --quiet)] [(-r | --right)] SEP [STRING...]