2020-09-27 19:51:20 +00:00
string-pad - pad strings to a fixed width
=========================================
2020-09-27 17:12:42 +00:00
Synopsis
--------
.. BEGIN SYNOPSIS
docs synopsis: add HTML highlighing and automate manpage markup
Recent synopsis changes move from literal code blocks to
[RST line blocks]. This does not translate well to HTML: it's not
rendered in monospace, so aligment is lost. Additionally, we don't
get syntax highlighting in HTML, which adds differences to our code
samples which are highlighted.
We hard-wrap synopsis lines (like code blocks). To align continuation
lines in manpages we need [backslashes in weird places]. Combined with
the **, *, and `` markup, it's a bit hard to get the alignment right.
Fix these by moving synopsis sources back to code blocks and compute
HTML syntax highlighting and manpage markup with a custom Sphinx
extension.
The new Pygments lexer can tokenize a synopsis and assign the various
highlighting roles, which closely matches fish's syntax highlighing:
- command/keyword (dark blue)
- parameter (light blue)
- operator like and/or/not/&&/|| (cyan)
- grammar metacharacter (black)
For manpage output, we don't project the fish syntax highlighting
but follow the markup convention in GNU's man(1):
bold text type exactly as shown.
italic text replace with appropriate argument.
To make it easy to separate these two automatically, formalize that
(italic) placeholders must be uppercase; while all lowercase text is
interpreted literally (so rendered bold).
This makes manpages more consistent, see string-join(1) and and(1).
Implementation notes:
Since we want manpage formatting but Sphinx's Pygments highlighing
plugin does not support manpage output, add our custom "synopsis"
directive. This directive parses differently when manpage output is
specified. This means that the HTML and manpage build processes must
not share a cache, because the parsed doctrees are cached. Work around
this by using separate cache locations for build targets "sphinx-docs"
(which creates HTML) and "sphinx-manpages". A better solution would
be to only override Sphinx's ManualPageBuilder but that would take a
bit more code (ideally we could override ManualPageWriter but Sphinx
4.3.2 doesn't really support that).
---
Alternative solution: stick with line blocks but use roles like
:command: or :option: (or custom ones). While this would make it
possible to produce HTML that is consistent with code blocks (by adding
a bit of CSS), the source would look uglier and is harder to maintain.
(Let's say we want to add custom formatting to the [|] metacharacters
in HTML. This is much easier with the proposed patch.)
---
[RST line blocks]: https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#line-blocks
[backslashes in weird places]: https://github.com/fish-shell/fish-shell/pull/8626#discussion_r782837750
2022-01-09 14:09:46 +00:00
.. synopsis ::
string pad [-r | --right] [(-c | --char) CHAR] [(-w | --width) INTEGER]
[STRING ...]
2020-09-27 17:12:42 +00:00
.. END SYNOPSIS
Description
-----------
.. BEGIN DESCRIPTION
2022-03-12 14:22:00 +00: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 :envvar: `fish_emoji_width` and :envvar: `fish_ambiguous_width` . It is the amount of columns in a terminal the *STRING* occupies.
2021-07-30 18:04:38 +00:00
2022-03-12 14:22:00 +00:00
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.
2020-09-27 17:12:42 +00:00
2022-03-12 14:22:00 +00:00
If **-r** or **--right** is given, add the padding after a string.
2020-09-27 17:12:42 +00:00
2022-03-12 14:22:00 +00:00
If **-c** or **--char** is given, pad with *CHAR* instead of whitespace.
2020-09-27 17:12:42 +00:00
2022-03-12 14:22:00 +00:00
The output is padded to the maximum width of all input strings. If **-w** or **--width** is given, use at least that.
2020-09-27 17:12:42 +00:00
.. END DESCRIPTION
Examples
--------
.. BEGIN EXAMPLES
::
2020-09-28 16:42:02 +00:00
>_ string pad -w 10 abc abcdef
2020-09-27 17:12:42 +00:00
abc
2020-09-28 16:42:02 +00:00
abcdef
2020-09-27 17:12:42 +00:00
2020-09-27 19:51:20 +00:00
>_ string pad --right --char=🐟 "fish are pretty" "rich. "
fish are pretty
rich. 🐟🐟🐟🐟
2020-09-27 17:12:42 +00:00
2020-09-28 16:42:02 +00:00
>_ string pad -w$COLUMNS (date)
# Prints the current time on the right edge of the screen.
2020-09-27 17:12:42 +00:00
2020-09-28 16:42:02 +00:00
See Also
--------
- The :ref: `printf <cmd-printf>` command can do simple padding, for example `` printf %10s\n `` works like `` string pad -w10 `` .
2021-07-30 18:04:38 +00:00
- :ref: `string length <cmd-string-length>` with the `` --visible `` option can be used to show what fish thinks the width is.
2020-09-27 17:12:42 +00:00
.. END EXAMPLES
