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://lttng.org/userspace-rcu.git
  20       * Website:  http://lttng.org/urcu
  21
  22     - libpopt
  23       Library for parsing command line parameters
  24
  25       * Debian/Ubuntu package: libpopt-dev
  26
  27 INSTALLATION INSTRUCTIONS:
  28
  29   - Download, compile and install the prerequisites.
  30   Then:
  31   $ ./configure
  32   $ make
  33   $ sudo make install
  34   $ sudo ldconfig
  35
  36   If compiling from the git repository, run ./bootstrap before running
  37   the configure script, to generate it.
  38
  39 USAGE:
  40
  41 Please see doc/quickstart.txt to help you start tracing. You can also use the
  42 -h/--help command on 'lttng' and all other commands offered in this tool (Ex:
  43 lttng enable-event -h).
  44
  45 PACKAGE CONTENTS:
  46
  47     This package contains the following elements:
  48
  49     - liblttngctl
  50       The LTTng tracing control library.
  51
  52     - liblttng-sessiond-comm
  53       The lttng-sessiond communication library. In order to talk with lttng-sessiond,
  54       this library must be used.
  55
  56     - libkernelctl
  57       Kernel tracer control and ioctl definitions.
  58
  59     - liblttng-consumer
  60       Library for Kernel and (optionally) UST trace consumer.
  61
  62     - lttng-consumerd
  63       The consumer daemon which uses liblttng-consumer.
  64
  65     - lttng-sessiond
  66       The LTTng session daemon binary.
  67
  68     - lttng
  69       The LTTng tracer command line control tool.
  70
  71     - include (lttng.h --> installed in $(includedir)/lttng/lttng.h)
  72       The liblttngctl API header file.
  73
  74     - tests
  75       Various test programs.