doc/man-pages/pod8/read_tape.pod

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