d3aa433ff668c4396fb9aad5d74e8094d4af4650
[openafs.git] / doc / man-pages / pod8 / read_tape.pod
1 =head1 NAME
2
3 read_tape - Reads volume dumps from a backup tape to a file
4
5 =head1 SYNOPSIS
6
7 =for html
8 <div class="synopsis">
9
10 B<read_tape> S<<< B<-tape> <I<tape device>> >>>
11    S<<< B<-restore> <I<# of volumes to restore>> >>>
12    S<<< B<-skip> <I<# of volumes to skip>> >>>
13    S<<< B<-file> <I<filename>> >>> [B<-scan>] [B<-noask>] [B<-label>]
14    [B<-vheaders>] [B<-verbose>] [B<-help>]
15
16 =for html
17 </div>
18
19 =head1 DESCRIPTION
20
21 B<read_tape> reads an OpenAFS backup tape and prompts for each dump file to
22 save.  This command does not require any OpenAFS infrastructure.  This
23 command does not need an OpenAFS client or server to be available, which is
24 not the case with the L<backup(8)> command.
25
26 The dump files will be named for the Read/Write name of the volume restored.
27 After saving each dump file, B<vos restore> or B<restorevol> can be used to
28 restore the volume into AFS and non-AFS space respectively.
29
30 B<read_tape> reads the tape while skipping the specified number of volumes.
31 After that, it restores the specified number of volumes.  B<read_tape>
32 doesn't rewind the tape so that it may be used multiple times in succession.
33
34 =head1 OPTIONS
35
36 =over 4
37
38 =item B<-tape> <I<tape device>>
39
40 Specifies the tape device from which to restore.
41
42 =item B<-restore> <I<# of volumes to restore>>
43
44 Specifies the number of volumes to restore from tape.
45
46 =item B<-skip> <I<# of volumes to skip>>
47
48 Specifies the number of volumes to skip before starting the restore.
49
50 =item B<-file> <I<filename>>
51
52 Specifies an alternate name for the restored volume dump file rather than
53 the default of the volume name.
54
55 =item B<-scan>
56
57 Scans the tape.
58
59 =item B<-noask>
60
61 Doesn't prompt for each volume.
62
63 =item B<-label>
64
65 Displays the full dump label.
66
67 =item B<-vheaders>
68
69 Displays the full volume headers.
70
71 =item B<-verbose>
72
73 Produces on the standard output stream a detailed trace of the command's
74 execution.  If this argument is omitted, only warnings and error messages
75 appear.
76
77 =item B<-help>
78
79 Prints the online help for this command. All other valid options are
80 ignored.
81
82 =back
83
84 =head1 EXAMPLES
85
86 The following command will read the third through fifth volumes from
87 the tape device /dev/tape without prompting:
88
89    % read_tape -tape /dev/tape -skip 2 -restore 3 -noask
90
91 =head1 PRIVILEGE REQUIRED
92
93 The issuer must have access to read and write to the specified tape device.
94
95 =head1 SEE ALSO
96
97 L<backup(8)>,
98 L<restorevol(8)>,
99 L<vos_restore(1)>
100
101 =head1 COPYRIGHT
102
103 Copyright 2007 Jason Edgecombe <jason@rampaginggeek.com>
104
105 This documentation is covered by the IBM Public License Version 1.0. This
106 man page was written by Jason Edgecombe for OpenAFS.