Tests: Convert the ust_global_event_wildcard test to an equivalent shell 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
d086eb77 20 -> Tested with liburcu >= v0.7.2
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
36907cb5 31 - SWIG >= 2.0 (optional)
d086eb77 32 Needed for Python bindings (--enable-python-bindings).
36907cb5
DS
33
34 * Debian/Ubuntu package: swig2.0
35
36 - python-dev (optional)
37 Python headers
38
39 * Debian/Ubuntu package: python-dev
40
71a76062
MD
41 - For kernel tracing: modprobe
42
1167f2bc
DG
43 - bash
44 Needed for running "make check".
45
8ad9aaaf
MD
46For developers using the git tree:
47
48This source tree is based on the autotools suite from GNU to simplify
49portability. Here are some things you should have on your system in order to
50compile the git repository tree :
51
52- GNU autotools (automake >=1.10, autoconf >=2.50, autoheader >=2.50)
53 (make sure your system wide "automake" points to a recent version!)
54- GNU Libtool >=2.2
55 (for more information, go to http://www.gnu.org/software/autoconf/)
5a82525d
DG
56- flex >= 2.5.35
57- bison >= 2.4
8ad9aaaf 58
ee10cdeb
DG
59If you use GNU gold, which is NOT mandatory, make sure you have this version:
60- GNU gold >= 2.22
61(Before this version we hit a known bug documented at:
62 http://sourceware.org/bugzilla/show_bug.cgi?id=11317)
63Be advise that with GNU gold, you'll might have to specify -L/usr/local/lib in
64LDFLAGS.
65
8ad9aaaf 66If you get the tree from the repository, you will need to use the "bootstrap"
ee10cdeb
DG
67script in the root of the tree. It calls all the GNU tools needed to prepare
68the tree configuration.
8ad9aaaf 69
fac6795d
DG
70INSTALLATION INSTRUCTIONS:
71
ebb6ebd5
DG
72 - Download, compile and install the prerequisites.
73 Then:
ee10cdeb 74 $ ./boostrap
ebb6ebd5
DG
75 $ ./configure
76 $ make
77 $ sudo make install
78 $ sudo ldconfig
fac6795d
DG
79
80 If compiling from the git repository, run ./bootstrap before running
81 the configure script, to generate it.
82
36907cb5
DS
83 If you want Python bindings, run ./configure --enable-python-bindings.
84
aeff77c8
DG
85USAGE:
86
87Please see doc/quickstart.txt to help you start tracing. You can also use the
88-h/--help command on 'lttng' and all other commands offered in this tool (Ex:
89lttng enable-event -h).
90
c0e668d0
DG
91A network streaming HOWTO can be found in doc/streaming-howto.txt which quickly
92helps you understand how to stream a LTTng 2.0 trace.
93
36907cb5
DS
94A Python HOWTO can be found in doc/python-howto.txt which quickly
95helps you understand how to use the Python module to control the LTTng API.
96
fac6795d
DG
97PACKAGE CONTENTS:
98
ebb6ebd5
DG
99 This package contains the following elements:
100
ffb25bd5 101 - liblttng-ctl
ebb6ebd5
DG
102 The LTTng tracing control library.
103
fe54b749
DG
104 - libsessiond-comm (internal)
105 The lttng-sessiond communication library. In order to talk with
106 lttng-sessiond, this library must be used.
ebb6ebd5 107
fe54b749 108 - libkernel-ctl (internal)
ebb6ebd5 109 Kernel tracer control and ioctl definitions.
fac6795d 110
fe54b749 111 - libconsumer (internal)
3bd1e081 112 Library for Kernel and (optionally) UST trace consumer.
fac6795d 113
fe54b749
DG
114 - libkernel-consumer (internal)
115 Library for Kernel consumer control
116
117 - libust-consumer (internal)
118 Library for UST consumer control
119
120 - libhashtable (internal)
121 Library wrapper over URCU hashtables.
122
ffb25bd5
DG
123 - libcommon (internal)
124 Contains multiple useful function call used by the whole tree.
125
126 - libcompat (internal)
127 Compatibility library mostly for FreeBSD and Linux.
128
129 - librelayd (internal)
130 Library for all relayd interactions over the network.
131
b8aa1682
JD
132 - lttng-relayd
133 The relay daemon used for network streaming
134
3bd1e081 135 - lttng-consumerd
fe54b749 136 The consumer daemon which uses libconsumer.
fac6795d 137
32258573 138 - lttng-sessiond
ebb6ebd5 139 The LTTng session daemon binary.
fac6795d 140
ebb6ebd5
DG
141 - lttng
142 The LTTng tracer command line control tool.
fac6795d 143
ebb6ebd5
DG
144 - include (lttng.h --> installed in $(includedir)/lttng/lttng.h)
145 The liblttngctl API header file.
fac6795d 146
ebb6ebd5
DG
147 - tests
148 Various test programs.
fe54b749
DG
149
150 - doc
151 Various documentations and quickstart guide.
ffb25bd5
DG
152
153 - extras
154 Contains extra data such as bash completion file.
This page took 0.032649 seconds and 4 git commands to generate.