Man page fixes: missing --version option and typo

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

diff --git a/doc/man/lttng-relayd.8 b/doc/man/lttng-relayd.8
index 1d1802a4c291131b1c808423b710f7c50c9b5dc1..3a51877a6aaa2a14f24b15c7f0917036cc81fd23 100644 (file)
--- a/doc/man/lttng-relayd.8
+++ b/doc/man/lttng-relayd.8
@@ -17,12 +17,18 @@ It's tracers help tracking down performance issues and debugging problems
 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.
-
-Once a trace has been streamed completely, the trace can be processed by any
-tool that can process a local LTTng CTF trace.
+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'.
+
+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
@@ -33,14 +39,17 @@ sessiond side.
 .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
 
@@ -50,12 +59,21 @@ There is three debugging level which will print on stderr. Maximum verbosity is
 .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 URL (tcp://0.0.0.0:5342 is the default)
 .TP
 .BR "-D, --data-port"
 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. Must use an absolute path (~/lttng-traces is the default)
 .TP
@@ -68,6 +86,8 @@ Show version number
 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"