doc: buserver manpage fixes

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

diff --git a/doc/man-pages/pod8/buserver.pod b/doc/man-pages/pod8/buserver.pod
index 8c98620..793c842 100644 (file)
--- a/doc/man-pages/pod8/buserver.pod
+++ b/doc/man-pages/pod8/buserver.pod
@@ -4,10 +4,21 @@ buserver - Initializes the Backup Server
 
 =head1 SYNOPSIS
 
-B<buserver> [B<-database> <I<database directory>>] 
-    [B<-cellservdb> <I<cell configuration directory>>] [B<-resetdb>]
-    [B<-noauth>] [B<-smallht>] [-servers <I<list of ubik database servers>>+]
-    [B<-enable_peer_stats>]  [-enable_process_stats] [B<-help>]
+=for html
+<div class="synopsis">
+
+B<buserver> S<<< [B<-database> <I<database directory>>] >>>
+    S<<< [B<-auditlog> <I<log path>>] >>>
+    S<<< [B<-audit-interface> (file | sysvmq)] >>>
+    S<<< [B<-cellservdb> <I<cell configuration directory>>] >>> [B<-resetdb>]
+    [B<-noauth>] [B<-smallht>]
+    S<<< [B<-servers> <I<list of ubik database servers>>+] >>>
+    [B<-rxbind>]
+    [B<-p> <I<number of threads>>] [B<-ubikbuffers> <I<# of buffers>>]
+    [B<-help>]
+
+=for html
+</div>
 
 =head1 DESCRIPTION
 
@@ -52,6 +63,19 @@ Specifies the pathname of an alternate directory for the Backup Database
 files, ending in a final slash (C</>). If this argument is not provided,
 the default is the F</usr/afs/db> directory.
 
+=item B<-auditlog> <I<log path>>
+
+Turns on audit logging, and sets the path for the audit log.  The audit
+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.
+
+=item B<-audit-interface> (file | sysvmq)
+
+Specifies what audit interface to use. Defaults to C<file>. See
+L<fileserver(8)> for an explanation of each interface.
+
 =item B<-cellservdb> <I<cell configuration directory>>
 
 Specifies the pathname of the directory from which the Backup Server reads
@@ -72,13 +96,10 @@ operations.
 
 =item B<-noauth>
 
-Establishes an unauthenticated connection between the issuer and the
-Backup Server, in which the Backup Server treats the issuer as the
-unprivileged user C<anonymous>. It is useful only when authorization
-checking is disabled on the database server machine. In normal
-circumstances, the Backup Server allows only authorized (privileged) users
-to issue commands that affect or contact the Backup Database, and refuses
-to perform such an action even if the B<-noauth> flag is used.
+Turns off all authorization checks, and allows all connecting users to act as
+administrators, even unauthenticated users. The use of this option is
+inherently insecure, and should only be used in controlled environments for
+experimental or debug purposes. See L<NoAuth(5)>.
 
 =item B<-smallht>
 
@@ -93,21 +114,21 @@ Server. Use this argument if running the Backup Server on a subset of the
 database server machines that is not a majority of the machines listed in
 the F</usr/afs/etc/CellServDB> file.
 
-=item B<-enable_peer_stats>
+=item B<-rxbind>
+
+Bind the Rx socket to the primary interface only.  (If not specified, the
+Rx socket will listen on all interfaces.)
+
+=item B<-p> <I<number of threads>>
 
-Activates the collection of Rx statistics and allocates memory for their
-storage. For each connection with a specific UDP port on another machine,
-a separate record is kept for each type of RPC (FetchFile, GetStatus, and
-so on) sent or received. To display or otherwise access the records, use
-the Rx Monitoring API.
+Sets the number of server lightweight processes (LWPs or pthreads) to run.
+Provide a positive integer from the range 3 to 16. The default value is 3.
 
-=item B<-enable_process_stats>
+=item B<-ubikbuffers> <I<# of buffers>>
 
-Activates the collection of Rx statistics and allocates memory for their
-storage. A separate record is kept for each type of RPC (FetchFile,
-GetStatus, and so on) sent or received, aggregated over all connections to
-other machines. To display or otherwise access the records, use the Rx
-Monitoring API.
+Sets the number of internal buffers used for maintaining the ubik database.
+The default is 400. If the buserver runs out of free buffers, errors can occur
+while trying to modify ubik data. It is not recommended to change this setting.
 
 =item B<-help>
 
@@ -119,10 +140,10 @@ ignored.
 =head1 EXAMPLES
 
 The following example B<bos create> command creates a C<buserver> process
-on the file server machine C<fs3.abc.com>. It appears here on two lines
+on the file server machine C<fs3.example.com>. It appears here on two lines
 only for legibility.
 
-   % bos create -server fs3.abc.com -instance buserver \
+   % bos create -server fs3.example.com -instance buserver \
                 -type simple -cmd /usr/afs/bin/buserver
 
 =head1 PRIVILEGE REQUIRED