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         - Linux kernel >= 2.6.27
  14           pipe2(), epoll_create1() and SOCK_CLOEXEC are needed to run the session
  15           daemon. There were introduce in the Linux 2.6.27
  16
  17     - liburcu
  18       Userspace RCU library, by Mathieu Desnoyers and Paul E. McKenney
  19
  20       -> Tested with liburcu >= v0.6.6
  21
  22       * Debian/Ubuntu package: liburcu-dev
  23       * Git : git://git.lttng.org/userspace-rcu.git
  24       * Website:  http://lttng.org/urcu
  25
  26     - libpopt >= 1.13
  27       Library for parsing command line parameters
  28
  29       * Debian/Ubuntu package: libpopt-dev
  30
  31 For developers using the git tree:
  32
  33 This source tree is based on the autotools suite from GNU to simplify
  34 portability. Here are some things you should have on your system in order to
  35 compile the git repository tree :
  36
  37 - GNU autotools (automake >=1.10, autoconf >=2.50, autoheader >=2.50)
  38   (make sure your system wide "automake" points to a recent version!)
  39 - GNU Libtool >=2.2
  40   (for more information, go to http://www.gnu.org/software/autoconf/)
  41 - GNU Gold >= 2.22
  42   (Before this version we hit a known bug documented at:
  43   http://sourceware.org/bugzilla/show_bug.cgi?id=11317)
  44
  45 If you get the tree from the repository, you will need to use the "bootstrap"
  46 script in the root of the tree. It calls all the GNU tools needed to prepare the
  47 tree configuration.
  48
  49 INSTALLATION INSTRUCTIONS:
  50
  51   - Download, compile and install the prerequisites.
  52   Then:
  53   $ ./configure
  54   $ make
  55   $ sudo make install
  56   $ sudo ldconfig
  57
  58   If compiling from the git repository, run ./bootstrap before running
  59   the configure script, to generate it.
  60
  61 USAGE:
  62
  63 Please see doc/quickstart.txt to help you start tracing. You can also use the
  64 -h/--help command on 'lttng' and all other commands offered in this tool (Ex:
  65 lttng enable-event -h).
  66
  67 PACKAGE CONTENTS:
  68
  69     This package contains the following elements:
  70
  71     - liblttngctl
  72       The LTTng tracing control library.
  73
  74     - libsessiond-comm (internal)
  75           The lttng-sessiond communication library. In order to talk with
  76           lttng-sessiond, this library must be used.
  77
  78     - libkernel-ctl (internal)
  79       Kernel tracer control and ioctl definitions.
  80
  81     - libconsumer (internal)
  82       Library for Kernel and (optionally) UST trace consumer.
  83
  84         - libkernel-consumer (internal)
  85           Library for Kernel consumer control
  86
  87         - libust-consumer (internal)
  88           Library for UST consumer control
  89
  90         - libhashtable (internal)
  91           Library wrapper over URCU hashtables.
  92
  93     - lttng-consumerd
  94       The consumer daemon which uses libconsumer.
  95
  96     - lttng-sessiond
  97       The LTTng session daemon binary.
  98
  99     - lttng
 100       The LTTng tracer command line control tool.
 101
 102     - include (lttng.h --> installed in $(includedir)/lttng/lttng.h)
 103       The liblttngctl API header file.
 104
 105     - tests
 106       Various test programs.
 107
 108         - doc
 109           Various documentations and quickstart guide.