LTTNG-RELAYD(8): document the --fd-pool-size option

[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 87135c4eb9af40fc60e798b7563be0621e6a0941..e70242d46170ff779487d800fd010e14e1ca07bf 100644 (file)
--- a/doc/man/lttng-relayd.8.txt
+++ b/doc/man/lttng-relayd.8.txt
@@ -12,9 +12,9 @@ SYNOPSIS
 --------
 [verse]
 *lttng-relayd* [option:--background | option:--daemonize]
-             [option:--control-port='URL'] [option:--data-port='URL'] [option:--live-port='URL']
-             [option:--output='PATH'] [option:-v | option:-vv | option:-vvv]
-             [option:--working-directory='PATH']
+             [option:--control-port='URL'] [option:--data-port='URL'] [option:--fd-pool-size='COUNT']
+             [option:--live-port='URL'] [option:--output='PATH']
+             [option:-v | option:-vv | option:-vvv] [option:--working-directory='PATH']
              [option:--group-output-by-session | option:--group-output-by-host]
 
 DESCRIPTION
@@ -40,7 +40,7 @@ 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://{default_network_viewer_bind_address}:{default_network_viewer_port}+.
++--live-port=tcp://0.0.0.0:{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
@@ -121,6 +121,12 @@ option:-d, option:--daemonize::
     option:--background option instead to keep the file descriptors
     open.
 
+option:--fd-pool-size='SIZE'::
+    Set the size of the file descriptor pool. This effectively sets a
+    limit on the number of file descriptors that may be kept open
+    simultaneously by the daemon (default: the soft `RLIMIT_NOFILE` resource
+    limit of the process).
+
 option:-g 'GROUP', option:--group='GROUP'::
     Use 'GROUP' as Unix tracing group (default: `tracing`).
 
@@ -190,6 +196,10 @@ ENVIRONMENT VARIABLES
     Socket connection, receive and send timeout (milliseconds). A value
     of 0 or -1 uses the timeout of the operating system (default).
 
+`LTTNG_RELAYD_DISALLOW_CLEAR`::
+    Set to 1 to disallow the use of lttng-clear(1) on sessions collected by
+    this relay daemon.
+
 `LTTNG_RELAYD_HEALTH`::
     Path to relay daemon health's socket.