Fix and update content of doc/ directory
[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)
5a82525d
DG
46- flex >= 2.5.35
47- bison >= 2.4
8ad9aaaf
MD
48
49If you get the tree from the repository, you will need to use the "bootstrap"
50script in the root of the tree. It calls all the GNU tools needed to prepare the
51tree configuration.
52
fac6795d
DG
53INSTALLATION INSTRUCTIONS:
54
ebb6ebd5
DG
55 - Download, compile and install the prerequisites.
56 Then:
57 $ ./configure
58 $ make
59 $ sudo make install
60 $ sudo ldconfig
fac6795d
DG
61
62 If compiling from the git repository, run ./bootstrap before running
63 the configure script, to generate it.
64
aeff77c8
DG
65USAGE:
66
67Please see doc/quickstart.txt to help you start tracing. You can also use the
68-h/--help command on 'lttng' and all other commands offered in this tool (Ex:
69lttng enable-event -h).
70
c0e668d0
DG
71A network streaming HOWTO can be found in doc/streaming-howto.txt which quickly
72helps you understand how to stream a LTTng 2.0 trace.
73
fac6795d
DG
74PACKAGE CONTENTS:
75
ebb6ebd5
DG
76 This package contains the following elements:
77
78 - liblttngctl
79 The LTTng tracing control library.
80
fe54b749
DG
81 - libsessiond-comm (internal)
82 The lttng-sessiond communication library. In order to talk with
83 lttng-sessiond, this library must be used.
ebb6ebd5 84
fe54b749 85 - libkernel-ctl (internal)
ebb6ebd5 86 Kernel tracer control and ioctl definitions.
fac6795d 87
fe54b749 88 - libconsumer (internal)
3bd1e081 89 Library for Kernel and (optionally) UST trace consumer.
fac6795d 90
fe54b749
DG
91 - libkernel-consumer (internal)
92 Library for Kernel consumer control
93
94 - libust-consumer (internal)
95 Library for UST consumer control
96
97 - libhashtable (internal)
98 Library wrapper over URCU hashtables.
99
b8aa1682
JD
100 - lttng-relayd
101 The relay daemon used for network streaming
102
3bd1e081 103 - lttng-consumerd
fe54b749 104 The consumer daemon which uses libconsumer.
fac6795d 105
32258573 106 - lttng-sessiond
ebb6ebd5 107 The LTTng session daemon binary.
fac6795d 108
ebb6ebd5
DG
109 - lttng
110 The LTTng tracer command line control tool.
fac6795d 111
ebb6ebd5
DG
112 - include (lttng.h --> installed in $(includedir)/lttng/lttng.h)
113 The liblttngctl API header file.
fac6795d 114
ebb6ebd5
DG
115 - tests
116 Various test programs.
fe54b749
DG
117
118 - doc
119 Various documentations and quickstart guide.
This page took 0.044126 seconds and 4 git commands to generate.