summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRadu Gheorghe <radu.gheorghe@sematext.com>2013-07-03 13:22:22 +0300
committerRainer Gerhards <rgerhards@adiscon.com>2013-07-06 11:00:34 +0200
commitbd09d31a8657aec0b78c21dde5c0c1fc611e8e8c (patch)
tree66620e9416b1d309cf1d92a7b0d5a0e1fdccff64
parent8ee2b0b1610fbf4dff20453d188f379583410b42 (diff)
downloadrsyslog-bd09d31a8657aec0b78c21dde5c0c1fc611e8e8c.tar.gz
rsyslog-bd09d31a8657aec0b78c21dde5c0c1fc611e8e8c.tar.bz2
rsyslog-bd09d31a8657aec0b78c21dde5c0c1fc611e8e8c.zip
imfile changes back again, but with retained format
-rw-r--r--doc/imfile.html18
1 files changed, 9 insertions, 9 deletions
diff --git a/doc/imfile.html b/doc/imfile.html
index dd62c86f..942fe531 100644
--- a/doc/imfile.html
+++ b/doc/imfile.html
@@ -61,15 +61,15 @@ nothing is left to be processed.</li>
<p><b>Action Directives</b></p>
<ul>
-<li><strong>File&nbsp;/path/to/file</strong><br>
+<li><strong>(required) File&nbsp;/path/to/file</strong><br>
The file being monitored. So far, this must be an absolute name (no
macros or templates)</li>
-<li><span style="font-weight: bold;">Tag
+<li><span style="font-weight: bold;">(required) Tag
tag:</span><br>
The tag to be used for messages that originate from this file. If you
would like to see the colon after the tag, you need to specify it here
(as shown above).</li>
-<li><span style="font-weight: bold;">StateFile
+<li><span style="font-weight: bold;">(required) StateFile
&lt;name-of-state-file&gt;</span><br>
Rsyslog must keep track of which parts of the to be monitored file it
already processed. This is done in the state file. This file always is
@@ -94,7 +94,7 @@ textual form (e.g. "info", "warning", ...) or as numbers (e.g. 4 for
is "notice".</li>
<li><b>PersistStateInterval</b> [lines]</b><br>
Specifies how often the state file shall be written when processing the input
-file. The default value is 0, which means a new state file is only written when
+file. The <strong>default</strong> value is 0, which means a new state file is only written when
the monitored files is being closed (end of rsyslogd execution). Any other
value n means that the state file is written every time n file lines have
been processed. This setting can be used to guard against message duplication due
@@ -103,7 +103,7 @@ performance, especially when set to a low value. Frequently writing the state
file is very time consuming.
<li><b>ReadMode</b> [mode]</b><br>
This mode should defined when having multiline messages. The value can range from 0-2 and determines the multiline detection method.
-<br>0 (default) - line based (Each line is a new message)
+<br>0 (<strong>default</strong>) - line based (Each line is a new message)
<br>1 - paragraph (There is a blank line between log messages)
<br>2 - indented (New log messages start at the beginning of a line. If a line starts with a space it is part of the log message before it)
<li><b>MaxLinesAtOnce</b> [number]</b>
@@ -114,11 +114,11 @@ will be fully processed and then processing switches to the next file
[number] lines is processed in sequence for each file, and then the file is
switched. This provides a kind of mutiplexing the load of multiple files and
probably leads to a more natural distribution of events when multiple busy files
-are monitored. The default is 1024.
+are monitored. The <strong>default</strong> is 1024.
<li><b>MaxSubmitAtOnce</b> [number]</b>
<br>
This is an expert option. It can be used to set the maximum input batch size that
-imfile can generate. The default is 1024, which is suitable for a wide range of
+imfile can generate. The <strong>default</strong> is 1024, which is suitable for a wide range of
applications. Be sure to understand rsyslog message batch processing before you
modify this option. If you do not know what this doc here talks about, this is a
good indication that you should NOT modify the default.
@@ -147,13 +147,13 @@ commands and uses defaults instead.<br>
# File 1
input(type="imfile" File="/path/to/file1"
Tag="tag1"
- StateFile="/var/spool/rsyslog/statefile1"
+ StateFile="statefile1"
Severity="error"
Facility="local7")
# File 2
input(type="imfile" File="/path/to/file2"
Tag="tag2"
- StateFile="/var/spool/rsyslog/statefile2")
+ StateFile="statefile2")
# ... and so on ...
#
</textarea>