.gitignore: ignore local vscode workspace settings file

[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 de90fa05a9bd4a413448cf6d6fe9e0d9c5c1beec..f3ee0e785053792c5e11575802b75fb626fc0e22 100644 (file)
--- a/doc/man/lttng-start.1.txt
+++ b/doc/man/lttng-start.1.txt
@@ -1,40 +1,42 @@
 lttng-start(1)
 ==============
-:revdate: 29 April 2021
+:revdate: 14 June 2021
 
 
 NAME
 ----
-lttng-start - Start an LTTng tracing session
+lttng-start - Start an LTTng recording session
 
 
 SYNOPSIS
 --------
 [verse]
-*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *start* ['SESSION']
+*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *start* [option::--all | option::--glob 'SESSION' | 'SESSION' ]
 
 
 DESCRIPTION
 -----------
-The `lttng start` command starts a tracing session, that is, it
+The `lttng start` command starts a recording session, that is, it
 activates the LTTng tracers for:
 
 With the 'SESSION' argument::
-    The tracing session named 'SESSION'.
+    The recording session named 'SESSION'.
 
 Without the 'SESSION' argument::
-    The current tracing session (see man:lttng-concepts(7) to learn more
-    about the current tracing session).
+    The current recording session (see man:lttng-concepts(7) to learn
+    more about the current recording session).
 
-See man:lttng-concepts(7) to learn more about tracing sessions.
+See man:lttng-concepts(7) to learn more about recording sessions.
 
-The selected tracing session must be inactive (stopped). A tracing
+The selected recording session must be inactive (stopped). A recording
 session is inactive on creation (see man:lttng-create(1)).
 
-A `start-session` trigger action can also start a tracing session
+A `start-session` trigger action can also start a recording session
 (see man:lttng-add-trigger(1)).
 
-Stop an active tracing session with the man:lttng-stop(1) command.
+See the ``<<examples,EXAMPLES>>'' section below for usage examples.
+
+Stop an active recording session with the man:lttng-stop(1) command.
 
 
 include::common-lttng-cmd-options-head.txt[]
@@ -42,10 +44,55 @@ include::common-lttng-cmd-options-head.txt[]
 
 include::common-lttng-cmd-help-options.txt[]
 
+option:-a, option:--all::
+    Start all sessions.
+
+option:-g, option:--glob::
+    Interpret SESSION as a globbing pattern.
 
 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
+----
+====
+
+.Start all sessions.
+====
+See the option::--all option.
+
+[role="term"]
+----
+$ lttng start --all
+----
+====
+
+.Start all sessions with the suffix foo.
+====
+See the option::--glob option.
+
+[role="term"]
+----
+$ lttng start --glob '*foo'
+----
+====
+
+
 include::common-footer.txt[]