diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/plzip.1 | 8 | ||||
| -rw-r--r-- | doc/plzip.info | 84 | ||||
| -rw-r--r-- | doc/plzip.texinfo | 106 |
3 files changed, 106 insertions, 92 deletions
diff --git a/doc/plzip.1 b/doc/plzip.1 index bad484c..5fe6e3b 100644 --- a/doc/plzip.1 +++ b/doc/plzip.1 @@ -1,7 +1,7 @@ .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.37.1. -.TH PLZIP "1" "March 2010" "Plzip 0.6" "User Commands" +.TH PLZIP "1" "December 2010" "Plzip 0.7" "User Commands" .SH NAME -Plzip \- data compressor based on the LZMA algorithm +Plzip \- reduces the size of files .SH SYNOPSIS .B plzip [\fIoptions\fR] [\fIfiles\fR] @@ -31,7 +31,7 @@ overwrite existing output files keep (don't delete) input files .TP \fB\-m\fR, \fB\-\-match\-length=\fR<n> -set match length limit in bytes [80] +set match length limit in bytes [36] .TP \fB\-n\fR, \fB\-\-threads=\fR<n> set the number of (de)compression threads @@ -72,7 +72,7 @@ Plzip home page: http://www.nongnu.org/lzip/plzip.html Copyright \(co 2009 Laszlo Ersek. .br Copyright \(co 2010 Antonio Diaz Diaz. -Using Lzlib 1.0\-rc1 +Using Lzlib 1.1\-rc1 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 037a286..22f0052 100644 --- a/doc/plzip.info +++ b/doc/plzip.info @@ -12,16 +12,16 @@ File: plzip.info, Node: Top, Next: Introduction, Up: (dir) Plzip Manual ************ -This manual is for Plzip (version 0.6, 20 March 2010). +This manual is for Plzip (version 0.7, 3 December 2010). * Menu: -* Introduction:: Purpose and features of plzip -* Invoking Plzip:: Command line interface -* Program Design:: Internal structure of plzip -* File Format:: Detailed format of the compressed file -* Problems:: Reporting bugs -* Concept Index:: Index of concepts +* Introduction:: Purpose and features of plzip +* Invoking Plzip:: Command line interface +* Program Design:: Internal structure of plzip +* File Format:: Detailed format of the compressed file +* Problems:: Reporting bugs +* Concept Index:: Index of concepts Copyright (C) 2009, 2010 Antonio Diaz Diaz. @@ -36,10 +36,10 @@ File: plzip.info, Node: Introduction, Next: Invoking Plzip, Prev: Top, Up: T ************** Plzip is a massively parallel (multi-threaded), lossless data compressor -based on the LZMA algorithm, with very safe integrity checking and a -user interface similar to the one of gzip or bzip2. Plzip uses the lzip -file format; the files produced by plzip are fully compatible with -lzip-1.4 or newer. +based on the lzlib compression library, with very safe integrity +checking and a user interface similar to the one of bzip2, gzip or lzip. +Plzip uses the lzip file format; the files produced by plzip are fully +compatible with lzip-1.4 or newer. Plzip is intended for faster compression/decompression of big files on multiprocessor machines, which makes it specially well suited for @@ -98,80 +98,80 @@ The format for running plzip is: Plzip supports the following options: -`--help' `-h' +`--help' Print an informative help message describing the options and exit. -`--version' `-V' +`--version' Print the version number of plzip on the standard output and exit. -`--data-size=SIZE' `-B' +`--data-size=SIZE' 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. -`--stdout' `-c' +`--stdout' Compress or decompress to standard output. Needed when reading from a named pipe (fifo) or from a device. -`--decompress' `-d' +`--decompress' Decompress. -`--force' `-f' +`--force' Force overwrite of output file. -`--keep' `-k' +`--keep' Keep (don't delete) input files during compression or decompression. -`--match-length=LENGTH' `-m LENGTH' +`--match-length=LENGTH' Set the match length limit in bytes. Valid values range from 5 to 273. Larger values usually give better compression ratios but longer compression times. -`--threads=THREADS' `-n THREADS' +`--threads=THREADS' Set the number of worker threads. Valid values range from 1 to "as many as your system can support". If this option is not used, plzip tries to detect the number of processors in the system and use it as default value. -`--output=FILE' `-o FILE' +`--output=FILE' When reading from standard input and `--stdout' has not been specified, use `FILE' as the virtual name of the uncompressed file. This produces a file named `FILE' when decompressing, and a file named `FILE.lz' when compressing. -`--quiet' `-q' +`--quiet' Quiet operation. Suppress all messages. -`--dictionary-size=SIZE' `-s SIZE' +`--dictionary-size=SIZE' Set the dictionary size limit in bytes. Valid values range from 4KiB to 512MiB. Note that dictionary sizes are quantized. If the specified size does not match one of the valid sizes, it will be rounded upwards. -`--test' `-t' +`--test' Check integrity of the specified file(s), but don't decompress them. This really performs a trial decompression and throws away the result. Use `-tvv' or `-tvvv' to see information about the file. -`--verbose' `-v' +`--verbose' Verbose mode. Show the compression ratio for each file processed. Further -v's increase the verbosity level. @@ -180,15 +180,21 @@ The format for running plzip is: limit) as shown in the table below. Note that `-9' can be much slower than `-1'. These options have no effect when decompressing. + 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 `--match-length' and + `--dictionary-size' options directly to achieve optimal + performance. + Level Dictionary size Match length limit - -1 1 MiB 10 bytes - -2 1.5 MiB 12 bytes - -3 2 MiB 17 bytes - -4 3 MiB 26 bytes - -5 4 MiB 44 bytes - -6 8 MiB 80 bytes - -7 16 MiB 108 bytes - -8 24 MiB 163 bytes + -1 1 MiB 5 bytes + -2 1.5 MiB 6 bytes + -3 2 MiB 8 bytes + -4 3 MiB 12 bytes + -5 4 MiB 20 bytes + -6 8 MiB 36 bytes + -7 16 MiB 68 bytes + -8 24 MiB 132 bytes -9 32 MiB 273 bytes `--fast' @@ -328,11 +334,11 @@ Concept Index Tag Table: Node: Top223 -Node: Introduction791 -Node: Invoking Plzip3533 -Node: Program Design7499 -Node: File Format8161 -Node: Problems10117 -Node: Concept Index10646 +Node: Introduction833 +Node: Invoking Plzip3592 +Node: Program Design7840 +Node: File Format8502 +Node: Problems10458 +Node: Concept Index10987 End Tag Table diff --git a/doc/plzip.texinfo b/doc/plzip.texinfo index 8867c7f..517dc11 100644 --- a/doc/plzip.texinfo +++ b/doc/plzip.texinfo @@ -5,8 +5,8 @@ @finalout @c %**end of header -@set UPDATED 20 March 2010 -@set VERSION 0.6 +@set UPDATED 3 December 2010 +@set VERSION 0.7 @dircategory Data Compression @direntry @@ -14,9 +14,10 @@ @end direntry +@ifnothtml @titlepage @title Plzip -@subtitle A data compressor based on the LZMA algorithm +@subtitle Parallel compressor compatible with lzip @subtitle for Plzip version @value{VERSION}, @value{UPDATED} @author by Antonio Diaz Diaz @@ -25,6 +26,7 @@ @end titlepage @contents +@end ifnothtml @node Top @top @@ -32,12 +34,12 @@ This manual is for Plzip (version @value{VERSION}, @value{UPDATED}). @menu -* Introduction:: Purpose and features of plzip -* Invoking Plzip:: Command line interface -* Program Design:: Internal structure of plzip -* File Format:: Detailed format of the compressed file -* Problems:: Reporting bugs -* Concept Index:: Index of concepts +* Introduction:: Purpose and features of plzip +* Invoking Plzip:: Command line interface +* Program Design:: Internal structure of plzip +* File Format:: Detailed format of the compressed file +* Problems:: Reporting bugs +* Concept Index:: Index of concepts @end menu @sp 1 @@ -52,10 +54,10 @@ to copy, distribute and modify it. @cindex introduction Plzip is a massively parallel (multi-threaded), lossless data compressor -based on the LZMA algorithm, with very safe integrity checking and a -user interface similar to the one of gzip or bzip2. Plzip uses the lzip -file format; the files produced by plzip are fully compatible with -lzip-1.4 or newer. +based on the lzlib compression library, with very safe integrity +checking and a user interface similar to the one of bzip2, gzip or lzip. +Plzip uses the lzip file format; the files produced by plzip are fully +compatible with lzip-1.4 or newer. Plzip is intended for faster compression/decompression of big files on multiprocessor machines, which makes it specially well suited for @@ -121,77 +123,77 @@ plzip [@var{options}] [@var{files}] Plzip supports the following options: @table @samp -@item --help -@itemx -h +@item -h +@itemx --help Print an informative help message describing the options and exit. -@item --version -@itemx -V +@item -V +@itemx --version Print the version number of plzip on the standard output and exit. -@item --data-size=@var{size} -@itemx -B +@item -B +@itemx --data-size=@var{size} 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. -@item --stdout -@itemx -c +@item -c +@itemx --stdout Compress or decompress to standard output. Needed when reading from a named pipe (fifo) or from a device. -@item --decompress -@itemx -d +@item -d +@itemx --decompress Decompress. -@item --force -@itemx -f +@item -f +@itemx --force Force overwrite of output file. -@item --keep -@itemx -k +@item -k +@itemx --keep Keep (don't delete) input files during compression or decompression. -@item --match-length=@var{length} -@itemx -m @var{length} +@item -m @var{length} +@itemx --match-length=@var{length} Set the match length limit in bytes. Valid values range from 5 to 273. Larger values usually give better compression ratios but longer compression times. -@item --threads=@var{threads} -@itemx -n @var{threads} +@item -n @var{threads} +@itemx --threads=@var{threads} Set the number of worker threads. Valid values range from 1 to "as many as your system can support". If this option is not used, plzip tries to detect the number of processors in the system and use it as default value. -@item --output=@var{file} -@itemx -o @var{file} +@item -o @var{file} +@itemx --output=@var{file} When reading from standard input and @samp{--stdout} has not been specified, use @samp{@var{file}} as the virtual name of the uncompressed file. This produces a file named @samp{@var{file}} when decompressing, and a file named @samp{@var{file}.lz} when compressing. -@item --quiet -@itemx -q +@item -q +@itemx --quiet Quiet operation. Suppress all messages. -@item --dictionary-size=@var{size} -@itemx -s @var{size} +@item -s @var{size} +@itemx --dictionary-size=@var{size} Set the dictionary size limit in bytes. Valid values range from 4KiB to 512MiB. Note that dictionary sizes are quantized. If the specified size does not match one of the valid sizes, it will be rounded upwards. -@item --test -@itemx -t +@item -t +@itemx --test Check integrity of the specified file(s), but don't decompress them. This really performs a trial decompression and throws away the result. Use @samp{-tvv} or @samp{-tvvv} to see information about the file. -@item --verbose -@itemx -v +@item -v +@itemx --verbose Verbose mode. Show the compression ratio for each file processed. Further -v's increase the verbosity level. @@ -200,16 +202,22 @@ Set the compression parameters (dictionary size and match length limit) as shown in the table below. Note that @samp{-9} can be much slower than @samp{-1}. These options have no effect when decompressing. +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. + @multitable {Level} {Dictionary size} {Match length limit} @item Level @tab Dictionary size @tab Match length limit -@item -1 @tab 1 MiB @tab 10 bytes -@item -2 @tab 1.5 MiB @tab 12 bytes -@item -3 @tab 2 MiB @tab 17 bytes -@item -4 @tab 3 MiB @tab 26 bytes -@item -5 @tab 4 MiB @tab 44 bytes -@item -6 @tab 8 MiB @tab 80 bytes -@item -7 @tab 16 MiB @tab 108 bytes -@item -8 @tab 24 MiB @tab 163 bytes +@item -1 @tab 1 MiB @tab 5 bytes +@item -2 @tab 1.5 MiB @tab 6 bytes +@item -3 @tab 2 MiB @tab 8 bytes +@item -4 @tab 3 MiB @tab 12 bytes +@item -5 @tab 4 MiB @tab 20 bytes +@item -6 @tab 8 MiB @tab 36 bytes +@item -7 @tab 16 MiB @tab 68 bytes +@item -8 @tab 24 MiB @tab 132 bytes @item -9 @tab 32 MiB @tab 273 bytes @end multitable |