cdbackup.1
author nathan
Sat, 29 Dec 2007 15:23:49 +0100
branchtrunk
changeset 2 6bcb44b9edb1
parent 0 d85c12073dea
child 4 79da91042fcc
permissions -rw-r--r--
release 0.6.3
     1 .TH "cdbackup" "1" "0.6.3" "Stefan Hülswitt" ""
     2 .SH "NAME"
     3 .LP 
     4 cdbackup \- Streaming backup to CD\-R(W)
     5 .SH "SYNOPSIS"
     6 .LP 
     7 cdbackup [\-mvDVX] [\-d \fIdevice\fP] [\-r \fIscsi\-dev\fP] [\-s \fIspeed\fP]
     8          [\-p \fInum\fP] [\-l \fIsize\fP] [\-a \fIlabel\fP] [\-c \fIcommand\fP]
     9          [\-\- \fIcdrecord\-options\fP]
    10 .SH "DESCRIPTION"
    11 .LP 
    12 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).
    13 .LP 
    14 \fINOTE:\fR this program REQUIRES that a recent version of \fBcdrecord\fR(1) is present in the PATH.
    15 .LP 
    16 \fIWARNING!\fR When using this program under Linux, be sure not to use dump on a mounted
    17 filesystem. This has a high potential for creating corrupted backups. As of kernel version
    18 2.4.19, this has not been fixed and it may not be fixed at all.
    19 You can read Linus statement about this at <http://search.alphanet.ch/cgi\-bin/search.cgi?max_results=10&type=long&msgid=Pine.LNX.4.21.0104270953280.2067\-100000@penguin.transmeta.com&domain=ml\-linux\-kernel>
    20 .SH "OPTIONS"
    21 .LP 
    22 .TP 
    23 \fB\-d\fR \fIdevice\fP
    24 The device name which is used for reading things like the TOC from a (partly written) media.
    25 .br 
    26 (default: /dev/burner)
    27 
    28 .TP 
    29 \fB\-r\fR \fIscsi\-device\fP
    30 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.
    31 .br 
    32 (default: none)
    33 
    34 .TP 
    35 \fB\-s\fR \fIspeed\fP
    36 The writing speed which is passed to \fBcdrecord\fR(1) (via speed=\fIspeed\fP).
    37 .br 
    38 (default: 4)
    39 
    40 .TP 
    41 \fB\-p\fR \fInum\fP
    42 The number of sectors (of 2048 byte) to use for padding (see \fBcdrecord\fR(1) padsize).
    43 .br 
    44 (default: 15)
    45 
    46 .TP 
    47 \fB\-X\fR
    48 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).
    49 
    50 .TP 
    51 \fB\-l\fR \fIsize\fP
    52 The media size in megabytes. This value is used to calculate how much data can be stored on the media.
    53 .br 
    54 (default: 650)
    55 
    56 .TP 
    57 \fB\-a\fR \fIlabel\fP
    58 A text label to identify the backup set. The first 32 characters of this string are save with the backup.
    59 .br 
    60 (default: "CDBackup Track")
    61 
    62 .TP 
    63 \fB\-c\fR \fIcommand\fP
    64 The command which is executed whenever cdbackup needs to request a new media in multi\-disk mode. This command (or script) should prompt the user and return after the recording device is ready again. The command receives one argument, which is the device name passed with \fB\-d\fR. This can be used to issue commands to the device like ejecting the media.
    65 .br 
    66 (default: use internal diskchange prompt)
    67 
    68 .TP 
    69 \fB\-m\fR
    70 Enables multi\-disk mode. When the current media is filled, a new media is requested (see option \fB\-c\fR) and the backup is continued. Backups can only be continued to empty media, this means you cannot insert a partly filled media for continuation.
    71 
    72 .TP 
    73 \fB\-v\fR
    74 Enables verbose mode.
    75 
    76 .TP 
    77 \fB\-D\fR
    78 Enables DEBUG output (probably not usefull for normal use).
    79 
    80 .TP 
    81 \fB\-V\fR
    82 Prints out version information and exits.
    83 
    84 .TP 
    85 \fB\-\-\fR \fIcdrecord\-options\fP
    86 Pass following options to \fBcdrecord\fR(1).
    87 .SH "EXAMPLES"
    88 .LP 
    89 To create a tar archive of /home and
    90 output it to a 700 MB CD\-R(W) on /dev/scd0 (scsi device 2,0):
    91 .IP 
    92 tar cvf \- /home | cdbackup \-d /dev/scd0 \-r 2,0 \-l 700 \-a "Test Backup"
    93 
    94 .LP 
    95 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:
    96 .IP 
    97 tar cf \- /usr | cdbackup \-d /dev/sr1 \-r 1,4,0 \-s 12 \-m \-v
    98 .SH "KNOWN PROBLEMS"
    99 .LP 
   100 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.
   101 .LP 
   102 All CDR sessions written in track\-at\-once mode (which is unavoidable for multisessions) end in at least two unreadable runout sectors (for additional information refer to the file README.copy from the cdrecord package). As the kernel does some readahead on the device, it stumbles over these unreadable sectors before reaching the actual end of data.
   103 .LP 
   104 Some drivers are reporting to syslog but doesn't pass the error to the application, while others make the application fail. From user feedback, it seems that pure SCSI setups are mostly working fine, while ide\-scsi setups are likely to fail.
   105 .LP  
   106 The author isn't able to provide a full solution, but some hints which may help:
   107 .TP 
   108 1.
   109 Update to a recent kernel.
   110 .TP 
   111 2.
   112 Disable kernel readahead with option \-R when restoring.
   113 .TP 
   114 3.
   115 Increase the padsize with option \-p. Use values >= 128.
   116 .TP 
   117 4.
   118 Use option \-X if your writer supports this (Sony drives doesn't supports this mode).
   119 .LP 
   120 Please contact the author if you can contribute additional information about the problem.
   121 .SH "AUTHORS"
   122 .LP 
   123 Stefan Hülswitt <huels@iname.com>
   124 .SH "SEE ALSO"
   125 .LP 
   126 \fBcdrestore\fR(1), \fBcdrecord\fR(1)
   127 .SH "LICENSE"
   128 Copyright (c) 2000\-2002 Craig Condit, Stefan Hülswitt.
   129 
   130 Redistribution and use in source and binary forms, with or without
   131 modification, are permitted provided that the following conditions are met: 
   132 
   133 .TP 
   134 1.
   135 Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 
   136 .TP 
   137 2.
   138 Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
   139 
   140 .LP 
   141 THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS
   142 OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
   143 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
   144 DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR
   145 ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
   146 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
   147 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
   148 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
   149 LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
   150 OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   151 SUCH DAMAGE.