projects / lttng-docs.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
linux-add-lttng-layer: probes/Makefile -> probes/KBuild
[lttng-docs.git] / 2.8 / lttng-docs-2.8.txt
diff --git a/2.8/lttng-docs-2.8.txt b/2.8/lttng-docs-2.8.txt
index 79496e893dbdcd8f360777e29f8ab46ca60d53d8..6b7b9291eb427cd4c59e4e9b137811f3745a14ad 100644 (file)
--- a/2.8/lttng-docs-2.8.txt
+++ b/2.8/lttng-docs-2.8.txt
@@ -1,7 +1,7 @@
 The LTTng Documentation
 =======================
 Philippe Proulx <pproulx@efficios.com>
 The LTTng Documentation
 =======================
 Philippe Proulx <pproulx@efficios.com>
-v2.8, 25 October 2016
+v2.8, 14 March 2017
 
 
 include::../common/copyright.txt[]
 
 
 include::../common/copyright.txt[]
@@ -74,6 +74,15 @@ include::../common/acknowledgements.txt[]
 [[whats-new]]
 == What's new in LTTng {revision}?
 
 [[whats-new]]
 == What's new in LTTng {revision}?
 
+LTTng{nbsp}{revision} bears the name _Isseki Nicho_. The result of a
+collaboration between http://www.dieuduciel.com/[Dieu du Ciel!] and
+Nagano-based Shiga Kogen,
+https://www.beeradvocate.com/beer/profile/1141/53111/[_**Isseki
+Nicho**_] is a strong Imperial Dark Saison offering a rich roasted malt
+flavor combined with a complex fruity finish typical of Saison yeasts.
+
+New features and changes in LTTng{nbsp}{revision}:
+
 * **Tracing control**:
 ** You can attach <<java-application-context,Java application-specific
    context fields>> to a <<channel,channel>> with the
 * **Tracing control**:
 ** You can attach <<java-application-context,Java application-specific
    context fields>> to a <<channel,channel>> with the
@@ -82,7 +91,7 @@ include::../common/acknowledgements.txt[]
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-lttng add-context --jul --type='$app.retriever:cur_msg_id'
+$ lttng add-context --jul --type='$app.retriever:cur_msg_id'
 ----
 --
 +
 ----
 --
 +
@@ -101,7 +110,7 @@ are supported.
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-lttng enable-event --log4j my_logger \
+$ lttng enable-event --log4j my_logger \
                    --filter='$app.retriever:cur_msg_id == 23'
 ----
 --
                    --filter='$app.retriever:cur_msg_id == 23'
 ----
 --
@@ -195,7 +204,7 @@ for an overview of the small API.
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-man lttng-enable-event
+$ man lttng-enable-event
 ----
 --
 +
 ----
 --
 +
@@ -372,68 +381,72 @@ but note that:
   applications.
 
 [role="growable"]
   applications.
 
 [role="growable"]
-.Availability of LTTng{nbsp}{revision} for major Linux distributions.
+.Availability of LTTng{nbsp}{revision} for major Linux distributions as of 14 March 2017.
 |====
 |Distribution |Available in releases |Alternatives
 
 |====
 |Distribution |Available in releases |Alternatives
 
-|Ubuntu
-|<<ubuntu,Ubuntu{nbsp}16.10 _Yakkety Yak_>>
+|https://www.ubuntu.com/[Ubuntu]
+|<<ubuntu,Ubuntu{nbsp}16.10 _Yakkety Yak_>>.
 |LTTng{nbsp}{revision} for Ubuntu{nbsp}14.04 _Trusty Tahr_
 and Ubuntu{nbsp}16.04 _Xenial Xerus_:
 <<ubuntu-ppa,use the LTTng Stable{nbsp}{revision} PPA>>.
 
 |LTTng{nbsp}{revision} for Ubuntu{nbsp}14.04 _Trusty Tahr_
 and Ubuntu{nbsp}16.04 _Xenial Xerus_:
 <<ubuntu-ppa,use the LTTng Stable{nbsp}{revision} PPA>>.
 
-<<building-from-source,Build LTTng{nbsp}{revision} from source>> for
-other Ubuntu releases.
+LTTng{nbsp}2.9 for Ubuntu{nbsp}14.04 _Trusty Tahr_
+and Ubuntu{nbsp}16.04 _Xenial Xerus_:
+link:/docs/v2.9#doc-ubuntu-ppa[use the LTTng Stable{nbsp}2.9 PPA].
 
 
-|Fedora
-|_Not available_
-|LTTng{nbsp}{revision} for Fedora{nbsp}25 and Fedora{nbsp}26 (not
-released yet).
+LTTng{nbsp}2.9 for Ubuntu{nbsp}17.04 _Zesty Zapus_ (not released
+yet).
 
 <<building-from-source,Build LTTng{nbsp}{revision} from source>> for
 
 <<building-from-source,Build LTTng{nbsp}{revision} from source>> for
+other Ubuntu releases.
+
+|https://getfedora.org/[Fedora]
+|<<fedora,Fedora{nbsp}25>>.
+|<<building-from-source,Build LTTng{nbsp}{revision} from source>> for
 other Fedora releases.
 
 other Fedora releases.
 
-|Debian
-|<<debian,Debian "stretch" (testing)>>
-|
-<<building-from-source,Build LTTng{nbsp}{revision} from source>> for
-previous Debian releases.
+|https://www.debian.org/[Debian]
+|_Not available_
+|link:/docs/v2.9#doc-debian[LTTng{nbsp}2.9 for Debian "stretch" (testing)
+and Debian "sid" (unstable)].
+
+<<building-from-source,Build LTTng{nbsp}{revision} from source>>.
 
 
-|openSUSE
+|https://www.opensuse.org/[openSUSE]
 |_Not available_
 |_Not available_
-|LTTng{nbsp}2.7 for openSUSE Leap{nbsp}42.1.
+|<<building-from-source,Build LTTng{nbsp}{revision} from source>>.
 
 
-<<building-from-source,Build LTTng{nbsp}{revision} from source>> for
-other openSUSE releases.
+|https://www.archlinux.org/[Arch Linux]
+|_Not available_
+|link:/docs/v2.9#doc-arch-linux[LTTng{nbsp}2.9 from the AUR].
 
 
-|Arch Linux
-|Latest AUR packages.
-|
+<<building-from-source,Build LTTng{nbsp}{revision} from source>>.
 
 
-|Alpine Linux
-|<<alpine-linux,Alpine Linux "edge">>
-|LTTng{nbsp}{revision} for Alpine Linux{nbsp}3.5 (not released yet).
+|https://alpinelinux.org/[Alpine Linux]
+|_Not available_
+|link:/docs/v2.9#doc-alpine-linux[LTTng{nbsp}2.9 for Alpine Linux "edge"].
 
 
-<<building-from-source,Build LTTng{nbsp}{revision} from source>> for
-other Alpine Linux releases.
+<<building-from-source,Build LTTng{nbsp}{revision} from source>>.
 
 
-|RHEL and SLES
+|https://www.redhat.com/[RHEL] and https://www.suse.com/[SLES]
 |See http://packages.efficios.com/[EfficiOS Enterprise Packages].
 |
 
 |See http://packages.efficios.com/[EfficiOS Enterprise Packages].
 |
 
-|Buildroot
-|_Not available_
-|LTTng{nbsp}{revision} for Buildroot{nbsp}2016.11 (not released yet).
-
-LTTng{nbsp}2.7 for Buildroot{nbsp}2016.02, Buildroot{nbsp}2016.05,
-and Buildroot{nbsp}2016.08.
+|https://buildroot.org/[Buildroot]
+|<<buildroot,Buildroot 2016.11>>.
+|link:/docs/v2.9#doc-buildroot[LTTng{nbsp}2.9 for Buildroot 2017.02].
 
 <<building-from-source,Build LTTng{nbsp}{revision} from source>> for
 other Buildroot releases.
 
 
 <<building-from-source,Build LTTng{nbsp}{revision} from source>> for
 other Buildroot releases.
 
-|OpenEmbedded and Yocto
-|<<oe-yocto,Yocto Project{nbsp}2.2 _Morty_>> (`openembedded-core` layer)
-|<<building-from-source,Build LTTng{nbsp}{revision} from source>> for
+|http://www.openembedded.org/wiki/Main_Page[OpenEmbedded] and
+https://www.yoctoproject.org/[Yocto]
+|<<oe-yocto,Yocto Project{nbsp}2.2 _Morty_>> (`openembedded-core` layer).
+|LTTng{nbsp}2.9 for Yocto Project{nbsp}2.3 _Pyro_
+(`openembedded-core` layer) (not released yet).
+
+<<building-from-source,Build LTTng{nbsp}{revision} from source>> for
 other OpenEmbedded releases.
 |====
 
 other OpenEmbedded releases.
 |====
 
@@ -445,16 +458,16 @@ LTTng{nbsp}{revision} is available on Ubuntu{nbsp}16.10 _Yakkety Yak_.
 For previous releases of Ubuntu, <<ubuntu-ppa,use the LTTng
 Stable{nbsp}{revision} PPA>>.
 
 For previous releases of Ubuntu, <<ubuntu-ppa,use the LTTng
 Stable{nbsp}{revision} PPA>>.
 
-To install LTTng{nbsp}{revision} on Ubuntu 16.10{nbsp}_Yakkety Yak_:
+To install LTTng{nbsp}{revision} on Ubuntu{nbsp}16.10 _Yakkety Yak_:
 
 . Install the main LTTng{nbsp}{revision} packages:
 +
 --
 [role="term"]
 ----
 
 . Install the main LTTng{nbsp}{revision} packages:
 +
 --
 [role="term"]
 ----
-sudo apt-get install lttng-tools
-sudo apt-get install lttng-modules-dkms
-sudo apt-get install liblttng-ust-dev
+# apt-get install lttng-tools
+# apt-get install lttng-modules-dkms
+# apt-get install liblttng-ust-dev
 ----
 --
 
 ----
 --
 
@@ -465,18 +478,18 @@ sudo apt-get install liblttng-ust-dev
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-sudo apt-get install liblttng-ust-agent-java
+# apt-get install liblttng-ust-agent-java
 ----
 --
 
 . **If you need to instrument and trace
 ----
 --
 
 . **If you need to instrument and trace
-  <<python-application,Python applications>>**, install the
+  <<python-application,Python{nbsp}3 applications>>**, install the
   LTTng-UST Python agent:
 +
 --
 [role="term"]
 ----
   LTTng-UST Python agent:
 +
 --
 [role="term"]
 ----
-sudo apt-get install python3-lttngust
+# apt-get install python3-lttngust
 ----
 --
 
 ----
 --
 
@@ -499,8 +512,8 @@ To install LTTng{nbsp}{revision} from the LTTng Stable{nbsp}{revision} PPA:
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-sudo apt-add-repository ppa:lttng/stable-2.8
-sudo apt-get update
+# apt-add-repository ppa:lttng/stable-2.8
+# apt-get update
 ----
 --
 
 ----
 --
 
