summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRainer Gerhards <rgerhards@adiscon.com>2008-02-12 13:09:27 +0000
committerRainer Gerhards <rgerhards@adiscon.com>2008-02-12 13:09:27 +0000
commitbc846dc0bddbf0f95c1354927adcb5daaf41ef4c (patch)
tree75c521e5cc0c6cd56f345cc5c02809d7a7689a66
parent35498720c851ff4187832dbf5898886ae97164b0 (diff)
downloadrsyslog-bc846dc0bddbf0f95c1354927adcb5daaf41ef4c.tar.gz
rsyslog-bc846dc0bddbf0f95c1354927adcb5daaf41ef4c.tar.xz
rsyslog-bc846dc0bddbf0f95c1354927adcb5daaf41ef4c.zip
clarified dependency of control character property replacer options to
$EscapeControlCharactersOnReceive
-rw-r--r--doc/property_replacer.html15
-rw-r--r--doc/rsconf1_escapecontrolcharactersonreceive.html5
2 files changed, 17 insertions, 3 deletions
diff --git a/doc/property_replacer.html b/doc/property_replacer.html
index 3df2fd0b..31ff3c38 100644
--- a/doc/property_replacer.html
+++ b/doc/property_replacer.html
@@ -128,11 +128,20 @@ are defined:</p>
<tr><td><b>escape-cc</b></td><td>replace control characters (ASCII value 127 and
values less then 32) with an escape sequence. The sequnce is &quot;#&lt;charval&gt;&quot;
where charval is the 3-digit decimal value of the control character. For
- example, a tabulator would be replaced by &quot;#009&quot;.</td></tr>
-<tr><td><b>space-cc</b></td><td>replace control characters by spaces</td></tr>
+ example, a tabulator would be replaced by &quot;#009&quot;.<br>
+ Note: using this option requires that
+ <a href="rsconf1_escapecontrolcharactersonreceive.html">$EscapeControlCharactersOnReceive</a>
+ is set to off.</td></tr>
+<tr><td><b>space-cc</b></td><td>replace control characters by spaces<br>
+ Note: using this option requires that
+ <a href="rsconf1_escapecontrolcharactersonreceive.html">$EscapeControlCharactersOnReceive</a>
+ is set to off.</td></tr>
<tr><td><b>drop-cc</b></td><td>drop control characters - the resulting string
will neither contain control characters, escape sequences nor any other
- replacement character like space.</td></tr>
+ replacement character like space.<br>
+ Note: using this option requires that
+ <a href="rsconf1_escapecontrolcharactersonreceive.html">$EscapeControlCharactersOnReceive</a>
+ is set to off.</td></tr>
</table>
<h2>Further Links</h2>
diff --git a/doc/rsconf1_escapecontrolcharactersonreceive.html b/doc/rsconf1_escapecontrolcharactersonreceive.html
index a8855119..26917736 100644
--- a/doc/rsconf1_escapecontrolcharactersonreceive.html
+++ b/doc/rsconf1_escapecontrolcharactersonreceive.html
@@ -14,6 +14,11 @@
(like Japanese, Chinese and Korean)</li>
<li>turning on this option destroys digital signatures if such exists inside
the message</li>
+ <li>if turned on, the drop-cc, space-cc and escape-cc
+ <a href="property_replacer.html">property replacer</a> options do not work
+ as expected because control characters are already removed upon message
+ reception. If you intend to use these property replacer options, you must
+ turn off $EscapeControlCharactersOnReceive.</li>
</ul>
<p><b>Sample:</b></p>
<p><code><b>$EscapeControlCharactersOnReceive on</b></code></p>