Fix README and add doc to tarball
[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 - liburcu
14 Userspace RCU library, by Mathieu Desnoyers and Paul E. McKenney
15
16 -> Tested with liburcu >= v0.5.4
17
18 * Debian/Ubuntu package: liburcu-dev
19 * Git : git://lttng.org/userspace-rcu.git
20 * Website: http://lttng.org/urcu
21
22 - libpopt
23 Library for parsing command line parameters
24
25 * Debian/Ubuntu package: libpopt-dev
26
27 INSTALLATION INSTRUCTIONS:
28
29 - Download, compile and install the prerequisites.
30 Then:
31 $ ./configure
32 $ make
33 $ sudo make install
34 $ sudo ldconfig
35
36 If compiling from the git repository, run ./bootstrap before running
37 the configure script, to generate it.
38
39 PACKAGE CONTENTS:
40
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.
52
53 - liblttkconsumerd
54 Library for Kernel trace consumer.
55
56 - ltt-kconsumerd
57 The Kernel consumer daemon which uses liblttkconsumerd.
58
59 - ltt-sessiond
60 The LTTng session daemon binary.
61
62 - lttng
63 The LTTng tracer command line control tool.
64
65 - include (lttng.h --> installed in $(includedir)/lttng/lttng.h)
66 The liblttngctl API header file.
67
68 - tests
69 Various test programs.
This page took 0.042212 seconds and 5 git commands to generate.