@@ -509,9 +522,9 @@ sudo apt-get update
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-sudo apt-get install lttng-tools
-sudo apt-get install lttng-modules-dkms
-sudo apt-get install liblttng-ust-dev
+# apt-get install lttng-tools
+# apt-get install lttng-modules-dkms
+# apt-get install liblttng-ust-dev
 ----
 --
 
 ----
 --
 
@@ -522,107 +535,99 @@ sudo apt-get install liblttng-ust-dev
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-sudo apt-get install liblttng-ust-agent-java
+# apt-get install liblttng-ust-agent-java
 ----
 --
 
 . **If you need to instrument and trace
 ----
 --
 
 . **If you need to instrument and trace
-  <<python-application,Python applications>>**, install the
+  <<python-application,Python{nbsp}3 applications>>**, install the
   LTTng-UST Python agent:
 +
 --
 [role="term"]
 ----
   LTTng-UST Python agent:
 +
 --
 [role="term"]
 ----
-sudo apt-get install python3-lttngust
+# apt-get install python3-lttngust
 ----
 --
 
 
 ----
 --
 
 
-[[debian]]
-=== Debian
+[[fedora]]
+=== Fedora
 
 
-To install LTTng{nbsp}{revision} on Debian "stretch" (testing):
+To install LTTng{nbsp}{revision} on Fedora{nbsp}25:
 
 
-. Install the main LTTng{nbsp}{revision} packages:
+. Install the LTTng-tools{nbsp}{revision} and LTTng-UST{nbsp}{revision}
+  packages:
 +
 --
 [role="term"]
 ----
 +
 --
 [role="term"]
 ----
-sudo apt-get install lttng-modules-dkms
-sudo apt-get install liblttng-ust-dev
-sudo apt-get install lttng-tools
+# yum install lttng-tools
+# yum install lttng-ust
 ----
 --
 
 ----
 --
 
-. **If you need to instrument and trace <<java-application,Java
-  applications>>**, install the LTTng-UST Java agent:
+. Download, build, and install the latest LTTng-modules{nbsp}{revision}:
 +
 --
 [role="term"]
 ----
 +
 --
 [role="term"]
 ----
-sudo apt-get install liblttng-ust-agent-java
+$ cd $(mktemp -d) &&
+wget http://lttng.org/files/lttng-modules/lttng-modules-latest-2.8.tar.bz2 &&
+tar -xf lttng-modules-latest-2.8.tar.bz2 &&
+cd lttng-modules-2.8.* &&
+make &&
+sudo make modules_install &&
+sudo depmod -a
 ----
 --
 
 ----
 --
 
-. **If you need to instrument and trace <<python-application,Python
-  applications>>**, install the LTTng-UST Python agent:
-+
---
-[role="term"]
-----
-sudo apt-get install python3-lttngust
-----
---
+[IMPORTANT]
+.Java and Python application instrumentation and tracing
+====
+If you need to instrument and trace <<java-application,Java
+applications>> on openSUSE, you need to build and install
+LTTng-UST{nbsp}{revision} <<building-from-source,from source>> and pass
+the `--enable-java-agent-jul`, `--enable-java-agent-log4j`, or
+`--enable-java-agent-all` options to the `configure` script, depending
+on which Java logging framework you use.
 
 
+If you need to instrument and trace <<python-application,Python
+applications>> on openSUSE, you need to build and install
+LTTng-UST{nbsp}{revision} from source and pass the
+`--enable-python-agent` option to the `configure` script.
+====
 
 
-[[alpine-linux]]
-=== Alpine Linux
 
 
-To install LTTng{nbsp}{revision} (tracing control and user space
-tracing) on Alpine Linux "edge":
+[[enterprise-distributions]]
+=== RHEL, SUSE, and other enterprise distributions
 
 
-. Make sure your system is
-  https://wiki.alpinelinux.org/wiki/Edge[configured for "edge"].
-. Enable the _testing_ repository by uncommenting the corresponding
-  line in path:{/etc/apk/repositories}.
-. Add the LTTng packages:
-+
---
-[role="term"]
-----
-sudo apk add lttng-tools
-sudo apk add lttng-ust-dev
-----
---
+To install LTTng on enterprise Linux distributions, such as Red Hat
+Enterprise Linux (RHEL) and SUSE Linux Enterprise Server (SUSE), please
+see http://packages.efficios.com/[EfficiOS Enterprise Packages].
 
 
-To install LTTng-modules{nbsp}{revision} (Linux kernel tracing support)
-on Alpine Linux "edge":
 
 
-. Add the vanilla Linux kernel:
-+
---
-[role="term"]
-----
-apk add linux-vanilla linux-vanilla-dev
-----
---
+[[buildroot]]
+=== Buildroot
 
 
-. Reboot with the vanilla Linux kernel.
-. Download, build, and install the latest LTTng-modules{nbsp}{revision}:
+To install LTTng{nbsp}{revision} on Buildroot{nbsp}2016.11:
+
+. Launch the Buildroot configuration tool:
 +
 --
 [role="term"]
 ----
 +
 --
 [role="term"]
 ----
-cd $(mktemp -d) &&
-wget http://lttng.org/files/lttng-modules/lttng-modules-latest-2.8.tar.bz2 &&
-tar -xf lttng-modules-latest-2.8.tar.bz2 &&
-cd lttng-modules-2.8.* &&
-make &&
-sudo make modules_install &&
-sudo depmod -a
+$ make menuconfig
 ----
 --
 
 ----
 --
 
+. In **Kernel**, check **Linux kernel**.
+. In **Toolchain**, check **Enable WCHAR support**.
+. In **Target packages**{nbsp}&#8594; **Debugging, profiling and benchmark**,
+  check **lttng-modules** and **lttng-tools**.
+. In **Target packages**{nbsp}&#8594; **Libraries**{nbsp}&#8594;
+  **Other**, check **lttng-libust**.
+
 
 [[oe-yocto]]
 === OpenEmbedded and Yocto
 
 [[oe-yocto]]
 === OpenEmbedded and Yocto
@@ -666,14 +671,6 @@ LTTng-UST{nbsp}{revision} from source and pass the
 ====
 
 
 ====
 
 
-[[enterprise-distributions]]
-=== RHEL, SUSE, and other enterprise distributions
-
-To install LTTng on enterprise Linux distributions, such as Red Hat
-Enterprise Linux (RHEL) and SUSE Linux Enterprise Server (SUSE), please
-see http://packages.efficios.com/[EfficiOS Enterprise Packages].
-
-
 [[building-from-source]]
 === Build from source
 
 [[building-from-source]]
 === Build from source
 
@@ -694,7 +691,7 @@ To build and install LTTng{nbsp}{revision} from source:
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-cd $(mktemp -d) &&
+$ cd $(mktemp -d) &&
 wget http://lttng.org/files/lttng-modules/lttng-modules-latest-2.8.tar.bz2 &&
 tar -xf lttng-modules-latest-2.8.tar.bz2 &&
 cd lttng-modules-2.8.* &&
 wget http://lttng.org/files/lttng-modules/lttng-modules-latest-2.8.tar.bz2 &&
 tar -xf lttng-modules-latest-2.8.tar.bz2 &&
 cd lttng-modules-2.8.* &&
@@ -709,7 +706,7 @@ sudo depmod -a
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-cd $(mktemp -d) &&
+$ cd $(mktemp -d) &&
 wget http://lttng.org/files/lttng-ust/lttng-ust-latest-2.8.tar.bz2 &&
 tar -xf lttng-ust-latest-2.8.tar.bz2 &&
 cd lttng-ust-2.8.* &&
 wget http://lttng.org/files/lttng-ust/lttng-ust-latest-2.8.tar.bz2 &&
 tar -xf lttng-ust-latest-2.8.tar.bz2 &&
 cd lttng-ust-2.8.* &&
@@ -759,7 +756,7 @@ instrumented user application with `liblttng-ust`>>:
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-cd $(mktemp -d) &&
+$ cd $(mktemp -d) &&
 wget http://lttng.org/files/lttng-tools/lttng-tools-latest-2.8.tar.bz2 &&
 tar -xf lttng-tools-latest-2.8.tar.bz2 &&
 cd lttng-tools-2.8.* &&
 wget http://lttng.org/files/lttng-tools/lttng-tools-latest-2.8.tar.bz2 &&
 tar -xf lttng-tools-latest-2.8.tar.bz2 &&
 cd lttng-tools-2.8.* &&
@@ -797,16 +794,18 @@ This tutorial walks you through the steps to:
 [[tracing-the-linux-kernel]]
 === Trace the Linux kernel
 
 [[tracing-the-linux-kernel]]
 === Trace the Linux kernel
 
-The following command lines start with cmd:sudo because you need root
-privileges to trace the Linux kernel. You can avoid using cmd:sudo if
-your Unix user is a member of the <<lttng-sessiond,tracing group>>.
+The following command lines start with the `#` prompt because you need
+root privileges to trace the Linux kernel. You can also trace the kernel
+as a regular user if your Unix user is a member of the
+<<tracing-group,tracing group>>.
 
 
-. Create a <<tracing-session,tracing session>>:
+. Create a <<tracing-session,tracing session>> which writes its traces
+  to dir:{/tmp/my-kernel-trace}:
 +
 --
 [role="term"]
 ----
 +
 --
 [role="term"]
 ----
-sudo lttng create my-kernel-session
+# lttng create my-kernel-session --output=/tmp/my-kernel-trace
 ----
 --
 
 ----
 --
 
@@ -815,42 +814,46 @@ sudo lttng create my-kernel-session
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-lttng list --kernel
+# lttng list --kernel
+# lttng list --kernel --syscall
 ----
 --
 
 ----
 --
 
-. Create an <<event,event rule>> which matches the desired event names,
-  for example `sched_switch` and `sched_process_fork`:
+. Create <<event,event rules>> which match the desired instrumentation
+  point names, for example the `sched_switch` and `sched_process_fork`
+  tracepoints, and the man:open(2) and man:close(2) system calls:
 +
 --
 [role="term"]
 ----
 +
 --
 [role="term"]
 ----
-sudo lttng enable-event --kernel sched_switch,sched_process_fork
+# lttng enable-event --kernel sched_switch,sched_process_fork
+# lttng enable-event --kernel --syscall open,close
 ----
 --
 +
 ----
 --
 +
-You can also create an event rule which _matches_ all the Linux kernel
+You can also create an event rule which matches _all_ the Linux kernel
 tracepoints (this will generate a lot of data when tracing):
 +
 --
 [role="term"]
 ----
 tracepoints (this will generate a lot of data when tracing):
 +
 --
 [role="term"]
 ----
-sudo lttng enable-event --kernel --all
+# lttng enable-event --kernel --all
 ----
 --
 
 ----
 --
 
-. Start tracing:
+. <<basic-tracing-session-control,Start tracing>>:
 +
 --
 [role="term"]
 ----
 +
 --
 [role="term"]
 ----
-sudo lttng start
+# lttng start
 ----
 --
 
 . Do some operation on your system for a few seconds. For example,
   load a website, or list the files of a directory.
 ----
 --
 
 . Do some operation on your system for a few seconds. For example,
   load a website, or list the files of a directory.
-. Stop tracing and destroy the tracing session:
+. <<basic-tracing-session-control,Stop tracing>> and destroy the
+  tracing session:
 +
 --
 [role="term"]
 +
 --
 [role="term"]
@@ -863,10 +866,15 @@ sudo lttng destroy
 The man:lttng-destroy(1) command does not destroy the trace data; it
 only destroys the state of the tracing session.
 
 The man:lttng-destroy(1) command does not destroy the trace data; it
 only destroys the state of the tracing session.
 
-By default, LTTng saves the traces in
-+$LTTNG_HOME/lttng-traces/__name__-__date__-__time__+,
-where +__name__+ is the tracing session name. Note that the
-env:LTTNG_HOME environment variable defaults to `$HOME` if not set.
+. For the sake of this example, make the recorded trace accessible to
+  the non-root users:
++
+--
+[role="term"]
+----
+sudo chown -R $(whoami) /tmp/my-kernel-trace
+----
+--
 
 See <<viewing-and-analyzing-your-traces,View and analyze the
 recorded events>> to view the recorded events.
 
 See <<viewing-and-analyzing-your-traces,View and analyze the
 recorded events>> to view the recorded events.
