README

   1 LTTng Trace Control
   2 ----------------
   3
   4 Please visit http://lttng.org for more information.
   5
   6 Latest development can be found at:
   7
   8     * Gitweb :  http://git.lttng.org/lttng-tools.git/
   9     * Git :     git://git.lttng.org/lttng-tools.git
  10
  11 REQUIREMENTS:
  12
  13     - liburcu
  14       Userspace RCU library, by Mathieu Desnoyers and Paul E. McKenney
  15
  16       -> Tested with liburcu >= v0.6.6
  17
  18       * Debian/Ubuntu package: liburcu-dev
  19       * Git : git://git.lttng.org/userspace-rcu.git
  20       * Website:  http://lttng.org/urcu
  21
  22     - libpopt >= 1.13
  23       Library for parsing command line parameters
  24
  25       * Debian/Ubuntu package: libpopt-dev
  26
  27 For developers using the git tree:
  28
  29 This source tree is based on the autotools suite from GNU to simplify
  30 portability. Here are some things you should have on your system in order to
  31 compile the git repository tree :
  32
  33 - GNU autotools (automake >=1.10, autoconf >=2.50, autoheader >=2.50)
  34   (make sure your system wide "automake" points to a recent version!)
  35 - GNU Libtool >=2.2
  36   (for more information, go to http://www.gnu.org/software/autoconf/)
  37
  38 If you get the tree from the repository, you will need to use the "bootstrap"
  39 script in the root of the tree. It calls all the GNU tools needed to prepare the
  40 tree configuration.
  41
  42
  43 INSTALLATION INSTRUCTIONS:
  44
  45   - Download, compile and install the prerequisites.
  46   Then:
  47   $ ./configure
  48   $ make
  49   $ sudo make install
  50   $ sudo ldconfig
  51
  52   If compiling from the git repository, run ./bootstrap before running
  53   the configure script, to generate it.
  54
  55 USAGE:
  56
  57 Please see doc/quickstart.txt to help you start tracing. You can also use the
  58 -h/--help command on 'lttng' and all other commands offered in this tool (Ex:
  59 lttng enable-event -h).
  60
  61 PACKAGE CONTENTS:
  62
  63     This package contains the following elements:
  64
  65     - liblttngctl
  66       The LTTng tracing control library.
  67
  68     - liblttng-sessiond-comm
  69       The lttng-sessiond communication library. In order to talk with lttng-sessiond,
  70       this library must be used.
  71
  72     - libkernelctl
  73       Kernel tracer control and ioctl definitions.
  74
  75     - liblttng-consumer
  76       Library for Kernel and (optionally) UST trace consumer.
  77
  78     - lttng-consumerd
  79       The consumer daemon which uses liblttng-consumer.
  80
  81     - lttng-sessiond
  82       The LTTng session daemon binary.
  83
  84     - lttng
  85       The LTTng tracer command line control tool.
  86
  87     - include (lttng.h --> installed in $(includedir)/lttng/lttng.h)
  88       The liblttngctl API header file.
  89
  90     - tests
  91       Various test programs.