summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRainer Gerhards <rgerhards@adiscon.com>2013-11-26 12:11:32 +0100
committerRainer Gerhards <rgerhards@adiscon.com>2013-11-26 12:11:32 +0100
commit45f2150def02eccdc0e16cadc8b0afa4ffa1c64a (patch)
tree5ee29f872ec2c1fbffc688c2f3cc8eb97250db85
parentd7a0899203a911d7441f2d3a2efd908a7e50f8d9 (diff)
downloadrsyslog-45f2150def02eccdc0e16cadc8b0afa4ffa1c64a.tar.gz
rsyslog-45f2150def02eccdc0e16cadc8b0afa4ffa1c64a.tar.bz2
rsyslog-45f2150def02eccdc0e16cadc8b0afa4ffa1c64a.zip
doc: improve queue parameter doc
-rw-r--r--doc/queue_parameters.html14
1 files changed, 13 insertions, 1 deletions
diff --git a/doc/queue_parameters.html b/doc/queue_parameters.html
index 0237a475..049c467d 100644
--- a/doc/queue_parameters.html
+++ b/doc/queue_parameters.html
@@ -15,7 +15,19 @@ Queues need to be configured in the action or ruleset it should affect. If nothi
default values will be used. Thus, the default ruleset has only the default main queue. Specific Action
queues are not set up by default.</p>
<ul>
- <li><strong>queue.filename</strong> name</li>
+ <li><strong>queue.filename</strong> name<br>
+ File name to be used for the queue files. Please note that
+ this is actually just the file name. A directory can NOT be
+ specified in this paramter. If the files shall be
+ created in a specific directory, specify
+ queue.spoolDirectory for this. The filename is used to build
+ to complete path for queue files.</li>
+ <li><strong>queue.spoolDirectory</strong> name<br>
+ This is the directory into which queue files will be stored.
+ Note that the directory must exist, it is NOT automatically
+ created by rsyslog. If no spoolDirectory is specified, the
+ work directory is used.
+ </li>
<li><strong>queue.size</strong> number <br>
This is the maximum size of the queue in number of messages.
Note that setting the queue size to very small values (roughly