doc: add the PtLog man page

[openafs.git] / doc / man-pages / pod8 / ptserver.pod

diff --git a/doc/man-pages/pod8/ptserver.pod b/doc/man-pages/pod8/ptserver.pod
index 7318900..11e6770 100644 (file)
--- a/doc/man-pages/pod8/ptserver.pod
+++ b/doc/man-pages/pod8/ptserver.pod
@@ -17,8 +17,9 @@ ptserver S<<< [B<-database> | B<-db> <I<db path>>] >>>
     [B<-rxbind>] S<<< [B<-auditlog> <I<file path>>] >>>
     S<<< [B<-audit-interface> (file | sysvmq)] >>>
     S<<< [B<-syslog>[=<I<FACILITY>>]] >>>
-    S<<< [B<-logfile <I<log file>>] >>>
-    S<<< [B<-config <I<configuration path>>] >>>
+    S<<< [B<-logfile> <I<log file>>] >>>
+    [B<-transarc-logs>]
+    S<<< [B<-config> <I<configuration path>>] >>>
     S<<< [B<-rxmaxmtu> <I<bytes>>] >>>
     [B<-help>]
 
@@ -158,11 +159,17 @@ 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>.
 
+=item B<-transarc-logs>
+
+Use Transarc style logging features. Rename the log file
+F</usr/afs/logs/PtLog> to F</usr/afs/logs/PtLog.old> when the PT Server is
+restarted.  This option is provided for compatibility with older versions.
+
 =item B<-config> <I<configuration directory>>
 
 Set the location of the configuration directory used to configure this
@@ -213,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)>,