@@ -935,7 +943,7 @@ TRACEPOINT_EVENT(
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-gcc -c -I. hello-tp.c
+$ gcc -c -I. hello-tp.c
 ----
 --
 
 ----
 --
 
@@ -995,7 +1003,7 @@ int main(int argc, char *argv[])
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-gcc -c hello.c
+$ gcc -c hello.c
 ----
 --
 
 ----
 --
 
@@ -1005,7 +1013,7 @@ gcc -c hello.c
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-gcc -o hello hello.o hello-tp.o -llttng-ust -ldl
+$ gcc -o hello hello.o hello-tp.o -llttng-ust -ldl
 ----
 --
 
 ----
 --
 
@@ -1022,7 +1030,7 @@ To trace the user application:
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-./hello world and beyond
+$ ./hello world and beyond
 ----
 --
 +
 ----
 --
 +
@@ -1040,7 +1048,7 @@ Press Enter to continue...
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-lttng-sessiond --daemonize
+$ lttng-sessiond --daemonize
 ----
 --
 +
 ----
 --
 +
@@ -1052,7 +1060,7 @@ a service that the distribution's service manager started.
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-lttng list --userspace
+$ lttng list --userspace
 ----
 --
 +
 ----
 --
 +
@@ -1064,7 +1072,7 @@ under the `./hello` process.
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-lttng create my-user-space-session
+$ lttng create my-user-space-session
 ----
 --
 
 ----
 --
 
@@ -1074,28 +1082,29 @@ lttng create my-user-space-session
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-lttng enable-event --userspace hello_world:my_first_tracepoint
+$ lttng enable-event --userspace hello_world:my_first_tracepoint
 ----
 --
 
 ----
 --
 
-. Start tracing:
+. <<basic-tracing-session-control,Start tracing>>:
 +
 --
 [role="term"]
 ----
 +
 --
 [role="term"]
 ----
-lttng start
+$ lttng start
 ----
 --
 
 . Go back to the running `hello` application and press Enter. The
   program executes all `tracepoint()` instrumentation points and exits.
 ----
 --
 
 . Go back to the running `hello` application and press Enter. The
   program executes all `tracepoint()` instrumentation points and exits.
-. Stop tracing and destroy the tracing session:
+. <<basic-tracing-session-control,Stop tracing>> and destroy the
+  tracing session:
 +
 --
 [role="term"]
 ----
 +
 --
 [role="term"]
 ----
-sudo lttng stop
-sudo lttng destroy
+$ lttng stop
+$ lttng destroy
 ----
 --
 +
 ----
 --
 +
@@ -1104,7 +1113,7 @@ only destroys the state of the tracing session.
 
 By default, LTTng saves the traces in
 +$LTTNG_HOME/lttng-traces/__name__-__date__-__time__+,
 
 By default, LTTng saves the traces in
 +$LTTNG_HOME/lttng-traces/__name__-__date__-__time__+,
-where +__name__+ is the tracing session name. Note that the
+where +__name__+ is the tracing session name. The
 env:LTTNG_HOME environment variable defaults to `$HOME` if not set.
 
 See <<viewing-and-analyzing-your-traces,View and analyze the
 env:LTTNG_HOME environment variable defaults to `$HOME` if not set.
 
 See <<viewing-and-analyzing-your-traces,View and analyze the
@@ -1138,7 +1147,7 @@ Many tools are available to read LTTng traces:
 
 NOTE: This section assumes that the traces recorded during the previous
 tutorials were saved to their default location, in the
 
 NOTE: This section assumes that the traces recorded during the previous
 tutorials were saved to their default location, in the
-dir:{$LTTNG_HOME/lttng-traces} directory. Note that the env:LTTNG_HOME
+dir:{$LTTNG_HOME/lttng-traces} directory. The env:LTTNG_HOME
 environment variable defaults to `$HOME` if not set.
 
 
 environment variable defaults to `$HOME` if not set.
 
 
@@ -1150,7 +1159,7 @@ its path to cmd:babeltrace with no options:
 
 [role="term"]
 ----
 
 [role="term"]
 ----
-babeltrace ~/lttng-traces/my-user-space-session*
+$ babeltrace ~/lttng-traces/my-user-space-session*
 ----
 
 cmd:babeltrace finds all traces recursively within the given path and
 ----
 
 cmd:babeltrace finds all traces recursively within the given path and
@@ -1161,7 +1170,7 @@ further filtering:
 
 [role="term"]
 ----
 
 [role="term"]
 ----
-babeltrace ~/lttng-traces/my-kernel-session* | grep sys_
+$ babeltrace /tmp/my-kernel-trace | grep _switch
 ----
 
 You can pipe the output of cmd:babeltrace into a tool like man:wc(1) to
 ----
 
 You can pipe the output of cmd:babeltrace into a tool like man:wc(1) to
@@ -1169,7 +1178,7 @@ count the recorded events:
 
 [role="term"]
 ----
 
 [role="term"]
 ----
-babeltrace ~/lttng-traces/my-kernel-session* | grep sys_read | wc --lines
+$ babeltrace /tmp/my-kernel-trace | grep _open | wc --lines
 ----
 
 
 ----
 
 
@@ -1271,7 +1280,7 @@ Run this script:
 
 [role="term"]
 ----
 
 [role="term"]
 ----
-python3 top5proc.py ~/lttng-traces/my-kernel-session*/kernel
+$ python3 top5proc.py /tmp/my-kernel-trace/kernel
 ----
 
 Output example:
 ----
 
 Output example:
@@ -1549,8 +1558,8 @@ to configure the sub-buffer count and size for them:
 * **High event throughput**: In general, prefer bigger sub-buffers to
   lower the risk of losing event records.
 +
 * **High event throughput**: In general, prefer bigger sub-buffers to
   lower the risk of losing event records.
 +
-Having bigger sub-buffers also ensures a lower sub-buffer switching
-frequency.
+Having bigger sub-buffers also ensures a lower
+<<channel-switch-timer,sub-buffer switching frequency>>.
 +
 The number of sub-buffers is only meaningful if you create the channel
 in overwrite mode: in this case, if a sub-buffer overwrite happens, the
 +
 The number of sub-buffers is only meaningful if you create the channel
 in overwrite mode: in this case, if a sub-buffer overwrite happens, the
@@ -1787,7 +1796,7 @@ The cmd:lttng tool has a Git-like interface:
 
 [role="term"]
 ----
 
 [role="term"]
 ----
-lttng <general options> <command> <command options>
+$ lttng <GENERAL OPTIONS> <COMMAND> <COMMAND OPTIONS>
 ----
 
 The <<controlling-tracing,Tracing control>> section explores the
 ----
 
 The <<controlling-tracing,Tracing control>> section explores the
@@ -2628,7 +2637,7 @@ holding more than one tracepoint providers.
 Once you <<tpp-header,create a tracepoint provider header file>>, you
 can use the `tracepoint()` macro in your application's
 source code to insert the tracepoints that this header
 Once you <<tpp-header,create a tracepoint provider header file>>, you
 can use the `tracepoint()` macro in your application's
 source code to insert the tracepoints that this header
-<<defining-tracepoints,defined>> defines.
+<<defining-tracepoints,defines>>.
 
 The `tracepoint()` macro takes at least two parameters: the tracepoint
 provider name and the tracepoint name. The corresponding tracepoint
 
 The `tracepoint()` macro takes at least two parameters: the tracepoint
 provider name and the tracepoint name. The corresponding tracepoint
@@ -2837,10 +2846,11 @@ In the following diagrams, we use the following file names:
 `libemon.so`::
   User library shared object file.
 
 `libemon.so`::
   User library shared object file.
 
-The red star indicates that this object file is instrumented
-(contains code which uses the `tracepoint()` macro). The spring
-symbol between the application and a library means the application is
-linked with the library at build time.
+We use the following symbols in the diagrams of table below:
+
+[role="img-100"]
+.Symbols used in the build scenario diagrams.
+image::ust-sit-symbols.png[]
 
 We assume that path:{.} is part of the env:LD_LIBRARY_PATH environment
 variable in the following instructions.
 
 We assume that path:{.} is part of the env:LD_LIBRARY_PATH environment
 variable in the following instructions.
@@ -2875,7 +2885,7 @@ To build the instrumented application:
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-gcc -c app.c
+$ gcc -c app.c
 ----
 --
 
 ----
 --
 
@@ -2884,7 +2894,7 @@ gcc -c app.c
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-gcc -o app app.o tpp.o -llttng-ust -ldl
+$ gcc -o app app.o tpp.o -llttng-ust -ldl
 ----
 --
 
 ----
 --
 
@@ -2895,7 +2905,7 @@ To run the instrumented application:
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-./app
+$ ./app
 ----
 --
 
 ----
 --
 
@@ -2913,7 +2923,7 @@ To create the tracepoint provider package archive file:
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-gcc -I. -c tpp.c
+$ gcc -I. -c tpp.c
 ----
 --
 
 ----
 --
 
@@ -2922,7 +2932,7 @@ gcc -I. -c tpp.c
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-ar rcs tpp.a tpp.o
+$ ar rcs tpp.a tpp.o
 ----
 --
 
 ----
 --
 
@@ -2942,7 +2952,7 @@ To build the instrumented application:
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-gcc -c app.c
+$ gcc -c app.c
 ----
 --
 
 ----
 --
 
@@ -2951,7 +2961,7 @@ gcc -c app.c
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-gcc -o app app.o tpp.a -llttng-ust -ldl
+$ gcc -o app app.o tpp.a -llttng-ust -ldl
 ----
 --
 
 ----
 --
 
@@ -2962,7 +2972,7 @@ To run the instrumented application:
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-./app
+$ ./app
 ----
 --
 
 ----
 --
 
@@ -2991,7 +3001,7 @@ To build the instrumented application:
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-gcc -c app.c
+$ gcc -c app.c
 ----
 --
 
 ----
 --
 
@@ -3000,7 +3010,7 @@ gcc -c app.c
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-gcc -o app app.o -ldl -L. -ltpp
+$ gcc -o app app.o -ldl -L. -ltpp
 ----
 --
 
 ----
 --
 
@@ -3011,7 +3021,7 @@ To run the instrumented application:
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-./app
+$ ./app
 ----
 --
 
 ----
 --
 
@@ -3042,7 +3052,7 @@ To build the instrumented application:
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-gcc -c app.c
+$ gcc -c app.c
 ----
 --
 
 ----
 --
 
@@ -3051,7 +3061,7 @@ gcc -c app.c
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-gcc -o app app.o -ldl
+$ gcc -o app app.o -ldl
 ----
 --
 
 ----
 --
 
@@ -3063,7 +3073,7 @@ To run the instrumented application with tracing support:
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-LD_PRELOAD=./libtpp.so ./app
+$ LD_PRELOAD=./libtpp.so ./app
 ----
 --
 
 ----
 --
 
@@ -3074,7 +3084,7 @@ To run the instrumented application without tracing support:
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-./app
+$ ./app
 ----
 --
 
 ----
 --
 
@@ -3107,7 +3117,7 @@ To build the instrumented application:
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-gcc -c app.c
+$ gcc -c app.c
 ----
 --
 
 ----
 --
 
@@ -3116,7 +3126,7 @@ gcc -c app.c
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-gcc -o app app.o -ldl
+$ gcc -o app app.o -ldl
 ----
 --
 
 ----
 --
 
@@ -3127,7 +3137,7 @@ To run the instrumented application:
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-./app
+$ ./app
 ----
 --
 
 ----
 --
 
@@ -3159,7 +3169,7 @@ To build the instrumented user library:
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-gcc -I. -fpic -c emon.c
+$ gcc -I. -fpic -c emon.c
 ----
 --
 
 ----
 --
 
@@ -3168,7 +3178,7 @@ gcc -I. -fpic -c emon.c
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-gcc -shared -o libemon.so emon.o tpp.o -llttng-ust -ldl
+$ gcc -shared -o libemon.so emon.o tpp.o -llttng-ust -ldl
 ----
 --
 
 ----
 --
 
@@ -3179,7 +3189,7 @@ To build the application:
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-gcc -c app.c
+$ gcc -c app.c
 ----
 --
 
 ----
 --
 
@@ -3188,7 +3198,7 @@ gcc -c app.c
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-gcc -o app app.o -L. -lemon
+$ gcc -o app app.o -L. -lemon
 ----
 --
 
 ----
 --
 
@@ -3199,7 +3209,7 @@ To run the application:
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-./app
+$ ./app
 ----
 --
 
 ----
 --
 
@@ -3231,7 +3241,7 @@ To build the instrumented user library:
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-gcc -I. -fpic -c emon.c
+$ gcc -I. -fpic -c emon.c
 ----
 --
 
 ----
 --
 
@@ -3240,7 +3250,7 @@ gcc -I. -fpic -c emon.c
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-gcc -shared -o libemon.so emon.o -ldl -L. -ltpp
+$ gcc -shared -o libemon.so emon.o -ldl -L. -ltpp
 ----
 --
 
 ----
 --
 
@@ -3251,7 +3261,7 @@ To build the application:
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-gcc -c app.c
+$ gcc -c app.c
 ----
 --
 
 ----
 --
 
@@ -3260,7 +3270,7 @@ gcc -c app.c
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-gcc -o app app.o -L. -lemon
+$ gcc -o app app.o -L. -lemon
 ----
 --
 
 ----
 --
 
@@ -3271,7 +3281,7 @@ To run the application:
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-./app
+$ ./app
 ----
 --
 
 ----
 --
 
@@ -3289,7 +3299,7 @@ include::../common/ust-sit-step-tp-so.txt[]
 To build the instrumented user library:
 
 . In path:{emon.c}, before including path:{tpp.h}, add the
 To build the instrumented user library:
 
 . In path:{emon.c}, before including path:{tpp.h}, add the
-  following line:
+  following lines:
 +
 --
 [source,c]
 +
 --
 [source,c]
@@ -3304,7 +3314,7 @@ To build the instrumented user library:
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-gcc -I. -fpic -c emon.c
+$ gcc -I. -fpic -c emon.c
 ----
 --
 
 ----
 --
 
@@ -3313,7 +3323,7 @@ gcc -I. -fpic -c emon.c
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-gcc -shared -o libemon.so emon.o -ldl
+$ gcc -shared -o libemon.so emon.o -ldl
 ----
 --
 
 ----
 --
 
@@ -3324,7 +3334,7 @@ To build the application:
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-gcc -c app.c
+$ gcc -c app.c
 ----
 --
 
 ----
 --
 
@@ -3333,7 +3343,7 @@ gcc -c app.c
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-gcc -o app app.o -L. -lemon
+$ gcc -o app app.o -L. -lemon
 ----
 --
 
 ----
 --
 
@@ -3345,7 +3355,7 @@ To run the application with tracing support:
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-LD_PRELOAD=./libtpp.so ./app
+$ LD_PRELOAD=./libtpp.so ./app
 ----
 --
 
 ----
 --
 
@@ -3356,7 +3366,7 @@ To run the application without tracing support:
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-./app
+$ ./app
 ----
 --
 
 ----
 --
 
@@ -3376,7 +3386,7 @@ include::../common/ust-sit-step-tp-so.txt[]
 To build the instrumented user library:
 
 . In path:{emon.c}, before including path:{tpp.h}, add the
 To build the instrumented user library:
 
 . In path:{emon.c}, before including path:{tpp.h}, add the
-  following line:
+  following lines:
 +
 --
 [source,c]
 +
 --
 [source,c]
@@ -3391,7 +3401,7 @@ To build the instrumented user library:
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-gcc -I. -fpic -c emon.c
+$ gcc -I. -fpic -c emon.c
 ----
 --
 
 ----
 --
 
@@ -3400,7 +3410,7 @@ gcc -I. -fpic -c emon.c
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-gcc -shared -o libemon.so emon.o -ldl
+$ gcc -shared -o libemon.so emon.o -ldl
 ----
 --
 
 ----
 --
 
@@ -3411,7 +3421,7 @@ To build the application:
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-gcc -c app.c
+$ gcc -c app.c
 ----
 --
 
 ----
 --
 
@@ -3420,7 +3430,7 @@ gcc -c app.c
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-gcc -o app app.o -L. -lemon
+$ gcc -o app app.o -L. -lemon
 ----
 --
 
 ----
 --
 
@@ -3431,7 +3441,7 @@ To run the application:
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-./app
+$ ./app
 ----
 --
 
 ----
 --
 
@@ -3465,7 +3475,7 @@ To build the instrumented user library:
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-gcc -I. -fpic -c emon.c
+$ gcc -I. -fpic -c emon.c
 ----
 --
 
 ----
 --
 
@@ -3474,7 +3484,7 @@ gcc -I. -fpic -c emon.c
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-gcc -shared -o libemon.so emon.o -ldl -L. -ltpp
+$ gcc -shared -o libemon.so emon.o -ldl -L. -ltpp
 ----
 --
 
 ----
 --
 
@@ -3485,7 +3495,7 @@ To build the application:
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-gcc -c app.c
+$ gcc -c app.c
 ----
 --
 
 ----
 --
 
@@ -3494,7 +3504,7 @@ gcc -c app.c
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-gcc -o app app.o -ldl -L. -lemon
+$ gcc -o app app.o -ldl -L. -lemon
 ----
 --
 
 ----
 --
 
@@ -3505,7 +3515,7 @@ To run the application:
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-./app
+$ ./app
 ----
 --
 
 ----
 --
 
@@ -3525,7 +3535,7 @@ include::../common/ust-sit-step-tp-so.txt[]
 To build the instrumented user library:
 
 . In path:{emon.c}, before including path:{tpp.h}, add the
 To build the instrumented user library:
 
 . In path:{emon.c}, before including path:{tpp.h}, add the
-  following line:
+  following lines:
 +
 --
 [source,c]
 +
 --
 [source,c]
@@ -3540,7 +3550,7 @@ To build the instrumented user library:
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-gcc -I. -fpic -c emon.c
+$ gcc -I. -fpic -c emon.c
 ----
 --
 
 ----
 --
 
@@ -3549,7 +3559,7 @@ gcc -I. -fpic -c emon.c
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-gcc -shared -o libemon.so emon.o -ldl
+$ gcc -shared -o libemon.so emon.o -ldl
 ----
 --
 
 ----
 --
 
@@ -3560,7 +3570,7 @@ To build the application:
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-gcc -c app.c
+$ gcc -c app.c
 ----
 --
 
 ----
 --
 
@@ -3569,7 +3579,7 @@ gcc -c app.c
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-gcc -o app app.o -ldl -L. -lemon
+$ gcc -o app app.o -ldl -L. -lemon
 ----
 --
 
 ----
 --
 
@@ -3580,7 +3590,7 @@ To run the application:
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-./app
+$ ./app
 ----
 --
 
 ----
 --
 
@@ -3598,7 +3608,7 @@ include::../common/ust-sit-step-tp-so.txt[]
 To build the instrumented user library:
 
 . In path:{emon.c}, before including path:{tpp.h}, add the
 To build the instrumented user library:
 
 . In path:{emon.c}, before including path:{tpp.h}, add the
-  following line:
+  following lines:
 +
 --
 [source,c]
 +
 --
 [source,c]
@@ -3613,7 +3623,7 @@ To build the instrumented user library:
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-gcc -I. -fpic -c emon.c
+$ gcc -I. -fpic -c emon.c
 ----
 --
 
 ----
 --
 
@@ -3622,7 +3632,7 @@ gcc -I. -fpic -c emon.c
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-gcc -shared -o libemon.so emon.o -ldl
+$ gcc -shared -o libemon.so emon.o -ldl
 ----
 --
 
 ----
 --
 
@@ -3633,7 +3643,7 @@ To build the application:
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-gcc -c app.c
+$ gcc -c app.c
 ----
 --
 
 ----
 --
 
@@ -3642,7 +3652,7 @@ gcc -c app.c
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-gcc -o app app.o -L. -lemon
+$ gcc -o app app.o -L. -lemon
 ----
 --
 
 ----
 --
 
@@ -3654,7 +3664,7 @@ To run the application with tracing support:
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-LD_PRELOAD=./libtpp.so ./app
+$ LD_PRELOAD=./libtpp.so ./app
 ----
 --
 
 ----
 --
 
@@ -3665,7 +3675,7 @@ To run the application without tracing support:
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-./app
+$ ./app
 ----
 --
 
 ----
 --
 
@@ -3697,7 +3707,7 @@ To build the instrumented user library:
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-gcc -I. -fpic -c emon.c
+$ gcc -I. -fpic -c emon.c
 ----
 --
 
 ----
 --
 
@@ -3706,7 +3716,7 @@ gcc -I. -fpic -c emon.c
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-gcc -shared -o libemon.so emon.o
+$ gcc -shared -o libemon.so emon.o
 ----
 --
 
 ----
 --
 
@@ -3717,7 +3727,7 @@ To build the application:
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-gcc -c app.c
+$ gcc -c app.c
 ----
 --
 
 ----
 --
 
@@ -3726,7 +3736,7 @@ gcc -c app.c
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-gcc -o app app.o tpp.o -llttng-ust -ldl -L. -lemon
+$ gcc -o app app.o tpp.o -llttng-ust -ldl -L. -lemon
 ----
 --
 
 ----
 --
 
@@ -3737,7 +3747,7 @@ To run the instrumented application:
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-./app
+$ ./app
 ----
 --
 
 ----
 --
 
@@ -3768,7 +3778,7 @@ To build the application:
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-gcc -c app.c
+$ gcc -c app.c
 ----
 --
 
 ----
 --
 
@@ -3777,7 +3787,7 @@ gcc -c app.c
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-gcc -Wl,--export-dynamic -o app app.o tpp.o \
+$ gcc -Wl,--export-dynamic -o app app.o tpp.o \
     -llttng-ust -ldl
 ----
 --
     -llttng-ust -ldl
 ----
 --
@@ -3793,7 +3803,7 @@ To build the instrumented user library:
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-gcc -I. -fpic -c emon.c
+$ gcc -I. -fpic -c emon.c
 ----
 --
 
 ----
 --
 
@@ -3802,7 +3812,7 @@ gcc -I. -fpic -c emon.c
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-gcc -shared -o libemon.so emon.o
+$ gcc -shared -o libemon.so emon.o
 ----
 --
 
 ----
 --
 
@@ -3813,7 +3823,7 @@ To run the application:
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-./app
+$ ./app
 ----
 --
 |====
 ----
 --
 |====
@@ -3852,7 +3862,7 @@ object when starting the application.
 
 [role="term"]
 ----
 
 [role="term"]
 ----
-LD_PRELOAD=liblttng-ust-fork.so ./my-app
+$ LD_PRELOAD=liblttng-ust-fork.so ./my-app
 ----
 
 If your tracepoint provider package is
 ----
 
 If your tracepoint provider package is
@@ -3861,7 +3871,7 @@ shared objects in env:LD_PRELOAD:
 
 [role="term"]
 ----
 
 [role="term"]
 ----
-LD_PRELOAD=liblttng-ust-fork.so:/path/to/tp.so ./my-app
+$ LD_PRELOAD=liblttng-ust-fork.so:/path/to/tp.so ./my-app
 ----
 
 
 ----
 
 
@@ -3875,7 +3885,7 @@ build an application on the command line:
 
 [role="term"]
 ----
 
 [role="term"]
 ----
-gcc -o my-app my-app.o tp.o $(pkg-config --cflags --libs lttng-ust)
+$ gcc -o my-app my-app.o tp.o $(pkg-config --cflags --libs lttng-ust)
 ----
 
 
 ----
 
 
@@ -3900,7 +3910,7 @@ or LTTng packages:
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-cd $(mktemp -d) &&
+$ cd $(mktemp -d) &&
 wget http://lttng.org/files/urcu/userspace-rcu-latest-0.9.tar.bz2 &&
 tar -xf userspace-rcu-latest-0.9.tar.bz2 &&
 cd userspace-rcu-0.9.* &&
 wget http://lttng.org/files/urcu/userspace-rcu-latest-0.9.tar.bz2 &&
 tar -xf userspace-rcu-latest-0.9.tar.bz2 &&
 cd userspace-rcu-0.9.* &&
@@ -3927,7 +3937,7 @@ sudo ldconfig
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-cd $(mktemp -d) &&
+$ cd $(mktemp -d) &&
 wget http://lttng.org/files/lttng-ust/lttng-ust-latest-2.8.tar.bz2 &&
 tar -xf lttng-ust-latest-2.8.tar.bz2 &&
 cd lttng-ust-2.8.* &&
 wget http://lttng.org/files/lttng-ust/lttng-ust-latest-2.8.tar.bz2 &&
 tar -xf lttng-ust-latest-2.8.tar.bz2 &&
 cd lttng-ust-2.8.* &&
@@ -3952,7 +3962,7 @@ relevant 32-bit library paths, for example:
 
 [role="term"]
 ----
 
 [role="term"]
 ----
-LDFLAGS='-L/usr/lib/i386-linux-gnu -L/usr/lib32'
+$ LDFLAGS='-L/usr/lib/i386-linux-gnu -L/usr/lib32'
 ----
 ====
 
 ----
 ====
 
@@ -3962,12 +3972,14 @@ LDFLAGS='-L/usr/lib/i386-linux-gnu -L/usr/lib32'
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-cd $(mktemp -d) &&
+$ cd $(mktemp -d) &&
 wget http://lttng.org/files/lttng-tools/lttng-tools-latest-2.8.tar.bz2 &&
 tar -xf lttng-tools-latest-2.8.tar.bz2 &&
 cd lttng-tools-2.8.* &&
 ./configure --libdir=/usr/local/lib32 CFLAGS=-m32 CXXFLAGS=-m32 \
 wget http://lttng.org/files/lttng-tools/lttng-tools-latest-2.8.tar.bz2 &&
 tar -xf lttng-tools-latest-2.8.tar.bz2 &&
 cd lttng-tools-2.8.* &&
 ./configure --libdir=/usr/local/lib32 CFLAGS=-m32 CXXFLAGS=-m32 \
-            LDFLAGS='-L/usr/local/lib32 -L/usr/lib32' &&
+            LDFLAGS='-L/usr/local/lib32 -L/usr/lib32' \
+            --disable-bin-lttng --disable-bin-lttng-crash \
+            --disable-bin-lttng-relayd --disable-bin-lttng-sessiond &&
 make &&
 cd src/bin/lttng-consumerd &&
 sudo make install &&
 make &&
 cd src/bin/lttng-consumerd &&
 sudo make install &&
@@ -3984,7 +3996,7 @@ sudo ldconfig
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-cd $(mktemp -d) &&
+$ cd $(mktemp -d) &&
 wget http://lttng.org/files/lttng-tools/lttng-tools-latest-2.8.tar.bz2 &&
 tar -xf lttng-tools-latest-2.8.tar.bz2 &&
 cd lttng-tools-2.8.* &&
 wget http://lttng.org/files/lttng-tools/lttng-tools-latest-2.8.tar.bz2 &&
 tar -xf lttng-tools-latest-2.8.tar.bz2 &&
 cd lttng-tools-2.8.* &&
@@ -4011,9 +4023,9 @@ instrumented 32-bit application:
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-gcc -m32 -c -I. hello-tp.c
-gcc -m32 -c hello.c
-gcc -m32 -o hello hello.o hello-tp.o \
+$ gcc -m32 -c -I. hello-tp.c
+$ gcc -m32 -c hello.c
+$ gcc -m32 -o hello hello.o hello-tp.o \
     -L/usr/lib32 -L/usr/local/lib32 \
     -Wl,-rpath,/usr/lib32,-rpath,/usr/local/lib32 \
     -llttng-ust -ldl
     -L/usr/lib32 -L/usr/local/lib32 \
     -Wl,-rpath,/usr/lib32,-rpath,/usr/local/lib32 \
     -llttng-ust -ldl
@@ -4065,7 +4077,7 @@ To use `tracef()` in your application:
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-gcc -o app app.c -llttng-ust
+$ gcc -o app app.c -llttng-ust
 ----
 --
 
 ----
 --
 
@@ -4077,7 +4089,7 @@ To trace the events that `tracef()` calls emit:
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-lttng enable-event --userspace 'lttng_ust_tracef:*'
+$ lttng enable-event --userspace 'lttng_ust_tracef:*'
 ----
 --
 
 ----
 --
 
@@ -4152,7 +4164,7 @@ See man:lttng-ust(3) for a list of available log level names.
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-gcc -o app app.c -llttng-ust
+$ gcc -o app app.c -llttng-ust
 ----
 --
 
 ----
 --
 
@@ -4166,7 +4178,7 @@ _as severe as_ a specific log level:
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-lttng enable-event --userspace 'lttng_ust_tracelog:*'
+$ lttng enable-event --userspace 'lttng_ust_tracelog:*'
                    --loglevel=TRACE_WARNING
 ----
 --
                    --loglevel=TRACE_WARNING
 ----
 --
@@ -4180,7 +4192,7 @@ _specific log level_:
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-lttng enable-event --userspace 'lttng_ust_tracelog:*'
+$ lttng enable-event --userspace 'lttng_ust_tracelog:*'
                    --loglevel-only=TRACE_INFO
 ----
 --
                    --loglevel-only=TRACE_INFO
 ----
 --
@@ -4219,7 +4231,7 @@ To use a user space tracing helper with any user application:
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-LD_PRELOAD=liblttng-ust-libc-wrapper.so my-app
+$ LD_PRELOAD=liblttng-ust-libc-wrapper.so my-app
 ----
 --
 +
 ----
 --
 +
@@ -4228,7 +4240,7 @@ You can preload more than one helper:
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-LD_PRELOAD=liblttng-ust-libc-wrapper.so:liblttng-ust-dl.so my-app
+$ LD_PRELOAD=liblttng-ust-libc-wrapper.so:liblttng-ust-dl.so my-app
 ----
 --
 
 ----
 --
 
@@ -4278,7 +4290,7 @@ The path:{liblttng-ust-cyg-profile*.so} helpers can add instrumentation
 to the entry and exit points of functions.
 
 man:gcc(1) and man:clang(1) have an option named
 to the entry and exit points of functions.
 
 man:gcc(1) and man:clang(1) have an option named
-https://gcc.gnu.org/onlinedocs/gcc/Code-Gen-Options.html[`-finstrument-functions`]
+https://gcc.gnu.org/onlinedocs/gcc/Instrumentation-Options.html[`-finstrument-functions`]
 which generates instrumentation calls for entry and exit to functions.
 The LTTng-UST function tracing helpers,
 path:{liblttng-ust-cyg-profile.so} and
 which generates instrumentation calls for entry and exit to functions.
 The LTTng-UST function tracing helpers,
 path:{liblttng-ust-cyg-profile.so} and
@@ -4301,10 +4313,8 @@ Assuming no event record is lost, having only the function addresses on
 entry is enough to create a call graph, since an event record always
 contains the ID of the CPU that generated it.
 +
 entry is enough to create a call graph, since an event record always
 contains the ID of the CPU that generated it.
 +
-You can use a tool like
-https://sourceware.org/binutils/docs/binutils/addr2line.html[cmd:addr2line]
-to convert function addresses back to source file names and
-line numbers.
+You can use a tool like man:addr2line(1) to convert function addresses
+back to source file names and line numbers.
 
 * **path:{liblttng-ust-cyg-profile.so}** is a more robust variant
 which also works in use cases where event records might get discarded or
 
 * **path:{liblttng-ust-cyg-profile.so}** is a more robust variant
 which also works in use cases where event records might get discarded or
@@ -4473,7 +4483,7 @@ Build this example:
 
 [role="term"]
 ----
 
 [role="term"]
 ----
-javac -cp /usr/share/java/jarpath/lttng-ust-agent-common.jar:/usr/share/java/jarpath/lttng-ust-agent-jul.jar Test.java
+$ javac -cp /usr/share/java/jarpath/lttng-ust-agent-common.jar:/usr/share/java/jarpath/lttng-ust-agent-jul.jar Test.java
 ----
 
 <<creating-destroying-tracing-sessions,Create a tracing session>>,
 ----
 
 <<creating-destroying-tracing-sessions,Create a tracing session>>,
@@ -4482,16 +4492,16 @@ javac -cp /usr/share/java/jarpath/lttng-ust-agent-common.jar:/usr/share/java/jar
 
 [role="term"]
 ----
 
 [role="term"]
 ----
-lttng create
-lttng enable-event --jul jello
-lttng start
+$ lttng create
+$ lttng enable-event --jul jello
+$ lttng start
 ----
 
 Run the compiled class:
 
 [role="term"]
 ----
 ----
 
 Run the compiled class:
 
 [role="term"]
 ----
-java -cp /usr/share/java/jarpath/lttng-ust-agent-common.jar:/usr/share/java/jarpath/lttng-ust-agent-jul.jar:. Test
+$ java -cp /usr/share/java/jarpath/lttng-ust-agent-common.jar:/usr/share/java/jarpath/lttng-ust-agent-jul.jar:. Test
 ----
 
 <<basic-tracing-session-control,Stop tracing>> and inspect the
 ----
 
 <<basic-tracing-session-control,Stop tracing>> and inspect the
@@ -4499,11 +4509,36 @@ recorded events:
 
 [role="term"]
 ----
 
 [role="term"]
 ----
-lttng stop
-lttng view
+$ lttng stop
+$ lttng view
 ----
 ====
 
 ----
 ====
 
+In the resulting trace, an <<event,event record>> generated by a Java
+application using `java.util.logging` is named `lttng_jul:event` and
+has the following fields:
+
+`msg`::
+  Log record's message.
+
+`logger_name`::
+  Logger name.
+
+`class_name`::
+  Name of the class in which the log statement was executed.
+
+`method_name`::
+  Name of the method in which the log statement was executed.
+
+`long_millis`::
+  Logging time (timestamp in milliseconds).
+
+`int_loglevel`::
+  Log level integer value.
+
+`int_threadid`::
+  ID of the thread in which the log statement was executed.
+
 You can use the opt:lttng-enable-event(1):--loglevel or
 opt:lttng-enable-event(1):--loglevel-only option of the
 man:lttng-enable-event(1) command to target a range of JUL log levels
 You can use the opt:lttng-enable-event(1):--loglevel or
 opt:lttng-enable-event(1):--loglevel-only option of the
 man:lttng-enable-event(1) command to target a range of JUL log levels
@@ -4621,7 +4656,7 @@ file):
 
 [role="term"]
 ----
 
 [role="term"]
 ----
