From 8bb2143deb3ddf110dbb76c7ad2f49b664fbd172 Mon Sep 17 00:00:00 2001
From: Andre Lorbach
Date: Wed, 19 Jun 2013 10:49:32 +0200
Subject: Updated omprog documentation
---
doc/omprog.html | 30 ++++++++++++++++++++++++++++--
1 file changed, 28 insertions(+), 2 deletions(-)
(limited to 'doc/omprog.html')
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).
-Configuration Directives:
+
+
+
+Module Parameters:
+
+ - Template [templateName]
+ sets a new default template for file actions.
+
+
+
+Action Parameters:
+
+ - binary (The binary program to be executed including optional parameters.)
+ Parameters are not required but can be specified, for more see the config sample below.
+
+Caveats/Known Bugs:
+Sample:
+The following command writes all syslog messages into a file.
+
+
+
+
+Legacy Configuration Directives:
- $ActionOMProgBinary <binary>
The binary program to be executed.
@@ -36,7 +62,7 @@ The binary program to be executed.
[manual index] [rsyslog site]
This documentation is part of the rsyslog
project.
-Copyright © 2008-2011 by Rainer
+Copyright © 2008-2013 by Rainer
Gerhards and
Adiscon.
Released under the GNU GPL version 3 or higher.
--
cgit v1.2.3