Skip to content

Commit

Permalink
Eliminate unnecessary bracketing in links (syslog-ng#24)
Browse files Browse the repository at this point in the history
To save some site generation time, eliminated all the hardwired link
brackets.
  • Loading branch information
HofiOne authored May 13, 2024
2 parents b54ec22 + 19711ef commit 7b39d04
Show file tree
Hide file tree
Showing 219 changed files with 422 additions and 422 deletions.
2 changes: 1 addition & 1 deletion _includes/doc/admin-guide/examples/multi-line.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
>
{: .notice--info}
For details on using templates, see [[Templates and macros]].
For details on using templates, see Templates and macros.
- To actually convert the lines of multi-line messages to single line
(by replacing the newline characters with whitespaces), use the
Expand Down
4 changes: 2 additions & 2 deletions _includes/doc/admin-guide/examples/timezone.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
For details, see also [[Timezones and daylight saving]]
and [[A note on timezones and timestamps]].
For details, see also Timezones and daylight saving
and A note on timezones and timestamps.

The timezone can be specified by using the name, for example,
time-zone("Europe/Budapest"), or as the timezone offset in +/-HH:MM
Expand Down
2 changes: 1 addition & 1 deletion _includes/doc/admin-guide/host-from-macro.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,4 @@ the value of the {{ include.from }} macro:
the sender host.

For details on using name resolution in syslog-ng OSE, see
[[Using name resolution in syslog-ng]].
Using name resolution in syslog-ng.
8 changes: 4 additions & 4 deletions _includes/doc/admin-guide/host-macro.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
The name of the source host where the message originates from.

- If the message traverses several hosts and the
[[chain-hostnames()]] option is on, the first host
chain-hostnames() option is on, the first host
in the chain is used.

- If the [[keep-hostname()]] option is disabled
- If the keep-hostname() option is disabled
(**keep-hostname(no)**), the value of the {{ include.macro }} macro
will be the DNS hostname of the host that sent the message to
syslog-ng OSE (that is, the DNS hostname of the last hop). In this
case the {{ include.macro }} and {{ include.from }} macros will have the same
value.

- If the [[keep-hostname()]] option is enabled
- If the keep-hostname() option is enabled
(**keep-hostname(yes)**), the value of the {{ include.macro }} macro
will be the hostname retrieved from the log message. That way the
name of the original sender host can be used, even if there are log
Expand All @@ -24,4 +24,4 @@ The name of the source host where the message originates from.
{: .notice--info}

For details on using name resolution in syslog-ng OSE, see
[[Using name resolution in syslog-ng]].
Using name resolution in syslog-ng.
2 changes: 1 addition & 1 deletion _includes/doc/admin-guide/manpages-footnote.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## See also

The syslog-ng.conf manual page \
The syslog-ng.conf manual page
The syslog-ng manual page

>**NOTE:**
Expand Down
2 changes: 1 addition & 1 deletion _includes/doc/admin-guide/notes/convert-match-var.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
**NOTE:** To convert match variables into a syslog-ng OSE list, use the $\*
macro, which can be further manipulated using [[List manipulation]],
macro, which can be further manipulated using List manipulation,
or turned into a list in type-aware destinations.
{: .notice--info}
2 changes: 1 addition & 1 deletion _includes/doc/admin-guide/notes/hard-macros.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
**NOTE:** Hard macros cannot be modified, so they will not be overwritten.
For details on the hard and soft macros,
see [[Hard versus soft macros]].
see Hard versus soft macros.
{: .notice--info}
2 changes: 1 addition & 1 deletion _includes/doc/admin-guide/options/ca-dir.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
certificates in PEM format. The CA certificate files have to be named
after the 32-bit hash of the subject\'s name. This naming can be created
using the c\_rehash utility in openssl. For an example, see
[[Configuring TLS on the syslog-ng clients]].
Configuring TLS on the syslog-ng clients.
The syslog-ng OSE application uses the CA
certificates in this directory to validate the certificate of the peer.

Expand Down
2 changes: 1 addition & 1 deletion _includes/doc/admin-guide/options/cipher-suite.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ TLSv1.2). That way, the cipher-suite() also determines the encryption
protocol used in the connection: to disable SSLv3, use an algorithm that
is available only in TLSv1.2, and that both the client and the server
supports. You can also specify the encryption protocols using
[[ssl-options()]].
ssl-options().

You can also use the following command to automatically list only
ciphers permitted in a specific encryption protocol, for example,
Expand Down
2 changes: 1 addition & 1 deletion _includes/doc/admin-guide/options/dynamic-window-size.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@

