Doc: Add elfutils to README
[babeltrace.git] / README
CommitLineData
d79865b9 1BabelTrace - Trace Format Babel Tower
d79865b9
MD
2
3This project provides trace read and write libraries, as well as a trace
4converter. A plugin can be created for any trace format to allow its conversion
5to/from another trace format.
efc652bd 6
f5f66f74
MD
7The main format expected to be converted to/from is the Common Trace
8Format (CTF). The latest version of the CTF specification can be found at:
9
10 git tree: git://git.efficios.com/ctf.git
11 gitweb: http://git.efficios.com/?p=ctf.git
12
d8ff4d5c
MD
13The CE Workgroup of the Linux Foundation, Ericsson, and EfficiOS have
14sponsored this work.
15
e67a221d
MD
16The current maintainers are:
17 Jérémie Galarneau <jeremie.galarneau@efficios.com>
18 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
19
20Questions should be addressed to this mailing list:
21 lttng-dev@lists.lttng.org
22
f5f66f74 23
5c9abf1b
MD
24BUILDING
25--------
efc652bd 26
5c9abf1b
MD
27 ./bootstrap (skip if using tarball)
28 ./configure
29 make
30 make install
5d2e189a 31 ldconfig
5c9abf1b 32
e67a221d 33
5c9abf1b
MD
34DEPENDENCIES
35------------
36
37To compile Babeltrace, you will need:
38
39 gcc 3.2 or better
5c9abf1b
MD
40 libc6 development librairies
41 (Debian : libc6, libc6-dev)
42 (Fedora : glibc, glibc)
0da4d788
MD
43 glib 2.22 or better development libraries
44 (Debian : libglib2.0-0, libglib2.0-dev)
45 (Fedora : glib2, glib2-devel)
ce8e64d5
MD
46 uuid development libraries
47 (Debian : uuid-dev)
48 (Fedora : uuid-devel)
8479699f 49 libpopt >= 1.13 development libraries
0da4d788 50 (Debian : libpopt-dev)
16b695f5 51 (Fedora : popt)
631a99e8
MJ
52 elfutils development libraries (optional)
53 (Debian : libelf-dev, libdw-dev)
54 (Fedora : elfutils-devel, elfutils-libelf-devel)
24a3136a 55 python headers (optional)
94a6cea3 56 (Debian/Ubuntu : python3-dev)
24a3136a
DS
57 swig >= 2.0 (optional)
58 (Debian/Ubuntu : swig2.0)
9872e818
JG
59 python 3.0 or better (optional)
60 (Debian/Ubuntu : python3)
24a3136a 61
94a6cea3
JG
62 If you want Python bindings, run ./configure --enable-python-bindings.
63 Please note that some distributions will need the following
64 environment variables set before running configure:
65
66 export PYTHON="python3"
67 export PYTHON_CONFIG="/usr/bin/python3-config"
5c9abf1b
MD
68
69For developers using the git tree:
efc652bd
MD
70
71This source tree is based on the autotools suite from GNU to simplify
72portability. Here are some things you should have on your system in order to
73compile the git repository tree :
74
76fb4848 75- GNU autotools (automake >=1.10, autoconf >=2.50, autoheader >=2.50)
efc652bd 76 (make sure your system wide "automake" points to a recent version!)
0f71b863 77- GNU Libtool >=2.2
efc652bd 78 (for more information, go to http://www.gnu.org/software/autoconf/)
5e7e97cb
MD
79- Flex >=2.5.35.
80- Bison >=2.4.
efc652bd
MD
81
82If you get the tree from the repository, you will need to use the "bootstrap"
83script in the root of the tree. It calls all the GNU tools needed to prepare the
84tree configuration.
db96f222
MD
85
86Running "make check": bash is required.
This page took 0.043772 seconds and 4 git commands to generate.