summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/lziprecover.12
-rw-r--r--doc/lziprecover.info60
-rw-r--r--doc/lziprecover.texi45
3 files changed, 64 insertions, 43 deletions
diff --git a/doc/lziprecover.1 b/doc/lziprecover.1
index c2f55d7..09e4872 100644
--- a/doc/lziprecover.1
+++ b/doc/lziprecover.1
@@ -1,5 +1,5 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.46.1.
-.TH LZIPRECOVER "1" "January 2015" "lziprecover 1.17-rc1" "User Commands"
+.TH LZIPRECOVER "1" "April 2015" "lziprecover 1.17-rc2" "User Commands"
.SH NAME
lziprecover \- recovers data from damaged lzip files
.SH SYNOPSIS
diff --git a/doc/lziprecover.info b/doc/lziprecover.info
index 05c1196..883ed7e 100644
--- a/doc/lziprecover.info
+++ b/doc/lziprecover.info
@@ -12,7 +12,7 @@ File: lziprecover.info, Node: Top, Next: Introduction, Up: (dir)
Lziprecover Manual
******************
-This manual is for Lziprecover (version 1.17-rc1, 21 January 2015).
+This manual is for Lziprecover (version 1.17-rc2, 8 April 2015).
* Menu:
@@ -283,10 +283,11 @@ data stream, even if it is just one altered bit, the original data can't
be recovered.
If you used bzip2, and if the file is large enough to contain more
-than one compressed data block (usually larger than 900 kB), and if no
-block is damaged in both files, then the data can be manually recovered
-by splitting the files with bzip2recover, verifying every block and then
-copying the right blocks in the right order in another file.
+than one compressed data block (usually larger than 900 kB
+uncompressed), and if no block is damaged in both files, then the data
+can be manually recovered by splitting the files with bzip2recover,
+verifying every block and then copying the right blocks in the right
+order in another file.
But if you used lzip, the data can be automatically recovered as
long as no byte is damaged in both files.
@@ -429,21 +430,19 @@ additional information before, between, or after them.
now.
'DS (coded dictionary size, 1 byte)'
- Lzip divides the distance between any two powers of 2 into 8
- equally spaced intervals, named "wedges". The dictionary size is
- calculated by taking a power of 2 (the base size) and substracting
- from it a number of wedges between 0 and 7. The size of a wedge is
- (base_size / 16).
+ The dictionary size is calculated by taking a power of 2 (the base
+ size) and substracting from it a fraction between 0/16 and 7/16 of
+ the base size.
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.
+ Bits 7-5 contain the numerator of the fraction (0 to 7) to
+ substract from the base size to obtain the dictionary size.
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
- values for encoder properties. See the lzip manual for a full
- description.
+ values for encoder properties. *Note Stream format: (lzip)Stream
+ format, for a complete description.
'CRC32 (4 bytes)'
CRC of the uncompressed original data.
@@ -493,6 +492,8 @@ are abridged diagnostic messages from lziprecover).
lziprecover -v -R file.lz
Copy of input file repaired successfully.
+ lziprecover -tv file_fixed.lz
+ ok
mv file_fixed.lz file.lz
@@ -518,6 +519,9 @@ error-checked merging of copies (*Note GNU ddrescue manual:
cp /mnt/cdimage/backup.tar.lz rescued2.tar.lz
umount /mnt/cdimage
lziprecover -m -v -o backup.tar.lz rescued1.tar.lz rescued2.tar.lz
+ Input files merged successfully.
+ lziprecover -tv backup.tar.lz
+ ok
Example 8: Recover the first volume of those created with the command
@@ -527,7 +531,9 @@ damaged in the second copy, and member 12 damaged in both copies. The
correct file produced is saved in 'big_db_00001.lz'.
lziprecover -m -v -o big_db_00001.lz big_db1_00001.lz big_db2_00001.lz
- Input files merged successfully
+ Input files merged successfully.
+ lziprecover -tv big_db_00001.lz
+ ok

File: lziprecover.info, Node: Unzcrash, Next: Problems, Prev: Examples, Up: Top
@@ -646,18 +652,18 @@ Concept index

Tag Table:
Node: Top231
-Node: Introduction1216
-Node: Invoking lziprecover4312
-Node: Data safety9745
-Node: Repairing files11661
-Node: Merging files13563
-Node: File names15404
-Node: File format15868
-Node: Examples18375
-Ref: ddrescue-example19576
-Node: Unzcrash20685
-Node: Problems23239
-Node: Concept index23791
+Node: Introduction1213
+Node: Invoking lziprecover4309
+Node: Data safety9742
+Node: Repairing files11671
+Node: Merging files13573
+Node: File names15414
+Node: File format15878
+Node: Examples18282
+Ref: ddrescue-example19528
+Node: Unzcrash20770
+Node: Problems23324
+Node: Concept index23876

End Tag Table
diff --git a/doc/lziprecover.texi b/doc/lziprecover.texi
index 85f0385..2bcaa0a 100644
--- a/doc/lziprecover.texi
+++ b/doc/lziprecover.texi
@@ -6,8 +6,8 @@
@finalout
@c %**end of header
-@set UPDATED 21 January 2015
-@set VERSION 1.17-rc1
+@set UPDATED 8 April 2015
+@set VERSION 1.17-rc2
@dircategory Data Compression
@direntry
@@ -311,10 +311,11 @@ data stream, even if it is just one altered bit, the original data can't
be recovered.
If you used bzip2, and if the file is large enough to contain more than
-one compressed data block (usually larger than 900 kB), and if no block
-is damaged in both files, then the data can be manually recovered by
-splitting the files with bzip2recover, verifying every block and then
-copying the right blocks in the right order in another file.
+one compressed data block (usually larger than 900 kB uncompressed), and
+if no block is damaged in both files, then the data can be manually
+recovered by splitting the files with bzip2recover, verifying every
+block and then copying the right blocks in the right order in another
+file.
But if you used lzip, the data can be automatically recovered as long as
no byte is damaged in both files.
@@ -463,19 +464,26 @@ A four byte string, identifying the lzip format, with the value "LZIP"
Just in case something needs to be modified in the future. 1 for now.
@item DS (coded dictionary size, 1 byte)
-Lzip divides the distance between any two powers of 2 into 8 equally
-spaced intervals, named "wedges". The dictionary size is calculated by
-taking a power of 2 (the base size) and substracting from it a number of
-wedges between 0 and 7. The size of a wedge is (base_size / 16).@*
+The dictionary size is calculated by taking a power of 2 (the base size)
+and substracting from it a fraction between 0/16 and 7/16 of the base
+size.@*
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.@*
+Bits 7-5 contain the numerator of the fraction (0 to 7) to substract
+from the base size to obtain the dictionary size.@*
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
-for encoder properties. See the lzip manual for a full description.
+The lzma stream, finished by an end of stream marker. Uses default
+values for encoder properties.
+@ifnothtml
+@xref{Stream format,,,lzip},
+@end ifnothtml
+@ifhtml
+See
+@uref{http://www.nongnu.org/lzip/manual/lzip_manual.html#Stream-format,,Stream format}
+@end ifhtml
+for a complete description.
@item CRC32 (4 bytes)
CRC of the uncompressed original data.
@@ -538,6 +546,8 @@ lines are abridged diagnostic messages from lziprecover).
@example
lziprecover -v -R file.lz
Copy of input file repaired successfully.
+lziprecover -tv file_fixed.lz
+ ok
mv file_fixed.lz file.lz
@end example
@@ -577,6 +587,9 @@ mount -t iso9660 -o loop,ro cdimage2 /mnt/cdimage
cp /mnt/cdimage/backup.tar.lz rescued2.tar.lz
umount /mnt/cdimage
lziprecover -m -v -o backup.tar.lz rescued1.tar.lz rescued2.tar.lz
+ Input files merged successfully.
+lziprecover -tv backup.tar.lz
+ ok
@end example
@sp 1
@@ -590,7 +603,9 @@ member 12 damaged in both copies. The correct file produced is saved in
@example
lziprecover -m -v -o big_db_00001.lz big_db1_00001.lz big_db2_00001.lz
- Input files merged successfully
+ Input files merged successfully.
+lziprecover -tv big_db_00001.lz
+ ok
@end example