X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=blobdiff_plain;f=README;h=ebd76bdb2105c9cd1e94c732e863c81447a7260c;hp=033679b7fc3f9147bfd326c57d19ff0dc0f04d46;hb=3822545da613a8add254dcff34ca879cf8fce7fc;hpb=c0e668d09d6222ab3c792f70183f71eb5a18d8a7 diff --git a/README b/README index 033679b7f..ebd76bdb2 100644 --- a/README +++ b/README @@ -28,8 +28,21 @@ REQUIREMENTS: * Debian/Ubuntu package: libpopt-dev + - SWIG >= 2.0 (optional) + Needed for Python bindings + + * Debian/Ubuntu package: swig2.0 + + - python-dev (optional) + Python headers + + * Debian/Ubuntu package: python-dev + - For kernel tracing: modprobe + - bash + Needed for running "make check". + For developers using the git tree: This source tree is based on the autotools suite from GNU to simplify @@ -62,6 +75,8 @@ INSTALLATION INSTRUCTIONS: If compiling from the git repository, run ./bootstrap before running the configure script, to generate it. + If you want Python bindings, run ./configure --enable-python-bindings. + USAGE: Please see doc/quickstart.txt to help you start tracing. You can also use the @@ -71,11 +86,14 @@ lttng enable-event -h). A network streaming HOWTO can be found in doc/streaming-howto.txt which quickly helps you understand how to stream a LTTng 2.0 trace. +A Python HOWTO can be found in doc/python-howto.txt which quickly +helps you understand how to use the Python module to control the LTTng API. + PACKAGE CONTENTS: This package contains the following elements: - - liblttngctl + - liblttng-ctl The LTTng tracing control library. - libsessiond-comm (internal) @@ -97,6 +115,15 @@ PACKAGE CONTENTS: - libhashtable (internal) Library wrapper over URCU hashtables. + - libcommon (internal) + Contains multiple useful function call used by the whole tree. + + - libcompat (internal) + Compatibility library mostly for FreeBSD and Linux. + + - librelayd (internal) + Library for all relayd interactions over the network. + - lttng-relayd The relay daemon used for network streaming @@ -117,3 +144,6 @@ PACKAGE CONTENTS: - doc Various documentations and quickstart guide. + + - extras + Contains extra data such as bash completion file.