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