Document KeyFileExt(5)

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

diff --git a/doc/man-pages/pod8/bos_setrestart.pod b/doc/man-pages/pod8/bos_setrestart.pod
index 2bcaf26..eab6914 100644 (file)
--- a/doc/man-pages/pod8/bos_setrestart.pod
+++ b/doc/man-pages/pod8/bos_setrestart.pod
@@ -1,15 +1,21 @@
 =head1 NAME
 
-bos setrestart - Sets when the BOS Server restarts processes
+bos_setrestart - Sets when the BOS Server restarts processes
 
 =head1 SYNOPSIS
 
-B<bos setrestart> B<-server> <I<machine name>>
-    B<-time> <I<time to restart server>> [B<-general>] [B<-newbinary>]
-    [B<-cell> <I<cell name>>] [B<-noauth>] [B<-localauth>] [B<-help>]
+=for html
+<div class="synopsis">
 
-B<bos setr> B<-s> <I<machine name>> B<-t> <I<time to restart server>>
-    [B<-g>] [B<-ne>] [B<-c> <I<cell name>>] [B<-no>] [B<-l>] [B<-h>]
+B<bos setrestart> S<<< B<-server> <I<machine name>> >>>
+    S<<< B<-time> <I<time to restart server>> >>> [B<-general>] [B<-newbinary>]
+    S<<< [B<-cell> <I<cell name>>] >>> [B<-noauth>] [B<-localauth>] [B<-help>]
+
+B<bos setr> S<<< B<-s> <I<machine name>> >>> S<<< B<-t> <I<time to restart server>> >>>
+    [B<-g>] [B<-ne>] S<<< [B<-c> <I<cell name>>] >>> [B<-no>] [B<-l>] [B<-h>]
+
+=for html
+</div>
 
 =head1 DESCRIPTION
 
@@ -21,11 +27,11 @@ by the B<-server> argument performs two types of restarts:
 
 =item *
 
-A I<general restart>. By default, once per week the BOS Server restarts
-itself and then any AFS process marked with the C<Run> status flag in the
+A I<general restart>. The BOS Server will restart itself,
+and then any AFS process marked with the C<Run> status flag in the
 F<BosConfig> file (equivalent in effect to issuing the B<bos restart>
-command with the B<-bosserver> flag). The default setting is 4:00
-a.m. each Sunday morning.
+command with the B<-bosserver> flag) at this time each week. By default,
+in a new bos installation, general restarts are disabled.
 
 =item *
 
@@ -70,7 +76,7 @@ as weekly (specifies both a day and a time), and the binary restart is
 defined as daily (specifies only a time). However, it is acceptable to
 define a daily general restart or weekly binary restart.
 
-There are four acceptable values for either type of restart setting: 
+There are four acceptable values for either type of restart setting:
 
 =over 4
 
@@ -130,7 +136,8 @@ L<bos(8)>.
 =item B<-localauth>
 
 Constructs a server ticket using a key from the local
-F</usr/afs/etc/KeyFile> file. The B<bos> command interpreter presents the
+F</usr/afs/etc/KeyFile> or F</usr/afs/etc/KeyFileExt> file.
+The B<bos> command interpreter presents the
 ticket to the BOS Server during mutual authentication. Do not combine this
 flag with the B<-cell> or B<-noauth> options. For more details, see
 L<bos(8)>.
@@ -145,14 +152,14 @@ ignored.
 =head1 EXAMPLES
 
 The following command sets the general restart time on the machine
-C<fs4.abc.com> to Saturday at 3:30 am.
+C<fs4.example.com> to Saturday at 3:30 am.
 
-   % bos setrestart -server fs4.abc.com -time "sat 3:30" -general
+   % bos setrestart -server fs4.example.com -time "sat 3:30" -general
 
 The following command sets the binary restart time on the machine
-C<fs6.abc.com> to 11:45 pm.
+C<fs6.example.com> to 11:45 pm.
 
-   % bos setrestart -server fs6.abc.com -time 23:45 -newbinary
+   % bos setrestart -server fs6.example.com -time 23:45 -newbinary
 
 =head1 PRIVILEGE REQUIRED
 
@@ -165,6 +172,7 @@ included.
 
 L<BosConfig(5)>,
 L<KeyFile(5)>,
+L<KeyFileExt(5)>,
 L<UserList(5)>,
 L<bos(8)>,
 L<bos_getrestart(8)>,