move lttv to root
[lttv.git] / doc / user / user_guide / html / x125.html
diff --git a/doc/user/user_guide/html/x125.html b/doc/user/user_guide/html/x125.html
new file mode 100644 (file)
index 0000000..864f17d
--- /dev/null
@@ -0,0 +1,185 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN""http://www.w3.org/TR/html4/loose.dtd">
+<HTML
+><HEAD
+><TITLE
+>The text dump module</TITLE
+><META
+NAME="GENERATOR"
+CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
+REL="HOME"
+TITLE="Linux Trace Toolkit Viewer User Guide"
+HREF="index.html"><LINK
+REL="UP"
+TITLE="Using LTTV text modules"
+HREF="c115.html"><LINK
+REL="PREVIOUS"
+TITLE="Using LTTV text modules"
+HREF="c115.html"></HEAD
+><BODY
+CLASS="sect1"
+BGCOLOR="#FFFFFF"
+TEXT="#000000"
+LINK="#0000FF"
+VLINK="#840084"
+ALINK="#0000FF"
+><DIV
+CLASS="NAVHEADER"
+><TABLE
+SUMMARY="Header navigation table"
+WIDTH="100%"
+BORDER="0"
+CELLPADDING="0"
+CELLSPACING="0"
+><TR
+><TH
+COLSPAN="3"
+ALIGN="center"
+>Linux Trace Toolkit Viewer User Guide</TH
+></TR
+><TR
+><TD
+WIDTH="10%"
+ALIGN="left"
+VALIGN="bottom"
+><A
+HREF="c115.html"
+ACCESSKEY="P"
+>Prev</A
+></TD
+><TD
+WIDTH="80%"
+ALIGN="center"
+VALIGN="bottom"
+>Chapter 4. Using LTTV text modules</TD
+><TD
+WIDTH="10%"
+ALIGN="right"
+VALIGN="bottom"
+>&nbsp;</TD
+></TR
+></TABLE
+><HR
+ALIGN="LEFT"
+WIDTH="100%"></DIV
+><DIV
+CLASS="sect1"
+><H1
+CLASS="sect1"
+><A
+NAME="textDump"
+>4.2. The text dump module</A
+></H1
+><P
+>&#13; The goal of this module is to convert the binary data of the traces into
+a formatted text file.
+</P
+><P
+>&#13;The text dump module is a good example of a usage of the batch analysis module
+backend. In fact, the text dump module depends on it. You don't need to
+explicitly load the batchAnalysis module though, as lttv offers a rich module
+backend that deals with the dependencies, loading the module automatically if
+needed.
+</P
+><P
+>&#13;The text dump module is invoked just like the batchAnalysis module. It adds more
+options that can be specified in argument. You may specify the -o switch for the
+output file name of the text dump. You can enable the output of the field names
+(the identifier of the fields) with the -l switch. The -s switch, for process
+states, is very useful to indicate the state in which the process is when the
+event happens.
+</P
+><P
+>&#13;If you use the --help option on the textDump module, you will see all the detail
+about the switches that can be used to show per cpu statistics and per process
+statistics. You will notice that you can use both the switches for the
+batchAnalysis module and those for textDump. You will also notice that the
+options --process_state (from textDump) and --stats (from batchAnalysis) has the
+same short name "-s". If you choose to invoke this option using the short name,
+it will use the option of the last module loaded just before the -s switch.
+</P
+><P
+>&#13;For exemple, if you load the textDump module with -m textDump, it will first
+load the batchAnalysis module, and then load itself. As it is the last module
+loaded, the -s switch used after it will signify --process_stats. On the other
+hand, if you choose to specify explicitly the loading of both modules like this
+:
+</P
+><PRE
+CLASS="screen"
+>&#13;<SAMP
+CLASS="prompt"
+>$</SAMP
+> <KBD
+CLASS="userinput"
+>lttv -L path/to/lib/plugins -m batchAnalysis -s\
+-m textDump -s -t trace</KBD
+>
+</PRE
+><P
+>&#13;The first "-s" will invoke batchAnalysis --stats and the second "-s" will invoke
+textDump --process_state. The list of options generated by --help follows the
+order of registration of the options by the modules, therefore the invocation 
+order of the modules.
+</P
+></DIV
+><DIV
+CLASS="NAVFOOTER"
+><HR
+ALIGN="LEFT"
+WIDTH="100%"><TABLE
+SUMMARY="Footer navigation table"
+WIDTH="100%"
+BORDER="0"
+CELLPADDING="0"
+CELLSPACING="0"
+><TR
+><TD
+WIDTH="33%"
+ALIGN="left"
+VALIGN="top"
+><A
+HREF="c115.html"
+ACCESSKEY="P"
+>Prev</A
+></TD
+><TD
+WIDTH="34%"
+ALIGN="center"
+VALIGN="top"
+><A
+HREF="index.html"
+ACCESSKEY="H"
+>Home</A
+></TD
+><TD
+WIDTH="33%"
+ALIGN="right"
+VALIGN="top"
+>&nbsp;</TD
+></TR
+><TR
+><TD
+WIDTH="33%"
+ALIGN="left"
+VALIGN="top"
+>Using LTTV text modules</TD
+><TD
+WIDTH="34%"
+ALIGN="center"
+VALIGN="top"
+><A
+HREF="c115.html"
+ACCESSKEY="U"
+>Up</A
+></TD
+><TD
+WIDTH="33%"
+ALIGN="right"
+VALIGN="top"
+>&nbsp;</TD
+></TR
+></TABLE
+></DIV
+></BODY
+></HTML
+>
\ No newline at end of file
This page took 0.028132 seconds and 4 git commands to generate.