From: Michael Meffie <mmeffie@sinenomine.net>
Date: Thu, 6 Oct 2011 10:03:07 +0000 (-0400)
Subject: bozo: bosserver man page updates
X-Git-Tag: upstream/1.6.1.pre1^2~189
X-Git-Url: https://git.michaelhowe.org/gitweb/?a=commitdiff_plain;h=84befb7f70bd7d9dc7b27930e35a87601d626133;p=packages%2Fo%2Fopenafs.git

bozo: bosserver man page updates

Add the new -pidfiles option to the man page. Add a few other missing
options as well.

Reviewed-on: http://gerrit.openafs.org/5587
Reviewed-by: Derrick Brashear <shadow@dementix.org>
Tested-by: Derrick Brashear <shadow@dementix.org>
(cherry picked from commit 26253df896a7709847cda041db1dc187f1dbf83e)

Change-Id: Iac3a96bfc825143a7b8c7b4e359f35d72bbb2d4c
Reviewed-on: http://gerrit.openafs.org/5611
Tested-by: Derrick Brashear <shadow@dementix.org>
Reviewed-by: Derrick Brashear <shadow@dementix.org>
---

diff --git a/doc/man-pages/pod8/bosserver.pod b/doc/man-pages/pod8/bosserver.pod
index 5c8a2f47b..1e7c1f92b 100644
--- a/doc/man-pages/pod8/bosserver.pod
+++ b/doc/man-pages/pod8/bosserver.pod
@@ -7,11 +7,22 @@ bosserver - Initializes the BOS Server
 =for html
 <div class="synopsis">
 
-B<bosserver> [B<-noauth>] [B<-log>] [B<-enable_peer_stats>]
-    S<<< [B<-auditlog> <I<log path>>] >>> [B<-audit-interface> (file | sysvmq)]
-    [B<-enable_process_stats>] [B<-allow-dotted-principals>]
-    [B<-cores=>(none|<I<path>>)]
-    [B<-restricted>] [B<-help>]
+B<bosserver>
+    S<<< [B<-noauth>] >>>
+    S<<< [B<-log>] >>>
+    S<<< [B<-enable_peer_stats>] >>>
+    S<<< [B<-auditlog> <I<log path>>] >>>
+    S<<< [B<-audit-interface> ( file | sysvmq )] >>>
+    S<<< [B<-enable_process_stats>] >>>
+    S<<< [B<-allow-dotted-principals>] >>>
+    S<<< [B<-cores>[=none|<I<path>>]] >>>
+    S<<< [B<-restricted>] >>>
+    S<<< [B<-rxmaxmtu> <I<bytes>>] >>>
+    S<<< [B<-rxbind>] >>>
+    S<<< [B<-syslog>[=<I<facility>>]>] >>>
+    S<<< [B<-pidfiles>[=<I<path>>]] >>>
+    S<<< [B<-nofork>] >>>
+    S<<< [B<-help>] >>>
 
 =for html
 </div>
@@ -170,6 +181,46 @@ of commands are unavailable. Note that this flag persists across reboots.
 Once a server has been placed in restricted mode, it can only be opened up
 by sending the SIGFPE signal.
 
+=item B<-rxmaxmtu> <I<bytes>>
+
+Sets the maximum transmission unit for the RX protocol.
+
+=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<-syslog>[=<I<facility>>]>
+
+Specifies that logging output should go to syslog instead of the normal
+log file.  B<-syslog>=I<facility> can be used to specify to which facility
+the log message should be sent.
+
+=item B<-pidfiles>[=<I<path>>]
+
+Create a one-line file containing the process id (pid) for each non-cron
+process started by the BOS Server.  This file is removed by the BOS Server when
+the process exits.  The optional <I<path>> argument specifies the path where
+the pid files are to be created.  The default location is C</usr/afs/local>.
+
+The name of the pid files for C<simple> BOS Server process types are the BOS
+Server instance name followed by C<.pid>.
+
+The name of the pid files for C<fs> and C<dafs> BOS Server process types are
+the BOS Server type name, C<fs> or C<dafs>, followed by the BOS Server core
+name of the process, followed by C<.pid>.  The pid file name for the
+C<fileserver> process is C<fs.file.pid>. The pid file name for the C<volserver>
+is C<fs.vol.pid>.
+
+BOS Server instance names are specfied using the B<bos create> command.  See
+L<bos_create> for a description of the BOS Server process types and instance
+names.
+
+=item B<-nofork>
+
+Run the BOS Server in the foreground. By default, the BOS Server process will
+fork and detach the stdio, stderr, and stdin streams.
+
 =item B<-help>
 
 Prints the online help for this command. All other valid options are
@@ -182,7 +233,7 @@ ignored.
 The following command initializes the BOS Server and logs the names of
 users who issue privileged B<bos> commands.
 
-   % bosserver -log &
+   % bosserver -log
 
 =head1 PRIVILEGE REQUIRED
 
diff --git a/src/bozo/bosserver.c b/src/bozo/bosserver.c
index 100bd694a..b439e3a38 100644
--- a/src/bozo/bosserver.c
+++ b/src/bozo/bosserver.c
@@ -1001,6 +1001,7 @@ main(int argc, char **argv, char **envp)
 		   "[-audit-interafce <file|sysvmq> (default is file)] "
 		   "[-rxmaxmtu <bytes>] [-rxbind] [-allow-dotted-principals]"
 		   "[-syslog[=FACILITY]] "
+		   "[-restricted] "
 		   "[-enable_peer_stats] [-enable_process_stats] "
 		   "[-cores=<none|path>] \n"
 		   "[-pidfiles[=path]] "
@@ -1010,6 +1011,7 @@ main(int argc, char **argv, char **envp)
 		   "[-auditlog <log path>] "
 		   "[-audit-interafce <file|sysvmq> (default is file)] "
 		   "[-rxmaxmtu <bytes>] [-rxbind] [-allow-dotted-principals]"
+		   "[-restricted] "
 		   "[-enable_peer_stats] [-enable_process_stats] "
 		   "[-cores=<none|path>] \n"
 		   "[-pidfiles[=path]] "