Update README
[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.6.6
17
18 * Debian/Ubuntu package: liburcu-dev
19 * Git : git://git.lttng.org/userspace-rcu.git
20 * Website: http://lttng.org/urcu
21
22 - libpopt >= 1.13
23 Library for parsing command line parameters
24
25 * Debian/Ubuntu package: libpopt-dev
26
27 For developers using the git tree:
28
29 This source tree is based on the autotools suite from GNU to simplify
30 portability. Here are some things you should have on your system in order to
31 compile 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
38 If you get the tree from the repository, you will need to use the "bootstrap"
39 script in the root of the tree. It calls all the GNU tools needed to prepare the
40 tree configuration.
41
42 INSTALLATION INSTRUCTIONS:
43
44 - Download, compile and install the prerequisites.
45 Then:
46 $ ./configure
47 $ make
48 $ sudo make install
49 $ sudo ldconfig
50
51 If compiling from the git repository, run ./bootstrap before running
52 the configure script, to generate it.
53
54 USAGE:
55
56 Please 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:
58 lttng enable-event -h).
59
60 PACKAGE CONTENTS:
61
62 This package contains the following elements:
63
64 - liblttngctl
65 The LTTng tracing control library.
66
67 - libsessiond-comm (internal)
68 The lttng-sessiond communication library. In order to talk with
69 lttng-sessiond, this library must be used.
70
71 - libkernel-ctl (internal)
72 Kernel tracer control and ioctl definitions.
73
74 - libconsumer (internal)
75 Library for Kernel and (optionally) UST trace consumer.
76
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
86 - lttng-consumerd
87 The consumer daemon which uses libconsumer.
88
89 - lttng-sessiond
90 The LTTng session daemon binary.
91
92 - lttng
93 The LTTng tracer command line control tool.
94
95 - include (lttng.h --> installed in $(includedir)/lttng/lttng.h)
96 The liblttngctl API header file.
97
98 - tests
99 Various test programs.
100
101 - doc
102 Various documentations and quickstart guide.
This page took 0.042099 seconds and 4 git commands to generate.