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