Skip to content

Commit 34031cc

Browse files
authored
Merge pull request #143 from cgzones/sphinx
Resolve RST warnings from sphinx
2 parents 4450a7f + bff08e5 commit 34031cc

File tree

1 file changed

+26
-44
lines changed

1 file changed

+26
-44
lines changed

doc/index.rst

Lines changed: 26 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -99,47 +99,29 @@ Options are in the ``[Network]`` section. Reload changes:
9999

100100
.. tabularcolumns:: |p{3cm}|p{1.5cm}|p{1.5cm}|p{7cm}|
101101

102-
+--------------------+----------+-------------+-------------------------------------------------------------+
103-
| Option | Type | Default | Description |
104-
+====================+==========+=============+=============================================================+
105-
| ``Address=`` | string | *(required)*| Destination (unicast ``IP:PORT`` or multicast ``GROUP:PORT``). See :manpage:`systemd.socket(5)`. |
106-
+--------------------+----------+-------------+-------------------------------------------------------------+
107-
| ``Protocol=`` | enum | ``udp`` | ``udp``, ``tcp``, ``tls``, ``dtls``. |
108-
+--------------------+----------+-------------+-------------------------------------------------------------+
109-
| ``LogFormat=`` | enum | ``rfc5424``| ``rfc5424``, ``rfc5425`` (TLS-friendly), ``rfc3339``. |
110-
+--------------------+----------+-------------+-------------------------------------------------------------+
111-
| ``Directory=`` | path | *system* | Custom journal directory. |
112-
+--------------------+----------+-------------+-------------------------------------------------------------+
113-
| ``Namespace=`` | string | *default* | Filter: ID, ``*`` (all), ``+ID`` (ID + default). |
114-
+--------------------+----------+-------------+-------------------------------------------------------------+
115-
| ``ConnectionRetrySec=`` | time | ``30s`` | Reconnect delay (≥1s). See :manpage:`systemd.time(5)`. |
116-
+--------------------+----------+-------------+-------------------------------------------------------------+
117-
| ``TLSCertificateAuthMode=`` | enum | ``no`` | ``no``, ``allow``, ``deny``, ``warn`` (validation modes). |
118-
+--------------------+----------+-------------+-------------------------------------------------------------+
119-
| ``TLSServerCertificate=`` | path || PEM CA/server cert for validation. |
120-
+--------------------+----------+-------------+-------------------------------------------------------------+
121-
| ``KeepAlive=`` | bool | ``false`` | Enable TCP keepalives (``SO_KEEPALIVE``). See :manpage:`socket(7)`. |
122-
+--------------------+----------+-------------+-------------------------------------------------------------+
123-
| ``KeepAliveTimeSec=`` | sec | ``7200`` | Idle before probes (``TCP_KEEPIDLE``). |
124-
+--------------------+----------+-------------+-------------------------------------------------------------+
125-
| ``KeepAliveIntervalSec=`` | sec | ``75`` | Probe interval (``TCP_KEEPINTVL``). |
126-
+--------------------+----------+-------------+-------------------------------------------------------------+
127-
| ``KeepAliveProbes=`` | int | ``9`` | Probes before close (``TCP_KEEPCNT``). |
128-
+--------------------+----------+-------------+-------------------------------------------------------------+
129-
| ``SendBuffer=`` | size | *system* | Send buffer (``SO_SNDBUF``; K/M/G suffixes). |
130-
+--------------------+----------+-------------+-------------------------------------------------------------+
131-
| ``NoDelay=`` | bool | ``false`` | Disable Nagle (``TCP_NODELAY``). See :manpage:`tcp(7)`. |
132-
+--------------------+----------+-------------+-------------------------------------------------------------+
133-
| ``StructuredData=``| string || Fixed SD-ID (e.g., for Loggly). |
134-
+--------------------+----------+-------------+-------------------------------------------------------------+
135-
| ``UseSysLogStructuredData=`` | bool | ``false`` | Extract ``SYSLOG_STRUCTURED_DATA`` from journal. |
136-
+--------------------+----------+-------------+-------------------------------------------------------------+
137-
| ``UseSysLogMsgId=``| bool | ``false`` | Extract ``SYSLOG_MSGID`` from journal. |
138-
+--------------------+----------+-------------+-------------------------------------------------------------+
139-
| ``ExcludeSyslogFacility=`` | list || Skip facilities (e.g., ``auth authpriv``). |
140-
+--------------------+----------+-------------+-------------------------------------------------------------+
141-
| ``ExcludeSyslogLevel=`` | list || Skip levels (e.g., ``debug``). |
142-
+--------------------+----------+-------------+-------------------------------------------------------------+
102+
============================ ====== ============ ================================================================================================
103+
Option Type Default Description
104+
============================ ====== ============ ================================================================================================
105+
``Address=`` string *(required)* Destination (unicast ``IP:PORT`` or multicast ``GROUP:PORT``). See :manpage:`systemd.socket(5)`.
106+
``Protocol=`` enum ``udp`` ``udp``, ``tcp``, ``tls``, ``dtls``.
107+
``LogFormat=`` enum ``rfc5424`` ``rfc5424``, ``rfc5425`` (TLS-friendly), ``rfc3339``.
108+
``Directory=`` path *system* Custom journal directory.
109+
``Namespace=`` string *default* Filter: ID, ``*`` (all), ``+ID`` (ID + default).
110+
``ConnectionRetrySec=`` time ``30s`` Reconnect delay (≥1s). See :manpage:`systemd.time(5)`.
111+
``TLSCertificateAuthMode=`` enum ``no`` ``no``, ``allow``, ``deny``, ``warn`` (validation modes).
112+
``TLSServerCertificate=`` path – PEM CA/server cert for validation.
113+
``KeepAlive=`` bool ``false`` Enable TCP keepalives (``SO_KEEPALIVE``). See :manpage:`socket(7)`.
114+
``KeepAliveTimeSec=`` sec ``7200`` Idle before probes (``TCP_KEEPIDLE``).
115+
``KeepAliveIntervalSec=`` sec ``75`` Probe interval (``TCP_KEEPINTVL``).
116+
``KeepAliveProbes=`` int ``9`` Probes before close (``TCP_KEEPCNT``).
117+
``SendBuffer=`` size *system* Send buffer (``SO_SNDBUF``; K/M/G suffixes).
118+
``NoDelay=`` bool ``false`` Disable Nagle (``TCP_NODELAY``). See :manpage:`tcp(7)`.
119+
``StructuredData=`` string – Fixed SD-ID (e.g., for Loggly).
120+
``UseSysLogStructuredData=`` bool ``false`` Extract ``SYSLOG_STRUCTURED_DATA`` from journal.
121+
``UseSysLogMsgId=`` bool ``false`` Extract ``SYSLOG_MSGID`` from journal.
122+
``ExcludeSyslogFacility=`` list – Skip facilities (e.g., ``auth authpriv``).
123+
``ExcludeSyslogLevel=`` list – Skip levels (e.g., ``debug``).
124+
============================ ====== ============ ================================================================================================
143125

144126
**Facilities**: ``kern``, ``user``, ``mail``, ``daemon``, ``auth``, ``syslog``, ``lpr``, ``news``, ``uucp``, ``cron``, ``authpriv``, ``ftp``, ``ntp``, ``security``, ``console``, ``solaris-cron``, ``local0``–``local7``.
145127

@@ -157,7 +139,7 @@ UDP Multicast
157139
Address=239.0.0.1:6000
158140
159141
Unicast UDP (RFC 3339)
160-
^^^^^^^^^^^^^^^^^^^^^
142+
^^^^^^^^^^^^^^^^^^^^^^
161143

162144
.. code-block:: ini
163145
@@ -166,7 +148,7 @@ Unicast UDP (RFC 3339)
166148
LogFormat=rfc3339
167149
168150
Custom Structured Data
169-
^^^^^^^^^^^^^^^^^^^^^
151+
^^^^^^^^^^^^^^^^^^^^^^
170152

171153
.. code-block:: ini
172154
@@ -245,7 +227,7 @@ Files
245227
/etc/systemd/netlogd.conf
246228
Main configuration.
247229

248-
/etc/systemd/netlogd.conf.d/*.conf
230+
/etc/systemd/netlogd.conf.d/\*.conf
249231
Drop-in snippets.
250232

251233
/lib/systemd/system/systemd-netlogd.service

0 commit comments

Comments
 (0)