doc/man-pages/pod/fms.pod

   1 =head1 NAME
   2
   3 fms - Determine a tape's capacity and a tape device's filemark size
   4
   5 =head1 SYNOPSIS
   6
   7 fms B<-tape> I<tape special file>  [B<-help>]
   8
   9 fms  B<-t> I<tape special file>  [B<-h>]
  10
  11 =head1 DESCRIPTION
  12
  13 The C<fms> command determines the capacity of the tape currently in the
  14 tape device identified by the B<-tape> argument, along with the size of
  15 the filemark for the device. The filemark is also referred to as the
  16 device's end-of-file (EOF) marker, and can differ for each combination
  17 of tape and tape device.
  18
  19 As the Tape Coordinator writes a dump, it writes a filemark between
  20 the data included from each volume and also tracks the amount of space
  21 left before the end of the tape (EOT). For some tape devices, the
  22 filemark is large enough (multiple megabytes) that failure to consider
  23 it leads the Tape Coordinator significantly to overestimate the
  24 available space.
  25
  26 The intended use of this command is to determine tape capacity and
  27 filemark size values that can be specified in a tape device's entry in
  28 the B</usr/afs/backup/tapeconfig> file. For certain types of tape drives,
  29 the Tape Coordinator operates more efficiently when the B<tapeconfig>
  30 file lists accurate values. For further discussion, see the IBM AFS
  31 Administration Guide chapter on configuring the Backup System.
  32
  33 Insert a tape in the drive before issuing this command.
  34
  35 =head1 OPTIONS
  36
  37 =over 4
  38
  39 =item B<-tape> I<tape special file>
  40
  41 Specifies the UNIX device name of the tape device for which to
  42 determine filemark size and the capacity of the tape it
  43 currently contains. The format varies on different system
  44 types, but usually begins with B</dev>; an example is B</dev/sd0a>.
  45
  46 =item B<-help>
  47
  48 Prints the online help for this command. All other valid
  49 options are ignored.
  50
  51 =back
  52
  53 =head1 OUTPUT
  54
  55 The command generates output both on the standard output stream and in
  56 the B<fms.log> file that it creates in the current working directory. The
  57 output reports the capacity of the tape in the device and the device's
  58 filemark size.
  59
  60 The first few lines of output include status information about the
  61 execution of the command, including such information as the number of
  62 blocks and the number of file marks written to the tape by the
  63 command. The last two lines of both screen and file output provide the
  64 following information:
  65
  66 =over
  67
  68 =item *
  69
  70 C<Tape capacity is> I<number> C<bytes>: specifies the size, in bytes, of
  71 the tape in the device.
  72
  73 =item *
  74
  75 C<File marks are> I<number> C<bytes>: specifies the device's filemark size
  76 in bytes.
  77
  78 =back
  79
  80 The following message indicates that the C<fms> command interpreter
  81 cannot access the tape device. The command halts.
  82
  83 Can't open tape drive I<device>
  84
  85 The following message indicates that the command interpreter cannot
  86 create the B<fms.log> log file. Again, the command halts.
  87
  88 Can't open log file
  89
  90 =head1 EXAMPLES
  91
  92 The following command illustrates the output for the device called
  93 B</dev/rmt1h>:
  94
  95     fms /dev/rmt1h
  96    wrote block: 130408
  97    Finished data capacity test - rewinding
  98    wrote 1109 blocks, 1109 file marks
  99    Finished file mark test
 100    Tape capacity is 2136604672 bytes
 101    File marks are 1910205 bytes
 102
 103 The following appears in the B<fms.log> file:
 104
 105    fms test started
 106    wrote 9230 blocks
 107    Finished file mark test
 108    Tape capacity is 151224320 bytes
 109    File marks are 2375680 bytes
 110
 111 =head1 PRIVILEGE REQUIRED
 112
 113 The issuer must be able to insert and write to files in the currently
 114 working directory, if the B<fms.log> file does not already exist. If it
 115 already exists, the issuer need only be able to write to it.
 116
 117 =head1 CAVEATS
 118
 119 Do not use this command on compressing tape devices in compression
 120 mode or with tape devices that handle tapes of multigigabyte (or
 121 multiterabyte) capacity. It does not produce accurate results in those
 122 cases. For alternate suggestions on the values to record in the
 123 B<tapeconfig> file for compressing drives, see the IBM AFS Administration
 124 Guide chapter on configuring the Backup System.
 125
 126 Running the command completely overwrites the tape, so use a blank one
 127 or one that can be recycled.
 128
 129 Because it writes filemarks to the complete length of the tape, the
 130 command can take from several hours to more than a day to complete.
 131
 132 =head1 COPYRIGHT
 133
 134 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
 135
 136 Converted from html to pod by Alf Wachsmann <alfw@slac.stanford.edu>, 2003,
 137 and Elizabeth Cassell <e_a_c@mailsnare.net>, 2004,
 138 Stanford Linear Accelerator Center, a department of Stanford University.
 139
 140 =head1 SEE ALSO
 141
 142 L<fms.log(1)>,
 143 L<tapeconfig(1)>
 144
 145 =cut