summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/debug.html6
-rw-r--r--doc/impstats.html5
-rw-r--r--doc/imuxsock.html8
-rw-r--r--doc/mmanon.html9
-rw-r--r--doc/mmnormalize.html11
-rw-r--r--doc/omfile.html5
-rw-r--r--doc/omfwd.html5
-rw-r--r--doc/omruleset.html5
-rw-r--r--doc/property_replacer.html4
-rw-r--r--doc/queues.html5
-rw-r--r--doc/rsyslog_conf_filter.html5
-rw-r--r--doc/rsyslog_conf_templates.html8
-rw-r--r--doc/rsyslog_packages.html5
-rw-r--r--doc/sigprov_gt.html6
-rw-r--r--doc/troubleshoot.html24
15 files changed, 89 insertions, 22 deletions
diff --git a/doc/debug.html b/doc/debug.html
index 557ca6d3..229aeb08 100644
--- a/doc/debug.html
+++ b/doc/debug.html
@@ -160,7 +160,11 @@ enable DebugOnDemand mode only for a reason. Note that when no debug mode is ena
SIGUSR1 and SIGUSR2 are completely ignored.
<p>When running in any of the debug modes (including on demand mode), an interactive
instance of rsyslogd can be aborted by pressing ctl-c.
-<p>
+<p><b>See Also</b>
+<ul>
+<li><a href="http://www.rsyslog.com/how-to-use-debug-on-demand/">How to use debug on demand</a></li>
+</ul>
+</p>
<p>[<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>
diff --git a/doc/impstats.html b/doc/impstats.html
index 8db9c6f6..6c44b0e9 100644
--- a/doc/impstats.html
+++ b/doc/impstats.html
@@ -81,6 +81,11 @@ If set to on, stats messages are emitted as structured cee-enhanced syslog. If
set to off, legacy format is used (which is compatible with pre v6-rsyslog).
</li>
</ul>
+<p><b>See Also</b>
+<ul>
+<li><a href="http://www.rsyslog.com/rsyslog-statistic-counter/">rsyslog statistics counter</a></li>
+</ul>
+</p>
<b>Caveats/Known Bugs:</b>
<ul>
<li>This module MUST be loaded right at the top of rsyslog.conf, otherwise
diff --git a/doc/imuxsock.html b/doc/imuxsock.html
index 0affe8c3..e89a67aa 100644
--- a/doc/imuxsock.html
+++ b/doc/imuxsock.html
@@ -180,7 +180,13 @@ oneself has the advantage that a limited amount of messages may be
queued by the OS if rsyslog is not running.
</li>
</ul>
-
+<p><b>See Also</b>
+<ul>
+<li><a href="http://www.rsyslog.com/what-are-trusted-properties/">What are "trusted properties"?</a></li>
+<li><a href="http://www.rsyslog.com/why-does-imuxsock-not-work-on-solaris/">Why does imuxsock not work
+on Solaris?</a></li>
+</ul>
+</p>
<b>Caveats/Known Bugs:</b><br>
<ul>
<li>There is a compile-time limit of 50 concurrent sockets. If you need more, you need to
diff --git a/doc/mmanon.html b/doc/mmanon.html
index 16065a1f..e14d75cf 100644
--- a/doc/mmanon.html
+++ b/doc/mmanon.html
@@ -18,14 +18,7 @@ Note that anonymization will break digital signatures on the message, if
they exist.
<p><i>How are IP-Addresses defined?</i>
<p>We assume that an IP address consists of four octets in dotted notation,
-where each of the octets has a value between 0 and 255, inclusively. After
-the last octet, there must be either a space or a colon. So, for example,
-"1.2.3.4 Test" and "1.2.3.4:514 Test" are detected as containing valid IP
-addresses, whereas this is not the case for "1.2.300.4 Test" or
-"1.2.3.4-Test". The message text may contain multiple addresses. If so,
-each of them is anonimized (according to the same rules).
-<b>Important:</b> We may change the set of acceptable characters after
-the last octet in the future, if there are good reasons to do so.
+where each of the octets has a value between 0 and 255, inclusively.
<p>&nbsp;</p>
<p><b>Module Configuration Parameters</b>:</p>
diff --git a/doc/mmnormalize.html b/doc/mmnormalize.html
index 787bd957..81100235 100644
--- a/doc/mmnormalize.html
+++ b/doc/mmnormalize.html
@@ -46,6 +46,17 @@ parameter.
<li>$mmnormalizeUseRawMsg &lt;on/off&gt; - equivalent to the "useRawMsg"
parameter.
</ul>
+<p><b>See Also</b>
+<ul>
+<li><a href="http://www.rsyslog.com/normalizer-first-steps-for-mmnormalize/">First steps for mmnormalize</a></li>
+<li><a href="http://www.rsyslog.com/log-normalization-and-special-characters/">Log normalization and
+special characters</a></li>
+<li><a href="http://www.rsyslog.com/log-normalization-and-the-leading-space/">Log normalization and
+the leading space</a></li>
+<li><a href="http://www.rsyslog.com/using-rsyslog-mmnormalize-module-effectively-with-adiscon-loganalyzer/">Using
+mmnormalize effectively with Adiscon LogAnalyzer</a></li>
+</ul>
+</p>
<b>Caveats/Known Bugs:</b>
<p>None known at this time.
</ul>
diff --git a/doc/omfile.html b/doc/omfile.html
index 72320921..0f64f26f 100644
--- a/doc/omfile.html
+++ b/doc/omfile.html
@@ -97,6 +97,11 @@
sets a new default template for file actions.<br></li><br>
</ul>
+<p><b>See Also</b>
+<ul>
+<li><a href="http://www.rsyslog.com/how-to-sign-log-messages-through-signature-provider-guardtime/">Sign log messages through signature provider Guardtime</a></li>
+</ul>
+</p>
<p><b>Caveats/Known Bugs:</b></p>
<ul>
<li>One needs to be careful with log rotation if signatures and/or encryption
diff --git a/doc/omfwd.html b/doc/omfwd.html
index 53f9e527..a541dd27 100644
--- a/doc/omfwd.html
+++ b/doc/omfwd.html
@@ -56,6 +56,11 @@
Permits to resend the last message when a connection is reconnected. This setting affects TCP-based syslog, only. It is most useful for traditional, plain TCP syslog. Using this protocol, it is not always possible to know which messages were successfully transmitted to the receiver when a connection breaks. In many cases, the last message sent is lost. By switching this setting to "yes", rsyslog will always retransmit the last message when a connection is reestablished. This reduces potential message loss, but comes at the price that some messages may be duplicated (what usually is more acceptable). <br></li><br>
</ul>
+<p><b>See Also</b>
+<ul>
+<li><a href="http://www.rsyslog.com/encrypted-disk-queues/">Encrypted Disk Queues</a></li>
+</ul>
+</p>
<p><b>Caveats/Known Bugs:</b></p><ul><li>None.</li></ul>
<p><b>Sample:</b></p>
<p>The following command sends all syslog messages to a remote server via TCP port 10514.</p>
diff --git a/doc/omruleset.html b/doc/omruleset.html
index 41d6ccfc..f0d5f7bd 100644
--- a/doc/omruleset.html
+++ b/doc/omruleset.html
@@ -122,6 +122,11 @@ $ActionOmrulesetRulesetName nested
# of course, we can have "regular" actions alongside :omrulset: actions
*.* /path/to/general-message-file.log
</textarea>
+<p><b>See Also</b>
+<ul>
+<li><a href="http://www.rsyslog.com/rulesets-and-rsyslog-7-2/">Calling rulesets since rsyslog 7.2</a></li>
+</ul>
+</p>
<p><b>Caveats/Known Bugs:</b>
<p>The current configuration file language is not really adequate for a complex construct
like omruleset. Unfortunately, more important work is currently preventing me from redoing the
diff --git a/doc/property_replacer.html b/doc/property_replacer.html
index 13ff41c3..7218c22e 100644
--- a/doc/property_replacer.html
+++ b/doc/property_replacer.html
@@ -746,13 +746,15 @@ use drop-cc and "drop-cc,escape-cc" will use escape-cc mode.
options. It was initially introduced to support the "jsonf" option, for which it provides
the capability to set an alternative field name. If it is not specified, it defaults to
the property name.
-<h2>Further Links</h2>
+<b>See also</b>
<ul>
<li>Article on "<a href="rsyslog_recording_pri.html">Recording
the Priority of Syslog Messages</a>" (describes use of templates
to record severity and facility of a message)</li>
<li><a href="rsyslog_conf.html">Configuration file
format</a>, this is where you actually use the property replacer.</li>
+<li><a href="http://www.rsyslog.com/what-is-the-difference-between-timereported-and-timegenerated/">
+Difference between timereported and timegenerated.</li>
</ul>
<p>[<a href="manual.html">manual index</a>]
[<a href="rsyslog_conf.html">rsyslog.conf</a>]
diff --git a/doc/queues.html b/doc/queues.html
index 75b70fbf..85df9fef 100644
--- a/doc/queues.html
+++ b/doc/queues.html
@@ -386,6 +386,11 @@ it terminates. This includes data elements there were begun being processed by
workers that needed to be cancelled due to too-long processing. For a large
queue, this operation may be lengthy. No timeout applies to a required shutdown
save.</p>
+<p><b>See Also</b>
+<ul>
+<li><a href="http://www.rsyslog.com/encrypted-disk-queues/">Encrypted Disk Queues</a></li>
+</ul>
+</p>
[<a href="manual.html">manual index</a>]
[<a href="rsyslog_conf.html">rsyslog.conf</a>]
[<a href="http://www.rsyslog.com/">rsyslog site</a>]</p>
diff --git a/doc/rsyslog_conf_filter.html b/doc/rsyslog_conf_filter.html
index a795193f..c8a40b6c 100644
--- a/doc/rsyslog_conf_filter.html
+++ b/doc/rsyslog_conf_filter.html
@@ -275,6 +275,11 @@ supported (except for "not" as outlined above). Please note that while
it is possible to query facility and severity via property-based
filters, it is far more advisable to use classic selectors (see above)
for those cases.</p>
+<p><b>See Also</b>
+<ul>
+<li><a href="http://www.rsyslog.com/filter-optimization-with-arrays/">Filter optimization with arrays</a></li>
+</ul>
+</p>
<p>[<a href="manual.html">manual index</a>]
[<a href="rsyslog_conf.html">rsyslog.conf</a>]
[<a href="http://www.rsyslog.com/">rsyslog site</a>]</p>
diff --git a/doc/rsyslog_conf_templates.html b/doc/rsyslog_conf_templates.html
index 9a6e1619..38927c03 100644
--- a/doc/rsyslog_conf_templates.html
+++ b/doc/rsyslog_conf_templates.html
@@ -524,7 +524,13 @@ $template TraditionalForwardFormat,"<%PRI%>%TIMESTAMP% %HOSTNAME% %syslogtag:1:3
<br><br>
$template StdSQLFormat,"insert into SystemEvents (Message, Facility, FromHost, Priority, DeviceReportedTime, ReceivedAt, InfoUnitID, SysLogTag) values ('%msg%', %syslogfacility%, '%HOSTNAME%', %syslogpriority%, '%timereported:::date-mysql%', '%timegenerated:::date-mysql%', %iut%, '%syslogtag%')",SQL
</code></p>
-
+<p><b>See Also</b>
+<ul>
+<li><a href="http://www.rsyslog.com/how-to-bind-a-template/">How to bind a template</a></li>
+<li><a href="http://www.rsyslog.com/adding-the-bom-to-a-message/">Adding the BOM to a message</a></li>
+<li><a href="http://www.rsyslog.com/article60/">How to separate log files by host name of the sending device</a></li>
+</ul>
+</p>
<p>[<a href="manual.html">manual index</a>]
[<a href="rsyslog_conf.html">rsyslog.conf</a>]
[<a href="http://www.rsyslog.com/">rsyslog site</a>]</p>
diff --git a/doc/rsyslog_packages.html b/doc/rsyslog_packages.html
index 5bb62fa5..014791a3 100644
--- a/doc/rsyslog_packages.html
+++ b/doc/rsyslog_packages.html
@@ -81,5 +81,10 @@ of the distribution name.
<p>If you do not find a suitable package for your distribution, there is no reason
to panic. It is quite simple to install rsyslog from the source tarball, so you
should consider that.
+<p><b>See Also</b>
+<ul>
+<li><a href="http://www.rsyslog.com/how-to-use-the-ubuntu-repository/">How to use the Ubuntu repository</a></li>
+</ul>
+</p>
</body>
</html>
diff --git a/doc/sigprov_gt.html b/doc/sigprov_gt.html
index caeee116..5ffd26d8 100644
--- a/doc/sigprov_gt.html
+++ b/doc/sigprov_gt.html
@@ -64,6 +64,12 @@ sig.keepRecordHashes requries). Note that both Tree and Record
hashes can be kept inside the signature file.
</li>
</ul>
+<p><b>See Also</b>
+<ul>
+<li><a href="http://www.rsyslog.com/how-to-sign-log-messages-through-signature-provider-guardtime/">How
+to sign log messages through signature provider Guardtime</a></li>
+</ul>
+</p>
<b>Caveats/Known Bugs:</b>
<ul>
<li>currently none known
diff --git a/doc/troubleshoot.html b/doc/troubleshoot.html
index 0f0c7fca..a0303a24 100644
--- a/doc/troubleshoot.html
+++ b/doc/troubleshoot.html
@@ -88,15 +88,19 @@ passwords or other sensitive data. If it does, you can change it to some <b>cons
meaningless value. <b>Do not delete the lines</b>, as this renders the debug log
unusable (and makes Rainer quite angry for wasted time, aka significantly reduces the chance
he will remain motivated to look at your problem ;)). For the same reason, make sure
-whatever you change is change consistently. Really!
-<p>Debug log file can get quite large. Before submitting them, it is a good idea to zip them.
-Rainer has handled files of around 1 to 2 GB. If your's is larger ask before submitting. Often,
-it is sufficient to submit the first 2,000 lines of the log file and around another 1,000 around
-the area where you see a problem. Also,
-ask you can submit a file via private mail. Private mail is usually a good way to go for large files
-or files with sensitive content. However, do NOT send anything sensitive that you do not want
-the outside to be known. While Rainer so far made effort no to leak any sensitive information,
-there is no guarantee that doesn't happen. If you need a guarantee, you are probably a
+whatever you change is changed consistently. Really!
+<p>While most debug log files are moderately large, some can get quite to extremly large.
+For those on the larger side, it is a good idea to zip them. If the file is less than
+around 100KiB, it's probably not necessary.
+<p>A good place to post your debug log is at the
+<a href="http://kb.monitorware.com/rsyslog-f40.html">rsyslog support forums</a>, together with
+your question. This also enables us to keep track of the case. The forums accept attachments in
+various common formats, but rejects others for security reasons. The zip, txt, and log extensions
+are definitely permitted, so it probably is a good idea to use one of them. For others, please
+simply try and revert to another format if the forum doesn't like what you used.
+<p>
+Please note that all information in your debug file is publically visiable.
+If this is not acceptable for you, you are probably a
candidate for a <a href="professional_support.html">commercial support contract</a>. Free support
comes without any guarantees, include no guarantee on confidentiality
[aka "we don't want to be sued for work were are not even paid for ;)].
@@ -156,7 +160,7 @@ need to program or do anything else except get a problem solved ;)
[<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-2010 by <a href="http://www.gerhards.net/rainer">Rainer Gerhards</a> and
+Copyright &copy; 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>
</body>