Add usage section to README
[lttng-tools.git] / README
diff --git a/README b/README
index a9b6dcb8c0b82ac92d47a42b669e59094b31195e..afdbf2311c10da73d195072551b3348ef13a4f14 100644 (file)
--- a/README
+++ b/README
@@ -5,67 +5,71 @@ Please visit http://lttng.org for more information.
 
 Latest development can be found at:
 
-       * Gitweb :      http://git.lttng.org/lttng-tools.git/
-       * Git :         git://git.lttng.org/lttng-tools.git
+    * Gitweb :  http://git.lttng.org/lttng-tools.git/
+    * Git :     git://git.lttng.org/lttng-tools.git
 
-PREREQUISITES:
+REQUIREMENTS:
 
-       - libuuid
-         Universally unique id library - headers and static libraries libuuid
-         generates and parses 128-bit universally unique ids (UUIDs). See RFC
-         4122 for more information.
+    - liburcu
+      Userspace RCU library, by Mathieu Desnoyers and Paul E. McKenney
 
-         * Debian/Ubuntu package: uuid-dev
+      -> Tested with liburcu >= v0.5.4
 
-       - liburcu
-         Userspace RCU library, by Mathieu Desnoyers and Paul E. McKenney
-         
-         -> Tested with liburcu >= v0.5.4
+      * Debian/Ubuntu package: liburcu-dev
+      * Git : git://lttng.org/userspace-rcu.git
+      * Website:  http://lttng.org/urcu
 
-         * Debian/Ubuntu package: liburcu-dev
-         * Git : git://lttng.org/userspace-rcu.git
-         * Website:  http://lttng.org/urcu
+    - libpopt
+      Library for parsing command line parameters
 
-       - libustctl
-         LTTng user-space tracer control library
-
-         Needed for interaction with that tracer.
-
-       - liblttctl
-         LTTng kernel tracer control library
-
-         Needed for interaction with that tracer.
+      * Debian/Ubuntu package: libpopt-dev
 
 INSTALLATION INSTRUCTIONS:
 
-  - Download, compile and install liburcu, libuuid, libustctl and liblttctl
-  - In this package's tree, run ./configure.
-  - Run make.
-  - Run make install.
-  - Run ldconfig.
+  - Download, compile and install the prerequisites.
+  Then:
+  $ ./configure
+  $ make
+  $ sudo make install
+  $ sudo ldconfig
 
   If compiling from the git repository, run ./bootstrap before running
   the configure script, to generate it.
 
+USAGE:
+
+Please see doc/quickstart.txt to help you start tracing. You can also use the
+-h/--help command on 'lttng' and all other commands offered in this tool (Ex:
+lttng enable-event -h).
+
 PACKAGE CONTENTS:
 
-       This package contains the following elements:
+    This package contains the following elements:
+
+    - liblttngctl
+      The LTTng tracing control library.
+
+    - liblttsessiondcomm
+      The ltt-sessiond communication library. In order to talk with ltt-sessiond,
+      thiis library must be used.
+
+    - libkernelctl
+      Kernel tracer control and ioctl definitions.
 
-       - liblttngctl
-         The LTTng trace control library.
+    - liblttkconsumerd
+      Library for Kernel trace consumer.
 
-       - liblttsessiondcomm
-         The ltt-sessiond communication library. In order to talk with ltt-sessiond,
-         thi library must be used.
+    - ltt-kconsumerd
+      The Kernel consumer daemon which uses liblttkconsumerd.
 
-       - ltt-sessiond
-         The LTTng session daemon binary.
+    - ltt-sessiond
+      The LTTng session daemon binary.
 
-       - lttng
-         The LTTng tracer command line control tool.
+    - lttng
+      The LTTng tracer command line control tool.
 
-       - include
-         The liblttngctl API header file.
+    - include (lttng.h --> installed in $(includedir)/lttng/lttng.h)
+      The liblttngctl API header file.
 
-       - tests
-         Various test programs.
+    - tests
+      Various test programs.
This page took 0.032954 seconds and 4 git commands to generate.