root
/
xz
mirror of https://git.tukaani.org/xz.git
1
0
Fork 0
Code Issues Releases Wiki Activity

xz: Avoid unneeded \f escapes on the man page. 

I don't want to use \c in macro arguments but groff_man(7)
suggests that \f has better portability. \f would be needed
for the .TP strings for portability reasons anyway.

Thanks to Bjarni Ingi Gislason.
This commit is contained in:
Lasse Collin 2020-11-01 22:34:25 +02:00
parent 3b40a0792e
commit ca7bcdb30f
1 changed files with 22 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
src/xz/xz.1
View File

@ -234,16 +234,18 @@ by default by setting the environment variable
for example, for example,
.BR XZ_DEFAULTS=\-\-memlimit=150MiB . .BR XZ_DEFAULTS=\-\-memlimit=150MiB .
It is possible to set the limits separately It is possible to set the limits separately
for compression and decompression for compression and decompression by using
by using \fB\-\-memlimit\-compress=\fIlimit\fR and .BI \-\-memlimit\-compress= limit
\fB\-\-memlimit\-decompress=\fIlimit\fR. and \fB\-\-memlimit\-decompress=\fIlimit\fR.
Using these two options outside Using these two options outside
.B XZ_DEFAULTS .B XZ_DEFAULTS
is rarely useful because a single run of is rarely useful because a single run of
.B xz .B xz
cannot do both compression and decompression and cannot do both compression and decompression and
.BI \-\-memlimit= limit .BI \-\-memlimit= limit
(or \fB\-M\fR \fIlimit\fR) (or
.B \-M
.IR limit )
is shorter to type on the command line. is shorter to type on the command line.
.PP .PP
If the specified memory usage limit is exceeded when decompressing, If the specified memory usage limit is exceeded when decompressing,
@ -252,8 +254,10 @@ will display an error and decompressing the file will fail.
If the limit is exceeded when compressing, If the limit is exceeded when compressing,
.B xz .B xz
will try to scale the settings down so that the limit will try to scale the settings down so that the limit
is no longer exceeded (except when using \fB\-\-format=raw\fR is no longer exceeded (except when using
or \fB\-\-no\-adjust\fR). .B \-\-format=raw
or
.BR \-\-no\-adjust ).
This way the operation won't fail unless the limit is very small. This way the operation won't fail unless the limit is very small.
The scaling of the settings is done in steps that don't The scaling of the settings is done in steps that don't
match the compression level presets, for example, if the limit is match the compression level presets, for example, if the limit is
@ -1042,7 +1046,8 @@ for possible ways to specify the
.IR limit . .IR limit .
.TP .TP
\fB\-M\fR \fIlimit\fR, \fB\-\-memlimit=\fIlimit\fR, \fB\-\-memory=\fIlimit \fB\-M\fR \fIlimit\fR, \fB\-\-memlimit=\fIlimit\fR, \fB\-\-memory=\fIlimit
This is equivalent to specifying \fB\-\-memlimit\-compress=\fIlimit This is equivalent to specifying
.BI \-\-memlimit\-compress= limit
\fB\-\-memlimit\-decompress=\fIlimit\fR. \fB\-\-memlimit\-decompress=\fIlimit\fR.
.TP .TP
.B \-\-no\-adjust .B \-\-no\-adjust
@ -1088,7 +1093,12 @@ A custom filter chain allows specifying
the compression settings in detail instead of relying on the compression settings in detail instead of relying on
the settings associated to the presets. the settings associated to the presets.
When a custom filter chain is specified, When a custom filter chain is specified,
preset options (\fB\-0\fR \&...\& \fB\-9\fR and \fB\-\-extreme\fR) preset options
.RB ( \-0
\&...\&
.B \-9
and
.BR \-\-extreme )
earlier on the command line are forgotten. earlier on the command line are forgotten.
If a preset option is specified If a preset option is specified
after one or more custom filter chain options, after one or more custom filter chain options,
@ -1172,7 +1182,10 @@ The integer can be from
.B 0 .B 0
to to
.BR 9 , .BR 9 ,
matching the command line options \fB\-0\fR \&...\& \fB\-9\fR. matching the command line options
.B \-0
\&...\&
.BR \-9 .
The only supported modifier is currently The only supported modifier is currently
.BR e , .BR e ,
which matches which matches