update quickstart html

[lttv.git] / trunk / lttv / QUICKSTART.html

diff --git a/trunk/lttv/QUICKSTART.html b/trunk/lttv/QUICKSTART.html
index 0dff574bb313bca7ba818943c8bb2e51d3a33366..77531afeaf2cfda665ad6743cda24a4595d07dff 100644 (file)
--- a/trunk/lttv/QUICKSTART.html
+++ b/trunk/lttv/QUICKSTART.html
@@ -34,7 +34,6 @@ to follow to trace a system and view it. The third part explains
 briefly how to add a new trace point to the kernel and to user space
 applications. The fourth and last part explains how to create Debian or RPM
 packages from the LTTng and LTTV sources.
 briefly how to add a new trace point to the kernel and to user space
 applications. The fourth and last part explains how to create Debian or RPM
 packages from the LTTng and LTTV sources.

-

 <p>
 These operations are made for installing the LTTng 0.86 tracer on a linux 2.6.X
 kernel. You will also find instructions for installation of LTTV 0.12.x : the
 <p>
 These operations are made for installing the LTTng 0.86 tracer on a linux 2.6.X
 kernel. You will also find instructions for installation of LTTV 0.12.x : the


@@ -338,11 +337,11 @@ system)
 ./configure
 make
 make install
 ./configure
 make
 make install

-
+</PRE>

 
 <li>Getting and installing the markers-userspace package for user space
 tracing (experimental)</li>
 
 <li>Getting and installing the markers-userspace package for user space
 tracing (experimental)</li>

-
+<p>

 See <a
 href="http://ltt.polymtl.ca/packages/markers-userspace-0.5.tar.bz2">markers-userspace-0.5.tar.bz2</a> or more recent.
 
 See <a
 href="http://ltt.polymtl.ca/packages/markers-userspace-0.5.tar.bz2">markers-userspace-0.5.tar.bz2</a> or more recent.
 


@@ -352,13 +351,11 @@ href="http://ltt.polymtl.ca/packages/markers-userspace-0.5.tar.bz2">markers-user
 <h2><a href="#TOCsection3" name="section3">Using LTTng and LTTV</a></h2>
 
 <li>IMPORTANT : Arm Linux Kernel Markers after each boot</li>
 <h2><a href="#TOCsection3" name="section3">Using LTTng and LTTV</a></h2>
 
 <li>IMPORTANT : Arm Linux Kernel Markers after each boot</li>

-

 <PRE>
 ltt-armall
 </PRE>
 
 <li>Use graphical LTTV to control tracing and analyse traces</li>
 <PRE>
 ltt-armall
 </PRE>
 
 <li>Use graphical LTTV to control tracing and analyse traces</li>

-

 <PRE>
 lttv-gui (or /usr/local/bin/lttv-gui)
   - Spot the "Tracing Control" icon : click on it
 <PRE>
 lttv-gui (or /usr/local/bin/lttv-gui)
   - Spot the "Tracing Control" icon : click on it


@@ -371,7 +368,6 @@ lttv-gui (or /usr/local/bin/lttv-gui)
 </PRE>
 
 <li>Use text mode LTTng to control tracing</li>
 </PRE>
 
 <li>Use text mode LTTng to control tracing</li>

-

 <PRE>
 The tracing can be controlled from a terminal by using the lttctl command (as
 root).
 <PRE>
 The tracing can be controlled from a terminal by using the lttctl command (as
 root).


@@ -386,7 +382,6 @@ lttctl -D trace1
 
 see lttctl --help for details.
 <PRE>
 
 see lttctl --help for details.
 <PRE>

-

 <p>
 (note : to see if the buffers has been filled, look at the dmesg output after
 lttctl -R or after stopping tracing from the GUI, it will show an event lost
 <p>
 (note : to see if the buffers has been filled, look at the dmesg output after
 lttctl -R or after stopping tracing from the GUI, it will show an event lost


@@ -395,21 +390,16 @@ how. lttv now also shows event lost messages in the console when loading a trace
 with missing events or lost subbuffers.)
 
 <li>Use text mode LTTV</li>
 with missing events or lost subbuffers.)
 
 <li>Use text mode LTTV</li>

-

 <p>
 Feel free to look in /usr/local/lib/lttv/plugins to see all the text and
 graphical plugins available.
 <p>
 Feel free to look in /usr/local/lib/lttv/plugins to see all the text and
 graphical plugins available.

-

 <p>
 For example, a simple trace dump in text format is available with :
 <p>
 For example, a simple trace dump in text format is available with :

-

 <PRE>
 lttv -m textDump -t /tmp/trace
 </PRE>
 <PRE>
 lttv -m textDump -t /tmp/trace
 </PRE>

-

 <p>
 See lttv -m textDump --help for detailed command line options of textDump.
 <p>
 See lttv -m textDump --help for detailed command line options of textDump.

-

 <p>
 It is, in the current state of the project, very useful to use "grep" on the
 text output to filter by specific event fields. You can later copy the timestamp
 <p>
 It is, in the current state of the project, very useful to use "grep" on the
 text output to filter by specific event fields. You can later copy the timestamp


@@ -418,18 +408,15 @@ bottom right label "Current time". Support for this type of filtering should
 be added to the filter module soon.
 
 <li>Hybrid mode</li>
 be added to the filter module soon.
 
 <li>Hybrid mode</li>

-

 <p>
 Starting from LTTng 0.5.105 and ltt-control 0.20, a new mode can be used :
 hybrid. It can be especially useful when studying big workloads on a long period
 of time.
 <p>
 Starting from LTTng 0.5.105 and ltt-control 0.20, a new mode can be used :
 hybrid. It can be especially useful when studying big workloads on a long period
 of time.

-

 <p>
 When using this mode, the most important, low rate control information will be
 recorded during all the trace by lttd (i.e. process creation/exit). The high
 rate information (i.e. interrupt/traps/syscall entry/exit) will be kept in a
 flight recorder buffer (now named flight-channelname_X).
 <p>
 When using this mode, the most important, low rate control information will be
 recorded during all the trace by lttd (i.e. process creation/exit). The high
 rate information (i.e. interrupt/traps/syscall entry/exit) will be kept in a
 flight recorder buffer (now named flight-channelname_X).

-

 <p>
 The following lttctl commands take an hybrid trace :
 <p>
 <p>
 The following lttctl commands take an hybrid trace :
 <p>


@@ -446,15 +433,12 @@ lttctl -D -w /tmp/trace2 trace2
 Each "overwrite" channel is flight recorder channel.
 
 <li>Flight recorder mode</li>
 Each "overwrite" channel is flight recorder channel.
 
 <li>Flight recorder mode</li>

-

 <p>
 The flight recorder mode writes data into overwritten buffers for all channels,
 including control channels, except for the facilities tracefiles. It consists of
 setting all channels to "overwrite".
 <p>
 The flight recorder mode writes data into overwritten buffers for all channels,
 including control channels, except for the facilities tracefiles. It consists of
 setting all channels to "overwrite".

-

 <p>
 The following lttctl commands take a flight recorder trace :
 <p>
 The following lttctl commands take a flight recorder trace :

-

 <PRE>
 lttctl -C -w /tmp/trace3 -o channel.all.overwrite=1 trace3
 ...
 <PRE>
 lttctl -C -w /tmp/trace3 -o channel.all.overwrite=1 trace3
 ...