imtcp: fix parameter scopes and add input examples

- remove duplicate case-insensitivity note\n- clarify AddtlFrameDelimiter description\n- document module+input scope and usage for flowControl, keepAlive, and related parameters\n\nAI-Agent: ChatGPT

doc/source/configuration/modules/imtcp.rst

@@ -70,11 +70,6 @@ datacenter deployments**.
 Configuration Parameters
 ========================
 
-.. note::
-
-   Parameter names are case-insensitive.
-
-
 Module Parameters
 -----------------
 
@@ -234,10 +229,6 @@ Module Parameters
 Input Parameters
 ----------------
 
-.. note::
-
-   Parameter names are case-insensitive; camelCase is recommended for readability.
-
 .. list-table::
    :widths: 30 70
    :header-rows: 1

doc/source/reference/parameters/imtcp-addtlframedelimiter.rst

@@ -1,5 +1,6 @@
 .. _param-imtcp-addtlframedelimiter:
 .. _imtcp.parameter.module.addtlframedelimiter:
+.. _imtcp.parameter.input.addtlframedelimiter:
 
 AddtlFrameDelimiter
 ===================
@@ -17,17 +18,17 @@ Specifies an additional frame delimiter for message reception.
 This parameter applies to :doc:`../../configuration/modules/imtcp`.
 
 :Name: AddtlFrameDelimiter
-:Scope: module
+:Scope: module, input
 :Type: integer
-:Default: module=-1
+:Default: module=-1, input=module parameter
 :Required?: no
 :Introduced: 4.3.1
 
 Description
 -----------
-This directive permits to specify an additional frame delimiter for
+This directive permits to specify an additional frame delimiter. The value
-Multiple receivers may be configured by specifying $InputTCPServerRun
+must be the decimal ASCII code of the character to be used as the delimiter.
-multiple times.
+For example, to use ``#`` as the delimiter, specify ``addtlFrameDelimiter="35"``.
 
 The same-named input parameter can override this module setting.
 
@@ -41,6 +42,15 @@ Module usage
 
    module(load="imtcp" addtlFrameDelimiter="...")
 
+Input usage
+-----------
+.. _param-imtcp-input-addtlframedelimiter:
+.. _imtcp.parameter.input.addtlframedelimiter-usage:
+
+.. code-block:: rsyslog
+
+   input(type="imtcp" port="514" addtlFrameDelimiter="...")
+
 Legacy names (for reference)
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 Historic names/directives for compatibility. Do not use in new configs.

doc/source/reference/parameters/imtcp-disablelfdelimiter.rst

@@ -1,5 +1,6 @@
 .. _param-imtcp-disablelfdelimiter:
 .. _imtcp.parameter.module.disablelfdelimiter:
+.. _imtcp.parameter.input.disablelfdelimiter:
 
 DisableLFDelimiter
 ==================
@@ -17,9 +18,9 @@ Disables LF as a frame delimiter to allow a custom delimiter.
 This parameter applies to :doc:`../../configuration/modules/imtcp`.
 
 :Name: DisableLFDelimiter
-:Scope: module
+:Scope: module, input
 :Type: boolean
-:Default: module=off
+:Default: module=off, input=module parameter
 :Required?: no
 :Introduced: at least 5.x, possibly earlier
 
@@ -47,6 +48,15 @@ Module usage
 
    module(load="imtcp" disableLFDelimiter="on")
 
+Input usage
+-----------
+.. _param-imtcp-input-disablelfdelimiter:
+.. _imtcp.parameter.input.disablelfdelimiter-usage:
+
+.. code-block:: rsyslog
+
+   input(type="imtcp" port="514" disableLFDelimiter="on")
+
 Legacy names (for reference)
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 Historic names/directives for compatibility. Do not use in new configs.

doc/source/reference/parameters/imtcp-discardtruncatedmsg.rst

@@ -1,5 +1,6 @@
 .. _param-imtcp-discardtruncatedmsg:
 .. _imtcp.parameter.module.discardtruncatedmsg:
