Fix README and add doc to tarball
[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
ebb6ebd5 16 -> Tested with liburcu >= v0.5.4
fac6795d 17
ebb6ebd5
DG
18 * Debian/Ubuntu package: liburcu-dev
19 * Git : git://lttng.org/userspace-rcu.git
20 * Website: http://lttng.org/urcu
fac6795d 21
ebb6ebd5
DG
22 - libpopt
23 Library for parsing command line parameters
fac6795d 24
ebb6ebd5 25 * Debian/Ubuntu package: libpopt-dev
fac6795d
DG
26
27INSTALLATION INSTRUCTIONS:
28
ebb6ebd5
DG
29 - Download, compile and install the prerequisites.
30 Then:
31 $ ./configure
32 $ make
33 $ sudo make install
34 $ sudo ldconfig
fac6795d
DG
35
36 If compiling from the git repository, run ./bootstrap before running
37 the configure script, to generate it.
38
39PACKAGE CONTENTS:
40
ebb6ebd5
DG
41 This package contains the following elements:
42
43 - liblttngctl
44 The LTTng tracing control library.
45
46 - liblttsessiondcomm
47 The ltt-sessiond communication library. In order to talk with ltt-sessiond,
48 thiis library must be used.
49
50 - libkernelctl
51 Kernel tracer control and ioctl definitions.
fac6795d 52
ebb6ebd5
DG
53 - liblttkconsumerd
54 Library for Kernel trace consumer.
fac6795d 55
ebb6ebd5
DG
56 - ltt-kconsumerd
57 The Kernel consumer daemon which uses liblttkconsumerd.
fac6795d 58
ebb6ebd5
DG
59 - ltt-sessiond
60 The LTTng session daemon binary.
fac6795d 61
ebb6ebd5
DG
62 - lttng
63 The LTTng tracer command line control tool.
fac6795d 64
ebb6ebd5
DG
65 - include (lttng.h --> installed in $(includedir)/lttng/lttng.h)
66 The liblttngctl API header file.
fac6795d 67
ebb6ebd5
DG
68 - tests
69 Various test programs.
This page took 0.036755 seconds and 4 git commands to generate.