Describe autotools/libtool/automake version dependency
[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
ebb6ebd5
DG
13 - liburcu
14 Userspace RCU library, by Mathieu Desnoyers and Paul E. McKenney
fac6795d 15
6e59ae26 16 -> Tested with liburcu >= v0.6.6
fac6795d 17
ebb6ebd5 18 * Debian/Ubuntu package: liburcu-dev
8bf332b9 19 * Git : git://git.lttng.org/userspace-rcu.git
ebb6ebd5 20 * Website: http://lttng.org/urcu
fac6795d 21
ebb6ebd5
DG
22 - libpopt
23 Library for parsing command line parameters
fac6795d 24
ebb6ebd5 25 * Debian/Ubuntu package: libpopt-dev
fac6795d 26
8ad9aaaf
MD
27For developers using the git tree:
28
29This source tree is based on the autotools suite from GNU to simplify
30portability. Here are some things you should have on your system in order to
31compile 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
38If you get the tree from the repository, you will need to use the "bootstrap"
39script in the root of the tree. It calls all the GNU tools needed to prepare the
40tree configuration.
41
42
fac6795d
DG
43INSTALLATION INSTRUCTIONS:
44
ebb6ebd5
DG
45 - Download, compile and install the prerequisites.
46 Then:
47 $ ./configure
48 $ make
49 $ sudo make install
50 $ sudo ldconfig
fac6795d
DG
51
52 If compiling from the git repository, run ./bootstrap before running
53 the configure script, to generate it.
54
aeff77c8
DG
55USAGE:
56
57Please 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:
59lttng enable-event -h).
60
fac6795d
DG
61PACKAGE CONTENTS:
62
ebb6ebd5
DG
63 This package contains the following elements:
64
65 - liblttngctl
66 The LTTng tracing control library.
67
40b7f485 68 - liblttng-sessiond-comm
32258573 69 The lttng-sessiond communication library. In order to talk with lttng-sessiond,
3bd1e081 70 this library must be used.
ebb6ebd5
DG
71
72 - libkernelctl
73 Kernel tracer control and ioctl definitions.
fac6795d 74
3bd1e081
MD
75 - liblttng-consumer
76 Library for Kernel and (optionally) UST trace consumer.
fac6795d 77
3bd1e081
MD
78 - lttng-consumerd
79 The consumer daemon which uses liblttng-consumer.
fac6795d 80
32258573 81 - lttng-sessiond
ebb6ebd5 82 The LTTng session daemon binary.
fac6795d 83
ebb6ebd5
DG
84 - lttng
85 The LTTng tracer command line control tool.
fac6795d 86
ebb6ebd5
DG
87 - include (lttng.h --> installed in $(includedir)/lttng/lttng.h)
88 The liblttngctl API header file.
fac6795d 89
ebb6ebd5
DG
90 - tests
91 Various test programs.
This page took 0.038354 seconds and 4 git commands to generate.