X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=blobdiff_plain;f=doc%2Fman%2Flttng-relayd.8.txt;h=4a51e15ba77400c871349a5b1f998f6e6c4c1dc5;hp=694eb49955852411ad650ef6c0cd30213a5d2a57;hb=e971184584781f70bbbfc52bbede8b9abf0436e5;hpb=26f0c7794376456fcb5b13d4eae91c0ccf0dfe66 diff --git a/doc/man/lttng-relayd.8.txt b/doc/man/lttng-relayd.8.txt index 694eb4995..4a51e15ba 100644 --- a/doc/man/lttng-relayd.8.txt +++ b/doc/man/lttng-relayd.8.txt @@ -1,6 +1,6 @@ lttng-relayd(8) =============== -:revdate: 30 April 2021 +:revdate: 14 June 2021 :daemon-bin-name: lttng-relayd :daemon-ini-section: relayd @@ -29,12 +29,12 @@ data from (possibly remote) LTTng session/consumer daemons and which writes it to the local file system. The relay daemon also accepts LTTng live connections from compatible readers (for example, man:babeltrace2(1)); this is the recommended approach to read trace data -while the remote tracing session is active. +while the remote recording session is active. By default, a relay daemon listens on all network interfaces to receive trace data, but only on `localhost` for LTTng live connections. Override the listening URLs with the option:--control-port, option:--data-port, -and option:--live-port options (see the <> +and option:--live-port options (see the ``<>'' section below). For example, use the option:--live-port=+tcp://0.0.0.0:{default_network_viewer_port}+ option to make a relay daemon listen to LTTng live connections on all network @@ -70,9 +70,9 @@ The relay daemon uses different output path patterns depending on: * Its configuration. + -See the <> section above. +See the ``<>'' section above. -* The tracing session configuration of the connected peer. +* The recording session configuration of the connected peer. * The LTTng session daemon (see man:lttng-sessiond(8)) version of the connected peer. @@ -86,10 +86,10 @@ Consider the following variables: Hostname of the connected peer. 'SESSION':: - Tracing session name. + Recording session name. 'DATETIME':: - Unique tracing session date/time. + Unique recording session date/time. 'TRACEDIR':: Custom trace directory path ('TRACEDIR' part of the argument of the @@ -112,7 +112,7 @@ With a custom trace directory::: [verse] 'BASE'/'HOSTNAME'/'TRACEDIR' -With the option:--group-output-by-session option (tracing session grouping):: +With the option:--group-output-by-session option (recording session grouping):: Without a custom trace directory::: 'SESSIONDV' is at least{nbsp}2.4:::: + @@ -180,7 +180,7 @@ option:-f 'PATH', option:--config='PATH':: addition to the default configuration files and the command-line options. + -See the <> section above. +See the ``<>'' section above. option:-d, option:--daemonize:: Start as a Unix daemon and close file descriptors (console). @@ -230,7 +230,7 @@ Specify this option up to three times to get more levels of verbosity. Output ~~~~~~ -See the <> section above to learn +See the ``<>'' section above to learn more. option:-p, option:--group-output-by-host:: @@ -240,8 +240,8 @@ As of LTTng{nbsp}{lttng_version}, this is the default output grouping strategy, but this may change in the future. option:-s, option:--group-output-by-session:: - Group the written trace directories by tracing session name instead - of by hostname. + Group the written trace directories by recording session name + instead of by hostname. option:-o 'DIR', option:--output='DIR':: Set the base output directory of the written trace directories to @@ -250,8 +250,8 @@ option:-o 'DIR', option:--output='DIR':: Ports ~~~~~ -See the <> section above to learn more about the -syntax of the 'URL' argument of the following options. +See the ``<>'' section above to learn more about +the syntax of the 'URL' argument of the following options. option:-C 'URL', option:--control-port='URL':: Listen to control data on URL 'URL'. @@ -280,8 +280,20 @@ option:-V, option:--version:: Show version and quit. -ENVIRONMENT VARIABLES ---------------------- +EXIT STATUS +----------- +*0*:: + Success + +*1*:: + Error + +*3*:: + Fatal error + + +ENVIRONMENT +----------- `LTTNG_ABORT_ON_ERROR`:: Set to `1` to abort the process after the first error is encountered. @@ -378,23 +390,11 @@ Override this path with the option:--output option. NOTE: `$LTTNG_HOME` defaults to `$HOME`. -EXIT STATUS ------------ -*0*:: - Success - -*1*:: - Error - -*3*:: - Fatal error - - include::common-footer.txt[] SEE ALSO -------- +man:babeltrace2(1), man:lttng(1), -man:lttng-sessiond(8), -man:babeltrace2(1) +man:lttng-sessiond(8)