Fix tests Makefile options
[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/)
41
42If you get the tree from the repository, you will need to use the "bootstrap"
43script in the root of the tree. It calls all the GNU tools needed to prepare the
44tree configuration.
45
fac6795d
DG
46INSTALLATION INSTRUCTIONS:
47
ebb6ebd5
DG
48 - Download, compile and install the prerequisites.
49 Then:
50 $ ./configure
51 $ make
52 $ sudo make install
53 $ sudo ldconfig
fac6795d
DG
54
55 If compiling from the git repository, run ./bootstrap before running
56 the configure script, to generate it.
57
aeff77c8
DG
58USAGE:
59
60Please see doc/quickstart.txt to help you start tracing. You can also use the
61-h/--help command on 'lttng' and all other commands offered in this tool (Ex:
62lttng enable-event -h).
63
fac6795d
DG
64PACKAGE CONTENTS:
65
ebb6ebd5
DG
66 This package contains the following elements:
67
68 - liblttngctl
69 The LTTng tracing control library.
70
fe54b749
DG
71 - libsessiond-comm (internal)
72 The lttng-sessiond communication library. In order to talk with
73 lttng-sessiond, this library must be used.
ebb6ebd5 74
fe54b749 75 - libkernel-ctl (internal)
ebb6ebd5 76 Kernel tracer control and ioctl definitions.
fac6795d 77
fe54b749 78 - libconsumer (internal)
3bd1e081 79 Library for Kernel and (optionally) UST trace consumer.
fac6795d 80
fe54b749
DG
81 - libkernel-consumer (internal)
82 Library for Kernel consumer control
83
84 - libust-consumer (internal)
85 Library for UST consumer control
86
87 - libhashtable (internal)
88 Library wrapper over URCU hashtables.
89
3bd1e081 90 - lttng-consumerd
fe54b749 91 The consumer daemon which uses libconsumer.
fac6795d 92
32258573 93 - lttng-sessiond
ebb6ebd5 94 The LTTng session daemon binary.
fac6795d 95
ebb6ebd5
DG
96 - lttng
97 The LTTng tracer command line control tool.
fac6795d 98
ebb6ebd5
DG
99 - include (lttng.h --> installed in $(includedir)/lttng/lttng.h)
100 The liblttngctl API header file.
fac6795d 101
ebb6ebd5
DG
102 - tests
103 Various test programs.
fe54b749
DG
104
105 - doc
106 Various documentations and quickstart guide.
This page took 0.041122 seconds and 4 git commands to generate.