Package: xz-utils Version: 5.2.2-1.3 Severity: minor Tags: patch Dear Maintainer,
the patch is in the attachment. Input file is xz.1 Test nr. 2: Enable and fix warnings from 'test-groff'. Input file is /tmp/xz.1 <xz.1>:408 (macro BR): only 1 argument, but more are expected <xz.1>:1724 (macro BR): only 1 argument, but more are expected <xz.1>:1901 (macro BR): only 1 argument, but more are expected <xz.1>:2194 (macro BR): only 1 argument, but more are expected chk_manuals: Output is from: test-groff -b -e -mandoc -T utf8 -rF0 -t -w w -z and Test nr. 15: Change the name of a macro for two fonts (e.g., BR and IR) to one letter, if there is only one argument. Add the second argument if needed. It is sometimes part of the first one. 408:.BR \-\-stdout 1724:.BR \-\-info\-memory 1901:.BR 0.123. 2194:.BR lzcat ##### Test nr. 5: Change '-' (\-) to '\(en' (en-dash) for a numeric range. xz.1:843:Typically a good value is 2\-4 times xz.1:1309:1\-3 xz.1:1425:0\-3 and xz.1:1429:4\-9. xz.1:1448:can be 2\-273 bytes. xz.1:1466:for Hash Chains is 4\-100 and 16\-1000 for Binary Trees. xz.1:1507:which can help LZMA2 to produce 0\-15\ % smaller xz.1:1626:must be 1\-256. ##### Test nr. 8: Protect a full stop (.) with "\&", if it has a blank (white-space) in front of or (ignoring transparent characters to the full stop) after it, and it does not mean an end of a sentence. 15:.RI [ option... ] 16:.RI [ file... ] 224:wasn't deemed to be flexible enough (e.g. using 259:match the compression level presets, e.g. if the limit is 279:This can be useful e.g. if the 673:e.g. for distributing files that need to be decompressible 1072:preset options (\fB\-0\fR ... \fB\-9\fR and \fB\-\-extreme\fR) 1156:matching the command line options \fB\-0\fR ... \fB\-9\fR. 1237:E.g. in typical English text, an upper-case letter is 1281:E.g. with text files having one-byte 1535:(e.g. object files, static libraries, and Linux kernel modules) 1609:It can be useful when compressing e.g. uncompressed bitmap images 1614:which compresses faster and better e.g. with 1685:never has any colons, e.g. 2 min 30 s. 1698:If the operation didn't finish, e.g. due to user interruption, 2152:This is the case e.g. when 2169:e.g. to set script-specific default compression options. 2172:if that is reasonable, e.g. in 2464:which is slower than e.g. the default 2618:somewhat big dictionary (e.g. 32 MiB) to compress well, 2621:would do, a preset with a low CompCPU value (e.g. 1) 2672:e.g. to make it possible to decompress the file on 2704:E.g. a source code archive contains mostly US-ASCII text, 2721:E.g. to compress a x86-32 or x86-64 shared library 2750:e.g. as uncompressed TIFF. 2753:E.g. 24-bit RGB bitmap needs ##### Test nr. 20: Use a macro to change to the italic font, instead of \fI [1], if possible. The macros have the italic corrections, but "\c" removes them. [1] man-pages(7) Only italic corrections (\, and \/) added if it is an argument to the macro .TP 230:the command line option \fB\-\-memlimit=\fIlimit\fR. 238:by using \fB\-\-memlimit\-compress=\fIlimit\fR and 239:\fB\-\-memlimit\-decompress=\fIlimit\fR. 246:(or \fB\-M\fR \fIlimit\fR) 473:\fB\-S\fR \fI.suf\fR, \fB\-\-suffix=\fI.suf 504:\fB\-\-files\fR[\fB=\fIfile\fR] 518:\fB\-\-files0\fR[\fB=\fIfile\fR] 519:This is identical to \fB\-\-files\fR[\fB=\fIfile\fR] except 524:\fB\-F\fR \fIformat\fR, \fB\-\-format=\fIformat 568:\fB\-C\fR \fIcheck\fR, \fB\-\-check=\fIcheck 889:the value specified with \fB\-\-block\-size=\fIsize\fR), 1025:\fB\-M\fR \fIlimit\fR, \fB\-\-memlimit=\fIlimit\fR, \fB\-\-memory=\fIlimit 1026:This is equivalent to specifying \fB\-\-memlimit\-compress=\fIlimit 1027:\fB\-\-memlimit\-decompress=\fIlimit\fR. 1037:\fB\-T\fR \fIthreads\fR, \fB\-\-threads=\fIthreads 1120:\fB\-\-lzma1\fR[\fB=\fIoptions\fR] 1123:\fB\-\-lzma2\fR[\fB=\fIoptions\fR] 1486:\fB\-\-x86\fR[\fB=\fIoptions\fR] 1489:\fB\-\-powerpc\fR[\fB=\fIoptions\fR] 1491:\fB\-\-ia64\fR[\fB=\fIoptions\fR] 1493:\fB\-\-arm\fR[\fB=\fIoptions\fR] 1495:\fB\-\-armthumb\fR[\fB=\fIoptions\fR] 1497:\fB\-\-sparc\fR[\fB=\fIoptions\fR] 1603:\fB\-\-delta\fR[\fB=\fIoptions\fR] ##### Test nr. 26: Find a repeated word ! 1554 --> have ##### Test nr. 30: Surround a block of comments with the macros ".ig" and "..". The .\" (\#) at the beginning of each line is then not needed. Makes it easier to add and remove text and adjust lengtxh of lines. NO PATCH 2:.\" 3:.\" Author: Lasse Collin 4:.\" 5:.\" This file has been put into the public domain. 6:.\" You can do whatever you want with this file. 7:.\" ##### -- System Information: Debian Release: buster/sid APT prefers stable-updates APT policy: (500, 'stable-updates'), (500, 'proposed-updates'), (500, 'testing'), (500, 'stable') Architecture: amd64 (x86_64) Kernel: Linux 4.9.80-2 (SMP w/2 CPU cores) Locale: LANG=is_IS.iso88591, LC_CTYPE=is_IS.iso88591 (charmap=ISO-8859-1), LANGUAGE=is_IS.iso88591 (charmap=ISO-8859-1) Shell: /bin/sh linked to /bin/dash Init: sysvinit (via /sbin/init) Versions of packages xz-utils depends on: ii libc6 2.27-2 ii liblzma5 5.2.2-1.3 xz-utils recommends no packages. xz-utils suggests no packages. -- no debconf information -- Bjarni I. Gislason
--- xz.1 2018-03-29 23:46:01.000000000 +0000 +++ xz.1.new 2018-03-30 05:07:40.000000000 +0000 @@ -12,8 +12,8 @@ xz, unxz, xzcat, lzma, unlzma, lzcat \- . .SH SYNOPSIS .B xz -.RI [ option... ] -.RI [ file... ] +.RI [ option...\& ] +.RI [ file...\& ] . .SH COMMAND ALIASES .B unxz @@ -221,13 +221,14 @@ To prevent uncomfortable surprises, has a built-in memory usage limiter, which is disabled by default. While some operating systems provide ways to limit the memory usage of processes, relying on it -wasn't deemed to be flexible enough (e.g. using +wasn't deemed to be flexible enough (e.g., using .BR ulimit (1) to limit virtual memory tends to cripple .BR mmap (2)). .PP The memory usage limiter can be enabled with -the command line option \fB\-\-memlimit=\fIlimit\fR. +the command line option +.BI \-\-memlimit= limit \fR. Often it is more convenient to enable the limiter by default by setting the environment variable .BR XZ_DEFAULTS , @@ -235,15 +236,18 @@ e.g.\& .BR XZ_DEFAULTS=\-\-memlimit=150MiB . It is possible to set the limits separately for compression and decompression -by using \fB\-\-memlimit\-compress=\fIlimit\fR and -\fB\-\-memlimit\-decompress=\fIlimit\fR. +by using +.BI \-\-memlimit\-compress= limit +and +.BI \-\-memlimit\-decompress= limit \fR. Using these two options outside .B XZ_DEFAULTS is rarely useful because a single run of .B xz cannot do both compression and decompression and .BI \-\-memlimit= limit -(or \fB\-M\fR \fIlimit\fR) +(or +.BI "\-M " limit \fR) is shorter to type on the command line. .PP If the specified memory usage limit is exceeded when decompressing, @@ -256,7 +260,7 @@ is no longer exceeded (except when using or \fB\-\-no\-adjust\fR). 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 -match the compression level presets, e.g. if the limit is +match the compression level presets, e.g., if the limit is only slightly less than the amount required for .BR "xz \-9" , the settings will be scaled down only a little, @@ -276,7 +280,7 @@ It is possible to insert padding between or after the last part. The padding must consist of null bytes and the size of the padding must be a multiple of four bytes. -This can be useful e.g. if the +This can be useful e.g., if the .B .xz file is stored on a medium that measures file sizes in 512-byte blocks. @@ -306,7 +310,7 @@ are accepted as synonyms for .B MiB Multiply the integer by 1,048,576 (2^20). .BR Mi , -.BR m , +.BR m " (bad, means milli (10^\-3))," .BR M , and .B MB @@ -405,7 +409,7 @@ to the target file. .IP \(bu 3 When used with .B \-\-decompress -.BR \-\-stdout +.B \-\-stdout and .B xz cannot recognize the type of the source file, @@ -470,7 +474,7 @@ and certain additional conditions are me Creating sparse files may save disk space and speed up the decompression by reducing the amount of disk I/O. .TP -\fB\-S\fR \fI.suf\fR, \fB\-\-suffix=\fI.suf +\fB\-S\fR \fI.suf\fR, \fB\-\-suffix=\,\fI.suf When compressing, use .I .suf as the suffix for the target file instead of @@ -501,7 +505,7 @@ the suffix must always be specified unle writing to standard output, because there is no default suffix for raw streams. .TP -\fB\-\-files\fR[\fB=\fIfile\fR] +\fB\-\-files\fR[\fB=\,\fIfile\/\fR] Read the filenames to process from .IR file ; if @@ -515,13 +519,15 @@ If filenames are given also as command l processed before the filenames read from .IR file . .TP -\fB\-\-files0\fR[\fB=\fIfile\fR] -This is identical to \fB\-\-files\fR[\fB=\fIfile\fR] except -that each filename must be terminated with the null character. +\fB\-\-files0\fR[\fB=\,\fIfile\/\fR] +This is identical to +.BR \-\-files [\c +.BI = file \fR] +except that each filename must be terminated with the null character. . .SS "Basic file format and compression options" .TP -\fB\-F\fR \fIformat\fR, \fB\-\-format=\fIformat +\fB\-F\fR \fIformat\fR, \fB\-\-format=\,\fIformat Specify the file .I format to compress or decompress: @@ -565,7 +571,7 @@ and explicitly specify the filter chain, which normally would have been stored in the container headers. .RE .TP -\fB\-C\fR \fIcheck\fR, \fB\-\-check=\fIcheck +\fB\-C\fR \fIcheck\fR, \fB\-\-check=\,\fIcheck Specify the type of the integrity check. The check is calculated from the uncompressed data and stored in the @@ -628,7 +634,7 @@ It's recommended to not use this option unless the file integrity is verified externally in some other way. .RE .TP -.BR \-0 " ... " \-9 +.BR \-0 " ...\& " \-9 Select a compression preset level. The default is .BR \-6 . @@ -653,7 +659,7 @@ and .BR bzip2 (1). .RS .TP -.BR "\-0" " ... " "\-3" +.BR "\-0" " ...\& " "\-3" These are somewhat fast presets. .B \-0 is sometimes faster than @@ -665,12 +671,12 @@ with comparable or better compression ra although the results depend a lot on the type of data being compressed. .TP -.BR "\-4" " ... " "\-6" +.BR "\-4" " ...\& " "\-6" Good to very good compression while keeping decompressor memory usage reasonable even for old systems. .B \-6 is the default, which is usually a good choice -e.g. for distributing files that need to be decompressible +e.g., for distributing files that need to be decompressible even on systems with only 16\ MiB RAM. .RB ( \-5e or @@ -679,7 +685,7 @@ may be worth considering too. See .BR \-\-extreme .) .TP -.B "\-7 ... \-9" +.BR "\-7" " ...\& " "\-9" These are like .B \-6 but with higher compressor and decompressor memory requirements. @@ -701,18 +707,21 @@ The following table summarises the featu .TS tab(;); c c c c c +c c c c c n n n n n. Preset;DictSize;CompCPU;CompMem;DecMem -\-0;256 KiB;0;3 MiB;1 MiB -\-1;1 MiB;1;9 MiB;2 MiB -\-2;2 MiB;2;17 MiB;3 MiB -\-3;4 MiB;3;32 MiB;5 MiB -\-4;4 MiB;4;48 MiB;5 MiB -\-5;8 MiB;5;94 MiB;9 MiB -\-6;8 MiB;6;94 MiB;9 MiB -\-7;16 MiB;6;186 MiB;17 MiB -\-8;32 MiB;6;370 MiB;33 MiB -\-9;64 MiB;6;674 MiB;65 MiB +; MiB;; MiB; MiB +_ +\-0;256 KiB;0;3 ;1 +\-1;1 ;1;9 ;2 +\-2;2 ;2;17 ;3 +\-3;4 ;3;32 ;5 +\-4;4 ;4;48 ;5 +\-5;8 ;5;94 ;9 +\-6;8 ;6;94 ;9 +\-7;16 ;6;186 ;17 +\-8;32 ;6;370 ;33 +\-9;64 ;6;674 ;65 .TE .RE .RE @@ -724,7 +733,7 @@ DictSize is the LZMA2 dictionary size. It is waste of memory to use a dictionary bigger than the size of the uncompressed file. This is why it is good to avoid using the presets -.BR \-7 " ... " \-9 +.BR \-7 "\ ...\&\ " \-9 when there's no real need for them. At .B \-6 @@ -735,7 +744,7 @@ CompCPU is a simplified representation o that affect compression speed. The dictionary size affects speed too, so while CompCPU is the same for levels -.BR \-6 " ... " \-9 , +.BR \-6 "\ ...\&\ " \-9 , higher levels still tend to be a little slower. To get even slower and thus possibly better compression, see .BR \-\-extreme . @@ -758,12 +767,12 @@ have been rounded up to the next full Mi .TP .BR \-e ", " \-\-extreme Use a slower variant of the selected compression preset level -.RB ( \-0 " ... " \-9 ) +.RB ( \-0 "\ ...\&\ " \-9 ) to hopefully get a little bit better compression ratio, but with bad luck this can also make it worse. Decompressor memory usage is not affected, but compressor memory usage increases a little at preset levels -.BR \-0 " ... " \-3 . +.BR \-0 "\ ...\&\ " \-3 . .IP "" Since there are two presets with dictionary sizes 4\ MiB and 8\ MiB, the presets @@ -782,18 +791,21 @@ That way no two presets are identical. .TS tab(;); c c c c c +c c c c c n n n n n. Preset;DictSize;CompCPU;CompMem;DecMem -\-0e;256 KiB;8;4 MiB;1 MiB -\-1e;1 MiB;8;13 MiB;2 MiB -\-2e;2 MiB;8;25 MiB;3 MiB -\-3e;4 MiB;7;48 MiB;5 MiB -\-4e;4 MiB;8;48 MiB;5 MiB -\-5e;8 MiB;7;94 MiB;9 MiB -\-6e;8 MiB;8;94 MiB;9 MiB -\-7e;16 MiB;8;186 MiB;17 MiB -\-8e;32 MiB;8;370 MiB;33 MiB -\-9e;64 MiB;8;674 MiB;65 MiB +; MiB;; MiB; MiB +_ +\-0e;256 KiB;8;4 ;1 +\-1e;1 ;8;13 ;2 +\-2e;2 ;8;25 ;3 +\-3e;4 ;7;48 ;5 +\-4e;4 ;8;48 ;5 +\-5e;8 ;7;94 ;9 +\-6e;8 ;8;94 ;9 +\-7e;16 ;8;186 ;17 +\-8e;32 ;8;370 ;33 +\-9e;64 ;8;674 ;65 .TE .RE .RE @@ -838,10 +850,10 @@ In multi-threaded mode about three times bytes will be allocated in each thread for buffering input and output. The default .I size -is three times the LZMA2 dictionary size or 1 MiB, +is three times the LZMA2 dictionary size or 1\ MiB, whichever is more. -Typically a good value is 2\-4 times -the size of the LZMA2 dictionary or at least 1 MiB. +Typically a good value is 2\(en4 times +the size of the LZMA2 dictionary or at least 1\ MiB. Using .I size less than the LZMA2 dictionary size is waste of RAM @@ -886,7 +898,8 @@ If one specifies .I sizes that exceed the encoder's block size (either the default value in threaded mode or -the value specified with \fB\-\-block\-size=\fIsize\fR), +the value specified with +.BI \-\-block\-size= size \fR), the encoder will create additional blocks while keeping the boundaries specified in .IR sizes . @@ -895,7 +908,7 @@ For example, if one specifies .B \-\-block\-list=5MiB,10MiB,8MiB,12MiB,24MiB and the input file is 80 MiB, one will get 11 blocks: -5, 10, 8, 10, 2, 10, 10, 4, 10, 10, and 1 MiB. +5, 10, 8, 10, 2, 10, 10, 4, 10, 10, and 1\ MiB. .IP "" In multi-threaded mode the sizes of the blocks are stored in the block headers. @@ -967,10 +980,10 @@ The .I limit can be an absolute value in bytes. Using an integer suffix like -.B MiB +.B Mi can be useful. Example: -.B "\-\-memlimit\-compress=80MiB" +.B "\-\-memlimit\-compress=80Mi" .IP \(bu 3 The .I limit @@ -1022,9 +1035,10 @@ See for possible ways to specify the .IR limit . .TP -\fB\-M\fR \fIlimit\fR, \fB\-\-memlimit=\fIlimit\fR, \fB\-\-memory=\fIlimit -This is equivalent to specifying \fB\-\-memlimit\-compress=\fIlimit -\fB\-\-memlimit\-decompress=\fIlimit\fR. +\fB\-M\fR \fIlimit\fR, \fB\-\-memlimit=\fIlimit\fR, \fB\-\-memory=\,\fIlimit +This is equivalent to specifying +.BI \-\-memlimit\-compress= limit +.BI \-\-memlimit\-decompress= limit \fR. .TP .B \-\-no\-adjust Display an error and exit if the compression settings exceed @@ -1034,7 +1048,7 @@ that the memory usage limit is not excee Automatic adjusting is always disabled when creating raw streams .RB ( \-\-format=raw ). .TP -\fB\-T\fR \fIthreads\fR, \fB\-\-threads=\fIthreads +\fB\-T\fR \fIthreads\fR, \fB\-\-threads=\,\fIthreads Specify the number of worker threads to use. Setting .I threads @@ -1052,7 +1066,7 @@ if using more threads would exceed the m Currently the only threading method is to split the input into blocks and compress them independently from each other. The default block size depends on the compression level and -can be overriden with the +can be overridden with the .BI \-\-block\-size= size option. .IP "" @@ -1069,7 +1083,7 @@ A custom filter chain allows specifying the compression settings in detail instead of relying on the settings associated to the presets. When a custom filter chain is specified, -preset options (\fB\-0\fR ... \fB\-9\fR and \fB\-\-extreme\fR) +preset options (\fB\-0\fR\ \&...\&\ \fB\-9\fR and \fB\-\-extreme\fR) earlier on the command line are forgotten. If a preset option is specified after one or more custom filter chain options, @@ -1117,10 +1131,10 @@ use twice). This works also for viewing the filter chain options used by presets. .TP -\fB\-\-lzma1\fR[\fB=\fIoptions\fR] +\fB\-\-lzma1\fR[\fB=\,\fIoptions\/\fR] .PD 0 .TP -\fB\-\-lzma2\fR[\fB=\fIoptions\fR] +\fB\-\-lzma2\fR[\fB=\,\fIoptions\/\fR] .PD Add LZMA1 or LZMA2 filter to the filter chain. These filters can be used only as the last filter in the chain. @@ -1153,7 +1167,8 @@ The integer can be from .B 0 to .BR 9 , -matching the command line options \fB\-0\fR ... \fB\-9\fR. +matching the command line options +.BR \-0 "\ \&...\&\ " \-9 . The only supported modifier is currently .BR e , which matches @@ -1234,7 +1249,7 @@ The literal coding makes an assumption t .I lc bits of the previous uncompressed byte correlate with the next byte. -E.g. in typical English text, an upper-case letter is +E.g., in typical English text, an upper-case letter is often followed by a lower-case letter, and a lower-case letter is usually followed by another lower-case letter. In the US-ASCII character set, the highest three bits are 010 @@ -1275,10 +1290,10 @@ The default means four-byte alignment .RI (2^ pb =2^2=4), which is often a good choice when there's no better guess. .IP "" -When the aligment is known, setting +When the alignment is known, setting .I pb accordingly may reduce the file size a little. -E.g. with text files having one-byte +E.g., with text files having one-byte alignment (US-ASCII, ISO-8859-*, UTF-8), setting .B pb=0 can improve compression slightly. @@ -1306,7 +1321,7 @@ The default depends on the .IR preset : 0 uses .BR hc3 , -1\-3 +1\(en3 use .BR hc4 , and the rest use @@ -1422,11 +1437,11 @@ The default is .B fast for .I presets -0\-3 and +0\(en3 and .B normal for .I presets -4\-9. +4\(en9. .IP "" Usually .B fast @@ -1445,7 +1460,7 @@ bytes is found, the algorithm stops looking for possibly better matches. .IP "" .I Nice -can be 2\-273 bytes. +can be 2\(en273 bytes. Higher values tend to give better compression ratio at the expense of speed. The default depends on the @@ -1463,7 +1478,7 @@ and .IP "" Reasonable .I depth -for Hash Chains is 4\-100 and 16\-1000 for Binary Trees. +for Hash Chains is 4\(en100 and 16\(en1000 for Binary Trees. Using very high values for .I depth can make the encoder extremely slow with some files. @@ -1483,18 +1498,18 @@ LZMA1 needs also and .IR pb . .TP -\fB\-\-x86\fR[\fB=\fIoptions\fR] +\fB\-\-x86\fR[\fB=\,\fIoptions\/\fR] .PD 0 .TP -\fB\-\-powerpc\fR[\fB=\fIoptions\fR] +\fB\-\-powerpc\fR[\fB=\,\fIoptions\/\fR] .TP -\fB\-\-ia64\fR[\fB=\fIoptions\fR] +\fB\-\-ia64\fR[\fB=\,\fIoptions\/\fR] .TP -\fB\-\-arm\fR[\fB=\fIoptions\fR] +\fB\-\-arm\fR[\fB=\,\fIoptions\/\fR] .TP -\fB\-\-armthumb\fR[\fB=\fIoptions\fR] +\fB\-\-armthumb\fR[\fB=\,\fIoptions\/\fR] .TP -\fB\-\-sparc\fR[\fB=\fIoptions\fR] +\fB\-\-sparc\fR[\fB=\,\fIoptions\/\fR] .PD Add a branch/call/jump (BCJ) filter to the filter chain. These filters can be used only as a non-last filter @@ -1504,7 +1519,7 @@ A BCJ filter converts relative addresses the machine code to their absolute counterparts. This doesn't change the size of the data, but it increases redundancy, -which can help LZMA2 to produce 0\-15\ % smaller +which can help LZMA2 to produce 0\(en15\ % smaller .B .xz file. The BCJ filters are always reversible, @@ -1532,7 +1547,7 @@ the compression ratio: .RS .IP \(bu 3 Some types of files containing executable code -(e.g. object files, static libraries, and Linux kernel modules) +(e.g., object files, static libraries, and Linux kernel modules) have the addresses in the instructions filled with filler values. These BCJ filters will still do the address conversion, which will make the compression worse with these files. @@ -1551,7 +1566,7 @@ The old BCJ filters will still be useful because the decoder of the new filter will be bigger and use more memory. .IP "" -Different instruction sets have have different alignment: +Different instruction sets have different alignment: .RS .RS .PP @@ -1600,18 +1615,18 @@ In practice, the default is good; specif is almost never useful. .RE .TP -\fB\-\-delta\fR[\fB=\fIoptions\fR] +\fB\-\-delta\fR[\fB=\,\fIoptions\/\fR] Add the Delta filter to the filter chain. The Delta filter can be only used as a non-last filter in the filter chain. .IP "" Currently only simple byte-wise delta calculation is supported. -It can be useful when compressing e.g. uncompressed bitmap images +It can be useful when compressing e.g., uncompressed bitmap images or uncompressed PCM audio. However, special purpose algorithms may give significantly better results than Delta + LZMA2. This is true especially with audio, -which compresses faster and better e.g. with +which compresses faster and better e.g.\& with .BR flac (1). .IP "" Supported @@ -1623,7 +1638,7 @@ Specify the .I distance of the delta calculation in bytes. .I distance -must be 1\-256. +must be 1\(en256. The default is 1. .IP "" For example, with @@ -1682,7 +1697,7 @@ known and a couple of seconds have alrea .B xz started processing the file. The time is shown in a less precise format which -never has any colons, e.g. 2 min 30 s. +never has any colons, e.g.\& 2 min 30 s. .RE .IP "" When standard error is not a terminal, @@ -1695,7 +1710,7 @@ on a single line to standard error after decompressing the file. The speed and elapsed time are included only when the operation took at least a few seconds. -If the operation didn't finish, e.g. due to user interruption, +If the operation didn't finish, e.g., due to user interruption, also the completion percentage is printed if the size of the input file is known. .TP @@ -1721,7 +1736,7 @@ See the section .B "ROBOT MODE" for details. .TP -.BR \-\-info\-memory +.B \-\-info\-memory Display, in human-readable format, how much physical memory (RAM) .B xz thinks the system has and the memory usage limits for compression @@ -1788,7 +1803,7 @@ just a counter for development releases. Stability. 0 is alpha, 1 is beta, and 2 is stable. .I S -should be always 2 when +should always be 2 when .I YYY is even. .PP @@ -1898,7 +1913,7 @@ Compressed size of the file Uncompressed size of the file .IP 6. 4 Compression ratio, for example -.BR 0.123. +.BR 0.123 . If ratio is over 9.999, three dashes .RB ( \-\-\- ) are displayed instead of the ratio. @@ -2149,9 +2164,9 @@ This is for passing options to when it is not possible to set the options directly on the .B xz command line. -This is the case e.g. when +This is the case e.g., when .B xz -is run by a script or tool, e.g. GNU +is run by a script or tool, e.g.\& GNU .BR tar (1): .RS .RS @@ -2166,10 +2181,10 @@ XZ_OPT=\-2v tar caf foo.tar.xz foo .IP "" Scripts may use .B XZ_OPT -e.g. to set script-specific default compression options. +e.g., to set script-specific default compression options. It is still recommended to allow users to override .B XZ_OPT -if that is reasonable, e.g. in +if that is reasonable, e.g.\& in .BR sh (1) scripts one may use something like this: .RS @@ -2191,7 +2206,7 @@ is practically a superset of .BR lzma , .BR unlzma , and -.BR lzcat +.B lzcat as found from LZMA Utils 4.32.x. In most cases, it is possible to replace LZMA Utils with XZ Utils without breaking existing scripts. @@ -2210,18 +2225,21 @@ Dictionary size is roughly equal to the .TS tab(;); c c c +c c c c n n. Level;xz;LZMA Utils +; MiB; MiB +_ \-0;256 KiB;N/A -\-1;1 MiB;64 KiB -\-2;2 MiB;1 MiB -\-3;4 MiB;512 KiB -\-4;4 MiB;1 MiB -\-5;8 MiB;2 MiB -\-6;8 MiB;4 MiB -\-7;16 MiB;8 MiB -\-8;32 MiB;16 MiB -\-9;64 MiB;32 MiB +\-1;1 ;64 KiB +\-2;2 ;1 +\-3;4 ;512 KiB +\-4;4 ;1 +\-5;8 ;2 +\-6;8 ;4 +\-7;16 ;8 +\-8;32 ;16 +\-9;64 ;32 .TE .RE .PP @@ -2235,18 +2253,21 @@ make the difference even bigger: .TS tab(;); c c c +c c c c n n. Level;xz;LZMA Utils 4.32.x -\-0;3 MiB;N/A -\-1;9 MiB;2 MiB -\-2;17 MiB;12 MiB -\-3;32 MiB;12 MiB -\-4;48 MiB;16 MiB -\-5;94 MiB;26 MiB -\-6;94 MiB;45 MiB -\-7;186 MiB;83 MiB -\-8;370 MiB;159 MiB -\-9;674 MiB;311 MiB +; MiB; MiB +_ +\-0;3 ;N/A +\-1;9 ;2 +\-2;17 ;12 +\-3;32 ;12 +\-4;48 ;16 +\-5;94 ;26 +\-6;94 ;45 +\-7;186 ;83 +\-8;370 ;159 +\-9;674 ;311 .TE .RE .PP @@ -2254,7 +2275,7 @@ The default preset level in LZMA Utils i .B \-7 while in XZ Utils it is .BR \-6 , -so both use an 8 MiB dictionary by default. +so both use an 8\ MiB dictionary by default. . .SS "Streamed vs. non-streamed .lzma files" The uncompressed size of the file can be stored in the @@ -2461,7 +2482,7 @@ Create with the preset .B \-4e .RB ( "\-4 \-\-extreme" ), -which is slower than e.g. the default +which is slower than e.g., the default .BR \-6 , but needs less memory for compression and decompression (48\ MiB and 5\ MiB, respectively): @@ -2590,7 +2611,7 @@ potentially useful combinations of compr .PP The CompCPU columns of the tables from the descriptions of the options -.BR "\-0" " ... " "\-9" +.BR "\-0" "\ ...\&\ " "\-9" and .B \-\-extreme are useful when customizing LZMA2 presets. @@ -2602,6 +2623,7 @@ tab(;); c c n n. Preset;CompCPU +_ \-0;0 \-1;1 \-2;2 @@ -2615,10 +2637,10 @@ Preset;CompCPU .RE .PP If you know that a file requires -somewhat big dictionary (e.g. 32 MiB) to compress well, +somewhat big dictionary (e.g.\& 32\ MiB) to compress well, but you want to compress it quicker than .B "xz \-8" -would do, a preset with a low CompCPU value (e.g. 1) +would do, a preset with a low CompCPU value (e.g.\& 1) can be modified to use a bigger dictionary: .RS .PP @@ -2645,7 +2667,7 @@ full advantage of the similarities betwe If very high compressor and decompressor memory usage is fine, and the file being compressed is at least several hundred megabytes, it may be useful -to use an even bigger dictionary than the 64 MiB that +to use an even bigger dictionary than the 64\ MiB that .B "xz \-9" would use: .RS @@ -2669,7 +2691,7 @@ so the above command isn't useful for sm .PP Sometimes the compression time doesn't matter, but the decompressor memory usage has to be kept low -e.g. to make it possible to decompress the file on +e.g., to make it possible to decompress the file on an embedded system. The following command uses .B \-6e @@ -2701,7 +2723,7 @@ might help too, but usually and .I pb are more important. -E.g. a source code archive contains mostly US-ASCII text, +E.g., a source code archive contains mostly US-ASCII text, so something like the following might give slightly (like 0.1\ %) smaller file than .B "xz \-6e" @@ -2718,7 +2740,7 @@ xz \-\-lzma2=preset=6e,pb=0,lc=4 source_ .PP Using another filter together with LZMA2 can improve compression with certain file types. -E.g. to compress a x86-32 or x86-64 shared library +E.g., to compress a x86-32 or x86-64 shared library using the x86 BCJ filter: .RS .PP @@ -2747,10 +2769,10 @@ which has a few more advanced filters th delta but uses Deflate for the actual compression. .PP The image has to be saved in uncompressed format, -e.g. as uncompressed TIFF. +e.g., as uncompressed TIFF. The distance parameter of the Delta filter is set to match the number of bytes per pixel in the image. -E.g. 24-bit RGB bitmap needs +E.g.\& a 24-bit RGB bitmap needs .BR dist=3 , and it is also good to pass .B pb=0
