From: Michael Meffie <mmeffie@sinenomine.net>
Date: Fri, 3 Jun 2016 19:33:19 +0000 (-0400)
Subject: doc: add the PtLog man page
X-Git-Tag: BP-openafs-stable-1_8_x~70
X-Git-Url: https://git.openafs.org/?p=openafs.git;a=commitdiff_plain;h=0ae62bfa99df8ef5d85b4848783f59a041f82828

doc: add the PtLog man page

Clone the VLLog man page to create a man page for ptserver log as well.

Fix the spelling of the PtLog file and add a link to the new PtLog man
page in the ptserver man page.

Add the missing PtLog log file name to the bos getlog man page.

Change-Id: I95ad4a2cf380077780160ec78fd1f9bdec132ba7
Reviewed-on: https://gerrit.openafs.org/12294
Tested-by: BuildBot <buildbot@rampaginggeek.com>
Reviewed-by: Benjamin Kaduk <kaduk@mit.edu>
---

diff --git a/doc/man-pages/pod5/PtLog.pod b/doc/man-pages/pod5/PtLog.pod
new file mode 100644
index 0000000..1ae09db
--- /dev/null
+++ b/doc/man-pages/pod5/PtLog.pod
@@ -0,0 +1,60 @@
+=head1 NAME
+
+PtLog - Traces Protection Server operations
+
+=head1 DESCRIPTION
+
+The F<PtLog> file records a trace of Protection Server (B<ptserver> process)
+operations on the local machine and describes any error conditions it
+encounters.
+
+If the F<PtLog> file does not already exist in the F</usr/afs/logs> directory
+when the Protection Server starts, the server process creates it and writes
+initial start-up messages to it.
+
+The file is in ASCII format. Administrators listed in the
+F</usr/afs/etc/UserList> file can use the B<bos getlog> 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 B<cat> command. By
+default, the mode bits on the F<PtLog> file grant the required C<r> (read)
+permission to all users.
+
+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.
+
+The Protection Server can record messages at several levels of detail. By default, it
+records only very rudimentary messages.  Specify the Protection Server B<-d> <I<debug level>> command
+line option to set the initial logging level when the Protection Server is started.
+
+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
+C<root>.
+
+   # kill -TSTP <ptserver_pid>
+
+where <ptserver_pid> is the process ID of the vlserver process, as
+reported in the output from the standard UNIX B<ps> command. To increase
+to the second and third levels of detail, repeat the command.
+
+To disable logging, issue the following command.
+
+   # kill -HUP <ptserver_pid>
+
+To decrease the level of logging, first completely disable it and then
+issue the C<kill -TSTP> command as many times as necessary to reach the
+desired level.
+
+=head1 SEE ALSO
+
+L<UserList(5)>,
+L<bos_getlog(8)>,
+L<ptserver(8)>
+
+=head1 COPYRIGHT
+
+IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
+
+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.
diff --git a/doc/man-pages/pod8/bos_getlog.pod b/doc/man-pages/pod8/bos_getlog.pod
index 1db10e1..4ea0dd5 100644
--- a/doc/man-pages/pod8/bos_getlog.pod
+++ b/doc/man-pages/pod8/bos_getlog.pod
@@ -67,6 +67,10 @@ The BOS Server (B<bosserver>) log file.
 
 The File Server (B<fileserver>) log file.
 
+=item F<PtLog>
+
+The Protection Server (B<ptserver>) log file.
+
 =item F<SalvageLog>
 
 The Salvager (B<salvager>) log file.
diff --git a/doc/man-pages/pod8/ptserver.pod b/doc/man-pages/pod8/ptserver.pod
index 6523280..11e6770 100644
--- a/doc/man-pages/pod8/ptserver.pod
+++ b/doc/man-pages/pod8/ptserver.pod
@@ -159,7 +159,7 @@ with the string "ptserver".
 =item B<-logfile> <I<log file>>
 
 Sets the file to use for server logging. If logfile is not specified, and
-no other logging options are supplied, this will be F</usr/afs/logs/PTLog>.
+no other logging options are supplied, this will be F</usr/afs/logs/PtLog>.
 Note that this option is intended for debugging and testing purposes.
 Changing the location of the log file from the command line may result
 in undesirable interactions with tools such as B<bos>.
@@ -220,6 +220,7 @@ command.
 =head1 SEE ALSO
 
 L<BosConfig(5)>,
+L<PtLog(5)>,
 L<prdb.DB0(5)>,
 L<bos_create(8)>,
 L<bos_getlog(8)>,