Man page fixes: missing --version option and typo

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

diff --git a/doc/man/lttng-sessiond.8 b/doc/man/lttng-sessiond.8
index ade2e66b571b02c09d89b9a3a1360281bc25dc8d..8c29e61ccd69871d9fc4c9c3ec2b34b6f7244cdd 100644 (file)
--- a/doc/man/lttng-sessiond.8
+++ b/doc/man/lttng-sessiond.8
@@ -36,14 +36,17 @@ them when the time has come. The user don't need to manage the lttng-consumerd.
 .SH "OPTIONS"
 
 .PP
 .SH "OPTIONS"
 
 .PP

-This program follow the usual GNU command line syntax with long options starting with
-two dashes. Below is a summary of the available options.
+This program follows the usual GNU command line syntax with long options starting
+with two dashes. Below is a summary of the available options.

 .PP
 
 .TP
 .BR "-h, --help"
 Show summary of possible options and commands
 .TP
 .PP
 
 .TP
 .BR "-h, --help"
 Show summary of possible options and commands
 .TP

+.BR "\-V, \-\-version"
+Show version.
+.TP

 .BR "-v, --verbose"
 Increase verbosity
 
 .BR "-v, --verbose"
 Increase verbosity
 


@@ -56,6 +59,9 @@ Verbose mode for consumer. Activate DBG() macro.
 .BR "-d, --daemonize"
 Start as a daemon
 .TP
 .BR "-d, --daemonize"
 Start as a daemon
 .TP

+.BR "-b, --background"
+Start as a daemon, keeping console open
+.TP

 .BR "-g, --group=NAME"
 Specify the tracing group name. (default: tracing)
 .TP
 .BR "-g, --group=NAME"
 Specify the tracing group name. (default: tracing)
 .TP


@@ -75,6 +81,20 @@ No output at all.
 .BR "    --no-kernel"
 No kernel tracer support
 .TP
 .BR "    --no-kernel"
 No kernel tracer support
 .TP

+.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
 .BR "-c, --client-sock=PATH"
 Specify path for the client unix socket
 .TP


@@ -110,6 +130,27 @@ Specify path for the 64-bit UST consumer daemon binary
 .TP
 .BR "    --consumerd64-libdir=PATH
 Specify path for the 64-bit UST consumer daemon libraries
 .TP
 .BR "    --consumerd64-libdir=PATH
 Specify path for the 64-bit UST consumer daemon libraries

+.TP
+.BR "-l, --load PATH
+Specify path from which to automatically load session configuration(s).
+.TP
+.BR "-f, --config PATH
+Specify path from which to load daemon configuration.
+
+.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
 .SH "ENVIRONMENT VARIABLES"
 
 .PP


@@ -124,10 +165,10 @@ override this variable.
 Specify the 64-bit consumer binary path. \fB--consumerd64-path\fP
 override this variable.
 .IP "LTTNG_CONSUMERD32_LIBDIR"
 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"
 \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
 \fB--consumerd64-libdir\fP override this variable.
 .IP "LTTNG_DEBUG_NOCLONE"
 Debug-mode disabling use of clone/fork. Insecure, but required to allow


@@ -142,6 +183,12 @@ value is 5 seconds.
 Control timeout of socket connection, receive and send. Takes an integer
 parameter: the timeout value, in milliseconds. A value of 0 or -1 uses
 the timeout of the operating system (this is the default).
 Control timeout of socket connection, receive and send. Takes an integer
 parameter: the timeout value, in milliseconds. A value of 0 or -1 uses
 the timeout of the operating system (this is the default).

+.IP "LTTNG_SESSION_CONFIG_XSD_PATH"
+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
 .SH "SEE ALSO"
 
 .PP


@@ -154,7 +201,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
 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.
 
 For the root user, the limit is bumped to 65535. Future version will deal with
 this limitation.


@@ -200,5 +247,5 @@ Montreal for the LTTng journey.
 .PP
 lttng-tools was originally written by Mathieu Desnoyers, Julien Desfossez and
 David Goulet. More people have since contributed to it. It is currently
 .PP
 lttng-tools was originally written by Mathieu Desnoyers, Julien Desfossez and
 David Goulet. More people have since contributed to it. It is currently

-maintained by David Goulet <dgoulet@efficios.com>.
+maintained by Jérémie Galarneau <jeremie.galarneau@efficios.com>.

 .PP
 .PP