-javac -cp /usr/share/java/jarpath/lttng-ust-agent-common.jar:/usr/share/java/jarpath/lttng-ust-agent-log4j.jar:$LOG4JPATH Test.java
+$ javac -cp /usr/share/java/jarpath/lttng-ust-agent-common.jar:/usr/share/java/jarpath/lttng-ust-agent-log4j.jar:$LOG4JPATH Test.java
 ----
 
 <<creating-destroying-tracing-sessions,Create a tracing session>>,
 ----
 
 <<creating-destroying-tracing-sessions,Create a tracing session>>,
@@ -4630,16 +4665,16 @@ javac -cp /usr/share/java/jarpath/lttng-ust-agent-common.jar:/usr/share/java/jar
 
 [role="term"]
 ----
 
 [role="term"]
 ----
-lttng create
-lttng enable-event --log4j jello
-lttng start
+$ lttng create
+$ lttng enable-event --log4j jello
+$ lttng start
 ----
 
 Run the compiled class:
 
 [role="term"]
 ----
 ----
 
 Run the compiled class:
 
 [role="term"]
 ----
-java -cp /usr/share/java/jarpath/lttng-ust-agent-common.jar:/usr/share/java/jarpath/lttng-ust-agent-log4j.jar:$LOG4JPATH:. Test
+$ java -cp /usr/share/java/jarpath/lttng-ust-agent-common.jar:/usr/share/java/jarpath/lttng-ust-agent-log4j.jar:$LOG4JPATH:. Test
 ----
 
 <<basic-tracing-session-control,Stop tracing>> and inspect the
 ----
 
 <<basic-tracing-session-control,Stop tracing>> and inspect the
