diff options
| author | Rainer Gerhards <rgerhards@adiscon.com> | 2008-02-12 13:12:32 +0000 |
|---|---|---|
| committer | Rainer Gerhards <rgerhards@adiscon.com> | 2008-02-12 13:12:32 +0000 |
| commit | 09d7d7d2583de936cfafa8b9452c77664b3fcdfa (patch) | |
| tree | 581aa039df09c93cd13b3bf79e39f39e4e849eb8 | |
| parent | dd70fc145fc8b8d94bfa98fc25e4ccd5a073859a (diff) | |
| download | rsyslog-09d7d7d2583de936cfafa8b9452c77664b3fcdfa.tar.gz rsyslog-09d7d7d2583de936cfafa8b9452c77664b3fcdfa.tar.xz rsyslog-09d7d7d2583de936cfafa8b9452c77664b3fcdfa.zip | |
clarified dependency of control character property replacer options to
$EscapeControlCharactersOnReceive
| -rw-r--r-- | doc/property_replacer.html | 27 | ||||
| -rw-r--r-- | doc/rsconf1_escapecontrolcharactersonreceive.html | 5 |
2 files changed, 26 insertions, 6 deletions
diff --git a/doc/property_replacer.html b/doc/property_replacer.html index 3df2fd0b..4b98774b 100644 --- a/doc/property_replacer.html +++ b/doc/property_replacer.html @@ -125,14 +125,29 @@ are defined:</p> <tr><td><b>date-mysql</b></td><td>format as mysql date</td></tr> <tr><td><b>date-rfc3164</b></td><td>format as RFC 3164 date</td></tr> <tr><td><b>date-rfc3339</b></td><td>format as RFC 3339 date</td></tr> -<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 "#<charval>" +<tr> + <td><b>escape-cc</b></td><td>replace control characters (ASCII value 127 and + values less then 32) with an escape sequence. The sequence is "#<charval>" where charval is the 3-digit decimal value of the control character. For - example, a tabulator would be replaced by "#009".</td></tr> -<tr><td><b>space-cc</b></td><td>replace control characters by spaces</td></tr> -<tr><td><b>drop-cc</b></td><td>drop control characters - the resulting string + example, a tabulator would be replaced by "#009".<br> + Note: using this option requires that + <a href="../../rsyslog/doc/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="../../rsyslog/doc/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="../../rsyslog/doc/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> |