fstrace: add dump -debug option

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

diff --git a/doc/man-pages/pod8/fstrace_dump.pod b/doc/man-pages/pod8/fstrace_dump.pod
index ea9f257..d1031ff 100644 (file)
--- a/doc/man-pages/pod8/fstrace_dump.pod
+++ b/doc/man-pages/pod8/fstrace_dump.pod
@@ -1,17 +1,29 @@
 =head1 NAME
 
-fstrace dump - Dumps a trace log
+fstrace_dump - Dumps a trace log
 
 =head1 SYNOPSIS
 
-B<fstrace dump> [B<-set> <I<set name>>+] [B<-follow> <I<log name>>]
-    [B<-file> <I<output filename>>] [B<-sleep> <I<seconds between reads>>]
+=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>>] >>>
+    S<<< [B<-debug>] >>>
     [B<-help>]
 
-B<fstrace d> [B<-se> <I<set name>>+] [B<-fo> <I<log name>>]
-    [B<-fi> <I<output filename>>] [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>>] >>>
+    S<<< [B<-d>] >>>
     [B<-h>]
 
+=for html
+</div>
+
 =head1 DESCRIPTION
 
 The B<fstrace dump> command displays the current contents of the C<cmfx>
@@ -21,7 +33,8 @@ the B<-file> argument.
 To write the log continuously to the standard output stream or to a file,
 use the B<-follow> argument. By default, the log's contents are written
 out every ten seconds and then automatically cleared. To change the
-interval between writes, use the B<-sleep> argument.
+interval between writes, use the B<-sleep> argument.  To display the raw
+format of each trace log entry, use the B<-debug> argument.
 
 =head1 CAUTIONS
 
@@ -75,6 +88,11 @@ Sets the number of seconds between writes of the trace log's contents when
 it is dumped continuously. Provide the B<-follow> argument along with this
 one. If this argument is omitted, the default interval is ten seconds.
 
+=item B<-debug>
+
+Specifies that each record in the trace log should be displayed in its raw
+hex format as well as the normal decoded output.
+
 =item B<-help>
 
 Prints the online help for this command. All other valid options are
@@ -186,6 +204,8 @@ completed:
 
    AFS Trace Dump - Completed
 
+=back
+
 =head1 EXAMPLES
 
 The following command dumps the log associated with the cm event set to