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

[deliverable/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 2f5fa91e3f058bd3a7723cc4d15e3c64f91738b4..1ed58815ae6332cef45070bea1cb3228d57b3e72 100644 (file)
--- a/doc/man/lttng-relayd.8.txt
+++ b/doc/man/lttng-relayd.8.txt
@@ -11,9 +11,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']
 
 
 DESCRIPTION
@@ -49,7 +49,8 @@ file system.
 [[output-directory]]
 Output directory
 ~~~~~~~~~~~~~~~~
-By default, the relay daemon writes the traces to:
+By default (option:--group-output-by-host), the relay daemon writes the traces
+to:
 
 [verse]
 $LTTNG_HOME/lttng-traces/'HOSTNAME'/'SESSION'/'DOMAIN'
@@ -65,11 +66,19 @@ with:
 'DOMAIN'::
     Tracing domain.
 
+You can group the output per session instead of per hostname with the
+option:--group-output-by-session option. This result in the following:
+
+[verse]
+
+$LTTNG_HOME/lttng-traces/'SESSION'/'HOST'/'DOMAIN'
+
 You can override the default output directory prefix
 (`$LTTNG_HOME/lttng-traces`) with the option:--output option. The other
 parts depend on the remote configuration.
 
 
+
 [[url-format]]
 URL format
 ~~~~~~~~~~
@@ -106,6 +115,12 @@ option:-d, option:--daemonize::
     option:--background option instead to keep the file descriptors
     open.
 
+option:--fd-pool-size='COUNT'::
+    Set the size of the file descritptor 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`).
 
@@ -115,11 +130,23 @@ option:-o 'PATH', option:--output='PATH'::
 See the <<output-directory,Output directory>> section above for more
 information.
 
-option:-w 'PATH', option:--working-directory='PATH'::
-    Set the working directory of the processes this relay daemon creates.
+option:-p, option:--group-output-by-host::
+    Organize the output directory by host. Default behavior.
++
+See the <<output-directory,Output directory>> section above for more
+information.
+
+option:-s, option:--group-output-by-session::
+    Organize the output directory by session.
++
+See the <<output-directory,Output directory>> section above for more
+information.
 
 option:-v, option:--verbose::
     Increase verbosity.
+
+option:-w 'PATH', option:--working-directory='PATH'::
+    Set the working directory of the processes this relay daemon creates.
 +
 Three levels of verbosity are available, which are triggered by
 appending additional `v` letters to the option