*Description:* The size of the dynamic control window used during
flow-control. For details on flow-control, see
[[Managing incoming and outgoing messages with flow-control]].
Managing incoming and outgoing messages with flow-control.
2 changes: 1 addition & 1 deletion _includes/doc/admin-guide/options/encoding.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@
UTF-8) of messages using the legacy BSD-syslog protocol. To list the
available character sets on a host, execute the iconv -l command. For
details on how encoding affects the size of the message, see
[[Message size and encoding]].
Message size and encoding.
2 changes: 1 addition & 1 deletion _includes/doc/admin-guide/options/failover.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

*Description:* Available only in syslog-ng Open Source Edition version
3.17 and later. For details about how client-side failover works, see
[[Client-side failover]].
Client-side failover.

### servers()

Expand Down
2 changes: 1 addition & 1 deletion _includes/doc/admin-guide/options/keep-hostname.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
parameter is set to **yes** and the IP address can be resolved to a
hostname) of the host sending the message to syslog-ng OSE. For
details on using name resolution in syslog-ng OSE, see
[[Using name resolution in syslog-ng]].
Using name resolution in syslog-ng.

**NOTE:** If the log message does not contain a hostname in its HOST field,
syslog-ng OSE automatically adds a hostname to the message.
Expand Down
2 changes: 1 addition & 1 deletion _includes/doc/admin-guide/options/keep-timestamp.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,5 @@ globally, and per-source as well. The local setting of the source
overrides the global option if available.

![]({{ site.baseurl}}/assets/images/caution.png) **CAUTION:** To use the S_ macros,
the [[keep-timestamp()]] option must be enabled (this is the default behavior of syslog-ng OSE).
the keep-timestamp() option must be enabled (this is the default behavior of syslog-ng OSE).
{: .notice--warning}
2 changes: 1 addition & 1 deletion _includes/doc/admin-guide/options/log-fetch-limit.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@

*Description:* The maximum number of messages fetched from a source
during a single poll loop. The destination queues might fill up before
flow-control could stop reading if [[log-fetch-limit()]] is too high.
flow-control could stop reading if log-fetch-limit() is too high.
4 changes: 2 additions & 2 deletions _includes/doc/admin-guide/options/log-iw-size.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,5 @@

*Description:* The size of the initial window, this value is used during
flow-control. Its value cannot be lower than 100, unless the
[[dynamic-window-size()]] option is enabled. For details on flow-control,
see [[Managing incoming and outgoing messages with flow-control]].
dynamic-window-size() option is enabled. For details on flow-control,
see Managing incoming and outgoing messages with flow-control.
4 changes: 2 additions & 2 deletions _includes/doc/admin-guide/options/log-msg-size.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@ size of the value of an SDATA field is 64 KiB.
{: .notice--info}

For details on how encoding affects the size of the message, see
[[Message size and encoding]].
Message size and encoding.

You can use human-readable units when setting configuration options. For
details, see [[Notes about the configuration syntax]].
details, see Notes about the configuration syntax.

Uses the value of the [[global option|adm-global-options]] if not specified.
20 changes: 10 additions & 10 deletions _includes/doc/admin-guide/options/multi-line-garbage.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,23 +3,23 @@
| Type: | regular expression|
|Default:| empty string|

*Description:* Use the [[multi-line-garbage()]] option when processing
*Description:* Use the multi-line-garbage() option when processing
multi-line messages that contain unneeded parts between the messages.
Specify a string or regular expression that matches the beginning of the
unneeded message parts. If the [[multi-line-garbage()]] option is set,
unneeded message parts. If the multi-line-garbage() option is set,
syslog-ng OSE ignores the lines between the line matching the
[[multi-line-garbage()]] and the next line matching [[multi-line-prefix()]]. See
also the [[multi-line-prefix()]] option.
multi-line-garbage() and the next line matching multi-line-prefix(). See
also the multi-line-prefix() option.

When receiving multi-line messages from a source when the
[[multi-line-garbage()]] option is set, but no matching line is received
between two lines that match [[multi-line-prefix()]], syslog-ng OSE will
multi-line-garbage() option is set, but no matching line is received
between two lines that match multi-line-prefix(), syslog-ng OSE will
continue to process the incoming lines as a single message until a line
matching [[multi-line-garbage()]] is received.
matching multi-line-garbage() is received.

To use the [[multi-line-garbage()]] option, set the [[multi-line-mode()]] option
To use the multi-line-garbage() option, set the multi-line-mode() option
to **prefix-garbage**.

