Imported Upstream version 0.72

documentation/dvdisaster.en.1

@@ -0,0 +1,234 @@
+.TH DVDISASTER 1 "2009-07-04" "0.72" "protection for CD/DVD media"
+
+.SH NAME
+DVDISASTER \- data loss/scratch/aging protection for CD/DVD media
+
+.SH SYNOPSIS
+.B dvdisaster
+.RB [\| \-r \||\| \-c \||\| \-f \||\| \-s \||\| \-t \||\| \-u \|]
+.RB [\| \-d
+.IR device \|]
+.RB [\| \-p
+.IR prefix \|]
+.RB [\| \-i
+.IR image \|]
+.RB [\| \-e
+.IR eccfile \|]
+.RB [\| \-\-list \|]
+.RB [\| \-j
+.IR n \|]
+.RB [\| -n
+.IR n% \|]
+.RB [\| -m
+.IR n \|]
+.RB [\| -v \|]
+.RB [\| \-\-adaptive-read \|]
+.RB [\| \-\-auto-suffix \|]
+.RB [\| \-\-cache-size
+.IR n \|]
+.RB [\| \-\-dao \|]
+.RB [\| \-\-eject \|]
+.RB [\| \-\-fill-unreadable
+.IR n \|]
+.RB [\| \-\-ignore-fatal-sense \|]
+.RB [\| \-\-internal-rereads
+.IR n \|]
+.RB [\| \-\-query-size
+.IR n \|]
+.RB [\| \-\-raw-mode
+.IR n \|]
+.RB [\| \-\-read-attempts
+.IR n-m \|]
+.RB [\| \-\-read-medium
+.IR n \|]
+.RB [\| \-\-read-raw \|]
+.RB [\| \-\-speed-warning
+.IR n \|]
+.RB [\| \-\-spinup\-delay
+.IR n \|]
+.RB [\| \-\-split\-files \|]
+
+.SH DESCRIPTION
+.B DVDISASTER
+provides a margin of safety against data loss on CD and DVD media caused by
+scratches or aging media. It creates error correction data which is used to
+recover unreadable sectors if the disc becomes damaged at a later time.
+
+.SH TYPICAL USAGE
+
+.TP
+\fBdvdisaster\fP \fB-d\fP \fI/dev/hdc\fP \fB-s\fP
+Scans the medium in drive \fI/dev/hdc\fP for errors.
+.TP
+\fBdvdisaster\fP \fB-d\fP \fI/dev/hdc\fP \fB-i\fP \fImedium.iso\fP \fB-r\fP
+Reads an image from drive \fI/dev/hdc\fP into the file \fImedium.iso\fP.
+.TP
+\fBdvdisaster\fP \fB-d\fP \fI/dev/hdc\fP \fB-i\fP \fImedium.iso\fP \fB--read-raw\fP \fB-r\fP
+Creates an image as described above. Each sector's integrity is verified
+by using its EDC and L-EC raw data. Only possible for CD media; otherwise
+the \fB--read-raw\fP option is silently ignored.
+.TP
+\fBdvdisaster\fP \fB-d\fP \fI/dev/hdc\fP \fB-i\fP \fImedium.iso\fP \fB--read-attempts\fP \fIn-m\fP \fB-r\fP
+Creates an image as described above. Defective sectors are retried at least \fIn\fP
+times and at most \fIm\fP times. Recovery of defective CD media may improve when
+combined with \fB--read-raw\fI. 
+.TP
+\fBdvdisaster\fP \fB-d\fP \fI/dev/hdc\fP \fB-i\fP \fImedium.iso\fP \fB-e\fP \fIcorr.ecc\fP \fB-r\fP \fB--adaptive-read\fP
+Uses the adaptive reading strategy to read an image from 
+drive \fI/dev/hdc\fP into the file \fImedium.iso\fP.
+Reading will stop when enough data has been
+gathered to repair the image using the error correction file \fIcorr.ecc\fP.
+.TP
+\fBdvdisaster\fP \fB-i\fP \fImedium.iso\fP \fB-e\fP \fIcorr.ecc\fP \fB-c\fP
+Creates an error correction file \fIcorr.ecc\fP for the image \fImedium.iso\fP.
+.TP
+\fBdvdisaster\fP \fB-i\fP \fImedium.iso\fP \fB-m\fIRS02\fP \fB-n\fP \fI350000\fP \fB-c\fP
+Augments the image \fImedium.iso\fP with error correction information,
+expanding the image to no more than \fI350000\fP sectors. If \fB-n\fP is omitted the image
+will be expanded to the smallest possible medium size (CD, DVD, DVD9).
+Note the missing blank between \fB-m\fP and \fIRS02\fP.
+.TP
+\fBdvdisaster\fP \fB-i\fP \fImedium.iso\fP \fB-e\fP \fIcorr.ecc\fP \fB-f\fP
+Repairs the image file \fImedium.iso\fP using the error correction file \fIcorr.ecc\fP.
+.TP
+\fBdvdisaster\fP \fB-i\fP \fImedium.iso\fP \fB-e\fP \fIcorr.ecc\fP \fB-t\fP
+Verifies the image \fImedium.iso\fP with information from
+the error correction file \fIcorr.ecc\fP.
+.TP
+\fBNOTE:\fP
+Omit the \fB-e corr.ecc\fP options when working with augmented images in the examples above.
+
+.SH OPTIONS
+Action selection (at least one action must be specified):
+.TP
+.B \-r, \-\-read
+Read the medium image to hard disc. Use -rn-m to read a certain sector range,
+e.g. -r100-200.
+.TP
+.B \-c, \-\-create
+Create .ecc information for the medium image.
+.TP
+.B \-f, \-\-fix
+Try to fix medium image using .ecc information.
+.TP
+.B \-s, \-\-scan
+Scan the medium for read errors.
+.TP
+.B \-t, \-\-test
+Test integrity of the .iso and .ecc files.
+.TP
+.B \-u, \-\-unlink
+Delete .iso files (when other actions complete).
+.PP
+
+Drive and file specification:
+.TP
+.B \-d, \-\-device device
+read from given device (default: /dev/cdrom).
+.TP
+.B \-p, \-\-prefix prefix
+prefix of .iso/.ecc file (default: medium.* ).
+.TP
+.B \-i, \-\-image imagefile
+name of image file (default: medium.iso).
+.TP
+.B \-e, \-\-ecc eccfile
+name of parity file (default: medium.ecc).
+.TP
+.B \-\-list
+lists available drives for the ASPI driver (Windows only).
+.PP
+
+Tweaking options (see manual before using!):
+.TP
+.B \-j, \-\-jump n
+jump n sectors forward after a read error (default: 16).
+.TP
+.B \-n, \-\-redundancy n%
+sets redundancy for error correction (default: 14.3%).
+.TP
+.B \-m, \-\-method n
+lists/selects error correction methods (default: RS01).
+.RS
+Possible values are RS01 and RS02.
+.RE
+.TP
+.B \-v, \-\-verbose n%
+more diagnostic messages
+.TP
+.B \-\-adaptive-read
+use optimized strategy for reading damaged media.
+.TP
+.B \-\-auto-suffix
+automatically add .iso and .ecc file suffixes.
+.TP
+.B \-\-cache-size n
+image cache size in MB during -c mode (default: 32MB).
+.TP
+.B \-\-dao
+assume DAO disc; do not trim image end.
+.TP
+.B \-\-eject
+eject medium after successful read.
+.TP
+.B \-\-fill-unreadable n
+fill unreadable sectors with byte n
+.TP
+.B \-\-ignore-fatal-sense
+continue reading after potentially fatal error condition.
+.TP
+.B \-\-internal-rereads n
+internal read attempts for defective CD media sectors (default: -1)
+.RS
+The drive firmware usually retries unreadable sectors a few times before
+giving up and returning a read error. It is more efficient to set this to 0 or 1
+and manage read attempts through the --read-attempts parameter. Most drives ignore
+this setting anyways. Use -1 to leave the drive at its default setting.
+.RE
+.TP
+.B \-\-query-size n
+queries drive or filesystem on medium for image size (default: ecc)
+.RS
+Possible values are: drive udf ecc 
+.RE
+.TP
+.B \-\-raw-mode n
+selects raw reading mode for CD media (default: 20)
+.RS
+The recommended mode is 20, which makes the drive apply its built-in error 
+correction to the best possible extent before transfering a defective sector.
+However some drives can only read defective sectors using mode 21, skipping
+the last stage of the internal error correction and returning 
+the uncorrected sector instead.
+.RE
+.TP
+.B \-\-read-attempts n-m
+attempts n upto m reads of a defective sector.
+.TP
+.B \-\-read-medium n
+read the whole medium up to n times.
+.TP
+.B \-\-read-raw
+performs read in raw mode if possible.
+.TP
+.B \-\-speed-warning n
+print warning if speed changes by more than n percent.
+.TP
+.B \-\-spinup-delay n
+wait n seconds for drive to spin up.
+.TP
+.B \-\-split-files
+split image into files <= 2GB.
+.PP
+
+.SH SEE ALSO
+.B Documentation
+DVDISASTER is documented by its own manual, installed in
+.IR %docdir%
+
+.SH AUTHOR
+DVDISASTER was written by Carsten Gnoerlich <carsten@dvdisaster.com>.
+.PP
+This manual page was written by Daniel Baumann
+<daniel.baumann@panthera-systems.net>, for the Debian project (but may be used
+by others). It was enhanced for V0.70/0.72 by Carsten Gnoerlich.