Add and change lttcomm socket API
[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
71a76062
MD
31 - For kernel tracing: modprobe
32
8ad9aaaf
MD
33For developers using the git tree:
34
35This source tree is based on the autotools suite from GNU to simplify
36portability. Here are some things you should have on your system in order to
37compile the git repository tree :
38
39- GNU autotools (automake >=1.10, autoconf >=2.50, autoheader >=2.50)
40 (make sure your system wide "automake" points to a recent version!)
41- GNU Libtool >=2.2
42 (for more information, go to http://www.gnu.org/software/autoconf/)
5c73c59b
DG
43- GNU Gold >= 2.22
44 (Before this version we hit a known bug documented at:
45 http://sourceware.org/bugzilla/show_bug.cgi?id=11317)
8ad9aaaf
MD
46
47If you get the tree from the repository, you will need to use the "bootstrap"
48script in the root of the tree. It calls all the GNU tools needed to prepare the
49tree configuration.
50
fac6795d
DG
51INSTALLATION INSTRUCTIONS:
52
ebb6ebd5
DG
53 - Download, compile and install the prerequisites.
54 Then:
55 $ ./configure
56 $ make
57 $ sudo make install
58 $ sudo ldconfig
fac6795d
DG
59
60 If compiling from the git repository, run ./bootstrap before running
61 the configure script, to generate it.
62
aeff77c8
DG
63USAGE:
64
65Please see doc/quickstart.txt to help you start tracing. You can also use the
66-h/--help command on 'lttng' and all other commands offered in this tool (Ex:
67lttng enable-event -h).
68
fac6795d
DG
69PACKAGE CONTENTS:
70
ebb6ebd5
DG
71 This package contains the following elements:
72
73 - liblttngctl
74 The LTTng tracing control library.
75
fe54b749
DG
76 - libsessiond-comm (internal)
77 The lttng-sessiond communication library. In order to talk with
78 lttng-sessiond, this library must be used.
ebb6ebd5 79
fe54b749 80 - libkernel-ctl (internal)
ebb6ebd5 81 Kernel tracer control and ioctl definitions.
fac6795d 82
fe54b749 83 - libconsumer (internal)
3bd1e081 84 Library for Kernel and (optionally) UST trace consumer.
fac6795d 85
fe54b749
DG
86 - libkernel-consumer (internal)
87 Library for Kernel consumer control
88
89 - libust-consumer (internal)
90 Library for UST consumer control
91
92 - libhashtable (internal)
93 Library wrapper over URCU hashtables.
94
3bd1e081 95 - lttng-consumerd
fe54b749 96 The consumer daemon which uses libconsumer.
fac6795d 97
32258573 98 - lttng-sessiond
ebb6ebd5 99 The LTTng session daemon binary.
fac6795d 100
ebb6ebd5
DG
101 - lttng
102 The LTTng tracer command line control tool.
fac6795d 103
ebb6ebd5
DG
104 - include (lttng.h --> installed in $(includedir)/lttng/lttng.h)
105 The liblttngctl API header file.
fac6795d 106
ebb6ebd5
DG
107 - tests
108 Various test programs.
fe54b749
DG
109
110 - doc
111 Various documentations and quickstart guide.
This page took 0.042003 seconds and 4 git commands to generate.