doc/man: add typical `$` and `#` prompts to command lines

It is more instinctive for the typical reader to immediately recognize
command lines when they start with the classic prompts.

On the online version of the man pages, those prompts are treated
specially to make them non-selectable. This makes it possible to copy
multiple command lines at once (without copying the prompts) and to
paste them to your shell.

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

diff --git a/doc/man/lttng-enable-channel.1.txt b/doc/man/lttng-enable-channel.1.txt
index 315f1c54e30e5334df1c7348238418d8d516ccf5..f9b0b1f5a59da57eb99e0a0722d2269fcf479776 100644 (file)
--- a/doc/man/lttng-enable-channel.1.txt
+++ b/doc/man/lttng-enable-channel.1.txt
@@ -201,10 +201,10 @@ in conjunction with the option:--tracefile-size option.
 For example, consider this command:
 
 [role="term"]
------------------------------------------------------
-lttng enable-channel --kernel --tracefile-size=4096 \
+----
+$ lttng enable-channel --kernel --tracefile-size=4096 \
                      --tracefile-count=32 my-channel
------------------------------------------------------
+----
 
 Here, for each stream, the maximum size of each trace file is
 4 kiB and there can be a maximum of 32 different files. When there is

diff --git a/doc/man/lttng-enable-event.1.txt b/doc/man/lttng-enable-event.1.txt
index 1a80fe774aaa4a8ba7574ca056d719efbf5ab7ac..2230df059c8c512882efc9666409a290a8ad18d9 100644 (file)
--- a/doc/man/lttng-enable-event.1.txt
+++ b/doc/man/lttng-enable-event.1.txt
@@ -107,10 +107,10 @@ a _don't care_.
 For example, consider the following commands:
 
 [role="term"]
-----------------------------------------------------------------
-lttng enable-event --userspace hello:world
-lttng enable-event --userspace hello:world --loglevel=TRACE_INFO
-----------------------------------------------------------------
+----
+$ lttng enable-event --userspace hello:world
+$ lttng enable-event --userspace hello:world --loglevel=TRACE_INFO
+----
 
 Here, two event rules are created. The first one has a single condition:
 the tracepoint name must match `hello:world`. The second one has two

diff --git a/doc/man/lttng-help.1.txt b/doc/man/lttng-help.1.txt
index 271e2e86733ece1771484f3c63fae521f743340a..ede7b88f4d866586e49e6973ebf48189d454800c 100644 (file)
--- a/doc/man/lttng-help.1.txt
+++ b/doc/man/lttng-help.1.txt
@@ -21,9 +21,9 @@ command.
 This command is the equivalent of:
 
 [role="term"]
---------------------
-lttng COMMAND --help
---------------------
+----
+$ lttng COMMAND --help
+----
 
 where `COMMAND` is the name of the command about which to get help. If
 'COMMAND' is omitted, `lttng help` shows general help about the

diff --git a/doc/man/lttng-snapshot.1.txt b/doc/man/lttng-snapshot.1.txt
index 816473a555ed8f1059badeba0355b3c9deaa42c3..ac4bebfd756355b9c9a7f80857de162a42128b45 100644 (file)
--- a/doc/man/lttng-snapshot.1.txt
+++ b/doc/man/lttng-snapshot.1.txt
@@ -86,9 +86,9 @@ Taking a snapshot
 Taking a snapshot of the current tracing session is as easy as:
 
 [role="term"]
----------------------
-lttng snapshot record
----------------------
+----
+$ lttng snapshot record
+----
 
 This writes the snapshot files to the configured output. It is possible
 to use a custom, unregistered output at record time using the same

diff --git a/doc/man/lttng-status.1.txt b/doc/man/lttng-status.1.txt
index 0d4965b77320c817b81f8fa75c702fa589f4364d..2fa7b47edd9db5b1ffa078f4854d916cb6c3cd2d 100644 (file)
--- a/doc/man/lttng-status.1.txt
+++ b/doc/man/lttng-status.1.txt
@@ -21,9 +21,9 @@ tracing session.
 This command is the exact equivalent of:
 
 [role="term"]
----------------------
-lttng list CURSESSION
----------------------
+----
+$ lttng list CURSESSION
+----
 
 where `CURSESSION` is the name of the current tracing session.
 Use man:lttng-set-session(1) to set the current tracing session.

diff --git a/doc/man/lttng-track.1.txt b/doc/man/lttng-track.1.txt
index f5696f0c22e4030aaba985447d5b2681220ca01b..de8e7ec9d484591a9450f4156d9c24cc2bc8002d 100644 (file)
--- a/doc/man/lttng-track.1.txt
+++ b/doc/man/lttng-track.1.txt
@@ -36,11 +36,11 @@ With the PID tracker, it is possible, for example, to record all system
 calls called by a given process:
 
 [role="term"]
--------------------------------------------
-lttng enable-event --kernel --all --syscall
-lttng track --kernel --pid=2345
-lttng start
--------------------------------------------
+----
+# lttng enable-event --kernel --all --syscall
+# lttng track --kernel --pid=2345
+# lttng start
+----
 
 If all the PIDs are tracked (i.e. `lttng track --pid --all`, which is
 the default state of all domains when creating a tracing session), then
@@ -62,9 +62,9 @@ Initial whitelist:
 Command:
 
 [role="term"]
------------------------------------
-lttng track --userspace --pid=3,6,7
------------------------------------
+----
+$ lttng track --userspace --pid=3,6,7
+----
 
 Whitelist:
 
@@ -75,9 +75,9 @@ Whitelist:
 Command:
 
 [role="term"]
----------------------------------
-lttng untrack --userspace --pid=7
----------------------------------
+----
+$ lttng untrack --userspace --pid=7
+----
 
 Whitelist:
 
@@ -88,9 +88,9 @@ Whitelist:
 Command:
 
 [role="term"]
----------------------------------
-lttng track --userspace --pid=1,5
----------------------------------
+----
+$ lttng track --userspace --pid=1,5
+----
 
 Whitelist:
 

diff --git a/doc/man/lttng-untrack.1.txt b/doc/man/lttng-untrack.1.txt
index d383740eb851e779be76221b8d6d418db058ee38..3fb02558db45df4e00f3fd78cd77c408a5cecc0d 100644 (file)
--- a/doc/man/lttng-untrack.1.txt
+++ b/doc/man/lttng-untrack.1.txt
@@ -41,9 +41,9 @@ Assume the maximum system PID is 7 for this example.
 Command:
 
 [role="term"]
-------------
-lttng create
-------------
+----
+$ lttng create
+----
 
 Initial whitelist:
 
@@ -54,9 +54,9 @@ Initial whitelist:
 Command:
 
 [role="term"]
--------------------------------------
-lttng untrack --userspace --pid --all
--------------------------------------
+----
+$ lttng untrack --userspace --pid --all
+----
 
 Whitelist:
 
@@ -67,12 +67,12 @@ Whitelist:
 Commands:
 
 [role="term"]
-----------------------------------
-lttng enable-event --userspace ...
-lttng start
-# ...
-lttng track --userspace --pid=3,5
-----------------------------------
+----
+$ lttng enable-event --userspace ...
+$ lttng start
+$ # ...
+$ lttng track --userspace --pid=3,5
+----
 
 Whitelist:
 
@@ -83,9 +83,9 @@ Whitelist:
 Command:
 
 [role="term"]
--------------------------------
-lttng track --userspace --pid=2
--------------------------------
+----
+$ lttng track --userspace --pid=2
+----
 
 Whitelist: