github-mirror/fish-shell
2
0
Fork 0
mirror of https://github.com/fish-shell/fish-shell.git synced 2024-11-26 02:13:38 +08:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity
3002c88f44
fish-shell/doc_src/cmds/string-pad.rst

51 lines
974 B
ReStructuredText
Raw Normal View History

string pad: handle padding characters of width > 1 If the padding is not divisible by the char's width without remainder, we pad the remainder with spaces, so the total width of the output is correct. Also add completions, changelog entry, adjust documentation, add examples with emoji and some tests. Apply some minor style nitpicks and avoid extra allocations of the input strings.
2020-09-28 03:51:20 +08:00
string-pad - pad strings to a fixed width
=========================================
New command "string pad" to pad text to a given width (#7340) Pads text to a given width, or the maximum width of all inputs.
2020-09-28 01:12:42 +08:00
Synopsis
--------
.. BEGIN SYNOPSIS
::
string pad [(-r | --right)] [(-c | --char) CHAR] [(-w | --width) INTEGER] [STRING...]
.. END SYNOPSIS
Description
-----------
.. BEGIN DESCRIPTION
string pad: handle padding characters of width > 1 If the padding is not divisible by the char's width without remainder, we pad the remainder with spaces, so the total width of the output is correct. Also add completions, changelog entry, adjust documentation, add examples with emoji and some tests. Apply some minor style nitpicks and avoid extra allocations of the input strings.
2020-09-28 03:51:20 +08:00
``string pad`` extends each STRING to the given width by adding CHAR to the left.
New command "string pad" to pad text to a given width (#7340) Pads text to a given width, or the maximum width of all inputs.
2020-09-28 01:12:42 +08:00
string pad: handle padding characters of width > 1 If the padding is not divisible by the char's width without remainder, we pad the remainder with spaces, so the total width of the output is correct. Also add completions, changelog entry, adjust documentation, add examples with emoji and some tests. Apply some minor style nitpicks and avoid extra allocations of the input strings.
2020-09-28 03:51:20 +08:00
If ``-r`` or ``--right`` is given, add the padding after a string.
New command "string pad" to pad text to a given width (#7340) Pads text to a given width, or the maximum width of all inputs.
2020-09-28 01:12:42 +08:00
string pad: handle padding characters of width > 1 If the padding is not divisible by the char's width without remainder, we pad the remainder with spaces, so the total width of the output is correct. Also add completions, changelog entry, adjust documentation, add examples with emoji and some tests. Apply some minor style nitpicks and avoid extra allocations of the input strings.
2020-09-28 03:51:20 +08:00
If ``-c`` or ``--char`` is given, pad with CHAR instead of whitespace.
New command "string pad" to pad text to a given width (#7340) Pads text to a given width, or the maximum width of all inputs.
2020-09-28 01:12:42 +08:00
string pad: handle padding characters of width > 1 If the padding is not divisible by the char's width without remainder, we pad the remainder with spaces, so the total width of the output is correct. Also add completions, changelog entry, adjust documentation, add examples with emoji and some tests. Apply some minor style nitpicks and avoid extra allocations of the input strings.
2020-09-28 03:51:20 +08:00
The output is padded to the maximum width of all input strings. If ``-w`` or ``--width`` is given, use at least that.
New command "string pad" to pad text to a given width (#7340) Pads text to a given width, or the maximum width of all inputs.
2020-09-28 01:12:42 +08:00
.. END DESCRIPTION
Examples
--------
.. BEGIN EXAMPLES
::
string pad: handle padding characters of width > 1 If the padding is not divisible by the char's width without remainder, we pad the remainder with spaces, so the total width of the output is correct. Also add completions, changelog entry, adjust documentation, add examples with emoji and some tests. Apply some minor style nitpicks and avoid extra allocations of the input strings.
2020-09-28 03:51:20 +08:00
>_ string pad -w 10 abc
New command "string pad" to pad text to a given width (#7340) Pads text to a given width, or the maximum width of all inputs.
2020-09-28 01:12:42 +08:00
abc
string pad: handle padding characters of width > 1 If the padding is not divisible by the char's width without remainder, we pad the remainder with spaces, so the total width of the output is correct. Also add completions, changelog entry, adjust documentation, add examples with emoji and some tests. Apply some minor style nitpicks and avoid extra allocations of the input strings.
2020-09-28 03:51:20 +08:00
>_ string pad --right --char=🐟 "fish are pretty" "rich. "
fish are pretty
rich. 🐟🐟🐟🐟
New command "string pad" to pad text to a given width (#7340) Pads text to a given width, or the maximum width of all inputs.
2020-09-28 01:12:42 +08:00
string pad: handle padding characters of width > 1 If the padding is not divisible by the char's width without remainder, we pad the remainder with spaces, so the total width of the output is correct. Also add completions, changelog entry, adjust documentation, add examples with emoji and some tests. Apply some minor style nitpicks and avoid extra allocations of the input strings.
2020-09-28 03:51:20 +08:00
>_ string pad -w 6 -c- " | " "|||" " | " | string pad -r -w 9 -c-
--- | ---
---|||---
--- | ---
New command "string pad" to pad text to a given width (#7340) Pads text to a given width, or the maximum width of all inputs.
2020-09-28 01:12:42 +08:00
.. END EXAMPLES
Reference in New Issue Copy Permalink