doc/man: put short option's argument too

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

diff --git a/doc/man/lttng-relayd.8.txt b/doc/man/lttng-relayd.8.txt
index 1a366f9b8a50e9f0cb31d2a26942fb1371d089cd..218526a1a3f9abe206c8a8275ea953289f107141 100644 (file)
--- a/doc/man/lttng-relayd.8.txt
+++ b/doc/man/lttng-relayd.8.txt
@@ -37,7 +37,8 @@ The relay daemon does not require any particular permissions, as long as
 it can write to the output directory and listen on the configured ports.
 If a user is within a secured network and/or has proper firewall
 settings, `lttng-relayd` can listen to LTTng live connections from _all_
-network interfaces by specifying `--live-port=tcp://0.0.0.0:5344`.
+network interfaces by specifying
++--live-port=tcp://{default_network_viewer_bind_address}:{default_network_viewer_port}+.
 
 Once a trace has been streamed completely, the trace can be processed by
 any tool that can process an LTTng trace located on the local
@@ -50,7 +51,7 @@ Output directory
 By default, the relay daemon writes the traces to:
 
 [verse]
-$HOME/lttng-traces/'HOSTNAME'/'SESSION'/'DOMAIN'
+$LTTNG_HOME/lttng-traces/'HOSTNAME'/'SESSION'/'DOMAIN'
 
 with:
 
@@ -64,7 +65,7 @@ with:
     Tracing domain.
 
 You can override the default output directory prefix
-(`$HOME/lttng-traces`) with the option:--output option. The other
+(`$LTTNG_HOME/lttng-traces`) with the option:--output option. The other
 parts depend on the remote configuration.
 
 
@@ -104,10 +105,10 @@ option:-d, option:--daemonize::
     option:--background option instead to keep the file descriptors
     open.
 
-option:-g, option:--group='GROUP'::
+option:-g 'GROUP', option:--group='GROUP'::
     Use 'GROUP' as Unix tracing group (default: `tracing`).
 
-option:-o, option:--output='PATH'::
+option:-o 'PATH', option:--output='PATH'::
     Set base directory of written trace data to 'PATH'.
 +
 See the <<output-directory,Output directory>> section above for more
@@ -126,15 +127,18 @@ Ports
 See the <<url-format,URL format>> section above for more information
 about the syntax of the following options' 'URL' argument.
 
-option:-C, option:--control-port='URL'::
-    Listen to control data on URL 'URL' (default: `tcp://0.0.0.0:5342`).
+option:-C 'URL', option:--control-port='URL'::
+    Listen to control data on URL 'URL' (default:
+    +tcp://{default_network_control_bind_address}:{default_network_control_port}+).
 
-option:-D, option:--data-port='URL'::
-    Listen to trace data on URL 'URL' (default: `tcp://0.0.0.0:5343`).
+option:-D 'URL', option:--data-port='URL'::
+    Listen to trace data on URL 'URL' (default:
+    +tcp://{default_network_data_bind_address}:{default_network_data_port}+).
 
-option:-L, option:--live-port='URL'::
+option:-L 'URL', option:--live-port='URL'::
     Listen to LTTng live connections on URL 'URL'
-    (default: `tcp://0.0.0.0:5344`).
+    (default:
+    +tcp://{default_network_viewer_bind_address}:{default_network_viewer_port}+).
 
 
 Program information
@@ -148,6 +152,9 @@ option:-V, option:--version::
 
 ENVIRONMENT VARIABLES
 ---------------------
+`LTTNG_ABORT_ON_ERROR`::
+    Set to 1 to abort the process after the first error is encountered.
+
 `LTTNG_NETWORK_SOCKET_TIMEOUT`::
     Socket connection, receive and send timeout (milliseconds). A value
     of 0 or -1 uses the timeout of the operating system (default).