.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.49.2.
.TH DDRESCUELOG "1" "January 2023" "GNU ddrescuelog 1.27" "User Commands"
.SH NAME
ddrescuelog \- tool for ddrescue mapfiles
.SH SYNOPSIS
.B ddrescuelog
[\fI\,options\/\fR] \fI\,mapfile\/\fR
.SH DESCRIPTION
GNU ddrescuelog is a tool that manipulates ddrescue mapfiles, shows mapfile
contents, converts mapfiles to/from other formats, compares mapfiles, tests
rescue status, and can delete a mapfile if the rescue is done. Ddrescuelog
operations can be restricted to one or several parts of the mapfile if the
domain setting options are used.
.PP
Use a hyphen '\-' as mapfile to read the mapfile from standard input
(also in the options taking a mapfile argument) or to write the mapfile
created by '\-\-create\-mapfile' to standard output.
.PP
NOTE: In versions of ddrescue prior to 1.20 the mapfile was called
\&'logfile'. The format is the same; only the name has changed.
.SH OPTIONS
.TP
\fB\-h\fR, \fB\-\-help\fR
display this help and exit
.TP
\fB\-V\fR, \fB\-\-version\fR
output version information and exit
.TP
\fB\-a\fR, \fB\-\-change\-types=\fR<ot>,<nt>
change the block types of mapfile
.TP
\fB\-A\fR, \fB\-\-annotate\-mapfile\fR
add comments with human\-readable pos/sizes
.TP
\fB\-b\fR, \fB\-\-block\-size=\fR<bytes>
block (sector) size in bytes [default 512]
.TP
\fB\-B\fR, \fB\-\-binary\-prefixes\fR
show binary multipliers in numbers [SI]
.TP
\fB\-c\fR, \fB\-\-create\-mapfile[=\fR<tt>]
create mapfile from list of blocks [+\-]
.TP
\fB\-C\fR, \fB\-\-complete\-mapfile[=\fR<t>]
complete mapfile adding blocks of type t [?]
.TP
\fB\-d\fR, \fB\-\-delete\-if\-done\fR
delete the mapfile if rescue is finished
.TP
\fB\-D\fR, \fB\-\-done\-status\fR
return 0 if rescue is finished
.TP
\fB\-f\fR, \fB\-\-force\fR
overwrite existing output files
.TP
\fB\-F\fR, \fB\-\-format=\fR<name>
format for \fB\-c\fR and \fB\-l\fR (list, bitmap\-[bl]e)
.TP
\fB\-i\fR, \fB\-\-input\-position=\fR<bytes>
starting position of rescue domain [0]
.TP
\fB\-l\fR, \fB\-\-list\-blocks=\fR<types>
print block numbers of given types (?*/\-+)
.TP
\fB\-L\fR, \fB\-\-loose\-domain\fR
accept unordered domain mapfile with gaps
.TP
\fB\-m\fR, \fB\-\-domain\-mapfile=\fR<file>
restrict domain to finished blocks in <file>
.TP
\fB\-n\fR, \fB\-\-invert\-mapfile\fR
invert block types (finished <\-\-> others)
.TP
\fB\-o\fR, \fB\-\-output\-position=\fR<bytes>
starting position in output file [ipos]
.TP
\fB\-p\fR, \fB\-\-compare\-mapfile=\fR<file>
compare block types in domain of both files
.TP
\fB\-P\fR, \fB\-\-compare\-as\-domain=\fR<file>
like \fB\-p\fR but compare finished blocks only
.TP
\fB\-q\fR, \fB\-\-quiet\fR
suppress all messages
.TP
\fB\-s\fR, \fB\-\-size=\fR<bytes>
maximum size of rescue domain to be processed
.TP
\fB\-t\fR, \fB\-\-show\-status\fR
show a summary of mapfile contents
.TP
\fB\-v\fR, \fB\-\-verbose\fR
be verbose (a 2nd \fB\-v\fR gives more)
.TP
\fB\-x\fR, \fB\-\-xor\-mapfile=\fR<file>
XOR the finished blocks in file with mapfile
.TP
\fB\-y\fR, \fB\-\-and\-mapfile=\fR<file>
AND the finished blocks in file with mapfile
.TP
\fB\-z\fR, \fB\-\-or\-mapfile=\fR<file>
OR the finished blocks in file with mapfile
.TP
\fB\-\-shift\fR
shift all block positions by (opos \- ipos)
.PP
Numbers may be in decimal, hexadecimal, or octal, and may be followed by a
multiplier: s = sectors, k = 1000, Ki = 1024, M = 10^6, Mi = 2^20, etc...
.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
indicate a corrupt or invalid input file, 3 for an internal consistency
error (e.g., bug) which caused ddrescuelog to panic.
.SH "REPORTING BUGS"
Report bugs to bug\-ddrescue@gnu.org
.br
Ddrescue home page: http://www.gnu.org/software/ddrescue/ddrescue.html
.br
General help using GNU software: http://www.gnu.org/gethelp
.SH COPYRIGHT
Copyright \(co 2023 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.
There is NO WARRANTY, to the extent permitted by law.
.SH "SEE ALSO"
The full documentation for
.B ddrescuelog
is maintained as a Texinfo manual.  If the
.B info
and
.B ddrescuelog
programs are properly installed at your site, the command
.IP
.B info ddrescue
.PP
should give you access to the complete manual.