doc/man: use specific revision date for each manual page

[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 4326daba393e53cd477ef92c6b1de508ef8395d1..2f41ec29bfae082b84ea0ccc5b3aa2961d41f918 100644 (file)
--- a/doc/man/lttng-relayd.8.txt
+++ b/doc/man/lttng-relayd.8.txt
@@ -1,5 +1,6 @@
 lttng-relayd(8)
 ===============
 lttng-relayd(8)
 ===============

+:revdate: 5 June 2018

 
 
 NAME
 
 
 NAME


@@ -17,7 +18,7 @@ SYNOPSIS
 
 DESCRIPTION
 -----------
 
 DESCRIPTION
 -----------

-The http://lttng.org/[_Linux Trace Toolkit: next generation_] is an open
+The https://lttng.org/[_Linux Trace Toolkit: next generation_] is an open

 source software package used for correlated tracing of the Linux kernel,
 user applications, and user libraries.
 
 source software package used for correlated tracing of the Linux kernel,
 user applications, and user libraries.
 


@@ -105,10 +106,10 @@ option:-d, option:--daemonize::
     option:--background option instead to keep the file descriptors
     open.
 
     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`).
 
     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
     Set base directory of written trace data to 'PATH'.
 +
 See the <<output-directory,Output directory>> section above for more


@@ -127,15 +128,15 @@ Ports
 See the <<url-format,URL format>> section above for more information
 about the syntax of the following options' 'URL' argument.
 
 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'::
+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}+).
 
     Listen to control data on URL 'URL' (default:
     +tcp://{default_network_control_bind_address}:{default_network_control_port}+).
 

-option:-D, option:--data-port='URL'::
+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}+).
 
     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://{default_network_viewer_bind_address}:{default_network_viewer_port}+).
     Listen to LTTng live connections on URL 'URL'
     (default:
     +tcp://{default_network_viewer_bind_address}:{default_network_viewer_port}+).


@@ -162,6 +163,60 @@ ENVIRONMENT VARIABLES
 `LTTNG_RELAYD_HEALTH`::
     Path to relay daemon health's socket.
 
 `LTTNG_RELAYD_HEALTH`::
     Path to relay daemon health's socket.
 

+`LTTNG_RELAYD_TCP_KEEP_ALIVE`::
+    Set to 1 to enable TCP keep-alive.
++
+The TCP keep-alive mechanism allows the detection of dead peers
+(man:lttng-sessiond(8)) in cases of unclean termination
+(for example, a hard reset) of a peer.
++
+Supported on Linux and Solaris only. The default behaviour of the TCP
+keep-alive mechanism is OS-specific.
++
+Search for `tcp_keepalive` in man:tcp(7) for more information.
+
+`LTTNG_RELAYD_TCP_KEEP_ALIVE_ABORT_THRESHOLD`::
+   The time threshold in seconds to abort a TCP connection after the keep-alive
+   probing mechanism has failed.
++
+Set to 0 or -1 to use the value chosen by the operating system (default).
++
+Supported on Solaris 11 only.
++
+Search for `tcp_keepalive_abort_threshold` in man:tcp(7) for more information.
+
+`LTTNG_RELAYD_TCP_KEEP_ALIVE_IDLE_TIME`::
+    Number of seconds a connection needs to be idle before TCP begins
+    sending out keep-alive probes.
++
+Set to 0 or -1 to use the value chosen by the operating system (default).
++
+Supported on Linux and Solaris 11 only.
++
+On Solaris{nbsp}11, the accepted values are -1, 0, and 10 to 864000.
++
+Search for `tcp_keepalive_time` and `tcp_keepalive_interval`
+in man:tcp(7) on Solaris 11 for more information.
+
+`LTTNG_RELAYD_TCP_KEEP_ALIVE_MAX_PROBE_COUNT`::
+    Maximum number of TCP keep-alive probes to send before giving up and
+    killing the connection if no response is obtained from the other end.
++
+Set to 0 or -1 to use the value chosen by the operating system (default).
++
+Supported on Linux only.
++
+Search for `tcp_keepalive_probes` in man:tcp(7) for more information.
+
+`LTTNG_RELAYD_TCP_KEEP_ALIVE_PROBE_INTERVAL`::
+    Number of seconds between TCP keep-alive probes.
++
+Set to 0 or -1 to use the value chosen by the operating system (default).
++
+Supported on Linux only.
++
+Search for `tcp_keepalive_intvl` in man:tcp(7) for more information.
+

 
 FILES
 -----
 
 FILES
 -----