doc: correct help for 'bos getlog' -restricted mode
[openafs.git] / doc / man-pages / pod8 / bos_getlog.pod
index 108af9f..1db10e1 100644 (file)
@@ -1,14 +1,20 @@
 =head1 NAME
 
-bos getlog - Prints a server process's log file
+bos_getlog - Prints a server process's log file
 
 =head1 SYNOPSIS
 
-B<bos getlog> B<-server> <I<machine name>> B<-file> <I<log file to examine>>
-    [B<-cell> <I<cell name>>] [B<-noauth>] [B<-localauth>] [B<-help>]
+=for html
+<div class="synopsis">
 
-B<bos getl> B<-s> <I<machine name>> B<-f> <I<log file to examine>>
-    [B<-c> <I<cell name>>] [B<-n>] [B<-l>] [B<-h>]
+B<bos getlog> S<<< B<-server> <I<machine name>> >>> S<<< B<-file> <I<log file to examine>> >>>
+    S<<< [B<-cell> <I<cell name>>] >>> [B<-noauth>] [B<-localauth>] [B<-help>]
+
+B<bos getl> S<<< B<-s> <I<machine name>> >>> S<<< B<-f> <I<log file to examine>> >>>
+    S<<< [B<-c> <I<cell name>>] >>> [B<-n>] [B<-l>] [B<-h>]
+
+=for html
+</div>
 
 =head1 DESCRIPTION
 
@@ -116,16 +122,16 @@ The remainder of the output depends on the particular log file.
 =head1 EXAMPLES
 
 The following example displays the FileLog file from the machine
-C<fs3.abc.com>:
+C<fs3.example.com>:
 
-   % bos getlog -server fs3.abc.com -file FileLog
+   % bos getlog -server fs3.example.com -file FileLog
    Fetching log file 'FileLog'...
    Sun Nov 8 04:00:34 1998 File server starting
-   Sun Nov 8 04:00:39 1998 Partition /vicepa:  attached 21 volumes; 
+   Sun Nov 8 04:00:39 1998 Partition /vicepa:  attached 21 volumes;
                            0 volumes not attached
-   Sun Nov 8 04:00:40 1998 File Server started Sun Nov 8 04:00:40 
+   Sun Nov 8 04:00:40 1998 File Server started Sun Nov 8 04:00:40
                            1998
-   Mon Nov 9 21:45:06 1998 CB: RCallBack (zero fid probe in host.c) 
+   Mon Nov 9 21:45:06 1998 CB: RCallBack (zero fid probe in host.c)
                            failed for host 28cf37c0.22811
 
 =head1 PRIVILEGE REQUIRED
@@ -135,6 +141,9 @@ machine named by the B<-server> argument, or must be logged onto a server
 machine as the local superuser C<root> if the B<-localauth> flag is
 included.
 
+When a server is in restricted mode, B<bos getlog> B<-file> may only
+specify files from the logs directory.
+
 =head1 SEE ALSO
 
 L<bos(8)>