@@ -4647,11 +4682,42 @@ recorded events:
 
 [role="term"]
 ----
 
 [role="term"]
 ----
-lttng stop
-lttng view
+$ lttng stop
+$ lttng view
 ----
 ====
 
 ----
 ====
 
+In the resulting trace, an <<event,event record>> generated by a Java
+application using log4j is named `lttng_log4j:event` and
+has the following fields:
+
+`msg`::
+  Log record's message.
+
+`logger_name`::
+  Logger name.
+
+`class_name`::
+  Name of the class in which the log statement was executed.
+
+`method_name`::
+  Name of the method in which the log statement was executed.
+
+`filename`::
+  Name of the file in which the executed log statement is located.
+
+`line_number`::
+  Line number at which the log statement was executed.
+
+`timestamp`::
+  Logging timestamp.
+
+`int_loglevel`::
+  Log level integer value.
+
+`thread_name`::
+  Name of the Java thread in which the log statement was executed.
+
 You can use the opt:lttng-enable-event(1):--loglevel or
 opt:lttng-enable-event(1):--loglevel-only option of the
 man:lttng-enable-event(1) command to target a range of Apache log4j log levels
 You can use the opt:lttng-enable-event(1):--loglevel or
 opt:lttng-enable-event(1):--loglevel-only option of the
 man:lttng-enable-event(1) command to target a range of Apache log4j log levels
@@ -4821,7 +4887,7 @@ Build this example:
 
 [role="term"]
 ----
 
 [role="term"]
 ----
-javac -cp /usr/share/java/jarpath/lttng-ust-agent-common.jar:/usr/share/java/jarpath/lttng-ust-agent-jul.jar Test.java
+$ javac -cp /usr/share/java/jarpath/lttng-ust-agent-common.jar:/usr/share/java/jarpath/lttng-ust-agent-jul.jar Test.java
 ----
 
 <<creating-destroying-tracing-sessions,Create a tracing session>>
 ----
 
 <<creating-destroying-tracing-sessions,Create a tracing session>>
@@ -4830,8 +4896,8 @@ and <<enabling-disabling-events,create an event rule>> matching the
 
 [role="term"]
 ----
 
 [role="term"]
 ----
-lttng create
-lttng enable-event --jul jello
+$ lttng create
+$ lttng enable-event --jul jello
 ----
 
 <<adding-context,Add the application-specific context fields>> to the
 ----
 
 <<adding-context,Add the application-specific context fields>> to the
@@ -4839,22 +4905,22 @@ JUL channel:
 
 [role="term"]
 ----
 
 [role="term"]
 ----
-lttng add-context --jul --type='$app.myRetriever:intCtx'
-lttng add-context --jul --type='$app.myRetriever:strContext'
+$ lttng add-context --jul --type='$app.myRetriever:intCtx'
+$ lttng add-context --jul --type='$app.myRetriever:strContext'
 ----
 
 <<basic-tracing-session-control,Start tracing>>:
 
 [role="term"]
 ----
 ----
 
 <<basic-tracing-session-control,Start tracing>>:
 
 [role="term"]
 ----
-lttng start
+$ lttng start
 ----
 
 Run the compiled class:
 
 [role="term"]
 ----
 ----
 
 Run the compiled class:
 
 [role="term"]
 ----
-java -cp /usr/share/java/jarpath/lttng-ust-agent-common.jar:/usr/share/java/jarpath/lttng-ust-agent-jul.jar:. Test
+$ java -cp /usr/share/java/jarpath/lttng-ust-agent-common.jar:/usr/share/java/jarpath/lttng-ust-agent-jul.jar:. Test
 ----
 
 <<basic-tracing-session-control,Stop tracing>> and inspect the
 ----
 
 <<basic-tracing-session-control,Stop tracing>> and inspect the
@@ -4862,8 +4928,8 @@ recorded events:
 
 [role="term"]
 ----
 
 [role="term"]
 ----
-lttng stop
-lttng view
+$ lttng stop
+$ lttng view
 ----
 ====
 
 ----
 ====
 
@@ -4949,16 +5015,16 @@ tracing>>:
 
 [role="term"]
 ----
 
 [role="term"]
 ----
-lttng create
-lttng enable-event --python my-logger
-lttng start
+$ lttng create
+$ lttng enable-event --python my-logger
+$ lttng start
 ----
 
 Run the Python script:
 
 [role="term"]
 ----
 ----
 
 Run the Python script:
 
 [role="term"]
 ----
-python test.py
+$ python test.py
 ----
 
 <<basic-tracing-session-control,Stop tracing>> and inspect the recorded
 ----
 
 <<basic-tracing-session-control,Stop tracing>> and inspect the recorded
@@ -4966,11 +5032,38 @@ events:
 
 [role="term"]
 ----
 
 [role="term"]
 ----
-lttng stop
-lttng view
+$ lttng stop
+$ lttng view
 ----
 ====
 
 ----
 ====
 
+In the resulting trace, an <<event,event record>> generated by a Python
+application is named `lttng_python:event` and has the following fields:
+
+`asctime`::
+  Logging time (string).
+
+`msg`::
+  Log record's message.
+
+`logger_name`::
+  Logger name.
+
+`funcName`::
+  Name of the function in which the log statement was executed.
+
+`lineno`::
+  Line number at which the log statement was executed.
+
+`int_loglevel`::
+  Log level integer value.
+
+`thread`::
+  ID of the Python thread in which the log statement was executed.
+
+`threadName`::
+  Name of the Python thread in which the log statement was executed.
+
 You can use the opt:lttng-enable-event(1):--loglevel or
 opt:lttng-enable-event(1):--loglevel-only option of the
 man:lttng-enable-event(1) command to target a range of Python log levels
 You can use the opt:lttng-enable-event(1):--loglevel or
 opt:lttng-enable-event(1):--loglevel-only option of the
 man:lttng-enable-event(1) command to target a range of Python log levels
