man5-editing-pass-20051213
[openafs.git] / doc / man-pages / pod5 / fms.log.pod
1 =head1 NAME
2
3 fms.log - Records output from the fms command
4
5 =head1 DESCRIPTION
6
7 The F<fms.log> file records the output generated by the B<fms>
8 command. The output includes two numbers that can appear in a tape
9 device's entry in the F</usr/afs/backup/tapeconfig> file on the Tape
10 Coordinator machine to which the tape device is attached:
11
12 =over 4
13
14 =item *
15
16 The capacity in bytes of the tape in the device.
17
18 =item *
19
20 The size in bytes of the end-of-file (EOF) marks (often referred to simply
21 as I<filemarks>) that the tape device writes.
22
23 =back
24
25 When transferring the numbers recorded in this file to the F<tapeconfig>
26 file, adjust them as specified in L<tapeconfig(5)>, to improve Tape
27 Coordinator performance during dump operations.
28
29 If the F<fms.log> file does not already exist in the current working
30 directory, the B<fms> command interpreter creates it.  In this case, the
31 directory's mode bits must grant the C<rwx> (read, write, and execute)
32 permissions to the issuer of the command. If there is an existing file,
33 the command interpreter overwrites it, so the file's mode bits need to
34 grant only the B<w> permission to the issuer of the B<fms> command.  The
35 B<fms> command interpreter also writes similar information to the standard
36 output stream as it runs.
37
38 The file is in ASCII format. To display its contents, log onto the client
39 machine and use a text editor or a file display command such as the UNIX
40 B<cat> command. By default, the mode bits on the F<fms.log> file grant the
41 required C<r> permission only to the owner (which is the local superuser
42 C<root> by default).
43
44 =head1 OUTPUT
45
46 The first few lines of the file provide a simple trace of the B<fms>
47 command interpreter's actions, specifying (for example) how many blocks it
48 wrote on the tape. The final two lines in the file specify tape capacity
49 and filemark size in bytes, using the following format:
50
51    Tape capacity is <tape_size> bytes
52    File marks are <filemark_size> bytes
53
54 =head1 EXAMPLES
55
56 The following example of the fms.log file specifies that the tape used
57 during the execution of the B<fms> command had a capacity of 2,136,604,672
58 bytes, and that the tape device writes filemarks of size 1,910,220 bytes.
59
60    fms test started
61    wrote 130408 blocks
62    Tape capacity is 2136604672 bytes
63    File marks are 1910220 bytes
64
65 =head1 SEE ALSO
66
67 L<tapeconfig(5)>,
68 L<fms(8)>
69
70 =head1 COPYRIGHT
71
72 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
73
74 This documentation is covered by the IBM Public License Version 1.0.  It was
75 converted from HTML to POD by software written by Chas Williams and Russ
76 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.