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