diff options
Diffstat (limited to '')
| -rw-r--r-- | doc/plzip.1 | 9 | ||||
| -rw-r--r-- | doc/plzip.info | 28 | ||||
| -rw-r--r-- | doc/plzip.texinfo | 27 |
3 files changed, 33 insertions, 31 deletions
diff --git a/doc/plzip.1 b/doc/plzip.1 index 781baf9..291a67f 100644 --- a/doc/plzip.1 +++ b/doc/plzip.1 @@ -1,5 +1,5 @@ .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.37.1. -.TH PLZIP "1" "July 2013" "Plzip 1.1-pre1" "User Commands" +.TH PLZIP "1" "September 2013" "Plzip 1.1" "User Commands" .SH NAME Plzip \- reduces the size of files .SH SYNOPSIS @@ -46,7 +46,7 @@ if reading stdin, place the output into <file> suppress all messages .TP \fB\-s\fR, \fB\-\-dictionary\-size=\fR<bytes> -set dictionary size limit in bytes [8MiB] +set dictionary size limit in bytes [8 MiB] .TP \fB\-t\fR, \fB\-\-test\fR test compressed file integrity @@ -70,7 +70,8 @@ Ki = KiB = 2^10 = 1024, M = 10^6, Mi = 2^20, G = 10^9, Gi = 2^30, etc... The bidimensional parameter space of LZMA can't be mapped to a linear scale optimal for all files. If your files are large, very repetitive, etc, you may need to use the \fB\-\-match\-length\fR and \fB\-\-dictionary\-size\fR -options directly to achieve optimal performance. +options directly to achieve optimal performance. For example, \fB\-9m64\fR +usually compresses executables more (and faster) than \fB\-9\fR. .PP Exit status: 0 for a normal exit, 1 for environmental problems (file not found, invalid flags, I/O errors, etc), 2 to indicate a corrupt or @@ -84,7 +85,7 @@ Plzip home page: http://www.nongnu.org/lzip/plzip.html Copyright \(co 2009 Laszlo Ersek. .br Copyright \(co 2013 Antonio Diaz Diaz. -Using Lzlib 1.4 +Using Lzlib 1.5 License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html> .br This is free software: you are free to change and redistribute it. diff --git a/doc/plzip.info b/doc/plzip.info index 72e9511..7461e06 100644 --- a/doc/plzip.info +++ b/doc/plzip.info @@ -12,7 +12,7 @@ File: plzip.info, Node: Top, Next: Introduction, Up: (dir) Plzip Manual ************ -This manual is for Plzip (version 1.1-pre1, 20 July 2013). +This manual is for Plzip (version 1.1, 17 September 2013). * Menu: @@ -149,8 +149,8 @@ The format for running plzip is: `--data-size=BYTES' Set the input data block size in bytes. The input file will be divided in chunks of this size before compression is performed. - Valid values range from 8KiB to 1GiB. Default value is two times - the dictionary size. Plzip will reduce the dictionary size if it + Valid values range from 8 KiB to 1 GiB. Default value is two times + the dictionary size. Plzip will reduce the dictionary size if it is larger than the chosen data size. `-c' @@ -204,8 +204,8 @@ The format for running plzip is: `-s BYTES' `--dictionary-size=BYTES' - Set the dictionary size limit in bytes. Valid values range from - 4KiB to 512MiB. Plzip will use the smallest possible dictionary + Set the dictionary size limit in bytes. Valid values range from 4 + KiB to 512 MiB. Plzip will use the smallest possible dictionary size for each member without exceeding this limit. Note that dictionary sizes are quantized. If the specified size does not match one of the valid sizes, it will be rounded upwards by adding @@ -241,7 +241,8 @@ The format for running plzip is: linear scale optimal for all files. If your files are large, very repetitive, etc, you may need to use the `--match-length' and `--dictionary-size' options directly to achieve optimal - performance. + performance. For example, `-9m64' usually compresses executables + more (and faster) than `-9'. Level Dictionary size Match length limit -1 1 MiB 5 bytes @@ -259,7 +260,6 @@ The format for running plzip is: Aliases for GNU gzip compatibility. - Numbers given as arguments to options may be followed by a multiplier and an optional `B' for "byte". @@ -318,7 +318,7 @@ additional information before, between, or after them. `ID string' A four byte string, identifying the lzip format, with the value - "LZIP". + "LZIP" (0x4C, 0x5A, 0x49, 0x50). `VN (version number, 1 byte)' Just in case something needs to be modified in the future. 1 for @@ -333,8 +333,8 @@ additional information before, between, or after them. Bits 4-0 contain the base 2 logarithm of the base size (12 to 29). Bits 7-5 contain the number of wedges (0 to 7) to substract from the base size to obtain the dictionary size. - Example: 0xD3 = (2^19 - 6 * 2^15) = (512KiB - 6 * 32KiB) = 320KiB - Valid values for dictionary size range from 4KiB to 512MiB. + Example: 0xD3 = 2^19 - 6 * 2^15 = 512 KiB - 6 * 32 KiB = 320 KiB + Valid values for dictionary size range from 4 KiB to 512 MiB. `Lzma stream' The lzma stream, finished by an end of stream marker. Uses default @@ -357,7 +357,7 @@ additional information before, between, or after them. File: plzip.info, Node: Problems, Next: Concept index, Prev: File format, Up: Top -5 Reporting Bugs +5 Reporting bugs **************** There are probably bugs in plzip. There are certainly errors and @@ -395,9 +395,9 @@ Node: Top223 Node: Introduction871 Node: Program design4426 Node: Invoking plzip5480 -Node: File format10776 -Node: Problems13255 -Node: Concept index13784 +Node: File format10864 +Node: Problems13369 +Node: Concept index13898 End Tag Table diff --git a/doc/plzip.texinfo b/doc/plzip.texinfo index c3b0613..0370677 100644 --- a/doc/plzip.texinfo +++ b/doc/plzip.texinfo @@ -6,8 +6,8 @@ @finalout @c %**end of header -@set UPDATED 20 July 2013 -@set VERSION 1.1-pre1 +@set UPDATED 17 September 2013 +@set VERSION 1.1 @dircategory Data Compression @direntry @@ -173,9 +173,9 @@ Print the version number of plzip on the standard output and exit. @itemx --data-size=@var{bytes} Set the input data block size in bytes. The input file will be divided in chunks of this size before compression is performed. Valid values -range from 8KiB to 1GiB. Default value is two times the dictionary size. -Plzip will reduce the dictionary size if it is larger than the chosen -data size. +range from 8 KiB to 1 GiB. Default value is two times the dictionary +size. Plzip will reduce the dictionary size if it is larger than the +chosen data size. @item -c @itemx --stdout @@ -225,8 +225,8 @@ Quiet operation. Suppress all messages. @item -s @var{bytes} @itemx --dictionary-size=@var{bytes} -Set the dictionary size limit in bytes. Valid values range from 4KiB to -512MiB. Plzip will use the smallest possible dictionary size for each +Set the dictionary size limit in bytes. Valid values range from 4 KiB to +512 MiB. Plzip will use the smallest possible dictionary size for each member without exceeding this limit. Note that dictionary sizes are quantized. If the specified size does not match one of the valid sizes, it will be rounded upwards by adding up to (@var{bytes} / 16) to it. @@ -259,7 +259,8 @@ The bidimensional parameter space of LZMA can't be mapped to a linear scale optimal for all files. If your files are large, very repetitive, etc, you may need to use the @samp{--match-length} and @samp{--dictionary-size} options directly to achieve optimal -performance. +performance. For example, @samp{-9m64} usually compresses executables +more (and faster) than @samp{-9}. @multitable {Level} {Dictionary size} {Match length limit} @item Level @tab Dictionary size @tab Match length limit @@ -280,7 +281,6 @@ Aliases for GNU gzip compatibility. @end table -@sp 1 Numbers given as arguments to options may be followed by a multiplier and an optional @samp{B} for "byte". @@ -346,7 +346,8 @@ All multibyte values are stored in little endian order. @table @samp @item ID string -A four byte string, identifying the lzip format, with the value "LZIP". +A four byte string, identifying the lzip format, with the value "LZIP" +(0x4C, 0x5A, 0x49, 0x50). @item VN (version number, 1 byte) Just in case something needs to be modified in the future. 1 for now. @@ -359,8 +360,8 @@ wedges between 0 and 7. The size of a wedge is (base_size / 16).@* Bits 4-0 contain the base 2 logarithm of the base size (12 to 29).@* Bits 7-5 contain the number of wedges (0 to 7) to substract from the base size to obtain the dictionary size.@* -Example: 0xD3 = (2^19 - 6 * 2^15) = (512KiB - 6 * 32KiB) = 320KiB@* -Valid values for dictionary size range from 4KiB to 512MiB. +Example: 0xD3 = 2^19 - 6 * 2^15 = 512 KiB - 6 * 32 KiB = 320 KiB@* +Valid values for dictionary size range from 4 KiB to 512 MiB. @item Lzma stream The lzma stream, finished by an end of stream marker. Uses default values @@ -381,7 +382,7 @@ facilitates safe recovery of undamaged members from multi-member files. @node Problems -@chapter Reporting Bugs +@chapter Reporting bugs @cindex bugs @cindex getting help |