From bff56affee4da0bc21abce35be7ac2e3bcaf8fad Mon Sep 17 00:00:00 2001 From: Kienan Stewart Date: Fri, 27 Oct 2023 14:58:03 -0400 Subject: [PATCH] docs: Add man page entry for LTTNG_UST_APP_PATH and LTTNG_UST_CTL_PATH MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit Add manual entries for the LTTNG_UST_APP_PATH and LTTNG_UST_CTL_PATH environment variables in lttng-sessiond(8). Change-Id: I9c7fd672d006b0e8afad7a8dfacbb3dd41e28f8f Signed-off-by: Kienan Stewart Signed-off-by: Jérémie Galarneau --- doc/man/lttng-sessiond.8.txt | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/doc/man/lttng-sessiond.8.txt b/doc/man/lttng-sessiond.8.txt index 57b05ecc0..60382d59d 100644 --- a/doc/man/lttng-sessiond.8.txt +++ b/doc/man/lttng-sessiond.8.txt @@ -382,6 +382,32 @@ Set to `0` or `-1` to use the timeout of the operating system (default). `LTTNG_SESSION_CONFIG_XSD_PATH`:: Recording session configuration XML schema definition (XSD) path. +`LTTNG_UST_APP_PATH`:: + The directory path in which to look for listening sockets as a tracee. ++ +See man:lttng-ust(1) for more details. + +`LTTNG_UST_CTL_PATH`:: + The directory path in which listening sockets for UST applications are opened. + If the value contains a colon (':'), each section delimited by the colons is + considered as a separate path. ++ +The directory must exist prior to starting lttng-sessiond. There is no provision +for escaping the colons (':') that are used as path separators. ++ +At this time, paths after the first are ignored and warning issued. ++ +When `LTTNG_UST_CTL_PATH` is set, the default UST socket paths are not used. When +tracing an application, start the application with `LTTNG_UST_APP_PATH` set to +the same value of the session daemons `LTTNG_UST_CTL_PATH`. + +`LTTNG_UST_ALLOW_BLOCKING`:: + Allow the sessiond to operate as a tracee in blocking mode. ++ +See man:lttng-ust(1) for more details. lttng-sessiond will refuse to start as a +tracee in blocking mode if neither `LTTNG_UST_APP_PATH` nor `LTTNG_UST_CTL_PATH` +are set, or if both `LTTNG_UST_APP_PATH` and `LTTNG_UST_CTL_PATH` are set to the +same value. FILES ----- -- 2.34.1