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