Add --list-options to save/load command

[lttng-tools.git] / README

diff --git a/README b/README
index 538996e9e8cd371044f2e82b3ad220b4642ef45b..43fd0c5cba33be283d85cb020fb4d271a6873511 100644 (file)
--- a/README
+++ b/README
@@ -11,16 +11,16 @@ Latest development can be found at:
 
 REQUIREMENTS:
 
-       - Linux kernel >= 2.6.27
-         For epoll() support, at least this version is needed. However, poll() is
-         also supported by running "./configure --disable-epoll". Using that, the
-         kernel version can probably be older but we can't provide any guarantee.
-         Please let us know if you are able to go lower without any problems.
+    - Linux kernel >= 2.6.27
+      For epoll() support, at least this version is needed. However, poll() is
+      also supported by running "./configure --disable-epoll". Using that, the
+      kernel version can probably be older but we can't provide any guarantee.
+      Please let us know if you are able to go lower without any problems.
 
-    - liburcu
+    - liburcu >= 0.8.0
       Userspace RCU library, by Mathieu Desnoyers and Paul E. McKenney
 
-      -> Tested with liburcu 0.7.x stable.
+      -> Tested with liburcu 0.8.x stable.
 
       * Debian/Ubuntu package: liburcu-dev
       * Git : git://git.lttng.org/userspace-rcu.git
@@ -31,6 +31,21 @@ REQUIREMENTS:
 
       * Debian/Ubuntu package: libpopt-dev
 
+    - libuuid
+      Universally unique id library
+
+      * Debian/Ubuntu package: uuid-dev
+
+    - Babeltrace (optional)
+      Trace viewer. Enable the use of "lttng view" command
+
+      * Debian/Ubuntu package: babeltrace
+
+    - libxml2 >= 2.7.6
+      XML document parsing library.
+
+      * Debian/Ubuntu package: libxml2-dev
+
     - Perl (optional)
       Needed for make check and tests.
 
@@ -47,12 +62,12 @@ REQUIREMENTS:
     - python-dev (optional)
       Python headers
 
-      * Debian/Ubuntu package: python-dev
+      * Debian/Ubuntu package: python3-dev
 
     - For kernel tracing: modprobe
 
-       - bash
-         Needed for running "make check".
+    - bash
+      Needed for running "make check".
 
 For developers using the git tree:
 
@@ -92,6 +107,11 @@ INSTALLATION INSTRUCTIONS:
   the configure script, to generate it.
 
   If you want Python bindings, run ./configure --enable-python-bindings.
+  Please note that some distributions will need the following
+  environment variables set before running configure:
+
+    export PYTHON="python3"
+    export PYTHON_CONFIG="/usr/bin/python3-config"
 
 USAGE:
 
@@ -113,8 +133,8 @@ PACKAGE CONTENTS:
       The LTTng tracing control library.
 
     - libsessiond-comm (internal)
-         The lttng-sessiond communication library. In order to talk with
-         lttng-sessiond, this library must be used.
+      The lttng-sessiond communication library. In order to talk with
+      lttng-sessiond, this library must be used.
 
     - libkernel-ctl (internal)
       Kernel tracer control and ioctl definitions.
@@ -122,26 +142,26 @@ PACKAGE CONTENTS:
     - libconsumer (internal)
       Library for Kernel and (optionally) UST trace consumer.
 
-       - libkernel-consumer (internal)
-         Library for Kernel consumer control
+    - libkernel-consumer (internal)
+      Library for Kernel consumer control
+
+    - libust-consumer (internal)
+      Library for UST consumer control
 
-       - libust-consumer (internal)
-         Library for UST consumer control
+    - libhashtable (internal)
+      Library wrapper over URCU hashtables.
 
-       - libhashtable (internal)
-         Library wrapper over URCU hashtables.
+    - libcommon (internal)
+      Contains multiple useful function call used by the whole tree.
 
-       - libcommon (internal)
-         Contains multiple useful function call used by the whole tree.
+    - libcompat (internal)
+      Compatibility library mostly for FreeBSD and Linux.
 
-       - libcompat (internal)
-         Compatibility library mostly for FreeBSD and Linux.
-       
-       - librelayd (internal)
-         Library for all relayd interactions over the network.
+    - librelayd (internal)
+      Library for all relayd interactions over the network.
 
-       - lttng-relayd
-         The relay daemon used for network streaming
+    - lttng-relayd
+      The relay daemon used for network streaming
 
     - lttng-consumerd
       The consumer daemon which uses libconsumer.
@@ -158,9 +178,10 @@ PACKAGE CONTENTS:
     - tests
       Various test programs.
 
-       - doc
-         Various documentations and quickstart guide.
+    - doc
+      Various documentations and quickstart guide.
 
-       - extras
-         Contains extra data such as bash completion file. Python bindings for
-         liblttng-ctl are also available there.
+    - extras
+      Contains extra data such as bash completion file.
+        Note: the presence of xmllint is required for bash-completion.
+         Python bindings for liblttng-ctl are also available there.