+.. _imtcp.parameter.input.discardtruncatedmsg:
 
 DiscardTruncatedMsg
 ===================
@@ -17,9 +18,9 @@ Discards data beyond the truncation point in octet-stuffing mode.
 This parameter applies to :doc:`../../configuration/modules/imtcp`.
 
 :Name: DiscardTruncatedMsg
-:Scope: module
+:Scope: module, input
 :Type: boolean
-:Default: module=off
+:Default: module=off, input=module parameter
 :Required?: no
 :Introduced: at least 5.x, possibly earlier
 
@@ -39,6 +40,15 @@ Module usage
 
    module(load="imtcp" discardTruncatedMsg="on")
 
+Input usage
+-----------
+.. _param-imtcp-input-discardtruncatedmsg:
+.. _imtcp.parameter.input.discardtruncatedmsg-usage:
+
+.. code-block:: rsyslog
+
+   input(type="imtcp" port="514" discardTruncatedMsg="on")
+
 See also
 --------
 See also :doc:`../../configuration/modules/imtcp`.

doc/source/reference/parameters/imtcp-flowcontrol.rst

@@ -1,5 +1,6 @@
 .. _param-imtcp-flowcontrol:
 .. _imtcp.parameter.module.flowcontrol:
+.. _imtcp.parameter.input.flowcontrol:
 
 FlowControl
 ===========
@@ -17,9 +18,9 @@ Applies light flow control to throttle senders when queues near full.
 This parameter applies to :doc:`../../configuration/modules/imtcp`.
 
 :Name: FlowControl
-:Scope: module
+:Scope: module, input
 :Type: boolean
-:Default: module=on
+:Default: module=on, input=module parameter
 :Required?: no
 :Introduced: at least 5.x, possibly earlier
 
@@ -46,6 +47,15 @@ Module usage
 
    module(load="imtcp" flowControl="off")
 
+Input usage
+-----------
+.. _param-imtcp-input-flowcontrol:
+.. _imtcp.parameter.input.flowcontrol-usage:
+
+.. code-block:: rsyslog
+
+   input(type="imtcp" port="514" flowControl="off")
+
 Legacy names (for reference)
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 Historic names/directives for compatibility. Do not use in new configs.

doc/source/reference/parameters/imtcp-gnutlsprioritystring.rst

@@ -1,5 +1,6 @@
 .. _param-imtcp-gnutlsprioritystring:
 .. _imtcp.parameter.module.gnutlsprioritystring:
+.. _imtcp.parameter.input.gnutlsprioritystring:
 
 gnutlsPriorityString
 ====================
@@ -17,9 +18,9 @@ Provides driver-specific TLS configuration via a priority string.
 This parameter applies to :doc:`../../configuration/modules/imtcp`.
 
 :Name: gnutlsPriorityString
-:Scope: module
+:Scope: module, input
 :Type: string (see :doc:`../../rainerscript/constant_strings`)
-:Default: module=none
+:Default: module=none, input=module parameter
 :Required?: no
 :Introduced: 8.29.0
 
@@ -47,7 +48,7 @@ In GNUTLS, this setting determines the handshake algorithms and options for the
 
 **OpenSSL Configuration**
 
