doc: add the PtLog man page
[openafs.git] / doc / man-pages / pod5 / PtLog.pod
1 =head1 NAME
2
3 PtLog - Traces Protection Server operations
4
5 =head1 DESCRIPTION
6
7 The F<PtLog> file records a trace of Protection Server (B<ptserver> process)
8 operations on the local machine and describes any error conditions it
9 encounters.
10
11 If the F<PtLog> file does not already exist in the F</usr/afs/logs> directory
12 when the Protection Server starts, the server process creates it and writes
13 initial start-up messages to it.
14
15 The file is in ASCII format. Administrators listed in the
16 F</usr/afs/etc/UserList> file can use the B<bos getlog> command to display
17 its contents. Alternatively, log onto the server machine and use a text
18 editor or a file display command such as the UNIX B<cat> command. By
19 default, the mode bits on the F<PtLog> file grant the required C<r> (read)
20 permission to all users.
21
22 The Protection Server records operations only as it completes them, and cannot
23 recover from failures by reviewing the file. The log contents are useful
24 for administrative evaluation of process failures and other problems.
25
26 The Protection Server can record messages at several levels of detail. By default, it
27 records only very rudimentary messages.  Specify the Protection Server B<-d> <I<debug level>> command
28 line option to set the initial logging level when the Protection Server is started.
29
30 To increase the level of detail logged by a running Protection Server, issue the following
31 command while logged onto the database server machine as the local superuser
32 C<root>.
33
34    # kill -TSTP <ptserver_pid>
35
36 where <ptserver_pid> is the process ID of the vlserver process, as
37 reported in the output from the standard UNIX B<ps> command. To increase
38 to the second and third levels of detail, repeat the command.
39
40 To disable logging, issue the following command.
41
42    # kill -HUP <ptserver_pid>
43
44 To decrease the level of logging, first completely disable it and then
45 issue the C<kill -TSTP> command as many times as necessary to reach the
46 desired level.
47
48 =head1 SEE ALSO
49
50 L<UserList(5)>,
51 L<bos_getlog(8)>,
52 L<ptserver(8)>
53
54 =head1 COPYRIGHT
55
56 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
57
58 This documentation is covered by the IBM Public License Version 1.0.  It was
59 converted from HTML to POD by software written by Chas Williams and Russ
60 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.