From a69cb35a80ecf772d62ab73eecae55e42eb53280 Mon Sep 17 00:00:00 2001 From: Florian Riedl Date: Mon, 7 Oct 2013 11:19:25 +0200 Subject: doc: link from doc to relevant places on the web the idea is to increase usability by directly linking to additional information, scenarios etc... --- doc/debug.html | 6 +++++- doc/impstats.html | 5 +++++ doc/imuxsock.html | 10 ++++++++-- doc/mmnormalize.html | 11 +++++++++++ doc/omfile.html | 5 +++++ doc/omfwd.html | 5 +++++ doc/omruleset.html | 5 +++++ doc/property_replacer.html | 4 +++- doc/queues.html | 5 +++++ doc/rsyslog_conf_filter.html | 5 +++++ doc/rsyslog_conf_templates.html | 8 +++++++- doc/rsyslog_packages.html | 5 +++++ doc/sigprov_gt.html | 6 ++++++ 13 files changed, 75 insertions(+), 5 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.

When running in any of the debug modes (including on demand mode), an interactive instance of rsyslogd can be aborted by pressing ctl-c. -

+

See Also +

+

[manual index] [rsyslog site]

This documentation is part of the rsyslog project.
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). +

See Also +

+

Caveats/Known Bugs: - +

See Also +

+

Caveats/Known Bugs:
Caveats/Known Bugs:
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.
  • $mmnormalizeUseRawMsg <on/off> - equivalent to the "useRawMsg" parameter. +

    See Also +

    +

    Caveats/Known Bugs:

    None known at this time. 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.


    • +

    See Also +

    +

    Caveats/Known Bugs:

    +

    See Also +

    +

    Caveats/Known Bugs:

    Sample:

    The following command sends all syslog messages to a remote server via TCP port 10514.

    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 +

    See Also +

    +

    Caveats/Known Bugs:

    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. -

    Further Links

    +See also

    [manual index] [rsyslog.conf] 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.

    +

    See Also +

    +

    [manual index] [rsyslog.conf] [rsyslog site]

    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.

    +

    See Also +

    +

    [manual index] [rsyslog.conf] [rsyslog site]

    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

    $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

    - +

    See Also +

    +

    [manual index] [rsyslog.conf] [rsyslog site]

    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.

    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. +

    See Also +

    +

    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. +

    See Also +

    +

    Caveats/Known Bugs: