Update fstrace suite manpages
authorDavor Ocelic <docelic@spinlocksolutions.com>
Thu, 8 Oct 2009 20:58:31 +0000 (22:58 +0200)
committerJeffrey Altman <jaltman|account-1000011@unknown>
Thu, 8 Oct 2009 22:28:56 +0000 (15:28 -0700)
 -- Add missing POD links (L<>)

 -- Verify all subcommands and options

 -- Format > 80 columns synopsis lines

Reviewed-on: http://gerrit.openafs.org/616
Tested-by: Jeffrey Altman <jaltman@openafs.org>
Reviewed-by: Jeffrey Altman <jaltman@openafs.org>

doc/man-pages/pod8/fstrace.pod
doc/man-pages/pod8/fstrace_apropos.pod
doc/man-pages/pod8/fstrace_clear.pod
doc/man-pages/pod8/fstrace_dump.pod
doc/man-pages/pod8/fstrace_lslog.pod
doc/man-pages/pod8/fstrace_setlog.pod
doc/man-pages/pod8/fstrace_setset.pod

index b9cc6f8..55459e2 100644 (file)
@@ -27,20 +27,26 @@ There are several categories of commands in the B<fstrace> command suite:
 =item *
 
 Commands to administer or display information about the trace log:
-B<fstrace clear>, B<fstrace lslog>, B<fstrace setlog>.
+L<B<fstrace clear>|fstrace_clear(8)>,
+L<B<fstrace lslog>|fstrace_lslog(8)>,
+and L<B<fstrace setlog>|fstrace_setlog(8)>.
 
 =item *
 
-Commands to set or display the status of the event set: B<fstrace lsset>
-and B<fstrace setset>.
+Commands to set or display the status of the event set:
+L<B<fstrace lsset>|fstrace_lsset(8)>
+and L<B<fstrace setset>|fstrace_setset(8)>.
 
 =item *
 
-A command to display the contents of the trace log: B<fstrace dump>.
+A command to display the contents of the trace log:
+L<B<fstrace dump>|fstrace_dump(8)>.
 
 =item *
 
-Commands to obtain help: B<fstrace apropos> and B<fstrace help>.
+Commands to obtain help:
+L<B<fstrace apropos>|fstrace_apropos(8)>
+and L<B<fstrace help>|fstrace_help(8)>.
 
 =back
 
index f24c8c3..eed02bc 100644 (file)
@@ -9,7 +9,7 @@ fstrace_apropos - Displays each help entry containing a keyword string
 
 B<fstrace apropos> S<<< B<-topic> <I<help string>> >>> [B<-help>]
 
-B<fstrace ap> S<<< B<-t> <I<help string>> >>> [B<-h>]
+B<fstrace a> S<<< B<-t> <I<help string>> >>> [B<-h>]
 
 =for html
 </div>
index 7de9e6b..c6b4eda 100644 (file)
@@ -7,10 +7,12 @@ fstrace_clear - Clears the trace log
 =for html
 <div class="synopsis">
 
-B<fstrace clear> S<<< [B<-set> <I<set name>>+] >>> S<<< [B<-log> <I<log name>>+] >>>
+B<fstrace clear> S<<< [B<-set> <I<set name>>+] >>>
+    S<<< [B<-log> <I<log name>>+] >>>
     [B<-help>]
 
-B<fstrace c> S<<< [B<-s> <I<set name>>+] >>> S<<< [B<-l> <I<log name>>+] >>> [B<-h>]
+B<fstrace c> S<<< [B<-s> <I<set name>>+] >>>
+    S<<< [B<-l> <I<log name>>+] >>> [B<-h>]
 
 =for html
 </div>
index 81d659d..92c5224 100644 (file)
@@ -7,12 +7,16 @@ fstrace_dump - Dumps a trace log
 =for html
 <div class="synopsis">
 
-B<fstrace dump> S<<< [B<-set> <I<set name>>+] >>> S<<< [B<-follow> <I<log name>>] >>>
-    S<<< [B<-file> <I<output filename>>] >>> S<<< [B<-sleep> <I<seconds between reads>>] >>>
+B<fstrace dump> S<<< [B<-set> <I<set name>>+] >>>
+    S<<< [B<-follow> <I<log name>>] >>>
+    S<<< [B<-file> <I<output filename>>] >>>
+    S<<< [B<-sleep> <I<seconds between reads>>] >>>
     [B<-help>]
 
-B<fstrace d> S<<< [B<-se> <I<set name>>+] >>> S<<< [B<-fo> <I<log name>>] >>>
-    S<<< [B<-fi> <I<output filename>>] >>> S<<< [B<-sl> <I<seconds between reads>>] >>>
+B<fstrace d> S<<< [B<-se> <I<set name>>+] >>>
+    S<<< [B<-fo> <I<log name>>] >>>
+    S<<< [B<-fi> <I<output filename>>] >>>
+    S<<< [B<-sl> <I<seconds between reads>>] >>>
     [B<-h>]
 
 =for html
index 41289cf..6a9d45e 100644 (file)
@@ -7,11 +7,13 @@ fstrace_lslog - Displays information about a log
 =for html
 <div class="synopsis">
 
-B<fstrace lslog> S<<< [B<-set> <I<set name>>+] >>> S<<< [B<-log> <I<log name>>] >>>
+B<fstrace lslog> S<<< [B<-set> <I<set name>>+] >>>
+    S<<< [B<-log> <I<log name>>] >>>
     [B<-long>] [B<-help>]
 
-B<fstrace lsl> S<<< [B<-s> <I<set name>>+] >>> S<<< [B<-log> <I<log name>>] >>> [B<-lon>]
-    [B<-h>]
+B<fstrace lsl> S<<< [B<-s> <I<set name>>+] >>>
+    S<<< [B<-log> <I<log name>>] >>>
+    [B<-lon>] [B<-h>]
 
 =for html
 </div>
index c82962d..c8c037a 100644 (file)
@@ -10,9 +10,8 @@ fstrace_setlog - Sets the size of a trace log
 B<fstrace setlog> S<<< [B<-log> <I<log name>>+] >>>
     S<<< B<-buffersize> <I<1-kilobyte units>> >>> [B<-help>]
 
-B<fstrace setl> S<<< [B<-l> <I<log name>>+] >>> S<<< B<-b> <I<1-kilobyte units>> >>> [B<-h>]
-
-B<fstrace sl> S<<< [B<-l> <I<log name>>+] >>> S<<< B<-b> <I<1-kilobyte units>> >>> [B<-h>]
+B<fstrace setl> S<<< [B<-l> <I<log name>>+] >>>
+    S<<< B<-b> <I<1-kilobyte units>> >>> [B<-h>]
 
 =for html
 </div>
index 808e766..e9bbfa4 100644 (file)
@@ -7,10 +7,10 @@ fstrace_setset - Sets the status of an event set
 =for html
 <div class="synopsis">
 
-B<fstrace setset> S<<< [B<-set> <I<set name>>+] >>> [B<-active>] [B<-inactive>]
-    [B<-dormant>] [B<-help>]
+B<fstrace setset> S<<< [B<-set> <I<set name>>+] >>>
+    [B<-active>] [B<-inactive>] [B<-dormant>] [B<-help>]
 
-B<fs set> S<<< [B<-s> <I<set name>>+] >>> [B<-a>] [B<-i>] [B<-d>] [B<-h>]
+B<fs sets> S<<< [B<-s> <I<set name>>+] >>> [B<-a>] [B<-i>] [B<-d>] [B<-h>]
 
 =for html
 </div>