cdrestore.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
nathan@2
     1
.TH "cdrestore" "1" "0.6.3" "Stefan Hülswitt" ""
nathan@0
     2
.SH "NAME"
nathan@0
     3
.LP 
nathan@0
     4
cdrestore \- Streaming restore from CD\-R(W)
nathan@0
     5
.SH "SYNOPSIS"
nathan@0
     6
.LP 
nathan@2
     7
cdrestore [\-qvDFRTV] [\-d \fIdevice\fP] [\-l \fIsize\fP] [\-t \fItrack\fP]
nathan@0
     8
          [\-c \fIcommand\fP]
nathan@0
     9
.SH "DESCRIPTION"
nathan@0
    10
.LP 
nathan@0
    11
cdrestore is a utility to make streaming restores from CD\-R(W) disks. It's designed to work with any backup tool which is able to restore from stdin (like tar/cpio/afio).
nathan@0
    12
.SH "OPTIONS"
nathan@0
    13
.LP 
nathan@0
    14
.TP 
nathan@0
    15
\fB\-d\fR \fIdevice\fP
nathan@0
    16
The device name which is used for reading the backup.
nathan@0
    17
.br 
nathan@0
    18
(default: /dev/cdrom)
nathan@0
    19
nathan@0
    20
.TP 
nathan@0
    21
\fB\-l\fR \fIsize\fP
nathan@0
    22
The media size in megabytes. This value is used to calculate the free space on the media.
nathan@0
    23
.br 
nathan@0
    24
(default: 650)
nathan@0
    25
nathan@0
    26
.TP 
nathan@0
    27
\fB\-t\fR \fItrack\fP
nathan@0
    28
The number of the data track on the media for reading the backup.
nathan@0
    29
.br 
nathan@0
    30
(default: none)
nathan@0
    31
nathan@0
    32
.TP 
nathan@2
    33
\fB\-T\fR
nathan@2
    34
Enables test mode. The complete restore process is done to test data integrity, but no data is output.
nathan@2
    35
.br 
nathan@2
    36
\fINOTE:\fR This only verifies that the data is readable by cdrestore at all. This doesn't quaranties that your backup software will be able to do a real restore with the data.
nathan@2
    37
nathan@2
    38
.TP 
nathan@2
    39
\fB\-F\fR
nathan@2
    40
Forces cdrestore to begin the restore in the middle of a multi\-disk set. This may be usefull if you have lost a disk or a disk is badly damaged.
nathan@2
    41
.br 
nathan@2
    42
\fINOTE:\fR This will most probably start the restore in the middle of a file. It's up to your backup software to sync to the beginning of the next file.
nathan@2
    43
nathan@2
    44
.TP 
nathan@2
    45
\fB\-R\fR
nathan@2
    46
Disable the kernel readahead for the CDROM device during the restore process.
nathan@2
    47
(see \fBcdbackup\fR(1) Known problems)
nathan@2
    48
nathan@2
    49
.TP 
nathan@0
    50
\fB\-c\fR \fIcommand\fP
nathan@0
    51
The command which is executed whenever cdrestore needs to request a new media for multi\-disk backups. This command (or script) should prompt the user and return after the 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
    52
.br 
nathan@0
    53
(default: use internal diskchange prompt)
nathan@0
    54
nathan@0
    55
.TP 
nathan@0
    56
\fB\-q\fR
nathan@0
    57
Queries the media, prints out the contents and exits.
nathan@0
    58
nathan@0
    59
.TP 
nathan@2
    60
\fB\-v\fR
nathan@2
    61
Enables verbose mode.
nathan@2
    62
nathan@2
    63
.TP 
nathan@2
    64
\fB\-D\fR
nathan@2
    65
Enables DEBUG output (probably not usefull for normal use).
nathan@2
    66
nathan@2
    67
.TP 
nathan@0
    68
\fB\-V\fR
nathan@0
    69
Prints out version information and exits.
nathan@0
    70
.SH "EXAMPLES"
nathan@0
    71
.LP 
nathan@0
    72
To query the 700 MB media on /dev/sr0:
nathan@0
    73
.IP 
nathan@0
    74
cdrestore \-d /dev/sr0 \-l 700 \-q
nathan@0
    75
nathan@0
    76
.LP 
nathan@0
    77
To restore a tar archive to the current directory from track 2 of a 702 MB media on /dev/scd0:
nathan@0
    78
.IP 
nathan@0
    79
cdrestore \-d /dev/scd0 \-l 702 \-t 2 | tar xf \-
nathan@0
    80
.SH "AUTHORS"
nathan@0
    81
.LP 
nathan@0
    82
Stefan Hülswitt <huels@iname.com>
nathan@0
    83
.SH "SEE ALSO"
nathan@0
    84
.LP 
nathan@0
    85
\fBcdbackup\fR(1)
nathan@0
    86
.SH "LICENSE"
nathan@0
    87
Copyright (c) 2000\-2002 Craig Condit, Stefan Hülswitt.
nathan@0
    88
nathan@0
    89
Redistribution and use in source and binary forms, with or without
nathan@0
    90
modification, are permitted provided that the following conditions are met: 
nathan@0
    91
nathan@0
    92
.TP 
nathan@0
    93
1.
nathan@0
    94
Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 
nathan@0
    95
.TP 
nathan@0
    96
2.
nathan@0
    97
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
    98
nathan@0
    99
.LP 
nathan@0
   100
THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS
nathan@0
   101
OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
nathan@0
   102
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
nathan@0
   103
DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR
nathan@0
   104
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
nathan@0
   105
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
nathan@0
   106
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
nathan@0
   107
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
nathan@0
   108
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
nathan@0
   109
OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
nathan@0
   110
SUCH DAMAGE.