added some doc for imgssapi and imtcp input modules

5 files changed, 113 insertions, 3 deletions

diff --git a/doc/Makefile.am b/doc/Makefile.am
index 901f1202..f03c9120 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -30,6 +30,8 @@ html_files = \
 	omsnmp.html \
 	omlibdbi.html \
 	imfile.html \
+	imtcp.html \
+	imgssapi.html \
 	professional_support.html \
 	queues.html \
 	queueWorkerLogic.dia \
diff --git a/doc/expression.html b/doc/expression.html
index 3aecf298..6d187413 100644
--- a/doc/expression.html
+++ b/doc/expression.html
@@ -9,7 +9,7 @@ far, they are supported for filtering messages.</p><p>C-like comments (/* some c
 <h2>Formal Definition</h2>
 
 <p>Below is the formal definition of expression format (in ABNF, RFC 2234):<br>
-</p><pre>; The stuff immediately below here is a quick shot at how the config<br>; file ABNF *at whole* may look like. That is not really related to<br>; expressions, but for the time being I put it here. It will later be<br>; moved to a more appropriate place. -- rgerhards, 2008-02-22<br>?line?   := cfsysline / cfli<br>cfsysline:= BOL "$" *char EOL ; how to handle the first line? (no EOL in front!)<br>BOL      := ; Begin of Line - implicitely set on file beginning and after each EOL<br>EOL       := 0x0a ;LF<br>if_stmt  := "if" expr "then"<br>old_filter:= BOL facility "." severity<br>facility := "*" / "auth" / "authpriv" / "cron" / "daemon" / "kern" / "lpr" / <br>            "mail" / "mark" / "news" / "security" / "syslog" / "user" / "uucp" / <br>            "local0" .. "local7" / "mark"<br>	   ; The keyword security should not be used anymore<br>	   ; mark is just internal<br>severity := <br><br>; and now the actual expression<br>expr     := e_and *("or" e_and)<br>e_and    := e_cmp *("and" e_cmp)<br>e_cmp    := val 0*1(cmp_op val)<br>val      := term *(("+" / "-") term)<br>term     := factor *(("*" / "/" / "%") factor)<br>factor   := ["not"] ["-"] terminal<br>terminal := var / constant / function / ( "(" expr ")" )<br>function := name "(" *("," expr) ")"<br>var      := "$" varname<br>varname  := msgvar / sysvar<br>msgvar   := name<br>sysvar   := "$" name<br>name     := alpha *(alnum)<br>constant := string / number<br>string   := simpstr / tplstr ; tplstr will be implemented in next phase<br>simpstr  := "'" *char "'"    ; use your imagination for char ;)<br>tplstr   := '"' template '"' ; not initially implemented<br>number   := ["-"] 1*digit ; 0nn = octal, 0xnn = hex, nn = decimal<br>cmp_op   := "==" / "!=" / "&lt;&gt;" / "&lt;" / "&gt;" / "&lt;=" / "&gt;=" / "contains" / "startswith"<br>digit    := %x30-39<br>alpha    := "a" ... "z" # all letters<br>alnum    :* alpha / digit / "_"<br></pre>
+</p><pre>; The stuff immediately below here is a quick shot at how the config<br>; file ABNF *at whole* may look like. That is not really related to<br>; expressions, but for the time being I put it here. It will later be<br>; moved to a more appropriate place. -- rgerhards, 2008-02-22<br>?line?   := cfsysline / cfli<br>cfsysline:= BOL "$" *char EOL ; how to handle the first line? (no EOL in front!)<br>BOL      := ; Begin of Line - implicitely set on file beginning and after each EOL<br>EOL       := 0x0a ;LF<br>if_stmt  := "if" expr "then"<br>old_filter:= BOL facility "." severity ; no whitespace allowed between BOL and facility!<br>facility := "*" / "auth" / "authpriv" / "cron" / "daemon" / "kern" / "lpr" / <br>            "mail" / "mark" / "news" / "security" / "syslog" / "user" / "uucp" / <br>            "local0" .. "local7" / "mark"<br>	   ; The keyword security should not be used anymore<br>	   ; mark is just internal<br>severity := TBD ; not really relevant in this context<br><br>; and now the actual expression<br>expr     := e_and *("or" e_and)<br>e_and    := e_cmp *("and" e_cmp)<br>e_cmp    := val 0*1(cmp_op val)<br>val      := term *(("+" / "-") term)<br>term     := factor *(("*" / "/" / "%") factor)<br>factor   := ["not"] ["-"] terminal<br>terminal := var / constant / function / ( "(" expr ")" )<br>function := name "(" *("," expr) ")"<br>var      := "$" varname<br>varname  := msgvar / sysvar<br>msgvar   := name<br>sysvar   := "$" name<br>name     := alpha *(alnum)<br>constant := string / number<br>string   := simpstr / tplstr ; tplstr will be implemented in next phase<br>simpstr  := "'" *char "'"    ; use your imagination for char ;)<br>tplstr   := '"' template '"' ; not initially implemented<br>number   := ["-"] 1*digit ; 0nn = octal, 0xnn = hex, nn = decimal<br>cmp_op   := "==" / "!=" / "&lt;&gt;" / "&lt;" / "&gt;" / "&lt;=" / "&gt;=" / "contains" / "startswith"<br>digit    := %x30-39<br>alpha    := "a" ... "z" # all letters<br>alnum    :* alpha / digit / "_"<br></pre>
 <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
diff --git a/doc/imgssapi.html b/doc/imgssapi.html
new file mode 100644
index 00000000..8e6b7d87
--- /dev/null
+++ b/doc/imgssapi.html
@@ -0,0 +1,57 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html><head>
+<meta http-equiv="Content-Language" content="en"><title>GSSAPI Syslog Input Module</title>
+
+</head>
+<body>
+<h1>GSSAPI Syslog Input Module</h1>
+<p><b>Module Name:&nbsp;&nbsp;&nbsp; imtcp</b></p>
+<p><b>Author: </b>varmojfekoj
+&lt;email address here? which?&gt;</p>
+<p><b>Description</b>:</p>
+<p>Provides the ability to receive syslog messages from the
+network protected via Kerberos 5 encryption and authentication. This
+module also contains the functionality found in <a href="imtcp.html">imtcp</a>,
+which can not be used if imgssapi is used.</p>
+<p><b>Configuration Directives</b>:</p>
+<ul>
+<li>InputGSSServerRun &lt;port&gt;<br>
+Starts a GSSAPI server on selected port - note that this runs
+independently from the TCP server.</li>
+<li>InputGSSServerServiceName &lt;name&gt;<br>
+The service name to use for the GSS server.</li>
+<li>$InputTCPServerRun &lt;port&gt;<br>
+Starts a TCP server on selected port</li>
+<li>$InputTCPMaxSessions &lt;number&gt;<br>
+Sets the maximum number of sessions supported</li>
+</ul>
+<b>Caveats/Known Bugs:</b>
+<ul>
+<li>module always binds to all interfaces</li>
+<li>only a single listener can be bound (one each for GSS and
+plain TCP)</li>
+<li>duplicates <a href="imtcp.html">imtcp</a>
+functionality and thus conflicts with it. This will change in the
+future. Unfortunately, that also means that&nbsp;your config files
+probably&nbsp;need &nbsp;to be changed in the future when that
+change happens.</li>
+</ul>
+<p><b>Sample:</b></p>
+<p>This sets up a TCP server on port 514 and a GSSAPI protected
+syslog server at port 1514:<br>
+</p>
+<textarea rows="15" cols="60">$ModLoad imtcp.so #
+needs to be done just once
+$InputTCPServerRun 514
+$InputGSSServerRun 1514
+</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 © 2008 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>
+</body></html>
\ No newline at end of file
diff --git a/doc/imtcp.html b/doc/imtcp.html
new file mode 100644
index 00000000..b2c6d21d
--- /dev/null
+++ b/doc/imtcp.html
@@ -0,0 +1,51 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html><head>
+<meta http-equiv="Content-Language" content="en"><title>TCP Syslog Input Module</title>
+
+</head>
+<body>
+<h1>TCP Syslog Input Module</h1>
+<p><b>Module Name:&nbsp;&nbsp;&nbsp; imtcp</b></p>
+<p><b>Author: </b>Rainer Gerhards
+&lt;rgerhards@adiscon.com&gt;</p>
+<p><b>Description</b>:</p>
+<p>Provides the ability to receive syslog messages via TCP.
+Encryption can be provided by using <a href="rsyslog_stunnel.html">stunnel</a>
+(an alternative is the use
+the&nbsp;<a href="imgssapi.html">imgssapi</a>
+modul).</p>
+<p>In the future, multiple receivers may be configured by
+specifying
+$InputTCPServerRun multiple times. This is not currently supported.
+</p>
+<p><b>Configuration Directives</b>:</p>
+<ul>
+<li>$InputTCPServerRun &lt;port&gt;<br>
+Starts a TCP server on selected port</li>
+<li>$InputTCPMaxSessions &lt;number&gt;<br>
+Sets the maximum number of sessions supported</li>
+</ul>
+<b>Caveats/Known Bugs:</b>
+<ul>
+<li>module always binds to all interfaces</li>
+<li>only a single listener can be bound</li>
+<li>can not be loaded together with <a href="imgssapi.html">imgssapi</a>
+(which includes the functionality of imtcp)</li>
+</ul>
+<p><b>Sample:</b></p>
+<p>This sets up a TCP server on port 514:<br>
+</p>
+<textarea rows="15" cols="60">$ModLoad imtcp.so #
+needs to be done just once
+$InputTCPServerRun 514
+</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 © 2008 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>
+</body></html>
\ No newline at end of file
diff --git a/doc/rsyslog_conf.html b/doc/rsyslog_conf.html
index 977d37f0..60e2e7ac 100644
--- a/doc/rsyslog_conf.html
+++ b/doc/rsyslog_conf.html
@@ -36,7 +36,7 @@ SQLLite, Ingres, Oracle, mSQL)</li>
 <li><a href="imfile.html">imfile</a>
 -&nbsp; input module for text files</li>
 <li>imudp - udp syslog message input</li>
-<li>imtcp - input plugin for plain tcp and GSS-enable syslog</li>
+<li><a href="imtcp.html">imtcp</a> - input plugin for plain tcp syslog</li><li><a href="imgssapi.html">imgssapi</a> - input plugin for plain tcp and GSS-enable syslog</li>
 <li>immark - support for mark messages</li>
 <li>imklog - kernel logging</li>
 </ul>
@@ -1064,7 +1064,7 @@ Please note the colon in fron</p>
 <p>Rsyslogd uses a slightly different syntax for its
 configuration file than the original BSD sources. Originally all
 messages of a specific priority and above were forwarded to the log
-file. The modifiers "='', "!'' and "-'' were added to make rsyslogd
+file. The modifiers "='', "!'' and "!-'' were added to make rsyslogd
 more flexible and to use it in a more intuitive manner.<br>
 <br>
 The original BSD syslogd doesn't understand spaces as separators