ptserver: Add cmdline options for config and log

[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 3eac523..6c2d20f 100644 (file)
--- a/doc/man-pages/pod8/ptserver.pod
+++ b/doc/man-pages/pod8/ptserver.pod
@@ -7,15 +7,19 @@ ptserver - Initializes the Protection Server
 =for html
 <div class="synopsis">
 
-B<ptserver> S<<< [B<-database> | B<-db> <I<db path>>] >>> S<<< [B<-p> <I<number of threads>>] >>> S<<< [B<-d> <I<debug level>>] >>>
-    [B<-rebuildDB>] S<<< [B<-groupdepth> <I<# of nested groups>>] >>>
-    S<<< [B<-default_access> <I<user access mask>> <I<group access mask>>] >>>
-    [B<-restricted>] [B<-enable_peer_stats>]
-    [B<-enable_process_stats>] [B<-allow-dotted-principals>]
-    [B<-rxbind>] S<<< [B<-auditlog> <I<file path>>] >>>
-    S<<< [B<-audit-interface> (file | sysvmq)] >>>
-    S<<< [B<-syslog>[=<I<FACILITY>>]] >>> S<<< [B<-rxmaxmtu> <I<bytes>>] >>>
-    [B<-help>]
+ptserver S<<< [B<-database> | B<-db> <I<db path>>] >>>
+S<<< [B<-p> <I<number of threads>>] >>> S<<< [B<-d> <I<debug level>>] >>>
+S<<< [B<-groupdepth> <I<# of nested groups>>] >>>
+S<<< [B<-default_access> <I<user access mask>> <I<group access mask>>] >>>
+[B<-restricted>] [B<-enable_peer_stats>]
+[B<-enable_process_stats>] [B<-allow-dotted-principals>]
+[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<-rxmaxmtu> <I<bytes>>] >>>
+[B<-help>]
 
 =for html
 </div>
@@ -90,12 +94,6 @@ Sets the number of server lightweight processes (LWPs or pthreads) to run.
 Provide a positive integer from the range C<3> to C<16>. The default
 value is C<3>.
 
-=item B<-rebuildDB>
-
-Rebuilds the Protection Database at the beginning of Protection Server
-initialization. Use this argument only in consultation with AFS
-Development or Product Support.
-
 =item B<-groupdepth> <I<# of nested groups>>, B<-depth> <I<# of nested groups>>
 
 Specifies the group depth for nested groups when B<ptserver> is compiled
@@ -151,10 +149,25 @@ log file.  B<-syslog>=I<FACILITY> can be used to specify to which facility
 the log message should be sent.  Logging message sent to syslog are tagged
 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>.
+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<-config> <I<configuration directory>>
+
+Set the location of the configuration directory used to configure this
+service. In a typical configuration this will be F</usr/afs/etc> - this
+option allows the use of alternative configuration locations for testing
+purposes.
+
 =item B<-auditlog> <I<log path>>
 
 Turns on audit logging, and sets the path for the audit log.  The audit
-log shows one entry per RPC call. Each entry records the name of the RPC
+log records information about RPC calls, including the name of the RPC
 call, the host that submitted the call, the authenticated entity (user)
 that issued the call, the parameters for the call, and if the call
 succeeded or failed.