lttng(1)/lttng-create(1): document `--relayd-path`

[lttng-tools.git] / doc / man / lttng-create.1.txt

diff --git a/doc/man/lttng-create.1.txt b/doc/man/lttng-create.1.txt
index 5b5f7b62eebecd3f2545a543acf58c731063548b..6ebdcb78a698ba36f6b2a4ad4197ff9f9110e191 100644 (file)
--- a/doc/man/lttng-create.1.txt
+++ b/doc/man/lttng-create.1.txt
@@ -1,6 +1,6 @@
 lttng-create(1)
 ===============
 lttng-create(1)
 ===============

-:revdate: 3 May 2021
+:revdate: 12 May 2021

 
 
 NAME
 
 
 NAME


@@ -55,11 +55,38 @@ Specifying a location on an NVRAM file system makes it possible to
 recover the latest recorded trace data when the system reboots after a
 crash with the man:lttng-crash(1) utility.
 
 recover the latest recorded trace data when the system reboots after a
 crash with the man:lttng-crash(1) utility.
 

-By default, the `create` command automatically spawns a session daemon
-for your Unix user if none is currently running. Override the path of
-the session daemon binary to spawn with the general
-genoption:--sessiond-path option. Avoid automatically spawning a session
-daemon with the general genoption:--no-sessiond option.
+By default, the `create` command automatically spawns:
+
+* A session daemon for your Unix user if none is currently running.
++
+Override the path of the session daemon binary to spawn with the
+general genoption:--sessiond-path option.
++
+Avoid automatically spawning a session daemon with the general
+genoption:--no-sessiond option.
+
+* A relay daemon (see man:lttng-relayd(8)) if all the following
+  statements are true:
++
+--
+* You specify the option:--live option.
+
+* You don't specify any of the option:--set-url, option:--ctrl-url, or
+  option:--data-url options.
+
+* No relay daemon is currently listening for TCP connections on
+  +127.0.0.1:{default_network_viewer_port}+ (default LTTng live reader
+  connection address and port).
+--
++
+In this case, the `create` command spawns a relay daemon as such:
++
+[verse]
+*lttng-relayd* nloption:--live-port=**tcp://localhost:{default_network_viewer_port}**
+{nbsp}
++
+Override the path of the relay daemon binary to spawn with the general
+genoption:--relayd-path option.

 
 On success, the `create` command sets the current tracing session (see
 man:lttng-concepts(7) to learn more) to the created tracing session.
 
 On success, the `create` command sets the current tracing session (see
 man:lttng-concepts(7) to learn more) to the created tracing session.