.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "PTLOG 5"
.TH PTLOG 5 2024-02-03 OpenAFS "AFS File Reference"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
PtLog \- Traces Protection Server operations
.SH DESCRIPTION
.IX Header "DESCRIPTION"
The \fIPtLog\fR file records a trace of Protection Server (\fBptserver\fR process)
operations on the local machine and describes any error conditions it
encounters.
.PP
If the \fIPtLog\fR file does not already exist in the \fI/var/log/openafs\fR directory
when the Protection Server starts, the server process creates it and writes
initial start-up messages to it.
.PP
The file is in ASCII format. Administrators listed in the
\&\fI/etc/openafs/server/UserList\fR file can use the \fBbos getlog\fR command to display
its contents. Alternatively, log onto the server machine and use a text
editor or a file display command such as the UNIX \fBcat\fR command. By
default, the mode bits on the \fIPtLog\fR file grant the required \f(CW\*(C`r\*(C'\fR (read)
permission to all users.
.PP
The Protection Server records operations only as it completes them, and cannot
recover from failures by reviewing the file. The log contents are useful
for administrative evaluation of process failures and other problems.
.PP
The Protection Server can record messages at several levels of detail. By default, it
records only very rudimentary messages.  Specify the Protection Server \fB\-d\fR <\fIdebug level\fR> command
line option to set the initial logging level when the Protection Server is started.
.PP
To increase the level of detail logged by a running Protection Server, issue the following
command while logged onto the database server machine as the local superuser
\&\f(CW\*(C`root\*(C'\fR.
.PP
.Vb 1
\&   # kill \-TSTP <ptserver_pid>
.Ve
.PP
where <ptserver_pid> is the process ID of the vlserver process, as
reported in the output from the standard UNIX \fBps\fR command. To increase
to the second and third levels of detail, repeat the command.
.PP
To disable logging, issue the following command.
.PP
.Vb 1
\&   # kill \-HUP <ptserver_pid>
.Ve
.PP
To decrease the level of logging, first completely disable it and then
issue the \f(CW\*(C`kill \-TSTP\*(C'\fR command as many times as necessary to reach the
desired level.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBUserList\fR\|(5),
\&\fBbos_getlog\fR\|(8),
\&\fBptserver\fR\|(8)
.SH COPYRIGHT
.IX Header "COPYRIGHT"
IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
.PP
This documentation is covered by the IBM Public License Version 1.0.  It was
converted from HTML to POD by software written by Chas Williams and Russ
Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.