Update README and add files to gitignore
[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 - 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
17 - liburcu
18 Userspace RCU library, by Mathieu Desnoyers and Paul E. McKenney
19
20 -> Tested with liburcu >= v0.6.6
21
22 * Debian/Ubuntu package: liburcu-dev
23 * Git : git://git.lttng.org/userspace-rcu.git
24 * Website: http://lttng.org/urcu
25
26 - libpopt >= 1.13
27 Library for parsing command line parameters
28
29 * Debian/Ubuntu package: libpopt-dev
30
31 - For kernel tracing: modprobe
32
33 For developers using the git tree:
34
35 This source tree is based on the autotools suite from GNU to simplify
36 portability. Here are some things you should have on your system in order to
37 compile 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/)
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)
46 - flex >= 2.5.35
47 - bison >= 2.4
48
49 If you get the tree from the repository, you will need to use the "bootstrap"
50 script in the root of the tree. It calls all the GNU tools needed to prepare the
51 tree configuration.
52
53 INSTALLATION INSTRUCTIONS:
54
55 - Download, compile and install the prerequisites.
56 Then:
57 $ ./configure
58 $ make
59 $ sudo make install
60 $ sudo ldconfig
61
62 If compiling from the git repository, run ./bootstrap before running
63 the configure script, to generate it.
64
65 USAGE:
66
67 Please 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:
69 lttng enable-event -h).
70
71 PACKAGE CONTENTS:
72
73 This package contains the following elements:
74
75 - liblttngctl
76 The LTTng tracing control library.
77
78 - libsessiond-comm (internal)
79 The lttng-sessiond communication library. In order to talk with
80 lttng-sessiond, this library must be used.
81
82 - libkernel-ctl (internal)
83 Kernel tracer control and ioctl definitions.
84
85 - libconsumer (internal)
86 Library for Kernel and (optionally) UST trace consumer.
87
88 - libkernel-consumer (internal)
89 Library for Kernel consumer control
90
91 - libust-consumer (internal)
92 Library for UST consumer control
93
94 - libhashtable (internal)
95 Library wrapper over URCU hashtables.
96
97 - lttng-relayd
98 The relay daemon used for network streaming
99
100 - lttng-consumerd
101 The consumer daemon which uses libconsumer.
102
103 - lttng-sessiond
104 The LTTng session daemon binary.
105
106 - lttng
107 The LTTng tracer command line control tool.
108
109 - include (lttng.h --> installed in $(includedir)/lttng/lttng.h)
110 The liblttngctl API header file.
111
112 - tests
113 Various test programs.
114
115 - doc
116 Various documentations and quickstart guide.
This page took 0.030173 seconds and 4 git commands to generate.