cdbackup.1
author nathan
Sat, 29 Dec 2007 15:22:44 +0100
branchtrunk
changeset 1 6b6864d2c4ce
parent 0 d85c12073dea
child 2 6bcb44b9edb1
permissions -rw-r--r--
Added tag 0.6.2 for changeset d85c12073dea
     1 .TH "cdbackup" "1" "0.6.2" "Stefan Hülswitt" ""
     2 .SH "NAME"
     3 .LP 
     4 cdbackup \- Streaming backup to CD\-R(W)
     5 .SH "SYNOPSIS"
     6 .LP 
     7 cdbackup [\-mvVX] [\-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 NOTE: this program REQUIRES that a recent version of cdrecord is present in the PATH.
    15 .LP 
    16 WARNING! When using this program under Linux, be sure not to use dump with
    17 kernels in the 2.4.x series. Using dump on an ext2 filesystem has a very
    18 high potential for causing filesystem corruption. As of kernel version
    19 2.4.18, this has not been fixed and it may not be fixed at all.
    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 cdrecord (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 cdrecord (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 cdrecord. 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\-V\fR
    78 Prints out version information and exits.
    79 
    80 .TP 
    81 \fB\-\-\fR \fIcdrecord\-options\fP
    82 All options following \fB\-\-\fR are passed to cdrecord.
    83 .SH "EXAMPLES"
    84 .LP 
    85 To create a tar archive of /home and
    86 output it to a 700 MB CD\-R(W) on /dev/scd0 (scsi device 2,0):
    87 .IP 
    88 tar cvf \- /home | cdbackup \-d /dev/scd0 \-r 2,0 \-l 700 \-a "Test Backup"
    89 
    90 .LP 
    91 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:
    92 .IP 
    93 tar cf \- /usr | cdbackup \-d /dev/sr1 \-r 1,4,0 \-s 12 \-m \-v
    94 .SH "AUTHORS"
    95 .LP 
    96 Stefan Hülswitt <huels@iname.com>
    97 .SH "SEE ALSO"
    98 .LP 
    99 \fBcdrestore\fR(1), \fBcdrecord\fR(1)
   100 .SH "LICENSE"
   101 Copyright (c) 2000\-2002 Craig Condit, Stefan Hülswitt.
   102 
   103 Redistribution and use in source and binary forms, with or without
   104 modification, are permitted provided that the following conditions are met: 
   105 
   106 .TP 
   107 1.
   108 Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 
   109 .TP 
   110 2.
   111 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.
   112 
   113 .LP 
   114 THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS
   115 OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
   116 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
   117 DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR
   118 ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
   119 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
   120 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
   121 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
   122 LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
   123 OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   124 SUCH DAMAGE.