![]({{ site.baseurl}}/assets/images/caution.png) **CAUTION:** If the [[multi-line-garbage()]]
option is set, syslog-ng OSE discards lines between the line matching the [[multi-line-garbage()]] and the next line matching [[multi-line-prefix()]].
![]({{ site.baseurl}}/assets/images/caution.png) **CAUTION:** If the multi-line-garbage()
option is set, syslog-ng OSE discards lines between the line matching the multi-line-garbage() and the next line matching multi-line-prefix().
{: .notice--warning}
2 changes: 1 addition & 1 deletion _includes/doc/admin-guide/options/multi-line-mode.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
| Type: | indented \| regexp|
|Default: | empty string|

*Description:* Use the [[multi-line-mode()]] option when processing
*Description:* Use the multi-line-mode() option when processing
multi-line messages. The syslog-ng OSE application provides the
following methods to process multi-line messages:

Expand Down
2 changes: 1 addition & 1 deletion _includes/doc/admin-guide/options/prefix.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,5 +19,5 @@ Names starting with a dot (for example, .example) are reserved for use
by syslog-ng OSE. If you use such a macro name as the name of a parsed
value, it will attempt to replace the original value of the macro (note
that only soft macros can be overwritten, see
[[Hard versus soft macros]].
Hard versus soft macros.
To avoid such problems, use a prefix when naming the parsed values, for example, prefix(my-parsed-data.)
2 changes: 1 addition & 1 deletion _includes/doc/admin-guide/options/python-class.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,4 @@ python(
);
```

For details, see [[Python code in external files]]
For details, see Python code in external files
2 changes: 1 addition & 1 deletion _includes/doc/admin-guide/options/source-flags.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@
- *validate-utf8*: The validate-utf8 flag enables
encoding-verification for messages formatted according to the new
IETF syslog standard (for details, see
[[IETF-syslog messages]].
IETF-syslog messages.
If the BOM[^1] character is missing, but the message is otherwise UTF-8
compliant, syslog-ng automatically adds the BOM character to the
message.
Expand Down
2 changes: 1 addition & 1 deletion _includes/doc/admin-guide/options/source-transport.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ source.

For detailed information about how syslog-ng OSE supports the
proxied-tcp, the proxied-tls, and the proxied-tls-passthrough
parameters, see [[Proxy Protocol support]].
parameters, see Proxy Protocol support.
text-with-nuls: Allows embedded **NUL** characters in the message from a
TCP source, that is, syslog-ng OSE will not delimiter the incoming
messages on **NUL** characters, only on **newline** characters (contrary
Expand Down
2 changes: 1 addition & 1 deletion _includes/doc/admin-guide/options/template-logformat.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

*Description:* Specifies a template defining the logformat to be used in
the destination. Macros are described in
[[Macros of syslog-ng OSE]]. Please note that for network destinations it might not be appropriate to change the template as it changes the on-wire format of the syslog protocol which
Macros of syslog-ng OSE. Please note that for network destinations it might not be appropriate to change the template as it changes the on-wire format of the syslog protocol which
might not be tolerated by stock syslog receivers (like syslogd or
syslog-ng itself). For network destinations make sure the receiver can
cope with the custom format defined.
2 changes: 1 addition & 1 deletion _includes/doc/admin-guide/options/tls.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@
*Description:* This option sets various options related to TLS
encryption, for example, key/certificate files and trusted CA locations.
TLS can be used only with tcp-based transport protocols. For details,
see [[TLS options]].
see TLS options.
2 changes: 1 addition & 1 deletion _includes/doc/admin-guide/options/ts-format.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

*Description:* Override the global timestamp format (set in the global
ts-format() parameter) for the specific destination. For details, see
[[ts-format()]].
ts-format().

**NOTE:** This option applies only to file and file-like destinations.
Destinations that use specific protocols (for example, network(), or
Expand Down
2 changes: 1 addition & 1 deletion _includes/doc/admin-guide/options/value-pairs-short.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

*Description:* The value-pairs() option creates structured name-value
pairs from the data and metadata of the log message. For details on
using value-pairs(), see [[Structuring macros, metadata, and other value-pairs]].
using value-pairs(), see Structuring macros, metadata, and other value-pairs.

**NOTE:** Empty keys are not logged.
{: .notice--info}
10 changes: 5 additions & 5 deletions _includes/doc/admin-guide/options/value-pairs.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,10 +43,10 @@ information may appear if multiple macros include the same information
The value-pairs() option has the following parameters. The parameters
are evaluated in the following order:

1. [[scope()]]
2. [[exclude()]]
3. [[key()]]
4. [[pair()]]
1. scope()
2. exclude()
3. key()
4. pair()

#### exclude()

Expand Down Expand Up @@ -131,7 +131,7 @@ value-pairs(
| Type: | \<pattern-to-select-names\>, \<list of transformations\> |
| Default: | empty string |

*Description:* This option allows you to manipulate and modify the name of the value-pairs. You can define transformations, which are are applied to the selected name-value pairs. The first parameter of the rekey() option is a glob pattern that selects the name-value pairs to modify. If you omit the pattern, the transformations are applied to every key of the scope. For details on globs, see [[Options of regular expressions]]. If you want to modify the names of several message fields, see also [[map-value-pairs: Rename value-pairs to normalize logs]].
*Description:* This option allows you to manipulate and modify the name of the value-pairs. You can define transformations, which are are applied to the selected name-value pairs. The first parameter of the rekey() option is a glob pattern that selects the name-value pairs to modify. If you omit the pattern, the transformations are applied to every key of the scope. For details on globs, see Options of regular expressions. If you want to modify the names of several message fields, see also [[map-value-pairs: Rename value-pairs to normalize logs]].

- If rekey() is used within a key() option, the name-value pairs specified in the glob of the key() option are transformed.
- If rekey() is used outside the key() option, every name-value pair of the scope() is transformed.
Expand Down
2 changes: 1 addition & 1 deletion _includes/doc/admin-guide/parser-intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ syslog RFCs, making them difficult to parse. The {{ page.parser }}-parser() of
syslog-ng OSE solves this problem, and can separate these log messages
to name-value pairs, extracting also the Cisco-specific values, for
example, the mnemonic. For details on using value-pairs in syslog-ng OSE
see [[Structuring macros, metadata, and other value-pairs]].
see Structuring macros, metadata, and other value-pairs.
2 changes: 1 addition & 1 deletion _includes/doc/admin-guide/python-blocks-generic.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,4 +56,4 @@ general:

- To help debugging and troubleshooting your Python code, you can send
log messages to the internal() source of syslog-ng OSE. For details,
see [[Logging from your Python code]].
see Logging from your Python code.
2 changes: 1 addition & 1 deletion _includes/doc/admin-guide/python-deinit.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ method does not return a value.
{% include doc/admin-guide/warnings/python-reload.md %}

For the list of available optional parameters, see
[[python() and python-fetcher() source options]].
python() and python-fetcher() source options.
2 changes: 1 addition & 1 deletion _includes/doc/admin-guide/reusable-configuration.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
For details on using or writing such configuration snippets, see
[[Reusing configuration blocks]].
Reusing configuration blocks.
You can find the source of this configuration snippet on
[GitHub]({{ page.snippetlink }}).
Original file line number Diff line number Diff line change
Expand Up @@ -98,5 +98,5 @@ syslog-ng server.
**NOTE:** The syslog-ng application can stop reading messages from its
sources if the destinations cannot process the sent messages. This
feature is called flow-control and is detailed in
[[Managing incoming and outgoing messages with flow-control]].
Managing incoming and outgoing messages with flow-control.
{: .notice--info}
Original file line number Diff line number Diff line change
Expand Up @@ -33,15 +33,15 @@ A named collection of configured destination drivers.
An expression to select messages. For example, a simple filter can select the
messages received from a specific host.

For details, see [[Customize message format using macros and templates]].
For details, see Customize message format using macros and templates.

## Macro

An identifier that refers to a part of the log message. For example,
the `${HOST}` macro returns the name of the host that sent the message.
Macros are often used in templates and filenames.

For details, see [[Customize message format using macros and templates]].
For details, see Customize message format using macros and templates.

## Parser

Expand All @@ -58,7 +58,7 @@ and [[db-parser: Process message content with a pattern database (patterndb)]].
A rule modifies a part of the message, for example, replaces a string, or sets
a field to a specified value.

For details, see [[Modifying messages using rewrite rules]].
For details, see Modifying messages using rewrite rules.

## Log paths

Expand All @@ -78,12 +78,12 @@ A template is a set of macros that can be used to restructure log messages or
automatically generate file names. For example, a template can add the hostname
and the date to the beginning of every log message.

For details, see [[Customize message format using macros and templates]].
For details, see Customize message format using macros and templates.

## Option

Options set global parameters of syslog-ng, like the parameters of name
resolution and timezone handling.
For details, see [[Global options of syslog-ng OSE]].
For details, see Global options of syslog-ng OSE.

For details on the above objects, see [[The configuration syntax in detail]].
For details on the above objects, see The configuration syntax in detail.
Loading

0 comments on commit 7b39d04

Please sign in to comment.