mirror of
https://github.com/rsyslog/rsyslog.git
synced 2025-12-12 19:30:42 +01:00
Codex/refactor rsyslog module parameter documentation khpye2 (#6276)
* imsolaris: split parameter docs into reference pages; add summary list-tables; fix anchors - Split IMSolarisLogSocketName docs into reference/parameters entry with scoped anchors - Replace inline module parameter text with list-table summary and hidden toctree - Document legacy directive usage and provide module example With the help of AI-Agent: ChatGPT
This commit is contained in:
parent
aaa7f4c59c
commit
2e504217e2
@ -23,21 +23,23 @@ detects another active instance at startup, the module disables itself,
|
||||
but rsyslog will continue to run.
|
||||
|
||||
|
||||
Configuration Parameters
|
||||
========================
|
||||
Module Parameters
|
||||
=================
|
||||
|
||||
.. note::
|
||||
|
||||
Parameter names are case-insensitive.
|
||||
|
||||
.. list-table::
|
||||
:widths: 30 70
|
||||
:header-rows: 1
|
||||
|
||||
|FmtObsoleteName| Directives
|
||||
----------------------------
|
||||
|
||||
| functions:: $IMSolarisLogSocketName <name>
|
||||
|
||||
This is the name of the log socket (stream) to read. If not given,
|
||||
/dev/log is read.
|
||||
* - Parameter
|
||||
- Summary
|
||||
* - :ref:`param-imsolaris-imsolarislogsocketname`
|
||||
- .. include:: ../../reference/parameters/imsolaris-imsolarislogsocketname.rst
|
||||
:start-after: .. summary-start
|
||||
:end-before: .. summary-end
|
||||
|
||||
|
||||
Caveats/Known Bugs
|
||||
@ -57,3 +59,9 @@ The following sample pulls messages from the default log source
|
||||
$ModLoad imsolaris
|
||||
|
||||
|
||||
.. toctree::
|
||||
:hidden:
|
||||
|
||||
../../reference/parameters/imsolaris-imsolarislogsocketname
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,47 @@
|
||||
.. _param-imsolaris-imsolarislogsocketname:
|
||||
.. _imsolaris.parameter.module.imsolarislogsocketname:
|
||||
|
||||
IMSolarisLogSocketName
|
||||
======================
|
||||
|
||||
.. index::
|
||||
single: imsolaris; IMSolarisLogSocketName
|
||||
single: IMSolarisLogSocketName
|
||||
|
||||
.. summary-start
|
||||
|
||||
Specifies the Solaris log stream device imsolaris reads, defaulting to ``/dev/log``.
|
||||
|
||||
.. summary-end
|
||||
|
||||
This parameter applies to :doc:`../../configuration/modules/imsolaris`.
|
||||
|
||||
.. note::
|
||||
|
||||
This is a legacy global directive. The imsolaris module does not support the modern ``module()``/``input()`` syntax.
|
||||
|
||||
:Name: IMSolarisLogSocketName
|
||||
:Scope: module
|
||||
:Type: string (path)
|
||||
:Default: /dev/log
|
||||
:Required?: no
|
||||
:Introduced: Not documented
|
||||
|
||||
Description
|
||||
-----------
|
||||
This directive specifies the path to the Solaris log socket (stream) for reading local application and kernel messages. If omitted, it defaults to ``/dev/log``.
|
||||
Since directive names are case-insensitive, the canonical form ``$IMSolarisLogSocketName`` is recommended for readability.
|
||||
|
||||
Module usage
|
||||
------------
|
||||
.. _param-imsolaris-module-imsolarislogsocketname-usage:
|
||||
.. _imsolaris.parameter.module.imsolarislogsocketname-usage:
|
||||
|
||||
.. code-block:: rsyslog
|
||||
|
||||
$ModLoad imsolaris
|
||||
$IMSolarisLogSocketName "/var/run/rsyslog/solaris.log"
|
||||
|
||||
See also
|
||||
--------
|
||||
See also :doc:`../../configuration/modules/imsolaris`.
|
||||
Loading…
x
Reference in New Issue
Block a user