108af9ff7a9a8d077ed95163456824b8b13d6644
[openafs.git] / doc / man-pages / pod8 / bos_getlog.pod
1 =head1 NAME
2
3 bos getlog - Prints a server process's log file
4
5 =head1 SYNOPSIS
6
7 B<bos getlog> B<-server> <I<machine name>> B<-file> <I<log file to examine>>
8     [B<-cell> <I<cell name>>] [B<-noauth>] [B<-localauth>] [B<-help>]
9
10 B<bos getl> B<-s> <I<machine name>> B<-f> <I<log file to examine>>
11     [B<-c> <I<cell name>>] [B<-n>] [B<-l>] [B<-h>]
12
13 =head1 DESCRIPTION
14
15 The B<bos getlog> command displays on the standard output stream the
16 specified log file from the machine named by the B<-server> argument. The
17 BOS Server fetches the log file from the F</usr/afs/logs> directory unless
18 an alternate pathname is provided as part of the B<-file> argument.
19
20 =head1 CAUTIONS
21
22 Log files can grow quite large, especially for the database server
23 processes. To keep them to a manageable size, periodically either use the
24 UNIX B<rm> command to truncate each log file, or use the B<bos restart>
25 command to restart each process.
26
27 It can take up to five minutes after the file is removed or process
28 restarted for the space occupied by a log file to become available.
29
30 =head1 OPTIONS
31
32 =over 4
33
34 =item B<-server> <I<machine name>>
35
36 Indicates the server machine from which to retrieve the log file.
37 Identify the machine by IP address or its host name (either
38 fully-qualified or abbreviated unambiguously). For details, see L<bos(8)>.
39
40 =item B<-file> <I<log file to examine>>
41
42 Names the log file to display. If a filename only is provided, the BOS
43 Server fetches the log file from the F</usr/afs/logs> directory; the
44 standard values are:
45
46 =over 4
47
48 =item F<AuthLog>
49
50 The Authentication Server (B<kaserver>) log file.
51
52 =item F<BackupLog>
53
54 The Backup Server (B<buserver>) log file.
55
56 =item F<BosLog>
57
58 The BOS Server (B<bosserver>) log file.
59
60 =item F<FileLog>
61
62 The File Server (B<fileserver>) log file.
63
64 =item F<SalvageLog>
65
66 The Salvager (B<salvager>) log file.
67
68 =item F<VLLog>
69
70 The Volume Location (VL) Server (B<vlserver>) log file.
71
72 =item F<VolserLog>
73
74 The Volume Server (B<volserver>) log file.
75
76 =back
77
78 If a pathname and filename are provided, the log file is retrieved from
79 the indicated directory. Partial pathnames are interpreted relative to the
80 F</usr/afs/logs> directory.
81
82 =item B<-cell> <I<cell name>>
83
84 Names the cell in which to run the command. Do not combine this argument
85 with the B<-localauth> flag. For more details, see L<bos(8)>.
86
87 =item B<-noauth>
88
89 Assigns the unprivileged identity C<anonymous> to the issuer. Do not
90 combine this flag with the B<-localauth> flag. For more details, see
91 L<bos(8)>.
92
93 =item B<-localauth>
94
95 Constructs a server ticket using a key from the local
96 F</usr/afs/etc/KeyFile> file. The B<bos> command interpreter presents the
97 ticket to the BOS Server during mutual authentication. Do not combine this
98 flag with the B<-cell> or B<-noauth> options. For more details, see
99 L<bos(8)>.
100
101 =item B<-help>
102
103 Prints the online help for this command. All other valid options are
104 ignored.
105
106 =back
107
108 =head1 OUTPUT
109
110 The output is preceded by the line
111
112    Fetching log file '<filename>'...
113
114 The remainder of the output depends on the particular log file.
115
116 =head1 EXAMPLES
117
118 The following example displays the FileLog file from the machine
119 C<fs3.abc.com>:
120
121    % bos getlog -server fs3.abc.com -file FileLog
122    Fetching log file 'FileLog'...
123    Sun Nov 8 04:00:34 1998 File server starting
124    Sun Nov 8 04:00:39 1998 Partition /vicepa:  attached 21 volumes; 
125                            0 volumes not attached
126    Sun Nov 8 04:00:40 1998 File Server started Sun Nov 8 04:00:40 
127                            1998
128    Mon Nov 9 21:45:06 1998 CB: RCallBack (zero fid probe in host.c) 
129                            failed for host 28cf37c0.22811
130
131 =head1 PRIVILEGE REQUIRED
132
133 The issuer must be listed in the F</usr/afs/etc/UserList> file on the
134 machine named by the B<-server> argument, or must be logged onto a server
135 machine as the local superuser C<root> if the B<-localauth> flag is
136 included.
137
138 =head1 SEE ALSO
139
140 L<bos(8)>
141
142 =head1 COPYRIGHT
143
144 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
145
146 This documentation is covered by the IBM Public License Version 1.0.  It was
147 converted from HTML to POD by software written by Chas Williams and Russ
148 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.