Add project status to readme
[lttngtop.git] / README
CommitLineData
a3f4c49b
KS
1Project Status
2--------------
3
4LTTngTop is not currently maintained. Those interested in supporting continued
5efforts on this or other LTTng projects may contact
6EfficiOS <mailto:sales@efficios.com>`_.
7
8
9ABOUT
10-----
c263c4eb 11LTTngTop
54645d5c
JD
12Julien Desfossez <jdesfossez@efficios.com>
13June 2015
1fc22eb4
JD
14
15Lttngtop is an ncurses interface for reading and browsing traces recorded by
16the LTTng tracer and displaying various statistics.
661ad2e0 17As of now, the cpu usage, per file/process I/O bandwidth and perf counters are
54645d5c
JD
18displayed. This release is the first one that handles live sessions as well as
19offline sessions.
1fc22eb4
JD
20
21USAGE
22-----
23
2f6b0043
JD
24The manpage located in the doc folder of this source tree documents the usage
25of LTTngTop.
1fc22eb4
JD
26
27BUILDING
28--------
29
30 ./bootstrap (skip if using tarball)
31 ./configure
32 make
33 make install
34
35DEPENDENCIES
36------------
37
2ee217af 38To compile Babeltrace and lttngtop, you need:
1fc22eb4
JD
39
40 gcc 3.2 or better
41 libc6 development librairies
42 (Debian : libc6, libc6-dev)
43 (Fedora : glibc, glibc)
44 glib 2.22 or better development libraries
45 (Debian : libglib2.0-0, libglib2.0-dev)
46 (Fedora : glib2, glib2-devel)
1fc22eb4
JD
47 libpopt >= 1.13 development libraries
48 (Debian : libpopt-dev)
49 (Fedora : popt)
50 ncurses development libraries
51 (Debian : libncurses5-dev)
3f2c1b6d
JD
52 babeltrace = 1.2.4 development library
53 (Debian : libbabeltrace-dev, libbabeltrace-ctf-dev)
1fc22eb4 54
2ee217af
JD
55To use the local live tracing feature, you need:
56 lttng-tools >= 2.4
57 lttng-modules >= 2.4
54645d5c 58 babeltrace = 1.2.4
2ee217af 59
1fc22eb4
JD
60For developers using the git tree:
61
62This source tree is based on the autotools suite from GNU to simplify
63portability. Here are some things you should have on your system in order to
64compile the git repository tree :
65
66- GNU autotools (automake >=1.10, autoconf >=2.50, autoheader >=2.50)
67 (make sure your system wide "automake" points to a recent version!)
68- GNU Libtool >=2.2
69 (for more information, go to http://www.gnu.org/software/autoconf/)
1fc22eb4
JD
70
71If you get the tree from the repository, you will need to use the "bootstrap"
72script in the root of the tree. It calls all the GNU tools needed to prepare the
73tree configuration.
This page took 0.027429 seconds and 4 git commands to generate.