summaryrefslogtreecommitdiffstats
path: root/doc/lziprecover.1
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--doc/lziprecover.163
1 files changed, 40 insertions, 23 deletions
diff --git a/doc/lziprecover.1 b/doc/lziprecover.1
index 1f26b81..bb39f36 100644
--- a/doc/lziprecover.1
+++ b/doc/lziprecover.1
@@ -1,5 +1,5 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.2.
-.TH LZIPRECOVER "1" "June 2023" "lziprecover 1.24-pre1" "User Commands"
+.TH LZIPRECOVER "1" "October 2024" "lziprecover 1.25-pre1" "User Commands"
.SH NAME
lziprecover \- recovers data from damaged lzip files
.SH SYNOPSIS
@@ -7,11 +7,8 @@ lziprecover \- recovers data from damaged lzip files
[\fI\,options\/\fR] [\fI\,files\/\fR]
.SH DESCRIPTION
Lziprecover is a data recovery tool and decompressor for files in the lzip
-compressed data format (.lz). Lziprecover is able to repair slightly damaged
-files (up to one single\-byte error per member), produce a correct file by
-merging the good parts of two or more damaged copies, reproduce a missing
-(zeroed) sector using a reference file, extract data from damaged files,
-decompress files, and test integrity of files.
+compressed data format (.lz). Lziprecover also provides Forward Error
+Correction (FEC) able to repair any kind of file.
.PP
With the help of lziprecover, losing an entire archive just because of a
corrupt byte near the beginning is a thing of the past.
@@ -22,9 +19,6 @@ example multimember tar.lz archives.
Lziprecover provides random access to the data in multimember files; it only
decompresses the members containing the desired data.
.PP
-Lziprecover facilitates the management of metadata stored as trailing data
-in lzip files.
-.PP
Lziprecover is not a replacement for regular backups, but a last line of
defense for the case where the backups are also damaged.
.SH OPTIONS
@@ -41,6 +35,12 @@ exit with error status if trailing data
\fB\-A\fR, \fB\-\-alone\-to\-lz\fR
convert lzma\-alone files to lzip format
.TP
+\fB\-b\fR, \fB\-\-block\-size=\fR<bytes>
+make FEC block size a multiple of <bytes>
+.TP
+\fB\-B\fR, \fB\-\-byte\-repair\fR
+try to repair a corrupt byte in file
+.TP
\fB\-c\fR, \fB\-\-stdout\fR
write to standard output, keep input files
.TP
@@ -65,8 +65,17 @@ reference file for \fB\-\-reproduce\fR
\fB\-f\fR, \fB\-\-force\fR
overwrite existing output files
.TP
+\fB\-F\fR, \fB\-\-fec\fR=\fI\,c[N]\/\fR|r|t|l
+create, repair, test, list (using) fec file
+.TP
+\fB\-0\fR .. \fB\-9\fR
+set FEC fragmentation level [default 9]
+.TP
+\fB\-\-fec\-file=\fR<file>[/]
+read fec file from <file> or directory
+.TP
\fB\-i\fR, \fB\-\-ignore\-errors\fR
-ignore some errors in \fB\-d\fR, \fB\-D\fR, \fB\-l\fR, \fB\-t\fR, \fB\-\-dump\fR
+ignore non\-fatal errors
.TP
\fB\-k\fR, \fB\-\-keep\fR
keep (don't delete) input files
@@ -75,16 +84,22 @@ keep (don't delete) input files
print (un)compressed file sizes
.TP
\fB\-m\fR, \fB\-\-merge\fR
-correct errors in file using several copies
+repair errors in file using several copies
+.TP
+\fB\-n\fR, \fB\-\-threads=\fR<n>
+set number of threads for fec create [2]
.TP
-\fB\-o\fR, \fB\-\-output=\fR<file>
-place the output into <file>
+\fB\-o\fR, \fB\-\-output=\fR<file>[/]
+place the output into <file> or directory
.TP
\fB\-q\fR, \fB\-\-quiet\fR
suppress all messages
.TP
-\fB\-R\fR, \fB\-\-byte\-repair\fR
-try to repair a corrupt byte in file
+\fB\-r\fR, \fB\-\-recursive\fR
+(fec) operate recursively on directories
+.TP
+\fB\-R\fR, \fB\-\-dereference\-recursive\fR
+(fec) recursively follow symbolic links
.TP
\fB\-s\fR, \fB\-\-split\fR
split multimember file in single\-member files
@@ -104,28 +119,30 @@ remove members, tdata from files in place
\fB\-\-strip=\fR<list>:d:e:t
copy files to stdout stripping members given
.TP
-\fB\-\-empty\-error\fR
-exit with error status if empty member in file
+\fB\-\-ignore\-empty\fR
+ignore empty members in multimember files
.TP
-\fB\-\-marking\-error\fR
-exit with error status if 1st LZMA byte not 0
+\fB\-\-ignore\-nonzero\fR
+ignore a nonzero first LZMA byte
.TP
\fB\-\-loose\-trailing\fR
allow trailing data seeming corrupt header
.TP
-\fB\-\-clear\-marking\fR
-reset the first LZMA byte of each member
+\fB\-\-nonzero\-repair\fR
+repair in place a nonzero first LZMA byte
.PP
If no file names are given, or if a file is '\-', lziprecover decompresses
from standard input to standard output.
Numbers may be followed by a multiplier: k = kB = 10^3 = 1000,
Ki = KiB = 2^10 = 1024, M = 10^6, Mi = 2^20, G = 10^9, Gi = 2^30, etc...
+The argument to \fB\-\-fec\fR=\fI\,create\/\fR may be a number of blocks (\fB\-Fc20\fR), a
+percentage (\fB\-Fc5\fR%), or a size in bytes (\fB\-Fc10KiB\fR).
.PP
To extract all the files from archive 'foo.tar.lz', use the commands
\&'tar \fB\-xf\fR foo.tar.lz' or 'lziprecover \fB\-cd\fR foo.tar.lz | tar \fB\-xf\fR \-'.
.PP
Exit status: 0 for a normal exit, 1 for environmental problems
-(file not found, invalid command line options, I/O errors, etc), 2 to
+(file not found, invalid command\-line options, I/O errors, etc), 2 to
indicate a corrupt or invalid input file, 3 for an internal consistency
error (e.g., bug) which caused lziprecover to panic.
.SH "REPORTING BUGS"
@@ -133,7 +150,7 @@ Report bugs to lzip\-bug@nongnu.org
.br
Lziprecover home page: http://www.nongnu.org/lzip/lziprecover.html
.SH COPYRIGHT
-Copyright \(co 2023 Antonio Diaz Diaz.
+Copyright \(co 2024 Antonio Diaz Diaz.
License GPLv2+: GNU GPL version 2 or later <http://gnu.org/licenses/gpl.html>
.br
This is free software: you are free to change and redistribute it.