From a6e15c992e0d1d4a6934917acacc864160846eb0 Mon Sep 17 00:00:00 2001 From: Davor Ocelic Date: Thu, 8 Oct 2009 22:58:31 +0200 Subject: [PATCH] Update fstrace suite manpages -- 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 Reviewed-by: Jeffrey Altman --- doc/man-pages/pod8/fstrace.pod | 16 +++++++++++----- doc/man-pages/pod8/fstrace_apropos.pod | 2 +- doc/man-pages/pod8/fstrace_clear.pod | 6 ++++-- doc/man-pages/pod8/fstrace_dump.pod | 12 ++++++++---- doc/man-pages/pod8/fstrace_lslog.pod | 8 +++++--- doc/man-pages/pod8/fstrace_setlog.pod | 5 ++--- doc/man-pages/pod8/fstrace_setset.pod | 6 +++--- 7 files changed, 34 insertions(+), 21 deletions(-) diff --git a/doc/man-pages/pod8/fstrace.pod b/doc/man-pages/pod8/fstrace.pod index b9cc6f8f8..55459e2ce 100644 --- a/doc/man-pages/pod8/fstrace.pod +++ b/doc/man-pages/pod8/fstrace.pod @@ -27,20 +27,26 @@ There are several categories of commands in the B command suite: =item * Commands to administer or display information about the trace log: -B, B, B. +L|fstrace_clear(8)>, +L|fstrace_lslog(8)>, +and L|fstrace_setlog(8)>. =item * -Commands to set or display the status of the event set: B -and B. +Commands to set or display the status of the event set: +L|fstrace_lsset(8)> +and L|fstrace_setset(8)>. =item * -A command to display the contents of the trace log: B. +A command to display the contents of the trace log: +L|fstrace_dump(8)>. =item * -Commands to obtain help: B and B. +Commands to obtain help: +L|fstrace_apropos(8)> +and L|fstrace_help(8)>. =back diff --git a/doc/man-pages/pod8/fstrace_apropos.pod b/doc/man-pages/pod8/fstrace_apropos.pod index f24c8c378..eed02bc9f 100644 --- a/doc/man-pages/pod8/fstrace_apropos.pod +++ b/doc/man-pages/pod8/fstrace_apropos.pod @@ -9,7 +9,7 @@ fstrace_apropos - Displays each help entry containing a keyword string B S<<< B<-topic> > >>> [B<-help>] -B S<<< B<-t> > >>> [B<-h>] +B S<<< B<-t> > >>> [B<-h>] =for html diff --git a/doc/man-pages/pod8/fstrace_clear.pod b/doc/man-pages/pod8/fstrace_clear.pod index 7de9e6bac..c6b4edaf7 100644 --- a/doc/man-pages/pod8/fstrace_clear.pod +++ b/doc/man-pages/pod8/fstrace_clear.pod @@ -7,10 +7,12 @@ fstrace_clear - Clears the trace log =for html
-B S<<< [B<-set> >+] >>> S<<< [B<-log> >+] >>> +B S<<< [B<-set> >+] >>> + S<<< [B<-log> >+] >>> [B<-help>] -B S<<< [B<-s> >+] >>> S<<< [B<-l> >+] >>> [B<-h>] +B S<<< [B<-s> >+] >>> + S<<< [B<-l> >+] >>> [B<-h>] =for html
diff --git a/doc/man-pages/pod8/fstrace_dump.pod b/doc/man-pages/pod8/fstrace_dump.pod index 81d659d8b..92c522443 100644 --- a/doc/man-pages/pod8/fstrace_dump.pod +++ b/doc/man-pages/pod8/fstrace_dump.pod @@ -7,12 +7,16 @@ fstrace_dump - Dumps a trace log =for html
-B S<<< [B<-set> >+] >>> S<<< [B<-follow> >] >>> - S<<< [B<-file> >] >>> S<<< [B<-sleep> >] >>> +B S<<< [B<-set> >+] >>> + S<<< [B<-follow> >] >>> + S<<< [B<-file> >] >>> + S<<< [B<-sleep> >] >>> [B<-help>] -B S<<< [B<-se> >+] >>> S<<< [B<-fo> >] >>> - S<<< [B<-fi> >] >>> S<<< [B<-sl> >] >>> +B S<<< [B<-se> >+] >>> + S<<< [B<-fo> >] >>> + S<<< [B<-fi> >] >>> + S<<< [B<-sl> >] >>> [B<-h>] =for html diff --git a/doc/man-pages/pod8/fstrace_lslog.pod b/doc/man-pages/pod8/fstrace_lslog.pod index 41289cff8..6a9d45e88 100644 --- a/doc/man-pages/pod8/fstrace_lslog.pod +++ b/doc/man-pages/pod8/fstrace_lslog.pod @@ -7,11 +7,13 @@ fstrace_lslog - Displays information about a log =for html
-B S<<< [B<-set> >+] >>> S<<< [B<-log> >] >>> +B S<<< [B<-set> >+] >>> + S<<< [B<-log> >] >>> [B<-long>] [B<-help>] -B S<<< [B<-s> >+] >>> S<<< [B<-log> >] >>> [B<-lon>] - [B<-h>] +B S<<< [B<-s> >+] >>> + S<<< [B<-log> >] >>> + [B<-lon>] [B<-h>] =for html
diff --git a/doc/man-pages/pod8/fstrace_setlog.pod b/doc/man-pages/pod8/fstrace_setlog.pod index c82962d61..c8c037ada 100644 --- a/doc/man-pages/pod8/fstrace_setlog.pod +++ b/doc/man-pages/pod8/fstrace_setlog.pod @@ -10,9 +10,8 @@ fstrace_setlog - Sets the size of a trace log B S<<< [B<-log> >+] >>> S<<< B<-buffersize> > >>> [B<-help>] -B S<<< [B<-l> >+] >>> S<<< B<-b> > >>> [B<-h>] - -B S<<< [B<-l> >+] >>> S<<< B<-b> > >>> [B<-h>] +B S<<< [B<-l> >+] >>> + S<<< B<-b> > >>> [B<-h>] =for html
diff --git a/doc/man-pages/pod8/fstrace_setset.pod b/doc/man-pages/pod8/fstrace_setset.pod index 808e76693..e9bbfa44e 100644 --- a/doc/man-pages/pod8/fstrace_setset.pod +++ b/doc/man-pages/pod8/fstrace_setset.pod @@ -7,10 +7,10 @@ fstrace_setset - Sets the status of an event set =for html
-B S<<< [B<-set> >+] >>> [B<-active>] [B<-inactive>] - [B<-dormant>] [B<-help>] +B S<<< [B<-set> >+] >>> + [B<-active>] [B<-inactive>] [B<-dormant>] [B<-help>] -B S<<< [B<-s> >+] >>> [B<-a>] [B<-i>] [B<-d>] [B<-h>] +B S<<< [B<-s> >+] >>> [B<-a>] [B<-i>] [B<-d>] [B<-h>] =for html
-- 2.39.5