@@ -5011,15 +5104,15 @@ mostly to instrument shell scripts:
 
 [role="term"]
 ----
 
 [role="term"]
 ----
-echo "Some message, some $variable" > /proc/lttng-logger
+$ echo "Some message, some $variable" > /proc/lttng-logger
 ----
 
 Any event that the LTTng logger emits is named `lttng_logger` and
 belongs to the Linux kernel <<domain,tracing domain>>. However, unlike
 other instrumentation points in the kernel tracing domain, **any Unix
 user** can <<enabling-disabling-events,create an event rule>> which
 ----
 
 Any event that the LTTng logger emits is named `lttng_logger` and
 belongs to the Linux kernel <<domain,tracing domain>>. However, unlike
 other instrumentation points in the kernel tracing domain, **any Unix
 user** can <<enabling-disabling-events,create an event rule>> which
-matches its event name, not only the root user or users in the tracing
-group.
+matches its event name, not only the root user or users in the
+<<tracing-group,tracing group>>.
 
 To use the LTTng logger:
 
 
 To use the LTTng logger:
 
@@ -5057,16 +5150,16 @@ df --human-readable --print-type / > /proc/lttng-logger
 
 [role="term"]
 ----
 
 [role="term"]
 ----
-lttng create
-lttng enable-event --kernel lttng_logger
-lttng start
+$ lttng create
+$ lttng enable-event --kernel lttng_logger
+$ lttng start
 ----
 
 Run the Bash script:
 
 [role="term"]
 ----
 ----
 
 Run the Bash script:
 
 [role="term"]
 ----
-bash test.bash
+$ bash test.bash
 ----
 
 <<basic-tracing-session-control,Stop tracing>> and inspect the recorded
 ----
 
 <<basic-tracing-session-control,Stop tracing>> and inspect the recorded
@@ -5074,8 +5167,8 @@ events:
 
 [role="term"]
 ----
 
 [role="term"]
 ----
-lttng stop
-lttng view
+$ lttng stop
+$ lttng view
 ----
 ====
 
 ----
 ====
 
@@ -5146,7 +5239,7 @@ is your subsystem's name.
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-cd $(mktemp -d) &&
+$ cd $(mktemp -d) &&
 wget http://lttng.org/files/lttng-modules/lttng-modules-latest-2.8.tar.bz2 &&
 tar -xf lttng-modules-latest-2.8.tar.bz2 &&
 cd lttng-modules-2.8.*
 wget http://lttng.org/files/lttng-modules/lttng-modules-latest-2.8.tar.bz2 &&
 tar -xf lttng-modules-latest-2.8.tar.bz2 &&
 cd lttng-modules-2.8.*
