add lttctl explanation

[lttv.git] / ltt / branches / poly / QUICKSTART

diff --git a/ltt/branches/poly/QUICKSTART b/ltt/branches/poly/QUICKSTART
index 426fc711afc166c64d996240e8cfa0fd29ac0aa8..59ffb96e9a4cdd4b8468612476ffe8674a02232d 100644 (file)
--- a/ltt/branches/poly/QUICKSTART
+++ b/ltt/branches/poly/QUICKSTART
@@ -3,12 +3,36 @@ QUICKSTART
 
 How to use LTTng and LTTV in a few lines :
 
+This document is made of four parts : The first one explains how to install
+LTTng and LTTV from Debian and RPM binary packages, the second one explains how
+to install LTTng and LTTV from sources and the third one describes the steps
+to follow to trace a system and view it. The fourth and last part explains
+briefly how to add a new trace point to the kernel.
+
+What you will typically want is to read sections 1 and 3 : install LTTng from
+binary packages and use it. If there are no packages ready for your system, you
+will have to install from sources (section 2) instead.
+
 These operations are made for installing LTTng 0.2 on a linux 2.6.12-rc2-mm2
 kernel. Change the versions to fit your needs.
 
 Author : Mathieu Desnoyers, September 2005
 
 
+
+***********************************************************
+** Section 1 * Installation from Debian or RPM packages  **
+***********************************************************
+
+No Debian or RPM packages are ready yet.
+
+TODO
+
+
+***********************************************************
+** Section 2 * Installation from sources                 **
+***********************************************************
+
 * Getting the LTTng packages
 
 su -
@@ -49,6 +73,10 @@ make menuconfig
 make
 make install
 make modules_install
+
+Depending on your boot loader, you may want to execute :
+update-grub or lilo
+
 reboot
 
 
@@ -70,23 +98,65 @@ echo ltt-control >> /etc/modules
 
 su -
 cd /usr/src
-wget http://ltt.polymtl.ca/packages/LinuxTraceToolkitViewer-0.5-16092005.tar.gz
-gzip -cd LinuxTraceToolkitViewer-0.5-16092005.tar.gz | tar xvof -
-cd LinuxTraceToolkitViewer-0.5-16092005
+wget http://ltt.polymtl.ca/packages/LinuxTraceToolkitViewer-0.6.1-16092005.tar.gz
+gzip -cd LinuxTraceToolkitViewer-0.6.1-16092005.tar.gz | tar xvof -
+cd LinuxTraceToolkitViewer-0.6.1-16092005
+(refer to README to see the development libraries that must be installed on you
+system)
 ./configure
 make
 make install
 
-* Use LTTV
+
+
+
+***********************************************************
+** Section 3 * Using LTTng and LTTV                      **
+***********************************************************
+
+* Use graphical LTTV to control tracing and analyse traces
 
 lttv-gui (or /usr/local/bin/lttv-gui)
-  - Spot the "Trace Control" icon : click on it
+  - Spot the "Tracing Control" icon : click on it
+      (it's a traffic light icon)
     - enter the root password
     - click "start"
     - click "stop"
     - Yes
       * You should now see a trace
 
+* Use text mode LTTng to control tracing
+
+The tracing can be controlled from a terminal by using the lttctl command.
+
+Start tracing :
+
+lttctl -n trace -d -l /mnt/relayfs/ltt -t /tmp/trace1
+
+Stop tracing and destroy trace channels :
+
+lttctl -n trace -R
+
+see lttctl --help for details.
+
+
+* Use text mode LTTV
+
+Fell free to look in /usr/local/lib/lttv/plugins to see all the text and
+graphical plugins available.
+
+For example, a simple trace dump in text format is available with :
+
+lttv -m textDump -t /tmp/trace
+
+see lttv -m textDump --help for detailed command line options of textDump.
+
+
+
+
+***********************************************************
+** Section 4 * Adding new instrumentations with genevent **
+***********************************************************
 
 * Getting and installing genevent