doc: fix some broken link specifications
[openafs.git] / doc / man-pages / pod1 / scout.pod
index e4db177..baf7522 100644 (file)
@@ -4,23 +4,31 @@ scout - Monitors the File Server process
 
 =head1 SYNOPSIS
 
-B<scout> [B<initcmd>] B<-server> <I<servers to monitor>>+
-      [B<-basename> <I<base server name>>]
-      [B<-frequency> <I<poll frequency, in seconds>>] [B<-host>]
-      [B<-attention> <I<specify attention (highlighting) level>>+]
-      [B<-debug> <I<turn debugging output on to the named file>>]
+=for html
+<div class="synopsis">
+
+B<scout> [B<initcmd>] S<<< B<-server> <I<servers to monitor>>+ >>>
+      S<<< [B<-basename> <I<base server name>>] >>>
+      S<<< [B<-frequency> <I<poll frequency, in seconds>>] >>> [B<-host>]
+      S<<< [B<-attention> <I<specify attention (highlighting) level>>+] >>>
+      S<<< [B<-columnwidths> <I<number of characters>>+] >>>
+      S<<< [B<-debug> <I<turn debugging output on to the named file>>] >>>
       [B<-help>]
 
-B<scout> [B<i>] B<-s> <I<servers to monitor>>+
-      [B<-b> <I<base server name>>] [B<-f> <I<poll frequency, in seconds>>]
-      [B<-ho>] [B<-a> <I<specify attention (highlighting) level>>+]
-      [B<-d> <I<turn debugging output on to the named file>>] [B<-he>]
+B<scout> [B<i>] S<<< B<-s> <I<servers to monitor>>+ >>>
+      S<<< [B<-b> <I<base server name>>] >>> S<<< [B<-f> <I<poll frequency, in seconds>>] >>>
+      [B<-ho>] S<<< [B<-a> <I<specify attention (highlighting) level>>+] >>>
+      S<<< [B<-c> <I<number of characters>+>] >>>
+      S<<< [B<-d> <I<turn debugging output on to the named file>>] >>> [B<-he>]
+
+=for html
+</div>
 
 =head1 DESCRIPTION
 
 The scout command displays statistics gathered from the File Server
 process running on each machine specified with the B<-server>
-argument. L<OUTPUT> explains the meaning of the statistics and describes
+argument. L</OUTPUT> explains the meaning of the statistics and describes
 how they appear in the command shell, which is preferably a window managed
 by a window manager program.
 
@@ -149,6 +157,14 @@ Example of an acceptable value: ws 65
 
 =back
 
+=item B<-columnwidths> <I<number of characters>>+
+
+Specifies the number of characters to display in each column of the B<scout>
+statistics display region. Specify one to six numbers separated by spaces to
+set the number of characters to be displayed in each column.  The values
+specify the widths of the columns in the same order the columns are displayed
+from left to right.  Use 0 as a placeholder to specify a default column width.
+
 =item B<-debug> <I<debugging trace file>>
 
 Specifies the pathname of the file into which to write a debugging
@@ -301,7 +317,7 @@ of 60 seconds.
 
 =head1 EXAMPLES
 
-See the chapter on monitoring tools in the I<IBM AFS Administration
+See the chapter on monitoring tools in the I<OpenAFS Administration
 Guide>, which illustrates the displays that result from different
 combinations of options.