mirror of
https://github.com/fish-shell/fish-shell.git
synced 2024-11-25 18:03:37 +08:00
76b3965648
This isn't the same as "join"/"join0", where one is just a special case of the other. These are two different, if basically opposite commands. But more importantly this was a huge mess and the formatting was broken.
61 lines
1.7 KiB
ReStructuredText
61 lines
1.7 KiB
ReStructuredText
string-pad - pad strings to a fixed width
|
|
=========================================
|
|
|
|
Synopsis
|
|
--------
|
|
|
|
.. BEGIN SYNOPSIS
|
|
|
|
.. synopsis::
|
|
|
|
string pad [-r | --right] [(-c | --char) CHAR] [(-w | --width) INTEGER]
|
|
[STRING ...]
|
|
|
|
.. END SYNOPSIS
|
|
|
|
Description
|
|
-----------
|
|
|
|
.. BEGIN DESCRIPTION
|
|
|
|
``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 :envvar:`fish_emoji_width` and :envvar:`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.
|
|
|
|
If **-r** or **--right** is given, add the padding after a string.
|
|
|
|
If **-c** or **--char** is given, pad with *CHAR* instead of whitespace.
|
|
|
|
The output is padded to the maximum width of all input strings. If **-w** or **--width** is given, use at least that.
|
|
|
|
.. END DESCRIPTION
|
|
|
|
Examples
|
|
--------
|
|
|
|
.. BEGIN EXAMPLES
|
|
|
|
::
|
|
|
|
>_ string pad -w 10 abc abcdef
|
|
abc
|
|
abcdef
|
|
|
|
>_ string pad --right --char=🐟 "fish are pretty" "rich. "
|
|
fish are pretty
|
|
rich. 🐟🐟🐟🐟
|
|
|
|
>_ string pad -w$COLUMNS (date)
|
|
# Prints the current time on the right edge of the screen.
|
|
|
|
.. END EXAMPLES
|
|
|
|
See Also
|
|
--------
|
|
|
|
.. BEGIN SEEALSO
|
|
|
|
- The :doc:`printf <printf>` command can do simple padding, for example ``printf %10s\n`` works like ``string pad -w10``.
|
|
|
|
- :doc:`string length <string-length>` with the ``--visible`` option can be used to show what fish thinks the width is.
|