Update README
[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
ebb6ebd5
DG
13 - liburcu
14 Userspace RCU library, by Mathieu Desnoyers and Paul E. McKenney
fac6795d 15
6e59ae26 16 -> Tested with liburcu >= v0.6.6
fac6795d 17
ebb6ebd5 18 * Debian/Ubuntu package: liburcu-dev
8bf332b9 19 * Git : git://git.lttng.org/userspace-rcu.git
ebb6ebd5 20 * Website: http://lttng.org/urcu
fac6795d 21
7105c24c 22 - libpopt >= 1.13
ebb6ebd5 23 Library for parsing command line parameters
fac6795d 24
ebb6ebd5 25 * Debian/Ubuntu package: libpopt-dev
fac6795d 26
8ad9aaaf
MD
27For developers using the git tree:
28
29This source tree is based on the autotools suite from GNU to simplify
30portability. Here are some things you should have on your system in order to
31compile the git repository tree :
32
33- GNU autotools (automake >=1.10, autoconf >=2.50, autoheader >=2.50)
34 (make sure your system wide "automake" points to a recent version!)
35- GNU Libtool >=2.2
36 (for more information, go to http://www.gnu.org/software/autoconf/)
37
38If you get the tree from the repository, you will need to use the "bootstrap"
39script in the root of the tree. It calls all the GNU tools needed to prepare the
40tree configuration.
41
fac6795d
DG
42INSTALLATION INSTRUCTIONS:
43
ebb6ebd5
DG
44 - Download, compile and install the prerequisites.
45 Then:
46 $ ./configure
47 $ make
48 $ sudo make install
49 $ sudo ldconfig
fac6795d
DG
50
51 If compiling from the git repository, run ./bootstrap before running
52 the configure script, to generate it.
53
aeff77c8
DG
54USAGE:
55
56Please see doc/quickstart.txt to help you start tracing. You can also use the
57-h/--help command on 'lttng' and all other commands offered in this tool (Ex:
58lttng enable-event -h).
59
fac6795d
DG
60PACKAGE CONTENTS:
61
ebb6ebd5
DG
62 This package contains the following elements:
63
64 - liblttngctl
65 The LTTng tracing control library.
66
fe54b749
DG
67 - libsessiond-comm (internal)
68 The lttng-sessiond communication library. In order to talk with
69 lttng-sessiond, this library must be used.
ebb6ebd5 70
fe54b749 71 - libkernel-ctl (internal)
ebb6ebd5 72 Kernel tracer control and ioctl definitions.
fac6795d 73
fe54b749 74 - libconsumer (internal)
3bd1e081 75 Library for Kernel and (optionally) UST trace consumer.
fac6795d 76
fe54b749
DG
77 - libkernel-consumer (internal)
78 Library for Kernel consumer control
79
80 - libust-consumer (internal)
81 Library for UST consumer control
82
83 - libhashtable (internal)
84 Library wrapper over URCU hashtables.
85
3bd1e081 86 - lttng-consumerd
fe54b749 87 The consumer daemon which uses libconsumer.
fac6795d 88
32258573 89 - lttng-sessiond
ebb6ebd5 90 The LTTng session daemon binary.
fac6795d 91
ebb6ebd5
DG
92 - lttng
93 The LTTng tracer command line control tool.
fac6795d 94
ebb6ebd5
DG
95 - include (lttng.h --> installed in $(includedir)/lttng/lttng.h)
96 The liblttngctl API header file.
fac6795d 97
ebb6ebd5
DG
98 - tests
99 Various test programs.
fe54b749
DG
100
101 - doc
102 Various documentations and quickstart guide.
This page took 0.041077 seconds and 4 git commands to generate.