Add before-after test
[lttng-tools.git] / README
CommitLineData
fac6795d
DG
1LTTng Trace Control
2----------------
3
4Please visit http://lttng.org for more information.
5
6Latest development can be found at:
7
ebb6ebd5
DG
8 * Gitweb : http://git.lttng.org/lttng-tools.git/
9 * Git : git://git.lttng.org/lttng-tools.git
fac6795d 10
ebb6ebd5 11REQUIREMENTS:
fac6795d 12
2910b812
DG
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
ebb6ebd5
DG
17 - liburcu
18 Userspace RCU library, by Mathieu Desnoyers and Paul E. McKenney
fac6795d 19
6e59ae26 20 -> Tested with liburcu >= v0.6.6
fac6795d 21
ebb6ebd5 22 * Debian/Ubuntu package: liburcu-dev
8bf332b9 23 * Git : git://git.lttng.org/userspace-rcu.git
ebb6ebd5 24 * Website: http://lttng.org/urcu
fac6795d 25
7105c24c 26 - libpopt >= 1.13
ebb6ebd5 27 Library for parsing command line parameters
fac6795d 28
ebb6ebd5 29 * Debian/Ubuntu package: libpopt-dev
fac6795d 30
8ad9aaaf
MD
31For developers using the git tree:
32
33This source tree is based on the autotools suite from GNU to simplify
34portability. Here are some things you should have on your system in order to
35compile 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/)
5c73c59b
DG
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)
8ad9aaaf
MD
44
45If you get the tree from the repository, you will need to use the "bootstrap"
46script in the root of the tree. It calls all the GNU tools needed to prepare the
47tree configuration.
48
fac6795d
DG
49INSTALLATION INSTRUCTIONS:
50
ebb6ebd5
DG
51 - Download, compile and install the prerequisites.
52 Then:
53 $ ./configure
54 $ make
55 $ sudo make install
56 $ sudo ldconfig
fac6795d
DG
57
58 If compiling from the git repository, run ./bootstrap before running
59 the configure script, to generate it.
60
aeff77c8
DG
61USAGE:
62
63Please 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:
65lttng enable-event -h).
66
fac6795d
DG
67PACKAGE CONTENTS:
68
ebb6ebd5
DG
69 This package contains the following elements:
70
71 - liblttngctl
72 The LTTng tracing control library.
73
fe54b749
DG
74 - libsessiond-comm (internal)
75 The lttng-sessiond communication library. In order to talk with
76 lttng-sessiond, this library must be used.
ebb6ebd5 77
fe54b749 78 - libkernel-ctl (internal)
ebb6ebd5 79 Kernel tracer control and ioctl definitions.
fac6795d 80
fe54b749 81 - libconsumer (internal)
3bd1e081 82 Library for Kernel and (optionally) UST trace consumer.
fac6795d 83
fe54b749
DG
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
3bd1e081 93 - lttng-consumerd
fe54b749 94 The consumer daemon which uses libconsumer.
fac6795d 95
32258573 96 - lttng-sessiond
ebb6ebd5 97 The LTTng session daemon binary.
fac6795d 98
ebb6ebd5
DG
99 - lttng
100 The LTTng tracer command line control tool.
fac6795d 101
ebb6ebd5
DG
102 - include (lttng.h --> installed in $(includedir)/lttng/lttng.h)
103 The liblttngctl API header file.
fac6795d 104
ebb6ebd5
DG
105 - tests
106 Various test programs.
fe54b749
DG
107
108 - doc
109 Various documentations and quickstart guide.
This page took 0.028472 seconds and 4 git commands to generate.