Rename "tracing session" -> "recording session"

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

diff --git a/doc/man/lttng-start.1.txt b/doc/man/lttng-start.1.txt
index 2c9405bacc82336a8e391398d0ba2624eac7ad01..b595b2f5ce2f804f605f99ebd350fe910d6ab1a4 100644 (file)
--- a/doc/man/lttng-start.1.txt
+++ b/doc/man/lttng-start.1.txt
@@ -1,10 +1,11 @@
 lttng-start(1)
 ==============
+:revdate: 14 June 2021
 
 
 NAME
 ----
-lttng-start - Start LTTng tracers
+lttng-start - Start an LTTng recording session
 
 
 SYNOPSIS
@@ -15,37 +16,66 @@ SYNOPSIS
 
 DESCRIPTION
 -----------
-The `lttng start` command starts the various LTTng tracers for a
-given inactive tracing session.
+The `lttng start` command starts a recording session, that is, it
+activates the LTTng tracers for:
 
-Starting the LTTng tracers has the effect that all enabled event rules
-within enabled channels can make their target event sources _emit_ trace
-events. Whether they are recorded to the local file system, sent over
-the network, or not recorded at all depends on the specific
-configuration of the tracing session in which tracing is started. See
-linklttng:lttng-create(1) for different session modes.
+With the 'SESSION' argument::
+    The recording session named 'SESSION'.
 
-A tracing session with running tracers is said to be _active_. Active
-tracing sessions can return to the inactive state using the
-linklttng:lttng-stop(1) command.
+Without the 'SESSION' argument::
+    The current recording session (see man:lttng-concepts(7) to learn
+    more about the current recording session).
 
-If 'SESSION' is omitted, the LTTng tracers are started for the current
-tracing session (see linklttng:lttng-create(1) for more information
-about the current tracing session). Otherwise, they are started for the
-existing tracing session named 'SESSION'. `lttng list`
-outputs all the existing tracing sessions (see linklttng:lttng-list(1)).
+See man:lttng-concepts(7) to learn more about recording sessions.
 
+The selected recording session must be inactive (stopped). A recording
+session is inactive on creation (see man:lttng-create(1)).
 
-include::common-cmd-options-head.txt[]
+A `start-session` trigger action can also start a recording session
+(see man:lttng-add-trigger(1)).
 
+See the ``<<examples,EXAMPLES>>'' section below for usage examples.
 
-include::common-cmd-help-options.txt[]
+Stop an active recording session with the man:lttng-stop(1) command.
 
 
-include::common-cmd-footer.txt[]
+include::common-lttng-cmd-options-head.txt[]
+
+
+include::common-lttng-cmd-help-options.txt[]
+
+
+include::common-lttng-cmd-after-options.txt[]
+
+
+[[examples]]
+EXAMPLES
+--------
+.Start the current recording session.
+====
+[role="term"]
+----
+$ lttng start
+----
+====
+
+.Start a specific recording session.
+====
+[role="term"]
+----
+$ lttng start my-session
+----
+====
+
+
+include::common-footer.txt[]
 
 
 SEE ALSO
 --------
-linklttng:lttng-stop(1),
-linklttng:lttng(1)
+man:lttng(1),
+man:lttng-add-trigger(1),
+man:lttng-create(1),
+man:lttng-enable-event(1),
+man:lttng-stop(1),
+man:lttng-concepts(7)