.TH "LTTNG-RELAYD" "8" "July 15, 2012" "" ""
.SH "NAME"
-lttng-relayd \(em LTTng remote trace collection daemon
+lttng-relayd \- LTTng remote trace collection daemon
.SH "SYNOPSIS"
involving multiple concurrent processes and threads. Tracing across multiple
systems is also possible.
-The relay daemon listens on the network and receives traces streamed by a
-remote consumer. This daemon does not require any particular permissions as
-long as it can write in the output folder and listen on the ports.
+The relay daemon listens by default on all network interfaces to gather
+trace data, but only on localhost for viewer connections. This daemon
+does not require any particular permissions as long as it can write in
+the output folder and listen on the ports. If a user is within a secured
+network and/or has proper firewall settings, lttng-relayd can listen to
+viewer connections from all network interfaces by specifying '-L
+tcp://0.0.0.0:5344'.
-Once a trace has been streamed completely, the trace can be processed by any
-tool that can process a local LTTng CTF trace.
+Traces can be either viewed "live" (as they are produced) by attaching
+to the live viewer port using LTTng live protocol, or after tracing has
+been stopped. Once a trace has been streamed completely, the trace can
+be processed by any tool that can process a local LTTng CTF trace.
By default, the relayd outputs the traces in :
~/lttng-traces/hostname/session-name/domain-name
.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
+.BR "\-V, \-\-version"
+Show version.
+.TP
.BR "-v, --verbose"
Increase verbosity
.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 "-C, --control-port"
-Control port URI (tcp://0.0.0.0:5342 is the default)
+Control port URL (tcp://0.0.0.0:5342 is the default)
.TP
.BR "-D, --data-port"
-Data port URI (tcp://0.0.0.0:5343 is the default)
+Data port URL (tcp://0.0.0.0:5343 is the default)
+.TP
+.BR "-L, --live-port URL"
+Live view port URL (tcp://localhost:5344 is the default).
.TP
.BR "-o, --output"
-Output base directory (~/lttng-traces is the default)
+Output base directory. Must use an absolute path (~/lttng-traces is the default)
.TP
.BR "-V, --version"
Show version number
+.SH "ENVIRONMENT VARIABLES"
+
+.PP
+.IP "LTTNG_NETWORK_SOCKET_TIMEOUT"
+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_RELAYD_HEALTH"
+File path used for relay daemon health check communication.
+.PP
+
.SH "SEE ALSO"
.PP