doc/man: lttng(1): clarify UST domain and add links to languages

[lttng-tools.git] / doc / man / lttng.1.txt

diff --git a/doc/man/lttng.1.txt b/doc/man/lttng.1.txt
index 902d8a7e6b1bf70f291cc357d306650333efe345..c569d3db4332d0ce7d07195acb9427ff11210148 100644 (file)
--- a/doc/man/lttng.1.txt
+++ b/doc/man/lttng.1.txt
@@ -11,7 +11,7 @@ SYNOPSIS
 --------
 [verse]
 *lttng* [option:--group='GROUP'] [option:--mi='TYPE'] [option:--no-sessiond | option:--sessiond-path='PATH']
-      [option:--quiet | option:-v | option:-vv | option:-vvv] 'COMMAND' ['COMMAND OPTIONS']
+      [option:--quiet | option:-v | option:-vv | option:-vvv] '<<commands,COMMAND>>' ['COMMAND OPTIONS']
 
 
 DESCRIPTION
@@ -33,20 +33,22 @@ A _tracing domain_ is a tracer category. There are five available
 domains. For some commands, the domain needs to be specified with a
 command-line option. The domain options are:
 
-option:-j, option:--jul::
+nloption:-j, nloption:--jul::
     Apply command to the `java.util.logging` (JUL) domain.
 
-option:-k, option:--kernel::
+nloption:-k, nloption:--kernel::
     Apply command to the Linux kernel domain.
 
-option:-l, option:--log4j::
-    Apply command to the Apache log4j 1.2 (Java) domain.
+nloption:-l, nloption:--log4j::
+    Apply command to the https://logging.apache.org/log4j/1.2/[Apache log4j 1.2]
+    (Java) domain.
 
-option:-p, option:--python::
-    Apply command to the Python domain.
+nloption:-p, nloption:--python::
+    Apply command to the https://www.python.org/[Python] domain.
 
-option:-u, option:--userspace::
-    Apply command to the user space domain.
+nloption:-u, nloption:--userspace::
+    Apply command to the user space domain (application using
+    liblttng-ust directly; see linklttng:lttng-ust(3)).
 
 The LTTng session daemon is a tracing registry which allows the user to
 interact with multiple tracers (kernel and user space) within the same
@@ -137,9 +139,10 @@ option:-V, option:--version::
     Show version.
 
 
+[[commands]]
 COMMANDS
 --------
-The following commands also have their own option:--help option.
+The following commands also have their own nloption:--help option.
 
 
 Tracing sessions
@@ -150,6 +153,9 @@ linklttng:lttng-create(1)::
 linklttng:lttng-destroy(1)::
     Tear down tracing sessions.
 
+linklttng:lttng-load(1)::
+    Load tracing session configurations.
+
 linklttng:lttng-metadata(1)::
     Manage an LTTng tracing session's metadata generation.
 
@@ -159,30 +165,27 @@ linklttng:lttng-save(1)::
 linklttng:lttng-set-session(1)::
     Set current tracing session.
 
-linklttng:lttng-load(1)::
-    Load tracing session configurations.
-
 
 Channels
 ~~~~~~~~
-linklttng:lttng-enable-channel(1)::
-    Create or enable tracing channels.
+linklttng:lttng-add-context(1)::
+    Add context fields to a channel.
 
 linklttng:lttng-disable-channel(1)::
     Disable tracing channels.
 
-linklttng:lttng-add-context(1)::
-    Add context fields to a channel.
+linklttng:lttng-enable-channel(1)::
+    Create or enable tracing channels.
 
 
 Event rules
 ~~~~~~~~~~~
-linklttng:lttng-enable-event(1)::
-    Create or enable event rules.
-
 linklttng:lttng-disable-event(1)::
     Disable event rules.
 
+linklttng:lttng-enable-event(1)::
+    Create or enable event rules.
+
 
 Status
 ~~~~~~