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>
For example, consider this command:
[role="term"]
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
--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
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
For example, consider the following commands:
[role="term"]
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
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
This command is the equivalent of:
[role="term"]
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
where `COMMAND` is the name of the command about which to get help. If
'COMMAND' is omitted, `lttng help` shows general help about the
Taking a snapshot of the current tracing session is as easy as:
[role="term"]
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
This writes the snapshot files to the configured output. It is possible
to use a custom, unregistered output at record time using the same
This command is the exact equivalent of:
[role="term"]
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.
where `CURSESSION` is the name of the current tracing session.
Use man:lttng-set-session(1) to set the current tracing session.
calls called by a given process:
[role="term"]
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
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
------------------------------------
-lttng track --userspace --pid=3,6,7
------------------------------------
+----
+$ lttng track --userspace --pid=3,6,7
+----
----------------------------------
-lttng untrack --userspace --pid=7
----------------------------------
+----
+$ lttng untrack --userspace --pid=7
+----
----------------------------------
-lttng track --userspace --pid=1,5
----------------------------------
+----
+$ lttng track --userspace --pid=1,5
+----
-------------
-lttng create
-------------
+----
+$ lttng create
+----
--------------------------------------
-lttng untrack --userspace --pid --all
--------------------------------------
+----
+$ lttng untrack --userspace --pid --all
+----
-----------------------------------
-lttng enable-event --userspace ...
-lttng start
-# ...
-lttng track --userspace --pid=3,5
-----------------------------------
+----
+$ lttng enable-event --userspace ...
+$ lttng start
+$ # ...
+$ lttng track --userspace --pid=3,5
+----
--------------------------------
-lttng track --userspace --pid=2
--------------------------------
+----
+$ lttng track --userspace --pid=2
+----