doc/man: use double quotes when referring to internal section

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

diff --git a/doc/man/lttng-rotate.1.txt b/doc/man/lttng-rotate.1.txt
index 50cb3102b3d2a35ae0335572e31477eb858680e8..91df503feba6dbcc6603b3d28cdc612c67d99bfb 100644 (file)
--- a/doc/man/lttng-rotate.1.txt
+++ b/doc/man/lttng-rotate.1.txt
@@ -1,6 +1,6 @@
 lttng-rotate(1)
 ===============
-:revdate: 30 April 2021
+:revdate: 17 May 2021
 
 
 NAME
@@ -62,6 +62,8 @@ directly cause discarded event records or packets.
 A `rotate-session` trigger action can also rotate a tracing session (see
 man:lttng-add-trigger(1)).
 
+See the ``<<examples,EXAMPLES>>'' section below for usage examples.
+
 [IMPORTANT]
 ====
 You may only use the `rotate` command when:
@@ -79,7 +81,7 @@ You may only use the `rotate` command when:
 ====
 
 
-include::common-cmd-options-head.txt[]
+include::common-lttng-cmd-options-head.txt[]
 
 
 option:-n, option:--no-wait::
@@ -87,10 +89,43 @@ option:-n, option:--no-wait::
     completed before exiting.
 
 
-include::common-cmd-help-options.txt[]
+include::common-lttng-cmd-help-options.txt[]
+
+
+include::common-lttng-cmd-after-options.txt[]
+
+
+[[examples]]
+EXAMPLES
+--------
+.Rotate the current tracing session.
+====
+[role="term"]
+----
+$ lttng rotate
+----
+====
+
+.Rotate a specific tracing session.
+====
+[role="term"]
+----
+$ lttng rotate my-session
+----
+====
+
+.Rotate the current tracing session without waiting for completion.
+====
+See the option:--no-wait option.
+
+[role="term"]
+----
+$ lttng rotate --no-wait
+----
+====
 
 
-include::common-cmd-footer.txt[]
+include::common-footer.txt[]
 
 
 SEE ALSO