sessiond: Add --extra-kmod-probes option

[lttng-tools.git] / doc / man / lttng-sessiond.8

diff --git a/doc/man/lttng-sessiond.8 b/doc/man/lttng-sessiond.8
index 8a7e042100802a3c912703d9d7e0a609567614e6..9cd148eac18ae2c6586e02b7ad1bf663188554c7 100644 (file)
--- a/doc/man/lttng-sessiond.8
+++ b/doc/man/lttng-sessiond.8
@@ -78,14 +78,20 @@ No output at all.
 .BR "    --no-kernel"
 No kernel tracer support
 .TP
-.BR "    --jul-tcp-port"
-JUL application registration TCP port (default: 5345)
+.BR "    --agent-tcp-port"
+Agent application registration TCP port (default: 5345)
 .TP
 .BR "    --kmod-probes=probe1, probe2, ..."
 Specify the kernel modules containing LTTng probes to load by the session daemon.
 Only the component name of the probe needs to be specified, e.g. to load the
 lttng-probe-irq and lttng-probe-sched use: --kmod-probes="irq, sched".
 .TP
+.BR "    --extra-kmod-probes=probe1, probe2, ..."
+Specify extra kernel modules containing LTTng probes to be loaded by the session
+daemon. The list follows the format of the \fB--kmod-probes\fP option.
+This list is appended to the list provided by \fB--kmod-probes\fP or, if
+\fB--kmod-probes\fP is missing, to the default list of probes.
+.TP
 .BR "-c, --client-sock=PATH"
 Specify path for the client unix socket
 .TP
@@ -123,7 +129,22 @@ Specify path for the 64-bit UST consumer daemon binary
 Specify path for the 64-bit UST consumer daemon libraries
 .TP
 .BR "-l, --load PATH
-Specify path from which to load session configurations
+Specify path from which to automatically load session configuration(s).
+
+.SH "LOADING SESSIONS"
+
+.PP
+By default, the session daemon tries to load session configuration(s) located
+in the user default directory \fB~/.lttng/sessions/auto/\fP and in the system
+wide one in \fB/etc/lttng/sessions/auto/\fP. Note that the directory containing
+the session's configuration and lttng-sessiond MUST have the same UID for them
+to be automatically loaded.
+
+Specifying a path with \-l, \-\-load PATH overrides the default directory and
+UID check. The lttng-sessiond will simply check if it's accessible and try to
+load every session file in it.
+.PP
+
 .SH "ENVIRONMENT VARIABLES"
 
 .PP
@@ -138,10 +159,10 @@ override this variable.
 Specify the 64-bit consumer binary path. \fB--consumerd64-path\fP
 override this variable.
 .IP "LTTNG_CONSUMERD32_LIBDIR"
-Specifiy the 64-bit library path containing libconsumer.so.
+Specify the 64-bit library path containing libconsumer.so.
 \fB--consumerd32-libdir\fP override this variable.
 .IP "LTTNG_CONSUMERD64_LIBDIR"
-Specifiy the 32-bit library path containing libconsumer.so.
+Specify the 32-bit library path containing libconsumer.so.
 \fB--consumerd64-libdir\fP override this variable.
 .IP "LTTNG_DEBUG_NOCLONE"
 Debug-mode disabling use of clone/fork. Insecure, but required to allow
@@ -160,6 +181,8 @@ the timeout of the operating system (this is the default).
 Specify the path that contains the XML session configuration schema (xsd).
 .IP "LTTNG_KMOD_PROBES"
 Specify the kernel modules probes that should be loaded by the session daemon.
+.IP "LTTNG_EXTRA_KMOD_PROBES"
+Specify extra kernel modules probes that should be loaded by the session daemon.
 .SH "SEE ALSO"
 
 .PP
@@ -172,7 +195,7 @@ babeltrace(1), lttng-ust(3), lttng(1)
 For unprivileged user running lttng-sessiond, the maximum number of file
 descriptors per process is usually 1024. This limits the number of traceable
 applications since for each instrumented application there is two file
-descriptors per-CPU and one more socktet for bidirectional communication.
+descriptors per-CPU and one more socket for bidirectional communication.
 
 For the root user, the limit is bumped to 65535. Future version will deal with
 this limitation.