ommysql: updated doc

1 files changed, 30 insertions, 16 deletions

diff --git a/doc/ommysql.html b/doc/ommysql.html
index daef9cab..7769fb86 100644
--- a/doc/ommysql.html
+++ b/doc/ommysql.html
@@ -15,28 +15,37 @@
 <p>This module provides native support for logging to MySQL databases. It offers
 superior performance over the more generic <a href="omlibdbi.html">omlibdbi</a> module.
 </p>
-<p><b>Configuration Directives</b>:</p>
-<p>ommysql mostly uses the "old style" configuration, with almost everything on the
-action line itself. A few newer features are being migrated to the new style-config
-directive configuration system.
+<p><b>Action Parameters</b>:</p>
 <ul>
-<li><b>$ActionOmmysqlServerPort &lt;port&gt;</b><br>Permits to select
+<li><b>server</b><br>Name or address of the MySQL server
+<li><b>serverport</b><br>Permits to select
 a non-standard port for the MySQL server. The default is 0, which means the
-system default port is used. There is no need to specify this directive unless
+system default port is used. There is no need to specify this parameter unless
 you know the server is running on a non-standard listen port.
-<li><b>$OmMySQLConfigFile &lt;file name&gt;</b><br>Permits the selection
+<li><b>db</b><br>Database to use
+<li><b>uid</b><br>logon userid used to connect to server. Must have proper permissions.
+<li><b>pwd</b><br>the user's password
+<li><b>template</b><br>Template to use when submitting messages.
+<li><b>mysqlconfig.file</b><br>Permits the selection
 of an optional MySQL Client Library configuration file (my.cnf) for extended
 configuration functionality. The use of this configuration directive is necessary 
 only if you have a non-standard environment or if fine-grained control over the
 database connection is desired.</li>
-<li><b>$OmMySQLConfigSection &lt;string&gt;</b><br>Permits the selection of the
-section within the configuration file specified by the <b>$OmMySQLConfigFile</b> directive.
+<li><b>mysqlconfig.section</b><br>Permits the selection of the
+section within the configuration file specified by the <b>myselconfig.file</b> parameter.
 <br>This will likely only be used where the database administrator provides a single
 configuration file with multiple profiles.
-<br>This configuration directive is ignored unless <b>$OmMySQLConfigFile</b> is also used
-in the rsyslog configration file.
+<br>This configuration parameter is ignored unless <b>mysqlconfig.file</b> is also used.
 <br>If omitted, the MySQL Client Library default of &quot;client&quot; will be used.</li>
-<li>Action parameters:
+</ul>
+<p><b>Legacy (pre-v6) Configuration Directives</b>:</p>
+<p>ommysql mostly uses the "very old style" (v0) configuration, with almost everything on the
+action line itself.
+<ul>
+<li><b>$ActionOmmysqlServerPort &lt;port&gt;</b> - like the "serverport" action parameter.
+<li><b>$OmMySQLConfigFile &lt;file name&gt;</b> - like the "mysqlconfig.file" action parameter.
+<li><b>$OmMySQLConfigSection &lt;string&gt;</b> - like the "mysqlconfig.file" action parameter.
+<li>Action line:
 <br><b>:ommysql:database-server,database-name,database-userid,database-password</b>
 <br>All parameters should be filled in for a successful connect.
 </ul>
@@ -57,15 +66,20 @@ database "syslog_db" on mysqlsever.example.com. The server is
 being accessed under the account of "user" with password "pwd".
 </p>
 <textarea rows="5" cols="80">$ModLoad ommysql
+*.* 	action(type="ommysql" server="mysqlserver.example.com" serverport="1234"
+	       db="syslog_db" uid="user" pwd="pwd")
+</textarea>
+<p><b>Legacy Sample:</b></p>
+<p>The same as above, but in legacy config format (pre rsyslog-v6):
+<textarea rows="5" cols="80">$ModLoad ommysql
 $ActionOmmysqlServerPort 1234 # use non-standard port
 *.*&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; :ommysql:mysqlserver.example.com,syslog_db,user,pwd
 </textarea>
 <p>[<a href="rsyslog_conf.html">rsyslog.conf overview</a>]
 [<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 &copy; 2008, 2009 by <a href="http://www.gerhards.net/rainer">Rainer Gerhards</a> and
+<a href="http://www.rsyslog.com/">rsyslog</a> project.<br>
+Copyright &copy; 2008-2012 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>
+Released under the ASL 2.0.</font></p>
 </body></html>