@@ -5238,12 +5331,12 @@ MODULE_VERSION(__stringify(LTTNG_MODULES_MAJOR_VERSION) "."
 ----
 --
 
 ----
 --
 
-. Edit path:{probes/Makefile} and add your new kernel module object
+. Edit path:{probes/KBuild} and add your new kernel module object
   next to the existing ones:
 +
 --
 [source,make]
   next to the existing ones:
 +
 --
 [source,make]
-.path:{probes/Makefile}
+.path:{probes/KBuild}
 ----
 # ...
 
 ----
 # ...
 
@@ -5261,8 +5354,8 @@ obj-m += lttng-probe-my-subsys.o
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-make KERNELDIR=/path/to/linux
-sudo make modules_install
+$ make KERNELDIR=/path/to/linux
+# make modules_install && depmod -a
 ----
 --
 +
 ----
 --
 +
@@ -5379,7 +5472,7 @@ module:
 ====
 [role="term"]
 ----
 ====
 [role="term"]
 ----
-sudo lttng-sessiond --extra-kmod-probes=my_subsys,usb
+# lttng-sessiond --extra-kmod-probes=my_subsys,usb
 ----
 ====
 --
 ----
 ====
 --
@@ -5397,7 +5490,7 @@ To load _only_ a given custom probe kernel module:
 ====
 [role="term"]
 ----
 ====
 [role="term"]
 ----
-sudo lttng-sessiond --kmod-probes=my_subsys,usb
+# lttng-sessiond --kmod-probes=my_subsys,usb
 ----
 ====
 --
 ----
 ====
 --
@@ -5409,7 +5502,7 @@ To confirm that a probe module is loaded:
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-lsmod | grep lttng_probe_usb
+$ lsmod | grep lttng_probe_usb
 ----
 --
 
 ----
 --
 
@@ -5420,7 +5513,7 @@ To unload the loaded probe modules:
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-sudo pkill lttng-sessiond
+# pkill lttng-sessiond
 ----
 --
 +
 ----
 --
 +
@@ -5482,7 +5575,7 @@ To start a user session daemon:
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-lttng-sessiond --daemonize
+$ lttng-sessiond --daemonize
 ----
 --
 
 ----
 --
 
@@ -5493,7 +5586,7 @@ To start the root session daemon:
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-sudo lttng-sessiond --daemonize
+# lttng-sessiond --daemonize
 ----
 --
 
 ----
 --
 
@@ -5522,7 +5615,7 @@ To create a tracing session with a generated name:
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-lttng create
+$ lttng create
 ----
 --
 
 ----
 --
 
@@ -5536,7 +5629,7 @@ To create a tracing session with a specific name:
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-lttng create my-session
+$ lttng create my-session
 ----
 --
 +
 ----
 --
 +
@@ -5556,7 +5649,7 @@ To output LTTng traces to a non-default location:
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-lttng create --output=/tmp/some-directory my-session
+$ lttng create my-session --output=/tmp/some-directory
 ----
 --
 
 ----
 --
 
@@ -5569,7 +5662,7 @@ To list all the existing tracing sessions for your Unix user:
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-lttng list
+$ lttng list
 ----
 --
 
 ----
 --
 
@@ -5600,7 +5693,7 @@ To change the current tracing session:
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-lttng set-session new-session
+$ lttng set-session new-session
 ----
 --
 +
 ----
 --
 +
@@ -5618,7 +5711,7 @@ To destroy the current tracing session:
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-lttng destroy
+$ lttng destroy
 ----
 --
 
 ----
 --
 
@@ -5655,7 +5748,7 @@ To list the available instrumentation points:
 ====
 [role="term"]
 ----
 ====
 [role="term"]
 ----
-lttng list --userspace
+$ lttng list --userspace
 ----
 ====
 
 ----
 ====
 
@@ -5663,7 +5756,7 @@ lttng list --userspace
 ====
 [role="term"]
 ----
 ====
 [role="term"]
 ----
-lttng list --kernel --syscall
+$ lttng list --kernel --syscall
 ----
 ====
 
 ----
 ====
 
@@ -5767,7 +5860,7 @@ command-line options to create simple to more complex event rules.
 ====
 [role="term"]
 ----
 ====
 [role="term"]
 ----
-lttng enable-event --kernel sched_switch
+$ lttng enable-event --kernel sched_switch
 ----
 ====
 
 ----
 ====
 
@@ -5775,7 +5868,7 @@ lttng enable-event --kernel sched_switch
 ====
 [role="term"]
 ----
 ====
 [role="term"]
 ----
-lttng enable-event --kernel --syscall open,write,read,close
+$ lttng enable-event --kernel --syscall open,write,read,close
 ----
 ====
 
 ----
 ====
 
@@ -5783,18 +5876,18 @@ lttng enable-event --kernel --syscall open,write,read,close
 ====
 [role="term"]
 ----
 ====
 [role="term"]
 ----
-lttng enable-event --kernel sched_switch --filter='prev_comm == "bash"'
+$ lttng enable-event --kernel sched_switch --filter='prev_comm == "bash"'
 ----
 
 [role="term"]
 ----
 ----
 
 [role="term"]
 ----
-lttng enable-event --kernel --all \
+$ lttng enable-event --kernel --all \
                    --filter='$ctx.tid == 1988 || $ctx.tid == 1534'
 ----
 
 [role="term"]
 ----
                    --filter='$ctx.tid == 1988 || $ctx.tid == 1534'
 ----
 
 [role="term"]
 ----
-lttng enable-event --jul my_logger \
+$ lttng enable-event --jul my_logger \
                    --filter='$app.retriever:cur_msg_id > 3'
 ----
 
                    --filter='$app.retriever:cur_msg_id > 3'
 ----
 
@@ -5806,7 +5899,7 @@ use man:lttng(1) from a shell.
 ====
 [role="term"]
 ----
 ====
 [role="term"]
 ----
-lttng enable-event --userspace my_app:'*' --loglevel=TRACE_INFO
+$ lttng enable-event --userspace my_app:'*' --loglevel=TRACE_INFO
 ----
 
 IMPORTANT: Make sure to always quote the wildcard character when you
 ----
 
 IMPORTANT: Make sure to always quote the wildcard character when you
@@ -5817,7 +5910,7 @@ use man:lttng(1) from a shell.
 ====
 [role="term"]
 ----
 ====
 [role="term"]
 ----
-lttng enable-event --python my-app.'*' \
+$ lttng enable-event --python my-app.'*' \
                    --exclude='my-app.module,my-app.hello'
 ----
 ====
                    --exclude='my-app.module,my-app.hello'
 ----
 ====
@@ -5826,7 +5919,7 @@ lttng enable-event --python my-app.'*' \
 ====
 [role="term"]
 ----
 ====
 [role="term"]
 ----
-lttng enable-event --log4j --all --loglevel-only=LOG4J_WARN
+$ lttng enable-event --log4j --all --loglevel-only=LOG4J_WARN
 ----
 ====
 
 ----
 ====
 
@@ -5834,7 +5927,7 @@ lttng enable-event --log4j --all --loglevel-only=LOG4J_WARN
 ====
 [role="term"]
 ----
 ====
 [role="term"]
 ----
-lttng enable-event --userspace my_app:my_tracepoint --channel=my-channel
+$ lttng enable-event --userspace my_app:my_tracepoint --channel=my-channel
 ----
 ====
 
 ----
 ====
 
@@ -5846,8 +5939,8 @@ rules:
 
 [role="term"]
 ----
 
 [role="term"]
 ----
-lttng enable-event --userspace my_app:my_tracepoint
-lttng enable-event --userspace my_app:my_tracepoint \
+$ lttng enable-event --userspace my_app:my_tracepoint
+$ lttng enable-event --userspace my_app:my_tracepoint \
                    --loglevel=TRACE_INFO
 ----
 
                    --loglevel=TRACE_INFO
 ----
 
@@ -5871,7 +5964,7 @@ a _disabled_ event rule.
 ====
 [role="term"]
 ----
 ====
 [role="term"]
 ----
-lttng disable-event --python my-logger
+$ lttng disable-event --python my-logger
 ----
 ====
 
 ----
 ====
 
@@ -5879,7 +5972,7 @@ lttng disable-event --python my-logger
 ====
 [role="term"]
 ----
 ====
 [role="term"]
 ----
-lttng disable-event --jul '*'
+$ lttng disable-event --jul '*'
 ----
 ====
 
 ----
 ====
 
@@ -5892,7 +5985,7 @@ rules of a given channel.
 
 [role="term"]
 ----
 
 [role="term"]
 ----
-lttng disable-event --jul --all-events
+$ lttng disable-event --jul --all-events
 ----
 ====
 
 ----
 ====
 
@@ -5910,7 +6003,7 @@ parameters, its channels, event rules, and their attributes:
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-lttng status
+$ lttng status
 ----
 --
 +
 ----
 --
 +
@@ -5922,7 +6015,7 @@ To get the status of any tracing session:
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-lttng list my-session
+$ lttng list my-session
 ----
 --
 +
 ----
 --
 +
@@ -5944,7 +6037,7 @@ To start tracing in the current tracing session:
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-lttng start
+$ lttng start
 ----
 --
 
 ----
 --
 
@@ -5960,7 +6053,7 @@ To stop tracing in the current tracing session:
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-lttng stop
+$ lttng stop
 ----
 --
 +
 ----
 --
 +
@@ -6085,7 +6178,7 @@ command-line options to create simple to more complex channels.
 ====
 [role="term"]
 ----
 ====
 [role="term"]
 ----
-lttng enable-channel --kernel my-channel
+$ lttng enable-channel --kernel my-channel
 ----
 ====
 
 ----
 ====
 
@@ -6093,7 +6186,7 @@ lttng enable-channel --kernel my-channel
 ====
 [role="term"]
 ----
 ====
 [role="term"]
 ----
-lttng enable-channel --userspace --num-subbuf=4 --subbuf-size=1M \
+$ lttng enable-channel --userspace --num-subbuf=4 --subbuf-size=1M \
                      --buffers-pid my-channel
 ----
 ====
                      --buffers-pid my-channel
 ----
 ====
@@ -6102,7 +6195,7 @@ lttng enable-channel --userspace --num-subbuf=4 --subbuf-size=1M \
 ====
 [role="term"]
 ----
 ====
 [role="term"]
 ----
-lttng enable-channel --kernel --tracefile-count=8 \
+$ lttng enable-channel --kernel --tracefile-count=8 \
                      --tracefile-size=4194304 my-channel
 ----
 ====
                      --tracefile-size=4194304 my-channel
 ----
 ====
@@ -6111,7 +6204,7 @@ lttng enable-channel --kernel --tracefile-count=8 \
 ====
 [role="term"]
 ----
 ====
 [role="term"]
 ----
-lttng enable-channel --userspace --overwrite my-channel
+$ lttng enable-channel --userspace --overwrite my-channel
 ----
 ====
 
 ----
 ====
 
@@ -6120,8 +6213,8 @@ two different channels:
 
 [role="term"]
 ----
 
 [role="term"]
 ----
-lttng enable-event --userspace --channel=my-channel app:tp
-lttng enable-event --userspace --channel=other-channel app:tp
+$ lttng enable-event --userspace --channel=my-channel app:tp
+$ lttng enable-event --userspace --channel=other-channel app:tp
 ----
 
 If both channels are enabled, when a tracepoint named `app:tp` is
 ----
 
 If both channels are enabled, when a tracepoint named `app:tp` is
@@ -6138,7 +6231,7 @@ previously, use the man:lttng-disable-channel(1) command.
 ====
 [role="term"]
 ----
 ====
 [role="term"]
 ----
-lttng disable-channel --kernel my-channel
+$ lttng disable-channel --kernel my-channel
 ----
 ====
 
 ----
 ====
 
@@ -6186,7 +6279,7 @@ of the current tracing session.
 
 [role="term"]
 ----
 
 [role="term"]
 ----
-lttng add-context --userspace --type=vpid --type=perf:thread:cpu-cycles
+$ lttng add-context --userspace --type=vpid --type=perf:thread:cpu-cycles
 ----
 ====
 
 ----
 ====
 
@@ -6198,7 +6291,7 @@ tracing session.
 
 [role="term"]
 ----
 
 [role="term"]
 ----
-lttng add-context --kernel --channel=my-channel --type=tid
+$ lttng add-context --kernel --channel=my-channel --type=tid
 ----
 ====
 
 ----
 ====
 
@@ -6211,7 +6304,7 @@ in the channel named `my-channel`:
 
 [role="term"]
 ----
 
 [role="term"]
 ----
-lttng add-context --kernel --channel=my-channel \
+$ lttng add-context --kernel --channel=my-channel \
                   --type='$app:retriever:cur_msg_id'
 ----
 
                   --type='$app:retriever:cur_msg_id'
 ----
 
@@ -6260,7 +6353,7 @@ tracks the specific PIDs. After:
 
 [role="term"]
 ----
 
 [role="term"]
 ----
-lttng track --pid=3,4,7,10,13
+$ lttng track --pid=3,4,7,10,13
 ----
 
 the whitelist is:
 ----
 
 the whitelist is:
@@ -6273,7 +6366,7 @@ You can add more PIDs to the whitelist afterwards:
 
 [role="term"]
 ----
 
 [role="term"]
 ----
-lttng track --pid=1,15,16
+$ lttng track --pid=1,15,16
 ----
 
 The result is:
 ----
 
 The result is:
@@ -6287,7 +6380,7 @@ whitelist. Given the previous example, the following command:
 
 [role="term"]
 ----
 
 [role="term"]
 ----
-lttng untrack --pid=3,7,10,13
+$ lttng untrack --pid=3,7,10,13
 ----
 
 leads to this whitelist:
 ----
 
 leads to this whitelist:
@@ -6301,7 +6394,7 @@ option:
 
 [role="term"]
 ----
 
 [role="term"]
 ----
-lttng track --pid --all
+$ lttng track --pid --all
 ----
 
 The result is, again:
 ----
 
 The result is, again:
@@ -6322,7 +6415,7 @@ man:lttng-untrack(1) command to clear the whitelist after you
 
 [role="term"]
 ----
 
 [role="term"]
 ----
-lttng untrack --pid --all
+$ lttng untrack --pid --all
 ----
 
 gives:
 ----
 
 gives:
@@ -6338,7 +6431,7 @@ specific PIDs, for example:
 
 [role="term"]
 ----
 
 [role="term"]
 ----
-lttng track --pid=6,11
+$ lttng track --pid=6,11
 ----
 
 Result:
 ----
 
 Result:
@@ -6376,7 +6469,7 @@ To save a given tracing session configuration:
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-lttng save my-session
+$ lttng save my-session
 ----
 --
 +
 ----
 --
 +
@@ -6403,7 +6496,7 @@ To load a tracing session:
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-lttng load my-session
+$ lttng load my-session
 ----
 --
 +
 ----
 --
 +
@@ -6431,7 +6524,7 @@ To send the trace data over the network:
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-lttng-relayd
+$ lttng-relayd
 ----
 --
 
 ----
 --
 
@@ -6441,7 +6534,7 @@ lttng-relayd
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-lttng create my-session --set-url=net://remote-system
+$ lttng create my-session --set-url=net://remote-system
 ----
 --
 +
 ----
 --
 +
@@ -6450,7 +6543,7 @@ remote system. See man:lttng-create(1) for the exact URL format.
 
 . On the target system, use the man:lttng(1) command-line tool as usual.
   When tracing is active, the target's consumer daemon sends sub-buffers
 
 . On the target system, use the man:lttng(1) command-line tool as usual.
   When tracing is active, the target's consumer daemon sends sub-buffers
-  to the relay daemon running on the remote system intead of flushing
+  to the relay daemon running on the remote system instead of flushing
   them to the local file system. The relay daemon writes the received
   packets to the local file system.
 
   them to the local file system. The relay daemon writes the received
   packets to the local file system.
 
@@ -6487,7 +6580,7 @@ To use LTTng live:
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-lttng create --live my-session
+$ lttng create my-session --live
 ----
 --
 +
 ----
 --
 +
@@ -6499,7 +6592,8 @@ This spawns a local relay daemon.
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-babeltrace --input-format=lttng-live net://localhost/host/hostname/my-session
+$ babeltrace --input-format=lttng-live
+           net://localhost/host/hostname/my-session
 ----
 --
 +
 ----
 --
 +
@@ -6517,7 +6611,7 @@ You can list the available live tracing sessions with Babeltrace:
 
 [role="term"]
 ----
 
 [role="term"]
 ----
-babeltrace --input-format=lttng-live net://localhost
+$ babeltrace --input-format=lttng-live net://localhost
 ----
 
 You can start the relay daemon on another system. In this case, you need
 ----
 
 You can start the relay daemon on another system. In this case, you need
@@ -6554,7 +6648,7 @@ To take a snapshot:
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-lttng create --snapshot my-session
+$ lttng create my-session --snapshot
 ----
 --
 +
 ----
 --
 +
@@ -6577,7 +6671,7 @@ change before you actually take the snapshot.
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-lttng snapshot record --name=my-first-snapshot
+$ lttng snapshot record --name=my-first-snapshot
 ----
 --
 +
 ----
 --
 +
@@ -6615,7 +6709,7 @@ XML machine interface output, for example:
 
 [role="term"]
 ----
 
 [role="term"]
 ----
-lttng --mi=xml enable-event --kernel --syscall open
+$ lttng --mi=xml enable-event --kernel --syscall open
 ----
 
 A schema definition (XSD) is
 ----
 
 A schema definition (XSD) is
@@ -6650,7 +6744,7 @@ To regenerate the metadata of an LTTng trace:
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-lttng metadata regenerate
+$ lttng metadata regenerate
 ----
 --
 
 ----
 --
 
@@ -6697,7 +6791,7 @@ trace data after a system crash:
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-lttng create --shm-path=/path/to/shm
+$ lttng create my-session --shm-path=/path/to/shm
 ----
 --
 
 ----
 --
 
@@ -6710,7 +6804,7 @@ lttng create --shm-path=/path/to/shm
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-lttng-crash /path/to/shm
+$ lttng-crash /path/to/shm
 ----
 --
 
 ----
 --
 
@@ -6725,7 +6819,7 @@ To convert the ring buffer files to LTTng trace files:
 --
 [role="term"]
 ----
 --
 [role="term"]
 ----
-lttng-crash --extract=/path/to/trace /path/to/shm
+$ lttng-crash --extract=/path/to/trace /path/to/shm
 ----
 --
 
 ----
 --
 
@@ -7277,7 +7371,7 @@ tracer::
 <<domain,tracing domain>>::
   A namespace for event sources.
 
 <<domain,tracing domain>>::
   A namespace for event sources.
 
-tracing group::
+<<tracing-group,tracing group>>::
   The Unix group in which a Unix user can be to be allowed to trace the
   Linux kernel.
 
   The Unix group in which a Unix user can be to be allowed to trace the
   Linux kernel.
 
Unnamed repository; edit this file 'description' to name the repository.
This page took 0.055926 seconds and 4 git commands to generate.