cdbackup.1
author nathan
Sat, 29 Dec 2007 15:22:32 +0100
branchtrunk
changeset 0 d85c12073dea
child 2 6bcb44b9edb1
permissions -rw-r--r--
release 0.6.2
nathan@0
     1
.TH "cdbackup" "1" "0.6.2" "Stefan Hülswitt" ""
nathan@0
     2
.SH "NAME"
nathan@0
     3
.LP 
nathan@0
     4
cdbackup \- Streaming backup to CD\-R(W)
nathan@0
     5
.SH "SYNOPSIS"
nathan@0
     6
.LP 
nathan@0
     7
cdbackup [\-mvVX] [\-d \fIdevice\fP] [\-r \fIscsi\-dev\fP] [\-s \fIspeed\fP]
nathan@0
     8
         [\-p \fInum\fP] [\-l \fIsize\fP] [\-a \fIlabel\fP] [\-c \fIcommand\fP]
nathan@0
     9
         [\-\- \fIcdrecord\-options\fP]
nathan@0
    10
.SH "DESCRIPTION"
nathan@0
    11
.LP 
nathan@0
    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).
nathan@0
    13
.LP 
nathan@0
    14
NOTE: this program REQUIRES that a recent version of cdrecord is present in the PATH.
nathan@0
    15
.LP 
nathan@0
    16
WARNING! When using this program under Linux, be sure not to use dump with
nathan@0
    17
kernels in the 2.4.x series. Using dump on an ext2 filesystem has a very
nathan@0
    18
high potential for causing filesystem corruption. As of kernel version
nathan@0
    19
2.4.18, this has not been fixed and it may not be fixed at all.
nathan@0
    20
.SH "OPTIONS"
nathan@0
    21
.LP 
nathan@0
    22
.TP 
nathan@0
    23
\fB\-d\fR \fIdevice\fP
nathan@0
    24
The device name which is used for reading things like the TOC from a (partly written) media.
nathan@0
    25
.br 
nathan@0
    26
(default: /dev/burner)
nathan@0
    27
nathan@0
    28
.TP 
nathan@0
    29
\fB\-r\fR \fIscsi\-device\fP
nathan@0
    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.
nathan@0
    31
.br 
nathan@0
    32
(default: none)
nathan@0
    33
nathan@0
    34
.TP 
nathan@0
    35
\fB\-s\fR \fIspeed\fP
nathan@0
    36
The writing speed which is passed to cdrecord (via speed=\fIspeed\fP).
nathan@0
    37
.br 
nathan@0
    38
(default: 4)
nathan@0
    39
nathan@0
    40
.TP 
nathan@0
    41
\fB\-p\fR \fInum\fP
nathan@0
    42
The number of sectors (of 2048 byte) to use for padding (see \fBcdrecord\fR(1) padsize).
nathan@0
    43
.br 
nathan@0
    44
(default: 15)
nathan@0
    45
nathan@0
    46
.TP 
nathan@0
    47
\fB\-X\fR
nathan@0
    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).
nathan@0
    49
nathan@0
    50
.TP 
nathan@0
    51
\fB\-l\fR \fIsize\fP
nathan@0
    52
The media size in megabytes. This value is used to calculate how much data can be stored on the media.
nathan@0
    53
.br 
nathan@0
    54
(default: 650)
nathan@0
    55
nathan@0
    56
.TP 
nathan@0
    57
\fB\-a\fR \fIlabel\fP
nathan@0
    58
A text label to identify the backup set. The first 32 characters of this string are save with the backup.
nathan@0
    59
.br 
nathan@0
    60
(default: "CDBackup Track")
nathan@0
    61
nathan@0
    62
.TP 
nathan@0
    63
\fB\-c\fR \fIcommand\fP
nathan@0
    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.
nathan@0
    65
.br 
nathan@0
    66
(default: use internal diskchange prompt)
nathan@0
    67
nathan@0
    68
.TP 
nathan@0
    69
\fB\-m\fR
nathan@0
    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.
nathan@0
    71
nathan@0
    72
.TP 
nathan@0
    73
\fB\-v\fR
nathan@0
    74
Enables verbose mode.
nathan@0
    75
nathan@0
    76
.TP 
nathan@0
    77
\fB\-V\fR
nathan@0
    78
Prints out version information and exits.
nathan@0
    79
nathan@0
    80
.TP 
nathan@0
    81
\fB\-\-\fR \fIcdrecord\-options\fP
nathan@0
    82
All options following \fB\-\-\fR are passed to cdrecord.
nathan@0
    83
.SH "EXAMPLES"
nathan@0
    84
.LP 
nathan@0
    85
To create a tar archive of /home and
nathan@0
    86
output it to a 700 MB CD\-R(W) on /dev/scd0 (scsi device 2,0):
nathan@0
    87
.IP 
nathan@0
    88
tar cvf \- /home | cdbackup \-d /dev/scd0 \-r 2,0 \-l 700 \-a "Test Backup"
nathan@0
    89
nathan@0
    90
.LP 
nathan@0
    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:
nathan@0
    92
.IP 
nathan@0
    93
tar cf \- /usr | cdbackup \-d /dev/sr1 \-r 1,4,0 \-s 12 \-m \-v
nathan@0
    94
.SH "AUTHORS"
nathan@0
    95
.LP 
nathan@0
    96
Stefan Hülswitt <huels@iname.com>
nathan@0
    97
.SH "SEE ALSO"
nathan@0
    98
.LP 
nathan@0
    99
\fBcdrestore\fR(1), \fBcdrecord\fR(1)
nathan@0
   100
.SH "LICENSE"
nathan@0
   101
Copyright (c) 2000\-2002 Craig Condit, Stefan Hülswitt.
nathan@0
   102
nathan@0
   103
Redistribution and use in source and binary forms, with or without
nathan@0
   104
modification, are permitted provided that the following conditions are met: 
nathan@0
   105
nathan@0
   106
.TP 
nathan@0
   107
1.
nathan@0
   108
Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 
nathan@0
   109
.TP 
nathan@0
   110
2.
nathan@0
   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.
nathan@0
   112
nathan@0
   113
.LP 
nathan@0
   114
THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS
nathan@0
   115
OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
nathan@0
   116
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
nathan@0
   117
DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR
nathan@0
   118
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
nathan@0
   119
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
nathan@0
   120
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
nathan@0
   121
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
nathan@0
   122
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
nathan@0
   123
OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
nathan@0
   124
SUCH DAMAGE.