From: Stephan Wiesand <stephan.wiesand@desy.de>
Date: Fri, 7 Mar 2014 10:03:36 +0000 (+0100)
Subject: doc: improve man pages related to bos restricted mode
X-Git-Tag: upstream/1.6.8^2~11
X-Git-Url: https://git.michaelhowe.org/gitweb/?a=commitdiff_plain;h=cbb2ce7fe1a297191336b2488c9f86cebab5f15d;p=packages%2Fo%2Fopenafs.git

doc: improve man pages related to bos restricted mode

Mention the restrictmode entry and the commands for setting and
querying it in the BosConfig man page, and add/fix cross references
between the BosConfig, bos, bos_getrestricted and bos_setrestricted
ones.

Reviewed-on: http://gerrit.openafs.org/10874
Reviewed-by: Ken Dreyer <ktdreyer@ktdreyer.com>
Reviewed-by: Benjamin Kaduk <kaduk@mit.edu>
Reviewed-by: Jeffrey Altman <jaltman@your-file-system.com>
Tested-by: Jeffrey Altman <jaltman@your-file-system.com>
(cherry picked from commit eee0bf5871944d919951cc8b7b4908ee909c3b62)

Change-Id: I25d2f23d75a9074ae478f86296bb13c1b2dda95b
Reviewed-on: http://gerrit.openafs.org/10883
Tested-by: BuildBot <buildbot@rampaginggeek.com>
Reviewed-by: Michael Meffie <mmeffie@sinenomine.net>
Reviewed-by: Andrew Deason <adeason@sinenomine.net>
Reviewed-by: Stephan Wiesand <stephan.wiesand@desy.de>
---

diff --git a/doc/man-pages/pod5/BosConfig.pod b/doc/man-pages/pod5/BosConfig.pod
index dec4b7e38..b991bd325 100644
--- a/doc/man-pages/pod5/BosConfig.pod
+++ b/doc/man-pages/pod5/BosConfig.pod
@@ -130,6 +130,9 @@ is 5:00 a.m.
 
 =back
 
+Finally, there is an entry specifying whether the BOS Server will start in
+restricted mode.
+
 Although the F<BosConfig> file is in ASCII format, it is normally best not
 to use a text editor to alter it.  The parser is very picky, and
 incorrectly formatted entries can prevent server startup in ways that are
@@ -155,11 +158,22 @@ performs automatic restarts.
 
 =item *
 
+The B<bos getrestricted> command to display whether the BOS Server is running
+in restricted mode.
+
+=item *
+
 The B<bos setrestart> command to set the times at which the BOS Server
 performs automatic process restarts.
 
 =item *
 
+The B<bos setrestricted> command to place the BOS Server in restricted mode.
+Since there is no command to revert this, setting the C<restrictmode>
+parameter back to 0 is only possible with an editor.
+
+=item *
+
 The B<bos start> command to change an entry's status flag to C<Run> and
 start the associated process.
 
@@ -209,8 +223,10 @@ file to F<BosConfig> before reading its configuration.
 L<bos_create(8)>,
 L<bos_delete(8)>,
 L<bos_getrestart(8)>,
+L<bos_getrestricted(8)>,
 L<bos_restart(8)>,
 L<bos_setrestart(8)>,
+L<bos_setrestricted(8)>,
 L<bos_shutdown(8)>,
 L<bos_start(8)>,
 L<bos_startup(8)>,
diff --git a/doc/man-pages/pod8/bos.pod b/doc/man-pages/pod8/bos.pod
index adeabca4e..61200d53b 100644
--- a/doc/man-pages/pod8/bos.pod
+++ b/doc/man-pages/pod8/bos.pod
@@ -93,11 +93,12 @@ B<bos adduser>, B<bos listusers>, and B<bos removeuser>.
 The F</usr/afs/local/BosConfig> file defines which AFS server processes
 run on the server machine, and whether the BOS Server restarts them
 automatically if they fail. It also defines when all processes restart
-automatically (by default once per week), and when the BOS Server restarts
-processes that have new binary files (by default once per day). To
+automatically (by default once per week), when the BOS Server restarts
+processes that have new binary files (by default once per day), and
+whether the BOS Server will start in restricted mode. To
 administer the F<BosConfig> file, use the following commands: B<bos
-create>, B<bos delete>, B<bos getrestart>, B<bos setrestart>, B<bos
-start>, and B<bos stop>.
+create>, B<bos delete>, B<bos getrestart>, B<bos getrestricted>, B<bos
+setrestart>, B<bos setrestricted>, B<bos start>, and B<bos stop>.
 
 =item *
 
diff --git a/doc/man-pages/pod8/bos_getrestricted.pod b/doc/man-pages/pod8/bos_getrestricted.pod
index f9706a99b..3caa64111 100644
--- a/doc/man-pages/pod8/bos_getrestricted.pod
+++ b/doc/man-pages/pod8/bos_getrestricted.pod
@@ -74,9 +74,9 @@ None
 
 =head1 SEE ALSO
 
-L<KeyFile(5)>,
+L<BosConfig(5)>,
 L<bos(8)>,
-L<bos_setrestricted(8)>,
+L<bos_setrestricted(8)>
 
 =head1 COPYRIGHT
 
diff --git a/doc/man-pages/pod8/bos_setrestricted.pod b/doc/man-pages/pod8/bos_setrestricted.pod
index 1c114778f..60f5a2a02 100644
--- a/doc/man-pages/pod8/bos_setrestricted.pod
+++ b/doc/man-pages/pod8/bos_setrestricted.pod
@@ -76,7 +76,9 @@ already in restricted mode.
 
 =head1 SEE ALSO
 
-L<bos(8)>
+L<BosConfig(5)>,
+L<bos(8)>,
+L<bos_getrestricted(8)>
 
 =head1 COPYRIGHT