Merging upstream version 1.5~rc1.
Signed-off-by: Daniel Baumann <daniel@debian.org>
This commit is contained in:
parent
d95c5a0612
commit
12490d92a1
13 changed files with 119 additions and 100 deletions
|
@ -12,7 +12,7 @@ File: clzip.info, Node: Top, Next: Introduction, Up: (dir)
|
|||
Clzip Manual
|
||||
************
|
||||
|
||||
This manual is for Clzip (version 1.5-pre2, 17 July 2013).
|
||||
This manual is for Clzip (version 1.5-rc1, 1 August 2013).
|
||||
|
||||
* Menu:
|
||||
|
||||
|
@ -42,10 +42,6 @@ compresses more than bzip2, which makes it well suited for software
|
|||
distribution and data archiving. Clzip is a clean implementation of the
|
||||
LZMA algorithm.
|
||||
|
||||
Clzip uses the same well-defined exit status values used by lzip and
|
||||
bzip2, which makes it safer when used in pipes or scripts than
|
||||
compressors returning ambiguous warning values, like gzip.
|
||||
|
||||
Clzip uses the lzip file format; the files produced by clzip are
|
||||
fully compatible with lzip-1.4 or newer, and can be rescued with
|
||||
lziprecover. Clzip is in fact a C language version of lzip, intended
|
||||
|
@ -70,6 +66,10 @@ lziprecover program. Lziprecover makes lzip files resistant to bit-flip
|
|||
recovery capabilities, including error-checked merging of damaged copies
|
||||
of a file.
|
||||
|
||||
Clzip uses the same well-defined exit status values used by lzip and
|
||||
bzip2, which makes it safer when used in pipes or scripts than
|
||||
compressors returning ambiguous warning values, like gzip.
|
||||
|
||||
Clzip replaces every file given in the command line with a compressed
|
||||
version of itself, with the name "original_name.lz". Each compressed
|
||||
file has the same modification date, permissions, and, when possible,
|
||||
|
@ -95,7 +95,7 @@ multivolume compressed tar archives.
|
|||
|
||||
Clzip is able to compress and decompress streams of unlimited size by
|
||||
automatically creating multi-member output. The members so created are
|
||||
large (about 2^60 bytes each).
|
||||
large, about 64 PiB each.
|
||||
|
||||
The amount of memory required for compression is about 1 or 2 times
|
||||
the dictionary size limit (1 if input file size is less than dictionary
|
||||
|
@ -174,7 +174,7 @@ The ideas embodied in clzip are due to (at least) the following people:
|
|||
Abraham Lempel and Jacob Ziv (for the LZ algorithm), Andrey Markov (for
|
||||
the definition of Markov chains), G.N.N. Martin (for the definition of
|
||||
range encoding), Igor Pavlov (for putting all the above together in
|
||||
LZMA), and Julian Seward (for bzip2's CLI and the idea of unzcrash).
|
||||
LZMA), and Julian Seward (for bzip2's CLI).
|
||||
|
||||
|
||||
File: clzip.info, Node: Invoking clzip, Next: File format, Prev: Algorithm, Up: Top
|
||||
|
@ -198,10 +198,9 @@ The format for running clzip is:
|
|||
|
||||
`-b BYTES'
|
||||
`--member-size=BYTES'
|
||||
Produce a multi-member file and set the member size limit to BYTES.
|
||||
Minimum member size limit is 100kB. Small member size may degrade
|
||||
compression ratio, so use it only when needed. The default is to
|
||||
produce single-member files.
|
||||
Set the member size limit to BYTES. A small member size may
|
||||
degrade compression ratio, so use it only when needed. Valid values
|
||||
range from 100 kB to 64 PiB. Defaults to 64 PiB.
|
||||
|
||||
`-c'
|
||||
`--stdout'
|
||||
|
@ -250,8 +249,8 @@ The format for running clzip is:
|
|||
|
||||
`-s BYTES'
|
||||
`--dictionary-size=BYTES'
|
||||
Set the dictionary size limit in bytes. Valid values range from
|
||||
4KiB to 512MiB. Clzip will use the smallest possible dictionary
|
||||
Set the dictionary size limit in bytes. Valid values range from 4
|
||||
KiB to 512 MiB. Clzip 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
|
||||
|
@ -267,9 +266,9 @@ The format for running clzip is:
|
|||
Split the compressed output into several volume files with names
|
||||
`original_name00001.lz', `original_name00002.lz', etc, and set the
|
||||
volume size limit to BYTES. Each volume is a complete, maybe
|
||||
multi-member, lzip file. Minimum volume size limit is 100kB. Small
|
||||
volume size may degrade compression ratio, so use it only when
|
||||
needed.
|
||||
multi-member, lzip file. A small volume size may degrade
|
||||
compression ratio, so use it only when needed. Valid values range
|
||||
from 100 kB to 4 EiB.
|
||||
|
||||
`-t'
|
||||
`--test'
|
||||
|
@ -296,7 +295,8 @@ The format for running clzip 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
|
||||
|
@ -314,7 +314,6 @@ The format for running clzip is:
|
|||
Aliases for GNU gzip compatibility.
|
||||
|
||||
|
||||
|
||||
Numbers given as arguments to options may be followed by a multiplier
|
||||
and an optional `B' for "byte".
|
||||
|
||||
|
@ -373,7 +372,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
|
||||
|
@ -388,8 +387,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
|
||||
|
@ -430,7 +429,7 @@ and show the compression ratio.
|
|||
|
||||
|
||||
Example 2: Like example 1 but the created `file.lz' is multi-member
|
||||
with a member size of 1MiB. The compression ratio is not shown.
|
||||
with a member size of 1 MiB. The compression ratio is not shown.
|
||||
|
||||
clzip -b 1MiB file
|
||||
|
||||
|
@ -453,7 +452,7 @@ Example 5: Compress a whole floppy in /dev/fd0 and send the output to
|
|||
clzip -c /dev/fd0 > file.lz
|
||||
|
||||
|
||||
Example 6: Decompress `file.lz' partially until 10KiB of decompressed
|
||||
Example 6: Decompress `file.lz' partially until 10 KiB of decompressed
|
||||
data are produced.
|
||||
|
||||
clzip -cd file.lz | dd bs=1024 count=10
|
||||
|
@ -466,7 +465,7 @@ to decompressed byte 15000 (5000 bytes are produced).
|
|||
|
||||
|
||||
Example 8: Create a multivolume compressed tar archive with a volume
|
||||
size of 1440KiB.
|
||||
size of 1440 KiB.
|
||||
|
||||
tar -c some_directory | clzip -S 1440KiB -o volume_name
|
||||
|
||||
|
@ -476,9 +475,9 @@ Example 9: Extract a multivolume compressed tar archive.
|
|||
clzip -cd volume_name*.lz | tar -xf -
|
||||
|
||||
|
||||
Example 10: Create a multivolume compressed backup of a big database
|
||||
file with a volume size of 650MB, where each volume is a multi-member
|
||||
file with a member size of 32MiB.
|
||||
Example 10: Create a multivolume compressed backup of a large database
|
||||
file with a volume size of 650 MB, where each volume is a multi-member
|
||||
file with a member size of 32 MiB.
|
||||
|
||||
clzip -b 32MiB -S 650MB big_db
|
||||
|
||||
|
@ -522,12 +521,12 @@ Concept index
|
|||
Tag Table:
|
||||
Node: Top212
|
||||
Node: Introduction914
|
||||
Node: Algorithm5096
|
||||
Node: Invoking clzip7620
|
||||
Node: File format13179
|
||||
Node: Examples15658
|
||||
Node: Problems17619
|
||||
Node: Concept index18145
|
||||
Node: Algorithm5091
|
||||
Node: Invoking clzip7590
|
||||
Node: File format13187
|
||||
Node: Examples15692
|
||||
Node: Problems17660
|
||||
Node: Concept index18186
|
||||
|
||||
End Tag Table
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue