From ca0eaeee3f5b8c7ff31bd6b26a65aedcb3ff8280 Mon Sep 17 00:00:00 2001 From: Rainer Gerhards Date: Mon, 18 Aug 2025 18:27:14 +0200 Subject: [PATCH] doc/imfile: add File and Tag to parameter samples --- doc/source/reference/parameters/imfile-addceetag.rst | 5 ++++- doc/source/reference/parameters/imfile-addmetadata.rst | 5 ++++- .../reference/parameters/imfile-deletestateonfiledelete.rst | 5 ++++- .../reference/parameters/imfile-deletestateonfilemove.rst | 5 ++++- .../reference/parameters/imfile-discardtruncatedmsg.rst | 5 ++++- doc/source/reference/parameters/imfile-endmsg-regex.rst | 5 ++++- .../reference/parameters/imfile-escapelf-replacement.rst | 5 ++++- doc/source/reference/parameters/imfile-escapelf.rst | 5 ++++- doc/source/reference/parameters/imfile-facility.rst | 5 ++++- doc/source/reference/parameters/imfile-file.rst | 4 +++- doc/source/reference/parameters/imfile-freshstarttail.rst | 5 ++++- doc/source/reference/parameters/imfile-ignoreolderthan.rst | 5 ++++- doc/source/reference/parameters/imfile-maxbytesperminute.rst | 5 ++++- doc/source/reference/parameters/imfile-maxlinesatonce.rst | 5 ++++- doc/source/reference/parameters/imfile-maxlinesperminute.rst | 5 ++++- doc/source/reference/parameters/imfile-maxsubmitatonce.rst | 5 ++++- .../reference/parameters/imfile-msgdiscardingerror.rst | 5 ++++- doc/source/reference/parameters/imfile-needparse.rst | 5 ++++- .../parameters/imfile-persiststateaftersubmission.rst | 5 ++++- .../reference/parameters/imfile-persiststateinterval.rst | 5 ++++- doc/source/reference/parameters/imfile-readmode.rst | 5 ++++- doc/source/reference/parameters/imfile-readtimeout.rst | 5 ++++- doc/source/reference/parameters/imfile-reopenontruncate.rst | 5 ++++- doc/source/reference/parameters/imfile-ruleset.rst | 5 ++++- doc/source/reference/parameters/imfile-severity.rst | 5 ++++- doc/source/reference/parameters/imfile-startmsg-regex.rst | 5 ++++- doc/source/reference/parameters/imfile-statefile.rst | 5 ++++- doc/source/reference/parameters/imfile-tag.rst | 4 +++- doc/source/reference/parameters/imfile-trimlineoverbytes.rst | 5 ++++- 29 files changed, 114 insertions(+), 29 deletions(-) diff --git a/doc/source/reference/parameters/imfile-addceetag.rst b/doc/source/reference/parameters/imfile-addceetag.rst index 88bdf39ca..62cb37f2b 100644 --- a/doc/source/reference/parameters/imfile-addceetag.rst +++ b/doc/source/reference/parameters/imfile-addceetag.rst @@ -36,7 +36,10 @@ Input usage .. code-block:: rsyslog - input(type="imfile" addCeeTag="on") + input(type="imfile" + File="/var/log/example.log" + Tag="example" + addCeeTag="on") Notes ----- diff --git a/doc/source/reference/parameters/imfile-addmetadata.rst b/doc/source/reference/parameters/imfile-addmetadata.rst index f14a28496..16d02b2d0 100644 --- a/doc/source/reference/parameters/imfile-addmetadata.rst +++ b/doc/source/reference/parameters/imfile-addmetadata.rst @@ -37,7 +37,10 @@ Input usage .. code-block:: rsyslog - input(type="imfile" addMetadata="on") + input(type="imfile" + File="/var/log/example.log" + Tag="example" + addMetadata="on") Notes ----- diff --git a/doc/source/reference/parameters/imfile-deletestateonfiledelete.rst b/doc/source/reference/parameters/imfile-deletestateonfiledelete.rst index bd479d3bf..e34e26b74 100644 --- a/doc/source/reference/parameters/imfile-deletestateonfiledelete.rst +++ b/doc/source/reference/parameters/imfile-deletestateonfiledelete.rst @@ -39,7 +39,10 @@ Input usage .. code-block:: rsyslog - input(type="imfile" deleteStateOnFileDelete="on") + input(type="imfile" + File="/var/log/example.log" + Tag="example" + deleteStateOnFileDelete="on") Notes ----- diff --git a/doc/source/reference/parameters/imfile-deletestateonfilemove.rst b/doc/source/reference/parameters/imfile-deletestateonfilemove.rst index 0036cf1a2..de71fde6a 100644 --- a/doc/source/reference/parameters/imfile-deletestateonfilemove.rst +++ b/doc/source/reference/parameters/imfile-deletestateonfilemove.rst @@ -50,7 +50,10 @@ Input usage .. code-block:: rsyslog - input(type="imfile" deleteStateOnFileMove="on") + input(type="imfile" + File="/var/log/example.log" + Tag="example" + deleteStateOnFileMove="on") Notes ----- diff --git a/doc/source/reference/parameters/imfile-discardtruncatedmsg.rst b/doc/source/reference/parameters/imfile-discardtruncatedmsg.rst index 867561303..690e736c5 100644 --- a/doc/source/reference/parameters/imfile-discardtruncatedmsg.rst +++ b/doc/source/reference/parameters/imfile-discardtruncatedmsg.rst @@ -37,7 +37,10 @@ Input usage .. code-block:: rsyslog - input(type="imfile" discardTruncatedMsg="on") + input(type="imfile" + File="/var/log/example.log" + Tag="example" + discardTruncatedMsg="on") Notes ----- diff --git a/doc/source/reference/parameters/imfile-endmsg-regex.rst b/doc/source/reference/parameters/imfile-endmsg-regex.rst index 403923780..f0f5979b7 100644 --- a/doc/source/reference/parameters/imfile-endmsg-regex.rst +++ b/doc/source/reference/parameters/imfile-endmsg-regex.rst @@ -50,7 +50,10 @@ Input usage .. code-block:: rsyslog - input(type="imfile" endmsg.regex="pattern") + input(type="imfile" + File="/var/log/example.log" + Tag="example" + endmsg.regex="pattern") See also -------- diff --git a/doc/source/reference/parameters/imfile-escapelf-replacement.rst b/doc/source/reference/parameters/imfile-escapelf-replacement.rst index b86e00b04..3ac153458 100644 --- a/doc/source/reference/parameters/imfile-escapelf-replacement.rst +++ b/doc/source/reference/parameters/imfile-escapelf-replacement.rst @@ -46,7 +46,10 @@ Input usage .. code-block:: rsyslog - input(type="imfile" escapeLF="on" escapeLF.replacement="[LF]") + input(type="imfile" + File="/var/log/example.log" + Tag="example" + escapeLF="on" escapeLF.replacement="[LF]") See also -------- diff --git a/doc/source/reference/parameters/imfile-escapelf.rst b/doc/source/reference/parameters/imfile-escapelf.rst index cf975ce3d..d632c2a3b 100644 --- a/doc/source/reference/parameters/imfile-escapelf.rst +++ b/doc/source/reference/parameters/imfile-escapelf.rst @@ -39,7 +39,10 @@ Input usage .. code-block:: rsyslog - input(type="imfile" escapeLF="on") + input(type="imfile" + File="/var/log/example.log" + Tag="example" + escapeLF="on") Notes ----- diff --git a/doc/source/reference/parameters/imfile-facility.rst b/doc/source/reference/parameters/imfile-facility.rst index e21a39635..4644bbb3f 100644 --- a/doc/source/reference/parameters/imfile-facility.rst +++ b/doc/source/reference/parameters/imfile-facility.rst @@ -37,7 +37,10 @@ Input usage .. code-block:: rsyslog - input(type="imfile" Facility="local0") + input(type="imfile" + File="/var/log/example.log" + Tag="example" + Facility="local0") Notes ----- diff --git a/doc/source/reference/parameters/imfile-file.rst b/doc/source/reference/parameters/imfile-file.rst index 016150f52..0db714bad 100644 --- a/doc/source/reference/parameters/imfile-file.rst +++ b/doc/source/reference/parameters/imfile-file.rst @@ -37,7 +37,9 @@ Input usage .. code-block:: rsyslog - input(type="imfile" File="/path/to/logfile") + input(type="imfile" + File="/path/to/logfile" + Tag="example") Legacy names (for reference) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/doc/source/reference/parameters/imfile-freshstarttail.rst b/doc/source/reference/parameters/imfile-freshstarttail.rst index e8df5c5a4..e43c3b15d 100644 --- a/doc/source/reference/parameters/imfile-freshstarttail.rst +++ b/doc/source/reference/parameters/imfile-freshstarttail.rst @@ -47,7 +47,10 @@ Input usage .. code-block:: rsyslog - input(type="imfile" freshStartTail="on") + input(type="imfile" + File="/var/log/example.log" + Tag="example" + freshStartTail="on") Notes ----- diff --git a/doc/source/reference/parameters/imfile-ignoreolderthan.rst b/doc/source/reference/parameters/imfile-ignoreolderthan.rst index ae9a5e09e..ac4da6b2c 100644 --- a/doc/source/reference/parameters/imfile-ignoreolderthan.rst +++ b/doc/source/reference/parameters/imfile-ignoreolderthan.rst @@ -37,7 +37,10 @@ Input usage .. code-block:: rsyslog - input(type="imfile" ignoreOlderThan="0") + input(type="imfile" + File="/var/log/example.log" + Tag="example" + ignoreOlderThan="0") See also -------- diff --git a/doc/source/reference/parameters/imfile-maxbytesperminute.rst b/doc/source/reference/parameters/imfile-maxbytesperminute.rst index 95ed24a85..f19c694ec 100644 --- a/doc/source/reference/parameters/imfile-maxbytesperminute.rst +++ b/doc/source/reference/parameters/imfile-maxbytesperminute.rst @@ -38,7 +38,10 @@ Input usage .. code-block:: rsyslog - input(type="imfile" MaxBytesPerMinute="0") + input(type="imfile" + File="/var/log/example.log" + Tag="example" + MaxBytesPerMinute="0") See also -------- diff --git a/doc/source/reference/parameters/imfile-maxlinesatonce.rst b/doc/source/reference/parameters/imfile-maxlinesatonce.rst index ec5f83166..72b6ae226 100644 --- a/doc/source/reference/parameters/imfile-maxlinesatonce.rst +++ b/doc/source/reference/parameters/imfile-maxlinesatonce.rst @@ -42,7 +42,10 @@ Input usage .. code-block:: rsyslog - input(type="imfile" MaxLinesAtOnce="0") + input(type="imfile" + File="/var/log/example.log" + Tag="example" + MaxLinesAtOnce="0") Legacy names (for reference) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/doc/source/reference/parameters/imfile-maxlinesperminute.rst b/doc/source/reference/parameters/imfile-maxlinesperminute.rst index f3e2acbe2..a2ea56d46 100644 --- a/doc/source/reference/parameters/imfile-maxlinesperminute.rst +++ b/doc/source/reference/parameters/imfile-maxlinesperminute.rst @@ -37,7 +37,10 @@ Input usage .. code-block:: rsyslog - input(type="imfile" MaxLinesPerMinute="0") + input(type="imfile" + File="/var/log/example.log" + Tag="example" + MaxLinesPerMinute="0") See also -------- diff --git a/doc/source/reference/parameters/imfile-maxsubmitatonce.rst b/doc/source/reference/parameters/imfile-maxsubmitatonce.rst index 7c50747d9..88a4412f3 100644 --- a/doc/source/reference/parameters/imfile-maxsubmitatonce.rst +++ b/doc/source/reference/parameters/imfile-maxsubmitatonce.rst @@ -38,7 +38,10 @@ Input usage .. code-block:: rsyslog - input(type="imfile" MaxSubmitAtOnce="1024") + input(type="imfile" + File="/var/log/example.log" + Tag="example" + MaxSubmitAtOnce="1024") See also -------- diff --git a/doc/source/reference/parameters/imfile-msgdiscardingerror.rst b/doc/source/reference/parameters/imfile-msgdiscardingerror.rst index f9e2ff4fe..25664b8a2 100644 --- a/doc/source/reference/parameters/imfile-msgdiscardingerror.rst +++ b/doc/source/reference/parameters/imfile-msgdiscardingerror.rst @@ -36,7 +36,10 @@ Input usage .. code-block:: rsyslog - input(type="imfile" msgDiscardingError="on") + input(type="imfile" + File="/var/log/example.log" + Tag="example" + msgDiscardingError="on") Notes ----- diff --git a/doc/source/reference/parameters/imfile-needparse.rst b/doc/source/reference/parameters/imfile-needparse.rst index 7bc179962..692c68f7c 100644 --- a/doc/source/reference/parameters/imfile-needparse.rst +++ b/doc/source/reference/parameters/imfile-needparse.rst @@ -37,7 +37,10 @@ Input usage .. code-block:: rsyslog - input(type="imfile" needParse="on") + input(type="imfile" + File="/var/log/example.log" + Tag="example" + needParse="on") Notes ----- diff --git a/doc/source/reference/parameters/imfile-persiststateaftersubmission.rst b/doc/source/reference/parameters/imfile-persiststateaftersubmission.rst index c902abae6..9b81540c8 100644 --- a/doc/source/reference/parameters/imfile-persiststateaftersubmission.rst +++ b/doc/source/reference/parameters/imfile-persiststateaftersubmission.rst @@ -38,7 +38,10 @@ Input usage .. code-block:: rsyslog - input(type="imfile" persistStateAfterSubmission="on") + input(type="imfile" + File="/var/log/example.log" + Tag="example" + persistStateAfterSubmission="on") Notes ----- diff --git a/doc/source/reference/parameters/imfile-persiststateinterval.rst b/doc/source/reference/parameters/imfile-persiststateinterval.rst index 94c6be91e..4e93d4af7 100644 --- a/doc/source/reference/parameters/imfile-persiststateinterval.rst +++ b/doc/source/reference/parameters/imfile-persiststateinterval.rst @@ -43,7 +43,10 @@ Input usage .. code-block:: rsyslog - input(type="imfile" PersistStateInterval="0") + input(type="imfile" + File="/var/log/example.log" + Tag="example" + PersistStateInterval="0") Legacy names (for reference) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/doc/source/reference/parameters/imfile-readmode.rst b/doc/source/reference/parameters/imfile-readmode.rst index be444030b..a09ddce26 100644 --- a/doc/source/reference/parameters/imfile-readmode.rst +++ b/doc/source/reference/parameters/imfile-readmode.rst @@ -42,7 +42,10 @@ Input usage .. code-block:: rsyslog - input(type="imfile" readMode="0") + input(type="imfile" + File="/var/log/example.log" + Tag="example" + readMode="0") Legacy names (for reference) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/doc/source/reference/parameters/imfile-readtimeout.rst b/doc/source/reference/parameters/imfile-readtimeout.rst index 6a03b4df8..f0ee6382b 100644 --- a/doc/source/reference/parameters/imfile-readtimeout.rst +++ b/doc/source/reference/parameters/imfile-readtimeout.rst @@ -53,7 +53,10 @@ Input usage .. code-block:: rsyslog - input(type="imfile" readTimeout="0") + input(type="imfile" + File="/var/log/example.log" + Tag="example" + readTimeout="0") Notes ----- diff --git a/doc/source/reference/parameters/imfile-reopenontruncate.rst b/doc/source/reference/parameters/imfile-reopenontruncate.rst index 8c990e52d..bdbacc6cd 100644 --- a/doc/source/reference/parameters/imfile-reopenontruncate.rst +++ b/doc/source/reference/parameters/imfile-reopenontruncate.rst @@ -37,7 +37,10 @@ Input usage .. code-block:: rsyslog - input(type="imfile" reopenOnTruncate="on") + input(type="imfile" + File="/var/log/example.log" + Tag="example" + reopenOnTruncate="on") Notes ----- diff --git a/doc/source/reference/parameters/imfile-ruleset.rst b/doc/source/reference/parameters/imfile-ruleset.rst index 8e2dad1fe..a52268082 100644 --- a/doc/source/reference/parameters/imfile-ruleset.rst +++ b/doc/source/reference/parameters/imfile-ruleset.rst @@ -35,7 +35,10 @@ Input usage .. code-block:: rsyslog - input(type="imfile" Ruleset="myrules") + input(type="imfile" + File="/var/log/example.log" + Tag="example" + Ruleset="myrules") Legacy names (for reference) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/doc/source/reference/parameters/imfile-severity.rst b/doc/source/reference/parameters/imfile-severity.rst index a64b4d88e..203027228 100644 --- a/doc/source/reference/parameters/imfile-severity.rst +++ b/doc/source/reference/parameters/imfile-severity.rst @@ -37,7 +37,10 @@ Input usage .. code-block:: rsyslog - input(type="imfile" Severity="notice") + input(type="imfile" + File="/var/log/example.log" + Tag="example" + Severity="notice") Notes ----- diff --git a/doc/source/reference/parameters/imfile-startmsg-regex.rst b/doc/source/reference/parameters/imfile-startmsg-regex.rst index f408ebe02..782679cfe 100644 --- a/doc/source/reference/parameters/imfile-startmsg-regex.rst +++ b/doc/source/reference/parameters/imfile-startmsg-regex.rst @@ -40,7 +40,10 @@ Input usage .. code-block:: rsyslog - input(type="imfile" startmsg.regex="^start") + input(type="imfile" + File="/var/log/example.log" + Tag="example" + startmsg.regex="^start") See also -------- diff --git a/doc/source/reference/parameters/imfile-statefile.rst b/doc/source/reference/parameters/imfile-statefile.rst index 956fef94b..a0bf3510c 100644 --- a/doc/source/reference/parameters/imfile-statefile.rst +++ b/doc/source/reference/parameters/imfile-statefile.rst @@ -41,7 +41,10 @@ Input usage .. code-block:: rsyslog - input(type="imfile" stateFile="/path/to/state") + input(type="imfile" + File="/var/log/example.log" + Tag="example" + stateFile="/path/to/state") Notes ----- diff --git a/doc/source/reference/parameters/imfile-tag.rst b/doc/source/reference/parameters/imfile-tag.rst index feb63bba1..006b237a0 100644 --- a/doc/source/reference/parameters/imfile-tag.rst +++ b/doc/source/reference/parameters/imfile-tag.rst @@ -37,7 +37,9 @@ Input usage .. code-block:: rsyslog - input(type="imfile" Tag="app:") + input(type="imfile" + File="/var/log/example.log" + Tag="app:") Legacy names (for reference) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/doc/source/reference/parameters/imfile-trimlineoverbytes.rst b/doc/source/reference/parameters/imfile-trimlineoverbytes.rst index ba677cf32..f77a00eb6 100644 --- a/doc/source/reference/parameters/imfile-trimlineoverbytes.rst +++ b/doc/source/reference/parameters/imfile-trimlineoverbytes.rst @@ -38,7 +38,10 @@ Input usage .. code-block:: rsyslog - input(type="imfile" trimLineOverBytes="0") + input(type="imfile" + File="/var/log/example.log" + Tag="example" + trimLineOverBytes="0") See also --------