[lttv.git] / trunk / lttng-xenomai / LinuxTraceToolkitViewer-0.8.61-xenoltt / doc / user / user_guide / html / x125.html

<!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
>
Commit	Line	Data
b1053af5	1	<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN""http://www.w3.org/TR/html4/loose.dtd">
	2	<HTML
	3	><HEAD
	4	><TITLE
	5	>The text dump module</TITLE
	6	><META
	7	NAME="GENERATOR"
	8	CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
	9	REL="HOME"
	10	TITLE="Linux Trace Toolkit Viewer User Guide"
	11	HREF="index.html"><LINK
	12	REL="UP"
	13	TITLE="Using LTTV text modules"
54bfc655	14	HREF="c115.html"><LINK
b1053af5	15	REL="PREVIOUS"
b1053af5	16	TITLE="Using LTTV text modules"
54bfc655	17	HREF="c115.html"></HEAD
b1053af5	18	><BODY
	19	CLASS="sect1"
	20	BGCOLOR="#FFFFFF"
	21	TEXT="#000000"
	22	LINK="#0000FF"
	23	VLINK="#840084"
	24	ALINK="#0000FF"
	25	><DIV
	26	CLASS="NAVHEADER"
	27	><TABLE
	28	SUMMARY="Header navigation table"
	29	WIDTH="100%"
	30	BORDER="0"
	31	CELLPADDING="0"
	32	CELLSPACING="0"
	33	><TR
	34	><TH
	35	COLSPAN="3"
	36	ALIGN="center"
	37	>Linux Trace Toolkit Viewer User Guide</TH
	38	></TR
	39	><TR
	40	><TD
	41	WIDTH="10%"
	42	ALIGN="left"
	43	VALIGN="bottom"
	44	><A
54bfc655	45	HREF="c115.html"
b1053af5	46	ACCESSKEY="P"
	47	>Prev</A
	48	></TD
	49	><TD
	50	WIDTH="80%"
	51	ALIGN="center"
	52	VALIGN="bottom"
	53	>Chapter 4. Using LTTV text modules</TD
	54	><TD
	55	WIDTH="10%"
	56	ALIGN="right"
	57	VALIGN="bottom"
	58	> </TD
	59	></TR
	60	></TABLE
	61	><HR
	62	ALIGN="LEFT"
	63	WIDTH="100%"></DIV
	64	><DIV
	65	CLASS="sect1"
	66	><H1
	67	CLASS="sect1"
	68	><A
	69	NAME="textDump"
	70	>4.2. The text dump module</A
	71	></H1
	72	><P
	73	> The goal of this module is to convert the binary data of the traces into
	74	a formatted text file.
	75	</P
	76	><P
	77	> The text dump module is a good example of a usage of the batch analysis module
	78	backend. In fact, the text dump module depends on it. You don't need to
	79	explicitly load the batchAnalysis module though, as lttv offers a rich module
	80	backend that deals with the dependencies, loading the module automatically if
	81	needed.
	82	</P
	83	><P
	84	> The text dump module is invoked just like the batchAnalysis module. It adds more
	85	options that can be specified in argument. You may specify the -o switch for the
	86	output file name of the text dump. You can enable the output of the field names
	87	(the identifier of the fields) with the -l switch. The -s switch, for process
	88	states, is very useful to indicate the state in which the process is when the
	89	event happens.
	90	</P
	91	><P
	92	> If you use the --help option on the textDump module, you will see all the detail
	93	about the switches that can be used to show per cpu statistics and per process
	94	statistics. You will notice that you can use both the switches for the
	95	batchAnalysis module and those for textDump. You will also notice that the
	96	options --process_state (from textDump) and --stats (from batchAnalysis) has the
	97	same short name "-s". If you choose to invoke this option using the short name,
	98	it will use the option of the last module loaded just before the -s switch.
	99	</P
	100	><P
	101	> For exemple, if you load the textDump module with -m textDump, it will first
	102	load the batchAnalysis module, and then load itself. As it is the last module
	103	loaded, the -s switch used after it will signify --process_stats. On the other
	104	hand, if you choose to specify explicitly the loading of both modules like this
	105	:
	106	</P
	107	><PRE
	108	CLASS="screen"
	109	> <SAMP
110	CLASS="prompt"
111	>$</SAMP
112	> <KBD
113	CLASS="userinput"
114	>lttv -L path/to/lib/plugins -m batchAnalysis -s\
115	-m textDump -s -t trace</KBD
116	>
117	</PRE
118	><P
119	> The first "-s" will invoke batchAnalysis --stats and the second "-s" will invoke
120	textDump --process_state. The list of options generated by --help follows the
121	order of registration of the options by the modules, therefore the invocation
122	order of the modules.
123	</P
124	></DIV
125	><DIV
126	CLASS="NAVFOOTER"
127	><HR
128	ALIGN="LEFT"
129	WIDTH="100%"><TABLE
130	SUMMARY="Footer navigation table"
131	WIDTH="100%"
132	BORDER="0"
133	CELLPADDING="0"
134	CELLSPACING="0"
135	><TR
136	><TD
137	WIDTH="33%"
138	ALIGN="left"
139	VALIGN="top"
140	><A
54bfc655	141	HREF="c115.html"
b1053af5	142	ACCESSKEY="P"
	143	>Prev</A
	144	></TD
	145	><TD
	146	WIDTH="34%"
	147	ALIGN="center"
	148	VALIGN="top"
	149	><A
	150	HREF="index.html"
	151	ACCESSKEY="H"
	152	>Home</A
	153	></TD
	154	><TD
	155	WIDTH="33%"
	156	ALIGN="right"
	157	VALIGN="top"
	158	> </TD
	159	></TR
	160	><TR
	161	><TD
	162	WIDTH="33%"
	163	ALIGN="left"
	164	VALIGN="top"
	165	>Using LTTV text modules</TD
	166	><TD
	167	WIDTH="34%"
	168	ALIGN="center"
	169	VALIGN="top"
	170	><A
54bfc655	171	HREF="c115.html"
b1053af5	172	ACCESSKEY="U"
	173	>Up</A
	174	></TD
	175	><TD
	176	WIDTH="33%"
	177	ALIGN="right"
	178	VALIGN="top"
	179	> </TD
	180	></TR
	181	></TABLE
	182	></DIV
	183	></BODY
	184	></HTML
	185	>