mirror of
https://github.com/rsyslog/rsyslog.git
synced 2025-12-16 12:10:46 +01:00
43cb156744
Make omprog docs easier to navigate and link while improving structure
for AI tooling and programmatic ingestion. This aids both humans and
assistants in finding a single parameter quickly with stable anchors.
BEFORE: All action parameters lived inline in modules/omprog.rst.
AFTER: Each parameter has its own reference page; omprog.rst shows a
list-table with concise summaries and a hidden toctree.
Technically, move each action parameter into
doc/source/reference/parameters/omprog-*.rst with stable anchors
(param-omprog-* and omprog.parameter.action.*), a summary block,
metadata (type/default/introduced), usage snippets, and legacy
directive mappings. The module page now pulls per-parameter summaries
via include directives and adds a hidden toctree for discovery.
Cross-references were aligned, legacy names preserved (e.g.
$ActionOMProgBinary), and a non-normative note recommends camelCase
for readability. No runtime or API/ABI changes; documentation only.
With help from AI coding Agents: codex, Gemini
see also: https://github.com/rsyslog/rsyslog/issues/5933
43 lines
859 B
ReStructuredText
43 lines
859 B
ReStructuredText
.. _param-omprog-template:
|
|
.. _omprog.parameter.action.template:
|
|
|
|
template
|
|
========
|
|
|
|
.. index::
|
|
single: omprog; template
|
|
single: template
|
|
|
|
.. summary-start
|
|
|
|
Sets the template for formatting messages sent to the program.
|
|
|
|
.. summary-end
|
|
|
|
This parameter applies to :doc:`../../configuration/modules/omprog`.
|
|
|
|
:Name: template
|
|
:Scope: action
|
|
:Type: word
|
|
:Default: action=RSYSLOG_FileFormat
|
|
:Required?: no
|
|
:Introduced: at least 5.x, possibly earlier
|
|
|
|
Description
|
|
-----------
|
|
Name of the :doc:`template <../../configuration/templates>` to use to format the log messages
|
|
passed to the external program.
|
|
|
|
Action usage
|
|
------------
|
|
.. _param-omprog-action-template:
|
|
.. _omprog.parameter.action.template-usage:
|
|
|
|
.. code-block:: rsyslog
|
|
|
|
action(type="omprog" template="RSYSLOG_FileFormat")
|
|
|
|
See also
|
|
--------
|
|
See also :doc:`../../configuration/modules/omprog`.
|