1.1 --- a/cdbackup.1 Sat Dec 29 15:23:55 2007 +0100
1.2 +++ b/cdbackup.1 Sat Dec 29 15:25:21 2007 +0100
1.3 @@ -1,17 +1,24 @@
1.4 -.TH "cdbackup" "1" "0.6.3" "Stefan Hülswitt" ""
1.5 +.TH "cdbackup" "1" "0.6.4beta" "Stefan Hülswitt" ""
1.6 .SH "NAME"
1.7 .LP
1.8 -cdbackup \- Streaming backup to CD\-R(W)
1.9 +cdbackup \- Streaming backup to CD\-R(W)/DVR\-R(W)
1.10 .SH "SYNOPSIS"
1.11 .LP
1.12 -cdbackup [\-mvDVX] [\-d \fIdevice\fP] [\-r \fIscsi\-dev\fP] [\-s \fIspeed\fP]
1.13 - [\-p \fInum\fP] [\-l \fIsize\fP] [\-a \fIlabel\fP] [\-c \fIcommand\fP]
1.14 - [\-\- \fIcdrecord\-options\fP]
1.15 +cdbackup [\-mvwCDRVX] [\-d \fIdevice\fP] [\-r \fIscsi\-dev\fP] [\-s \fIspeed\fP]
1.16 + [\-i \fIimage\fP] [\-p \fInum\fP] [\-l \fIsize\fP] [\-a \fIlabel\fP]
1.17 + [\-c \fIcommand\fP] [\-\- \fIcdrecord\-options\fP]
1.18 .SH "DESCRIPTION"
1.19 .LP
1.20 -cdbackup is a utility to make streaming backups to CD\-R(W) disks. It's designed to work with any backup tool which writes the backup to stdout (like tar/cpio/afio).
1.21 -.LP
1.22 -\fINOTE:\fR this program REQUIRES that a recent version of \fBcdrecord\fR(1) is present in the PATH.
1.23 +cdbackup is a utility to make streaming backups to CD\-R(W)/DVD\-R(W) disks. It's designed to work with any backup tool which writes the backup to stdout (like tar/cpio/afio).
1.24 +.LP
1.25 +\fINOTE:\fR this program REQUIRES that a recent version of \fBcdrecord\fR(1) (or
1.26 +cdrecord\-ProDVD for DVD support) is present in the PATH.
1.27 +.LP
1.28 +While you can perfectly append several sessions on CD\-R(W) media, I didn't manage to make this work on DVD\-R(W) media. To allow multiple, separate backups on these media, the concept of virtual images has been introduced.
1.29 +.br
1.30 +A virtual image is a plain file on your harddisk. You can append several backups to an image and after completing your backup session, the image is dumped to CDR/DVD media in one burning session. You can dump the same image multiple times too, if you want redundancy on the CDR/DVD media.
1.31 +.br
1.32 +Virtual image files are never deleted by cdbackup. After dumping an image, you have to delete it by your self.
1.33 .LP
1.34 \fIWARNING!\fR When using this program under Linux, be sure not to use dump on a mounted
1.35 filesystem. This has a high potential for creating corrupted backups. As of kernel version
1.36 @@ -29,13 +36,13 @@
1.37 \fB\-r\fR \fIscsi\-device\fP
1.38 The scsi device which is passed to \fBcdrecord\fR(1) (via dev=\fIscsi\-device\fP). Must be given as three, comma seperated number: \fIscsibus\fR,\fItarget\fR,\fIlun\fR.
1.39 .br
1.40 -(default: none)
1.41 +(default: none or the contents of the environment variable CDR_DEVICE)
1.42
1.43 .TP
1.44 \fB\-s\fR \fIspeed\fP
1.45 The writing speed which is passed to \fBcdrecord\fR(1) (via speed=\fIspeed\fP).
1.46 .br
1.47 -(default: 4)
1.48 +(default: 4 or the contents of the environment variable CDR_SPEED)
1.49
1.50 .TP
1.51 \fB\-p\fR \fInum\fP
1.52 @@ -48,10 +55,41 @@
1.53 Enables the use of CDROM XA2 mode in \fBcdrecord\fR(1). By default CDROM mode 1 is used. The default is possibly causing problems during restore on certain kernel version/CDROM hardware combinations at the end of the last session on a media. Sony drives doesn't support CDROM XA 2 mode (see \fBcdrecord\fR(1) \-multi).
1.54
1.55 .TP
1.56 +\fB\-R\fR
1.57 +Enables DVD writing mode. Cdrecord\-ProDVD is used to burn DVD media, but it's called through a script called "dvdrecord". You should set your cdrecord\-ProDVD key and call cdrecord\-ProDVD from there.
1.58 +.br
1.59 +Remember that you cannot write multiple sessions to DVD media. Either you stick with one backup per media or you have to use virtual images.
1.60 +.br
1.61 +In DVD mode the options \-p and \-X have no effect.
1.62 +
1.63 +.TP
1.64 +\fB\-i\fR \fIimage\fP
1.65 +Enables virtual image mode. The backup stream is written to the given image file. The file is created if it doesn't exists. It's mandatory to give an explicit media size with \-l. Take care that the created virtual image isn't lager that the media size you want to dump it later.
1.66 +You can add up to 96 backups to an virtual image.
1.67 +.br
1.68 +If the backup extends the specified media size and you have enabled multi\-disk mode, additional images files are created (the filenames are derived from the inital image name by adding a dot and a decimal number).
1.69 +.br
1.70 +(default: none)
1.71 +
1.72 +.TP
1.73 +\fB\-w\fR
1.74 +Dump the virtual image specified with \-i to real media. Image dumps are written as single sessions always. If you have enabled multi\-disk mode and additional images are found, you're prompted for media change, so that you can dump all images in turn.
1.75 +.br
1.76 +Virtual images (even when dumped to media) are not compatible with older cdbackup versions.
1.77 +
1.78 +.TP
1.79 \fB\-l\fR \fIsize\fP
1.80 -The media size in megabytes. This value is used to calculate how much data can be stored on the media.
1.81 -.br
1.82 -(default: 650)
1.83 +For normal operation the media size is auto\-detected from the cdrecord ATIP information. If this fails or for virtual image mode use this option to set the media size. This is used to calculate how much data can be stored on the media.
1.84 +.br
1.85 +By default the given value is taken as megabytes. You can append a single letter to the number to select: (k)ilobytes, (m)egabytes, (g)igabytes or (s)ectors (e.g. 170k, 4488m, 350000s).
1.86 +.br
1.87 +(default: auto\-detect)
1.88 +
1.89 +.TP
1.90 +\fB\-C\fR
1.91 +Disables creation of the datablock CRC checksum. There is no real reason to use this option, unless you can't efford the extra 0,2% media space that is used to store the checksum.
1.92 +.br
1.93 +Although the on\-disk layout of checksumed backups is different, they are fully backwards compatible with older version of cdbackup, but obviously older versions can't check the backup integrity.
1.94
1.95 .TP
1.96 \fB\-a\fR \fIlabel\fP
1.97 @@ -95,6 +133,21 @@
1.98 To create a tar archive of /usr and output it to a series (multi\-disk mode) of 650 MB CD\-R(W) on /dev/sr1 (scsi device 1,4,0) with writting speed 12 and verbose output:
1.99 .IP
1.100 tar cf \- /usr | cdbackup \-d /dev/sr1 \-r 1,4,0 \-s 12 \-m \-v
1.101 +
1.102 +.LP
1.103 +To create a backup on a virtual image:
1.104 +.IP
1.105 +tar cf \- /usr | cdbackup \-i /tmp/vimage \-l 4488m
1.106 +
1.107 +.LP
1.108 +Add another backup to the same virtual image (with multi\-disk mode):
1.109 +.IP
1.110 +tar cf \- /home | cdbackup \-i /tmp/vimage \-l 4488m
1.111 +
1.112 +.LP
1.113 +Dump the virtual image to one (or several) DVD media on /dev/cdrom (scsi\-ide device 0,0,0), enabling BURNFREE:
1.114 +.IP
1.115 +cdbackup \-i /tmp/vimage \-w \-R \-d /dev/cdrom \-r 0,0,0 \-s 4 \-m \-\- driveropts=burnfree
1.116 .SH "KNOWN PROBLEMS"
1.117 .LP
1.118 Certain combinations of CDROM drivers and kernel versions are causing a problem when restoring data. The restore process aborts with an read error close to the end of the session, while the data on the media is perfectly good.
1.119 @@ -120,12 +173,12 @@
1.120 Please contact the author if you can contribute additional information about the problem.
1.121 .SH "AUTHORS"
1.122 .LP
1.123 -Stefan Hülswitt <huels@iname.com>
1.124 +Stefan Hülswitt <s.huelswitt@gmx.de>
1.125 .SH "SEE ALSO"
1.126 .LP
1.127 \fBcdrestore\fR(1), \fBcdrecord\fR(1)
1.128 .SH "LICENSE"
1.129 -Copyright (c) 2000\-2002 Craig Condit, Stefan Hülswitt.
1.130 +Copyright (c) 2000\-2004 Craig Condit, Stefan Hülswitt.
1.131
1.132 Redistribution and use in source and binary forms, with or without
1.133 modification, are permitted provided that the following conditions are met: