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