diff --git a/doc_src/cmds/string-pad.rst b/doc_src/cmds/string-pad.rst index c798e9ecb..97e2b2d79 100644 --- a/doc_src/cmds/string-pad.rst +++ b/doc_src/cmds/string-pad.rst @@ -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