diff options
| author | Andre Lorbach <alorbach@adiscon.com> | 2013-06-19 10:49:32 +0200 |
|---|---|---|
| committer | Andre Lorbach <alorbach@adiscon.com> | 2013-06-19 10:49:32 +0200 |
| commit | 8bb2143deb3ddf110dbb76c7ad2f49b664fbd172 (patch) | |
| tree | 4d9002ac102b9a521cfa6948845b976548f2345a | |
| parent | db467c36e4fd560fa82ed42c331626a73dd3d006 (diff) | |
| download | rsyslog-8bb2143deb3ddf110dbb76c7ad2f49b664fbd172.tar.gz rsyslog-8bb2143deb3ddf110dbb76c7ad2f49b664fbd172.tar.bz2 rsyslog-8bb2143deb3ddf110dbb76c7ad2f49b664fbd172.zip | |
Updated omprog documentation
| -rw-r--r-- | doc/omprog.html | 30 |
1 files changed, 28 insertions, 2 deletions
diff --git a/doc/omprog.html b/doc/omprog.html index 471ab224..b4d13eec 100644 --- a/doc/omprog.html +++ b/doc/omprog.html @@ -25,7 +25,33 @@ con re-using existing binaries. For the time being, it simply is not done. In th we may add an option for such pooling, provided that some demand for that is voiced. You can also mimic the same effect by defining multiple rulesets and including them (at the price of some slight performance loss). -<p><b>Configuration Directives</b>:</p> + +<p> </p> + +<p><b>Module Parameters</b>:</p> +<ul> + <li><strong>Template </strong>[templateName]<br> + sets a new default template for file actions.<br></li> + +</ul> +<p> </p> +<p><b>Action Parameters</b>:</p> +<ul> + <li><strong>binary </strong>(The binary program to be executed including optional parameters.)<br> + Parameters are not required but can be specified, for more see the config sample below.<br></li><br> +</ul> +<p><b>Caveats/Known Bugs:</b></p><ul><li>None.</li></ul> +<p><b>Sample:</b></p> +<p>The following command writes all syslog messages into a file.</p> +<textarea rows="5" cols="85">Module (load="omprog") +*.* action(type="omprog" + binary="/pathto/omprog.py --parm1=\"value 1\" --parm2=value2" + template="RSYSLOG_TraditionalFileFormat") +</textarea> + +<br><br> + +<p><b>Legacy Configuration Directives</b>:</p> <ul> <li><b>$ActionOMProgBinary</b> <binary><br> The binary program to be executed. @@ -36,7 +62,7 @@ The binary program to be executed. [<a href="manual.html">manual index</a>] [<a href="http://www.rsyslog.com/">rsyslog site</a>]</p> <p><font size="2">This documentation is part of the <a href="http://www.rsyslog.com/">rsyslog</a> project.<br> -Copyright © 2008-2011 by <a href="http://www.gerhards.net/rainer">Rainer +Copyright © 2008-2013 by <a href="http://www.gerhards.net/rainer">Rainer Gerhards</a> and <a href="http://www.adiscon.com/">Adiscon</a>. Released under the GNU GPL version 3 or higher.</font></p> |