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
1c21e26d08
fish-shell/doc_src/cmds/string-pad.rst

59 lines
1.7 KiB
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
docs synopses: use parenthesis to indicate that short/long option pairs take same args Matches Git, see for example the -O option in git-grep(1).
2022-01-09 16:01:51 +08:00
``string`` pad [**-r** | **--right**] [(**-c** | **--char**) *CHAR*] [(**-w** | **--width**) *INTEGER*]
docs synopses: fix alignment of continuation lines This corrects what looks like wrong alignment of some synopsis lines. (I think the alignment is not a bad idea but it makes us do more manual work, maybe we can automate that in future. We still need to figure out how to translate it to HTML.) "man -l build/user_doc/man/man1/history.1" before: string match [-a | --all] [-e | --entire] [-i | --ignore-case] [-r | --regex] [-n | --index] [-q | --quiet] [-v | --invert] PATTERN [STRING…] and after: string match [-a | --all] [-e | --entire] [-i | --ignore-case] [-r | --regex] [-n | --index] [-q | --quiet] [-v | --invert] PATTERN [STRING…] Also make the lines align the same way in the RST source by carefully choosing the position of the backslash. I'm not sure why we used two backslashes per line. Use only one; this gives us no choice of where to put it so both source and man page output are aligned. Change tabs to spaces to make the alignment in the source work.
2022-01-09 18:03:31 +08:00
\ [*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
.. END SYNOPSIS
Description
-----------
.. BEGIN DESCRIPTION
docs
2021-07-31 02:04:38 +08:00
``string pad`` extends each STRING to the given visible width by adding CHAR to the left. That means the width of all visible characters added together, excluding escape sequences and accounting for $fish_emoji_width and $fish_ambiguous_width. It is the amount of columns in a terminal the STRING occupies.
The escape sequences reflect what *fish* knows about, and how it computes its output. Your terminal might support more escapes, or not support escape sequences that fish knows about.
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
::
Improve string pad examples and add a cross-reference The old examples were not really showcasing that it's nice for aligning text.
2020-09-29 00:42:02 +08:00
>_ string pad -w 10 abc abcdef
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
Improve string pad examples and add a cross-reference The old examples were not really showcasing that it's nice for aligning text.
2020-09-29 00:42:02 +08:00
abcdef
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 --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
Improve string pad examples and add a cross-reference The old examples were not really showcasing that it's nice for aligning text.
2020-09-29 00:42:02 +08:00
>_ string pad -w$COLUMNS (date)
# Prints the current time on the right edge of the screen.
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
Improve string pad examples and add a cross-reference The old examples were not really showcasing that it's nice for aligning text.
2020-09-29 00:42:02 +08:00
See Also
--------
- The :ref:`printf <cmd-printf>` command can do simple padding, for example ``printf %10s\n`` works like ``string pad -w10``.
docs
2021-07-31 02:04:38 +08:00
- :ref:`string length <cmd-string-length>` with the ``--visible`` option can be used to show what fish thinks the width is.
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