-This feature is compatible with OpenSSL Version 1.0.2 and above. It enables the passing of configuration commands to the OpenSSL library. You can find a comprehensive list of commands and their acceptable values in the OpenSSL Documentation, accessible at [OpenSSL Documentation](https://docs.openssl.org/1.0.2/man3/SSL_CONF_cmd/).
+This feature is compatible with OpenSSL Version 1.0.2 and above. It enables the passing of configuration commands to the OpenSSL library. You can find a comprehensive list of commands and their acceptable values in the `OpenSSL Documentation <https://docs.openssl.org/1.0.2/man3/SSL_CONF_cmd/>`_.
 
 **General Configuration Guidelines**
 
@@ -83,6 +84,15 @@ Module usage
 
    module(load="imtcp" gnutlsPriorityString="Protocol=ALL,-SSLv2,-SSLv3")
 
+Input usage
+-----------
+.. _param-imtcp-input-gnutlsprioritystring:
+.. _imtcp.parameter.input.gnutlsprioritystring-usage:
+
+.. code-block:: rsyslog
+
+   input(type="imtcp" port="514" gnutlsPriorityString="Protocol=ALL,-SSLv2,-SSLv3")
+
 See also
 --------
 See also :doc:`../../configuration/modules/imtcp`.

doc/source/reference/parameters/imtcp-keepalive-interval.rst

@@ -1,5 +1,6 @@
 .. _param-imtcp-keepalive-interval:
 .. _imtcp.parameter.module.keepalive-interval:
+.. _imtcp.parameter.input.keepalive-interval:
 
 KeepAlive.Interval
 ==================
@@ -17,9 +18,9 @@ Defines the interval for keep-alive packets.
 This parameter applies to :doc:`../../configuration/modules/imtcp`.
 
 :Name: KeepAlive.Interval
-:Scope: module
+:Scope: module, input
 :Type: integer
-:Default: module=0
+:Default: module=0, input=module parameter
 :Required?: no
 :Introduced: 8.2106.0
 
@@ -39,6 +40,15 @@ Module usage
 
    module(load="imtcp" keepAlive.interval="...")
 
+Input usage
+-----------
+.. _param-imtcp-input-keepalive-interval:
+.. _imtcp.parameter.input.keepalive-interval-usage:
+
+.. code-block:: rsyslog
+
+   input(type="imtcp" port="514" keepAlive.interval="...")
+
 See also
 --------
 See also :doc:`../../configuration/modules/imtcp`.

doc/source/reference/parameters/imtcp-keepalive-probes.rst

@@ -1,5 +1,6 @@
 .. _param-imtcp-keepalive-probes:
 .. _imtcp.parameter.module.keepalive-probes:
+.. _imtcp.parameter.input.keepalive-probes:
 
 KeepAlive.Probes
 ================
@@ -17,9 +18,9 @@ Defines how many unacknowledged probes are sent before a connection is considere
 This parameter applies to :doc:`../../configuration/modules/imtcp`.
 
 :Name: KeepAlive.Probes
-:Scope: module
+:Scope: module, input
 :Type: integer
-:Default: module=0
+:Default: module=0, input=module parameter
 :Required?: no
 :Introduced: at least 5.x, possibly earlier
 
@@ -43,6 +44,15 @@ Module usage
 
    module(load="imtcp" keepAlive.probes="...")
 
+Input usage
+-----------
+.. _param-imtcp-input-keepalive-probes:
+.. _imtcp.parameter.input.keepalive-probes-usage:
+
+.. code-block:: rsyslog
+
+   input(type="imtcp" port="514" keepAlive.probes="...")
+
 Legacy names (for reference)
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 Historic names/directives for compatibility. Do not use in new configs.

doc/source/reference/parameters/imtcp-keepalive-time.rst

@@ -1,5 +1,6 @@
 .. _param-imtcp-keepalive-time:
 .. _imtcp.parameter.module.keepalive-time:
+.. _imtcp.parameter.input.keepalive-time:
 
 KeepAlive.Time
 ==============
@@ -17,9 +18,9 @@ Sets the interval between last data and first keepalive probe.
 This parameter applies to :doc:`../../configuration/modules/imtcp`.
 
 :Name: KeepAlive.Time
-:Scope: module
+:Scope: module, input
 :Type: integer
-:Default: module=0
+:Default: module=0, input=module parameter
 :Required?: no
 :Introduced: at least 5.x, possibly earlier
 
@@ -44,6 +45,15 @@ Module usage
 
    module(load="imtcp" keepAlive.time="...")
 
+Input usage
+-----------
+.. _param-imtcp-input-keepalive-time:
+.. _imtcp.parameter.input.keepalive-time-usage:
+
+.. code-block:: rsyslog
+
+   input(type="imtcp" port="514" keepAlive.time="...")
+
 Legacy names (for reference)
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 Historic names/directives for compatibility. Do not use in new configs.

doc/source/reference/parameters/imtcp-keepalive.rst

@@ -1,5 +1,6 @@
 .. _param-imtcp-keepalive:
 .. _imtcp.parameter.module.keepalive:
+.. _imtcp.parameter.input.keepalive:
 
 KeepAlive
 =========
@@ -17,9 +18,9 @@ Enables TCP keep-alive packets on connections.
 This parameter applies to :doc:`../../configuration/modules/imtcp`.
 
 :Name: KeepAlive
-:Scope: module
+:Scope: module, input
 :Type: boolean
-:Default: module=off
+:Default: module=off, input=module parameter
 :Required?: no
 :Introduced: at least 5.x, possibly earlier
 
@@ -40,6 +41,15 @@ Module usage
 
    module(load="imtcp" keepAlive="on")
 
+Input usage
+-----------
+.. _param-imtcp-input-keepalive:
+.. _imtcp.parameter.input.keepalive-usage:
+
+.. code-block:: rsyslog
+
+   input(type="imtcp" port="514" keepAlive="on")
+
 Legacy names (for reference)
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 Historic names/directives for compatibility. Do not use in new configs.

doc/source/reference/parameters/imtcp-maxframesize.rst

@@ -1,5 +1,6 @@
 .. _param-imtcp-maxframesize:
 .. _imtcp.parameter.module.maxframesize:
+.. _imtcp.parameter.input.maxframesize:
 
 MaxFrameSize
 ============
@@ -17,9 +18,9 @@ Sets the maximum frame size in octet-counted mode before switching to octet stuf
 This parameter applies to :doc:`../../configuration/modules/imtcp`.
 
 :Name: MaxFrameSize
-:Scope: module
+:Scope: module, input
 :Type: integer
-:Default: module=200000
+:Default: module=200000, input=module parameter
 :Required?: no
 :Introduced: at least 5.x, possibly earlier
 
@@ -45,6 +46,15 @@ Module usage
 
    module(load="imtcp" maxFrameSize="...")
 
+Input usage
+-----------
+.. _param-imtcp-input-maxframesize:
+.. _imtcp.parameter.input.maxframesize-usage:
+
+.. code-block:: rsyslog
+
+   input(type="imtcp" port="514" maxFrameSize="...")
+
 See also
 --------
 See also :doc:`../../configuration/modules/imtcp`.

doc/source/reference/parameters/imtcp-maxlisteners.rst

@@ -1,5 +1,6 @@
 .. _param-imtcp-maxlisteners:
 .. _imtcp.parameter.module.maxlisteners:
+.. _imtcp.parameter.input.maxlisteners:
 
 MaxListeners
 ============
@@ -17,9 +18,9 @@ Sets the maximum number of listener ports supported.
 This parameter applies to :doc:`../../configuration/modules/imtcp`.
 
 :Name: MaxListeners
-:Scope: module
+:Scope: module, input
 :Type: integer
-:Default: module=20
+:Default: module=20, input=module parameter
 :Required?: no
 :Introduced: at least 5.x, possibly earlier
 
@@ -40,6 +41,15 @@ Module usage
 
    module(load="imtcp" maxListeners="50")
 
+Input usage
+-----------
+.. _param-imtcp-input-maxlisteners:
+.. _imtcp.parameter.input.maxlisteners-usage:
+
+.. code-block:: rsyslog
+
+   input(type="imtcp" port="514" maxListeners="50")
+
 Legacy names (for reference)
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 Historic names/directives for compatibility. Do not use in new configs.

doc/source/reference/parameters/imtcp-maxsessions.rst

@@ -1,5 +1,6 @@
 .. _param-imtcp-maxsessions:
 .. _imtcp.parameter.module.maxsessions:
+.. _imtcp.parameter.input.maxsessions:
 
 MaxSessions
 ===========
@@ -17,9 +18,9 @@ Sets the maximum number of sessions supported.
 This parameter applies to :doc:`../../configuration/modules/imtcp`.
 
 :Name: MaxSessions
-:Scope: module
+:Scope: module, input
 :Type: integer
-:Default: module=200
+:Default: module=200, input=module parameter
 :Required?: no
 :Introduced: at least 5.x, possibly earlier
 
@@ -40,6 +41,15 @@ Module usage
 
    module(load="imtcp" maxSessions="500")
 
+Input usage
+-----------
+.. _param-imtcp-input-maxsessions:
+.. _imtcp.parameter.input.maxsessions-usage:
+
+.. code-block:: rsyslog
+
+   input(type="imtcp" port="514" maxSessions="500")
+
 Legacy names (for reference)
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 Historic names/directives for compatibility. Do not use in new configs.

doc/source/reference/parameters/imtcp-notifyonconnectionclose.rst

@@ -1,5 +1,6 @@
 .. _param-imtcp-notifyonconnectionclose:
 .. _imtcp.parameter.module.notifyonconnectionclose:
+.. _imtcp.parameter.input.notifyonconnectionclose:
 
 NotifyOnConnectionClose
 =======================
@@ -17,9 +18,9 @@ Emits a message when a remote peer closes a connection.
 This parameter applies to :doc:`../../configuration/modules/imtcp`.
 
 :Name: NotifyOnConnectionClose
-:Scope: module
+:Scope: module, input
 :Type: boolean
-:Default: module=off
+:Default: module=off, input=module parameter
 :Required?: no
 :Introduced: at least 5.x, possibly earlier
 
@@ -40,6 +41,15 @@ Module usage
 
    module(load="imtcp" notifyOnConnectionClose="on")
 
+Input usage
+-----------
+.. _param-imtcp-input-notifyonconnectionclose:
+.. _imtcp.parameter.input.notifyonconnectionclose-usage:
+
+.. code-block:: rsyslog
+
+   input(type="imtcp" port="514" notifyOnConnectionClose="on")
+
 Legacy names (for reference)
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 Historic names/directives for compatibility. Do not use in new configs.

doc/source/reference/parameters/imtcp-permittedpeer.rst

@@ -1,5 +1,6 @@
 .. _param-imtcp-permittedpeer:
 .. _imtcp.parameter.module.permittedpeer:
+.. _imtcp.parameter.input.permittedpeer:
 
 PermittedPeer
 =============
@@ -17,9 +18,9 @@ Restricts connections to listed peer identities.
 This parameter applies to :doc:`../../configuration/modules/imtcp`.
 
 :Name: PermittedPeer
-:Scope: module
+:Scope: module, input
 :Type: array
-:Default: module=none
+:Default: module=none, input=module parameter
 :Required?: no
 :Introduced: at least 5.x, possibly earlier
 
@@ -51,6 +52,15 @@ Module usage
 
    module(load="imtcp" permittedPeer="127.0.0.1")
 
+Input usage
+-----------
+.. _param-imtcp-input-permittedpeer:
+.. _imtcp.parameter.input.permittedpeer-usage:
+
+.. code-block:: rsyslog
+
+   input(type="imtcp" port="514" permittedPeer="127.0.0.1")
+
 Legacy names (for reference)
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 Historic names/directives for compatibility. Do not use in new configs.

doc/source/reference/parameters/imtcp-preservecase.rst

@@ -1,5 +1,6 @@
 .. _param-imtcp-preservecase:
 .. _imtcp.parameter.module.preservecase:
+.. _imtcp.parameter.input.preservecase:
 
 PreserveCase
 ============
@@ -17,9 +18,9 @@ Controls whether the case of fromhost is preserved.
 This parameter applies to :doc:`../../configuration/modules/imtcp`.
 
 :Name: PreserveCase
-:Scope: module
+:Scope: module, input
 :Type: boolean
-:Default: module=on
+:Default: module=on, input=module parameter
 :Required?: no
 :Introduced: 8.37.0
 
@@ -39,6 +40,15 @@ Module usage
 
    module(load="imtcp" preserveCase="off")
 
+Input usage
+-----------
+.. _param-imtcp-input-preservecase:
+.. _imtcp.parameter.input.preservecase-usage:
+
+.. code-block:: rsyslog
+
+   input(type="imtcp" port="514" preserveCase="off")
+
 See also
 --------
 See also :doc:`../../configuration/modules/imtcp`.

doc/source/reference/parameters/imtcp-streamdriver-authmode.rst

@@ -1,5 +1,6 @@
 .. _param-imtcp-streamdriver-authmode:
 .. _imtcp.parameter.module.streamdriver-authmode:
+.. _imtcp.parameter.input.streamdriver-authmode:
 
 StreamDriver.AuthMode
 =====================
@@ -17,9 +18,9 @@ Sets stream driver authentication mode.
 This parameter applies to :doc:`../../configuration/modules/imtcp`.
 
 :Name: StreamDriver.AuthMode
-:Scope: module
+:Scope: module, input
 :Type: string (see :doc:`../../rainerscript/constant_strings`)
-:Default: module=none
+:Default: module=none, input=module parameter
 :Required?: no
 :Introduced: at least 5.x, possibly earlier
 
@@ -41,6 +42,15 @@ Module usage
 
    module(load="imtcp" streamDriver.authMode="...")
 
+Input usage
+-----------
+.. _param-imtcp-input-streamdriver-authmode:
+.. _imtcp.parameter.input.streamdriver-authmode-usage:
+
+.. code-block:: rsyslog
+
+   input(type="imtcp" port="514" streamDriver.authMode="...")
+
 Legacy names (for reference)
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 Historic names/directives for compatibility. Do not use in new configs.

doc/source/reference/parameters/imtcp-streamdriver-certfile.rst

@@ -30,6 +30,14 @@ Description
 This permits to override the ``DefaultNetstreamDriverCertFile`` global parameter on the ``input()``
 level. For further details, see the global parameter.
 
+.. note::
+
+   The GnuTLS driver sends all certificates contained in the file
+   specified via ``StreamDriver.CertFile`` to connecting clients.  To
+   expose intermediate certificates, the file must contain the server
+   certificate first, followed by the intermediate certificates.
+   This capability was added in rsyslog version 8.36.0.
+
 Input usage
 -----------
 .. _param-imtcp-input-streamdriver-certfile:

doc/source/reference/parameters/imtcp-streamdriver-checkextendedkeypurpose.rst

@@ -1,12 +1,13 @@
 .. _param-imtcp-streamdriver-checkextendedkeypurpose:
 .. _imtcp.parameter.module.streamdriver-checkextendedkeypurpose:
+.. _imtcp.parameter.input.streamdriver-checkextendedkeypurpose:
 
-StreamDriver.CheckExtendedKeyPurpose
+streamDriver.checkExtendedKeyPurpose
 ====================================
 
 .. index::
-   single: imtcp; StreamDriver.CheckExtendedKeyPurpose
+   single: imtcp; StreamDriver.checkExtendedKeyPurpose
-   single: StreamDriver.CheckExtendedKeyPurpose
+   single: StreamDriver.checkExtendedKeyPurpose
 
 .. summary-start
 
@@ -16,10 +17,10 @@ Checks certificate extended key purpose for compatibility with rsyslog operation
 
 This parameter applies to :doc:`../../configuration/modules/imtcp`.
 
-:Name: StreamDriver.CheckExtendedKeyPurpose
+:Name: StreamDriver.checkExtendedKeyPurpose
-:Scope: module
+:Scope: module, input
 :Type: boolean
-:Default: module=off
+:Default: module=off, input=module parameter
 :Required?: no
 :Introduced: at least 5.x, possibly earlier
 
@@ -40,6 +41,15 @@ Module usage
 
    module(load="imtcp" streamDriver.checkExtendedKeyPurpose="on")
 
+Input usage
+-----------
+.. _param-imtcp-input-streamdriver-checkextendedkeypurpose:
+.. _imtcp.parameter.input.streamdriver-checkextendedkeypurpose-usage:
+
+.. code-block:: rsyslog
+
+   input(type="imtcp" port="514" streamDriver.checkExtendedKeyPurpose="on")
+
 See also
 --------
 See also :doc:`../../configuration/modules/imtcp`.

doc/source/reference/parameters/imtcp-streamdriver-mode.rst

@@ -1,5 +1,6 @@
 .. _param-imtcp-streamdriver-mode:
 .. _imtcp.parameter.module.streamdriver-mode:
+.. _imtcp.parameter.input.streamdriver-mode:
 
 StreamDriver.Mode
 =================
@@ -17,9 +18,9 @@ Sets the driver mode for the selected network stream driver.
 This parameter applies to :doc:`../../configuration/modules/imtcp`.
 
 :Name: StreamDriver.Mode
-:Scope: module
+:Scope: module, input
 :Type: integer
-:Default: module=0
+:Default: module=0, input=module parameter
 :Required?: no
 :Introduced: at least 5.x, possibly earlier
 
@@ -41,6 +42,15 @@ Module usage
 
    module(load="imtcp" streamDriver.mode="...")
 
+Input usage
+-----------
+.. _param-imtcp-input-streamdriver-mode:
+.. _imtcp.parameter.input.streamdriver-mode-usage:
+
+.. code-block:: rsyslog
+
+   input(type="imtcp" port="514" streamDriver.mode="...")
+
 Legacy names (for reference)
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 Historic names/directives for compatibility. Do not use in new configs.

doc/source/reference/parameters/imtcp-streamdriver-name.rst

@@ -1,5 +1,6 @@
 .. _param-imtcp-streamdriver-name:
 .. _imtcp.parameter.module.streamdriver-name:
+.. _imtcp.parameter.input.streamdriver-name:
 
 StreamDriver.Name
 =================
@@ -17,9 +18,9 @@ Selects the network stream driver for all inputs using this module.
 This parameter applies to :doc:`../../configuration/modules/imtcp`.
 
 :Name: StreamDriver.Name
-:Scope: module
+:Scope: module, input
 :Type: string (see :doc:`../../rainerscript/constant_strings`)
-:Default: module=none
+:Default: module=none, input=module parameter
 :Required?: no
 :Introduced: at least 5.x, possibly earlier
 
@@ -40,6 +41,15 @@ Module usage
 
    module(load="imtcp" streamDriver.name="mydriver")
 
+Input usage
+-----------
+.. _param-imtcp-input-streamdriver-name:
+.. _imtcp.parameter.input.streamdriver-name-usage:
+
+.. code-block:: rsyslog
+
+   input(type="imtcp" port="514" streamDriver.name="mydriver")
+
 See also
 --------
 See also :doc:`../../configuration/modules/imtcp`.

doc/source/reference/parameters/imtcp-streamdriver-permitexpiredcerts.rst

@@ -1,5 +1,6 @@
 .. _param-imtcp-streamdriver-permitexpiredcerts:
 .. _imtcp.parameter.module.streamdriver-permitexpiredcerts:
+.. _imtcp.parameter.input.streamdriver-permitexpiredcerts:
 
 StreamDriver.PermitExpiredCerts
 ===============================
@@ -17,9 +18,9 @@ Controls how expired certificates are handled in TLS mode.
 This parameter applies to :doc:`../../configuration/modules/imtcp`.
 
 :Name: StreamDriver.PermitExpiredCerts
-:Scope: module
+:Scope: module, input
 :Type: string (see :doc:`../../rainerscript/constant_strings`)
-:Default: module=warn
+:Default: module=warn, input=module parameter
 :Required?: no
 :Introduced: at least 5.x, possibly earlier
 
@@ -46,6 +47,15 @@ Module usage
 
    module(load="imtcp" streamDriver.permitExpiredCerts="off")
 
+Input usage
+-----------
+.. _param-imtcp-input-streamdriver-permitexpiredcerts:
+.. _imtcp.parameter.input.streamdriver-permitexpiredcerts-usage:
+
+.. code-block:: rsyslog
+
+   input(type="imtcp" port="514" streamDriver.permitExpiredCerts="off")
+
 See also
 --------
 See also :doc:`../../configuration/modules/imtcp`.

doc/source/reference/parameters/imtcp-streamdriver-prioritizesan.rst

@@ -1,5 +1,6 @@
 .. _param-imtcp-streamdriver-prioritizesan:
 .. _imtcp.parameter.module.streamdriver-prioritizesan:
+.. _imtcp.parameter.input.streamdriver-prioritizesan:
 
 StreamDriver.PrioritizeSAN
 ==========================
@@ -17,9 +18,9 @@ Uses stricter SAN/CN matching for certificate validation.
 This parameter applies to :doc:`../../configuration/modules/imtcp`.
 
 :Name: StreamDriver.PrioritizeSAN
-:Scope: module
+:Scope: module, input
 :Type: boolean
-:Default: module=off
+:Default: module=off, input=module parameter
 :Required?: no
 :Introduced: at least 5.x, possibly earlier
 
@@ -39,6 +40,15 @@ Module usage
 
    module(load="imtcp" streamDriver.prioritizeSAN="on")
 
+Input usage
+-----------
+.. _param-imtcp-input-streamdriver-prioritizesan:
+.. _imtcp.parameter.input.streamdriver-prioritizesan-usage:
+
+.. code-block:: rsyslog
+
+   input(type="imtcp" port="514" streamDriver.prioritizeSAN="on")
+
 See also
 --------
 See also :doc:`../../configuration/modules/imtcp`.

doc/source/reference/parameters/imtcp-streamdriver-tlsverifydepth.rst

@@ -1,5 +1,6 @@
 .. _param-imtcp-streamdriver-tlsverifydepth:
 .. _imtcp.parameter.module.streamdriver-tlsverifydepth:
+.. _imtcp.parameter.input.streamdriver-tlsverifydepth:
 
 StreamDriver.TlsVerifyDepth
 ===========================
@@ -17,9 +18,9 @@ Specifies the maximum depth allowed for certificate chain verification.
 This parameter applies to :doc:`../../configuration/modules/imtcp`.
 
 :Name: StreamDriver.TlsVerifyDepth
-:Scope: module
+:Scope: module, input
 :Type: integer
-:Default: module=TLS library default
+:Default: module=TLS library default, input=module parameter
 :Required?: no
 :Introduced: at least 5.x, possibly earlier
 
@@ -33,15 +34,6 @@ https://docs.openssl.org/1.1.1/man3/SSL_CTX_set_verify/
 For GnuTLS, the default is 5 - see the doc for more:
 https://www.gnutls.org/manual/gnutls.html
 
-.. note::
-
-   The GnuTLS driver sends all certificates contained in the file
-   specified via ``StreamDriver.CertFile`` (or
-   ``$DefaultNetstreamDriverCertFile``) to connecting clients.  To
-   expose intermediate certificates, the file must contain the server
-   certificate first, followed by the intermediate certificates.
-   This capability was added in rsyslog version 8.36.0.
-
 The same-named input parameter can override this module setting.
 
 
@@ -54,6 +46,15 @@ Module usage
 
    module(load="imtcp" streamDriver.tlsVerifyDepth="7")
 
+Input usage
+-----------
+.. _param-imtcp-input-streamdriver-tlsverifydepth:
+.. _imtcp.parameter.input.streamdriver-tlsverifydepth-usage:
+
+.. code-block:: rsyslog
+
+   input(type="imtcp" port="514" streamDriver.tlsVerifyDepth="7")
+
 See also
 --------
 See also :doc:`../../configuration/modules/imtcp`.