Cleanup comments and bad indent

[lttng-tools.git] / README

LTTng Trace Control
----------------

Please visit http://lttng.org for more information.

Latest development can be found at:

    * Gitweb :  http://git.lttng.org/lttng-tools.git/
    * Git :     git://git.lttng.org/lttng-tools.git

REQUIREMENTS:

    - liburcu
      Userspace RCU library, by Mathieu Desnoyers and Paul E. McKenney

      -> Tested with liburcu >= v0.5.4

      * Debian/Ubuntu package: liburcu-dev
      * Git : git://lttng.org/userspace-rcu.git
      * Website:  http://lttng.org/urcu

    - libpopt
      Library for parsing command line parameters

      * Debian/Ubuntu package: libpopt-dev

INSTALLATION INSTRUCTIONS:

  - Download, compile and install the prerequisites.
  Then:
  $ ./configure
  $ make
  $ sudo make install
  $ sudo ldconfig

  If compiling from the git repository, run ./bootstrap before running
  the configure script, to generate it.

USAGE:

Please see doc/quickstart.txt to help you start tracing. You can also use the
-h/--help command on 'lttng' and all other commands offered in this tool (Ex:
lttng enable-event -h).

PACKAGE CONTENTS:

    This package contains the following elements:

    - liblttngctl
      The LTTng tracing control library.

    - liblttsessiondcomm
      The ltt-sessiond communication library. In order to talk with ltt-sessiond,
      thiis library must be used.

    - libkernelctl
      Kernel tracer control and ioctl definitions.

    - liblttngkconsumerd
      Library for Kernel trace consumer.

    - ltt-kconsumerd
      The Kernel consumer daemon which uses liblttngkconsumerd.

    - ltt-sessiond
      The LTTng session daemon binary.

    - lttng
      The LTTng tracer command line control tool.

    - include (lttng.h --> installed in $(includedir)/lttng/lttng.h)
      The liblttngctl API header file.

    - tests
      Various test programs.