root/xz
1
0
Fork 0
mirror of https://git.tukaani.org/xz.git synced 2026-10-31 11:24:56 +00:00
Code Issues Releases Wiki Activity

xz: Reduce indentation of three tables on the man page

Browse Source 
The extra indentation makes the tables stand out from the text, and
in the English man page it works well. However, some translations
have strings that require more space, and the table might become
too wide. In some translations this has been solved by splitting
the translated string on two lines, for example, Romanian translation
of "4096-byte alignment is best".

On Debian 13 with groff 1.23.0, the "man" command shows a few warnings:

    $ LANGUAGE=it MANWIDTH=80 man --warnings xz > /dev/null
    <standard input>:477: warning: table wider than line length minus indentation
    <standard input>:545: warning: table wider than line length minus indentation
    <standard input>:1182: warning: table wider than line length minus indentation

German man page shows those warnings too. On Arch with groff 1.24.1,
there are fewer warnings because the newer groff indents less, and
fewer tables reach or exceed the right margin. Thus, some safety margin
is good to keep the output neat with different man page formatters.

It feels silly to reduce the indentation on the English man page which
has plenty of safety margin, but it's simpler than trying to do it
only for the translated man pages. This doesn't affect readability;
it's just cosmetic.

I tried using .IP instead of .RS + .PP for the tables, but on Solaris 10
it results in an extra empty line before the table. It makes some
difference on AIX 7.3 too. With groff, both are fine. Stick to
.RS + .PP + .TS ... .TE + .RE for slightly better portability.

Co-authored-by: Otto Kekäläinen <otto@debian.org>
Partially-fixes: https://github.com/tukaani-project/xz/pull/220
This commit is contained in:
Lasse Collin 2026-05-20 21:21:51 +03:00
parent f9b243e203
commit 6237e4319f
No known key found for this signature in database
GPG Key ID: 38EE757D69184620
1 changed files with 0 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
src/xz/xz.1
View File

@ -771,7 +771,6 @@ produced per second can vary a lot.
.IP .IP
The following table summarises the features of the presets: The following table summarises the features of the presets:
.RS .RS
.RS
.PP .PP
.TS .TS
tab(;); tab(;);
@ -790,7 +789,6 @@ Preset;DictSize;CompCPU;CompMem;DecMem
\-9;64 MiB;6;674 MiB;65 MiB \-9;64 MiB;6;674 MiB;65 MiB
.TE .TE
.RE .RE
.RE
.IP .IP
Column descriptions: Column descriptions:
.RS .RS
@ -859,7 +857,6 @@ and
respectively. respectively.
That way no two presets are identical. That way no two presets are identical.
.RS .RS
.RS
.PP .PP
.TS .TS
tab(;); tab(;);
@ -878,7 +875,6 @@ Preset;DictSize;CompCPU;CompMem;DecMem
\-9e;64 MiB;8;674 MiB;65 MiB \-9e;64 MiB;8;674 MiB;65 MiB
.TE .TE
.RE .RE
.RE
.IP .IP
For example, there are a total of four presets that use For example, there are a total of four presets that use
8\ MiB dictionary, whose order from the fastest to the slowest is 8\ MiB dictionary, whose order from the fastest to the slowest is
@ -1906,7 +1902,6 @@ Different instruction sets have different alignment:
the executable file must be aligned to a multiple of the executable file must be aligned to a multiple of
this value in the input data to make the filter work. this value in the input data to make the filter work.
.RS .RS
.RS
.PP .PP
.TS .TS
tab(;); tab(;);
@ -1923,7 +1918,6 @@ SPARC;4;
RISC-V;2; RISC-V;2;
.TE .TE
.RE .RE
.RE
.IP .IP
Since the BCJ-filtered data is usually compressed with LZMA2, Since the BCJ-filtered data is usually compressed with LZMA2,
the compression ratio may be improved slightly if the compression ratio may be improved slightly if