Skip to content

Commit 7b39d04

Browse files
authored
Eliminate unnecessary bracketing in links (#24)
To save some site generation time, eliminated all the hardwired link brackets.
2 parents b54ec22 + 19711ef commit 7b39d04

File tree

219 files changed

+422
-422
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

219 files changed

+422
-422
lines changed

_includes/doc/admin-guide/examples/multi-line.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
>
1919
{: .notice--info}
2020
21-
For details on using templates, see [[Templates and macros]].
21+
For details on using templates, see Templates and macros.
2222
2323
- To actually convert the lines of multi-line messages to single line
2424
(by replacing the newline characters with whitespaces), use the

_includes/doc/admin-guide/examples/timezone.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
For details, see also [[Timezones and daylight saving]]
2-
and [[A note on timezones and timestamps]].
1+
For details, see also Timezones and daylight saving
2+
and A note on timezones and timestamps.
33

44
The timezone can be specified by using the name, for example,
55
time-zone("Europe/Budapest"), or as the timezone offset in +/-HH:MM

_includes/doc/admin-guide/host-from-macro.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,4 +19,4 @@ the value of the {{ include.from }} macro:
1919
the sender host.
2020

2121
For details on using name resolution in syslog-ng OSE, see
22-
[[Using name resolution in syslog-ng]].
22+
Using name resolution in syslog-ng.

_includes/doc/admin-guide/host-macro.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
The name of the source host where the message originates from.
22

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

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

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

2626
For details on using name resolution in syslog-ng OSE, see
27-
[[Using name resolution in syslog-ng]].
27+
Using name resolution in syslog-ng.

_includes/doc/admin-guide/manpages-footnote.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## See also
22

3-
The syslog-ng.conf manual page \
3+
The syslog-ng.conf manual page
44
The syslog-ng manual page
55

66
>**NOTE:**
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
**NOTE:** To convert match variables into a syslog-ng OSE list, use the $\*
2-
macro, which can be further manipulated using [[List manipulation]],
2+
macro, which can be further manipulated using List manipulation,
33
or turned into a list in type-aware destinations.
44
{: .notice--info}
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
**NOTE:** Hard macros cannot be modified, so they will not be overwritten.
22
For details on the hard and soft macros,
3-
see [[Hard versus soft macros]].
3+
see Hard versus soft macros.
44
{: .notice--info}

_includes/doc/admin-guide/options/ca-dir.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
certificates in PEM format. The CA certificate files have to be named
88
after the 32-bit hash of the subject\'s name. This naming can be created
99
using the c\_rehash utility in openssl. For an example, see
10-
[[Configuring TLS on the syslog-ng clients]].
10+
Configuring TLS on the syslog-ng clients.
1111
The syslog-ng OSE application uses the CA
1212
certificates in this directory to validate the certificate of the peer.
1313

_includes/doc/admin-guide/options/cipher-suite.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ TLSv1.2). That way, the cipher-suite() also determines the encryption
2222
protocol used in the connection: to disable SSLv3, use an algorithm that
2323
is available only in TLSv1.2, and that both the client and the server
2424
supports. You can also specify the encryption protocols using
25-
[[ssl-options()]].
25+
ssl-options().
2626

2727
You can also use the following command to automatically list only
2828
ciphers permitted in a specific encryption protocol, for example,

_includes/doc/admin-guide/options/dynamic-window-size.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,4 @@
55

66
*Description:* The size of the dynamic control window used during
77
flow-control. For details on flow-control, see
8-
[[Managing incoming and outgoing messages with flow-control]].
8+
Managing incoming and outgoing messages with flow-control.

_includes/doc/admin-guide/options/encoding.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,4 @@
77
UTF-8) of messages using the legacy BSD-syslog protocol. To list the
88
available character sets on a host, execute the iconv -l command. For
99
details on how encoding affects the size of the message, see
10-
[[Message size and encoding]].
10+
Message size and encoding.

_includes/doc/admin-guide/options/failover.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

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

77
### servers()
88

_includes/doc/admin-guide/options/keep-hostname.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
parameter is set to **yes** and the IP address can be resolved to a
1616
hostname) of the host sending the message to syslog-ng OSE. For
1717
details on using name resolution in syslog-ng OSE, see
18-
[[Using name resolution in syslog-ng]].
18+
Using name resolution in syslog-ng.
1919

2020
**NOTE:** If the log message does not contain a hostname in its HOST field,
2121
syslog-ng OSE automatically adds a hostname to the message.

_includes/doc/admin-guide/options/keep-timestamp.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,5 +10,5 @@ globally, and per-source as well. The local setting of the source
1010
overrides the global option if available.
1111

1212
![]({{ site.baseurl}}/assets/images/caution.png) **CAUTION:** To use the S_ macros,
13-
the [[keep-timestamp()]] option must be enabled (this is the default behavior of syslog-ng OSE).
13+
the keep-timestamp() option must be enabled (this is the default behavior of syslog-ng OSE).
1414
{: .notice--warning}

_includes/doc/admin-guide/options/log-fetch-limit.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,4 @@
55

66
*Description:* The maximum number of messages fetched from a source
77
during a single poll loop. The destination queues might fill up before
8-
flow-control could stop reading if [[log-fetch-limit()]] is too high.
8+
flow-control could stop reading if log-fetch-limit() is too high.

_includes/doc/admin-guide/options/log-iw-size.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,5 @@
55

66
*Description:* The size of the initial window, this value is used during
77
flow-control. Its value cannot be lower than 100, unless the
8-
[[dynamic-window-size()]] option is enabled. For details on flow-control,
9-
see [[Managing incoming and outgoing messages with flow-control]].
8+
dynamic-window-size() option is enabled. For details on flow-control,
9+
see Managing incoming and outgoing messages with flow-control.

_includes/doc/admin-guide/options/log-msg-size.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@ size of the value of an SDATA field is 64 KiB.
1515
{: .notice--info}
1616

1717
For details on how encoding affects the size of the message, see
18-
[[Message size and encoding]].
18+
Message size and encoding.
1919

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

2323
Uses the value of the [[global option|adm-global-options]] if not specified.

_includes/doc/admin-guide/options/multi-line-garbage.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,23 +3,23 @@
33
| Type: | regular expression|
44
|Default:| empty string|
55

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

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

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

23-
![]({{ site.baseurl}}/assets/images/caution.png) **CAUTION:** If the [[multi-line-garbage()]]
24-
option is set, syslog-ng OSE discards lines between the line matching the [[multi-line-garbage()]] and the next line matching [[multi-line-prefix()]].
23+
![]({{ site.baseurl}}/assets/images/caution.png) **CAUTION:** If the multi-line-garbage()
24+
option is set, syslog-ng OSE discards lines between the line matching the multi-line-garbage() and the next line matching multi-line-prefix().
2525
{: .notice--warning}

_includes/doc/admin-guide/options/multi-line-mode.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
| Type: | indented \| regexp|
44
|Default: | empty string|
55

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

_includes/doc/admin-guide/options/prefix.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,5 +19,5 @@ Names starting with a dot (for example, .example) are reserved for use
1919
by syslog-ng OSE. If you use such a macro name as the name of a parsed
2020
value, it will attempt to replace the original value of the macro (note
2121
that only soft macros can be overwritten, see
22-
[[Hard versus soft macros]].
22+
Hard versus soft macros.
2323
To avoid such problems, use a prefix when naming the parsed values, for example, prefix(my-parsed-data.)

_includes/doc/admin-guide/options/python-class.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,4 +21,4 @@ python(
2121
);
2222
```
2323

24-
For details, see [[Python code in external files]]
24+
For details, see Python code in external files

_includes/doc/admin-guide/options/source-flags.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@
116116
- *validate-utf8*: The validate-utf8 flag enables
117117
encoding-verification for messages formatted according to the new
118118
IETF syslog standard (for details, see
119-
[[IETF-syslog messages]].
119+
IETF-syslog messages.
120120
If the BOM[^1] character is missing, but the message is otherwise UTF-8
121121
compliant, syslog-ng automatically adds the BOM character to the
122122
message.

_includes/doc/admin-guide/options/source-transport.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ source.
88

99
For detailed information about how syslog-ng OSE supports the
1010
proxied-tcp, the proxied-tls, and the proxied-tls-passthrough
11-
parameters, see [[Proxy Protocol support]].
11+
parameters, see Proxy Protocol support.
1212
text-with-nuls: Allows embedded **NUL** characters in the message from a
1313
TCP source, that is, syslog-ng OSE will not delimiter the incoming
1414
messages on **NUL** characters, only on **newline** characters (contrary

_includes/doc/admin-guide/options/template-logformat.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
*Description:* Specifies a template defining the logformat to be used in
77
the destination. Macros are described in
8-
[[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
8+
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
99
might not be tolerated by stock syslog receivers (like syslogd or
1010
syslog-ng itself). For network destinations make sure the receiver can
1111
cope with the custom format defined.

_includes/doc/admin-guide/options/tls.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@
66
*Description:* This option sets various options related to TLS
77
encryption, for example, key/certificate files and trusted CA locations.
88
TLS can be used only with tcp-based transport protocols. For details,
9-
see [[TLS options]].
9+
see TLS options.

_includes/doc/admin-guide/options/ts-format.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

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

1010
**NOTE:** This option applies only to file and file-like destinations.
1111
Destinations that use specific protocols (for example, network(), or

_includes/doc/admin-guide/options/value-pairs-short.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

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

1010
**NOTE:** Empty keys are not logged.
1111
{: .notice--info}

_includes/doc/admin-guide/options/value-pairs.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -43,10 +43,10 @@ information may appear if multiple macros include the same information
4343
The value-pairs() option has the following parameters. The parameters
4444
are evaluated in the following order:
4545

46-
1. [[scope()]]
47-
2. [[exclude()]]
48-
3. [[key()]]
49-
4. [[pair()]]
46+
1. scope()
47+
2. exclude()
48+
3. key()
49+
4. pair()
5050

5151
#### exclude()
5252

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

134-
*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]].
134+
*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]].
135135

136136
- If rekey() is used within a key() option, the name-value pairs specified in the glob of the key() option are transformed.
137137
- If rekey() is used outside the key() option, every name-value pair of the scope() is transformed.

_includes/doc/admin-guide/parser-intro.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,4 @@ syslog RFCs, making them difficult to parse. The {{ page.parser }}-parser() of
33
syslog-ng OSE solves this problem, and can separate these log messages
44
to name-value pairs, extracting also the Cisco-specific values, for
55
example, the mnemonic. For details on using value-pairs in syslog-ng OSE
6-
see [[Structuring macros, metadata, and other value-pairs]].
6+
see Structuring macros, metadata, and other value-pairs.

_includes/doc/admin-guide/python-blocks-generic.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,4 +56,4 @@ general:
5656

5757
- To help debugging and troubleshooting your Python code, you can send
5858
log messages to the internal() source of syslog-ng OSE. For details,
59-
see [[Logging from your Python code]].
59+
see Logging from your Python code.

_includes/doc/admin-guide/python-deinit.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@ method does not return a value.
66
{% include doc/admin-guide/warnings/python-reload.md %}
77

88
For the list of available optional parameters, see
9-
[[python() and python-fetcher() source options]].
9+
python() and python-fetcher() source options.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
For details on using or writing such configuration snippets, see
2-
[[Reusing configuration blocks]].
2+
Reusing configuration blocks.
33
You can find the source of this configuration snippet on
44
[GitHub]({{ page.snippetlink }}).

doc/_admin-guide/020_The_concepts_of_syslog-ng/001_Logging_with_syslog-ng.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,5 +98,5 @@ syslog-ng server.
9898
**NOTE:** The syslog-ng application can stop reading messages from its
9999
sources if the destinations cannot process the sent messages. This
100100
feature is called flow-control and is detailed in
101-
[[Managing incoming and outgoing messages with flow-control]].
101+
Managing incoming and outgoing messages with flow-control.
102102
{: .notice--info}

doc/_admin-guide/020_The_concepts_of_syslog-ng/003_Global_objects.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -33,15 +33,15 @@ A named collection of configured destination drivers.
3333
An expression to select messages. For example, a simple filter can select the
3434
messages received from a specific host.
3535

36-
For details, see [[Customize message format using macros and templates]].
36+
For details, see Customize message format using macros and templates.
3737

3838
## Macro
3939

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

44-
For details, see [[Customize message format using macros and templates]].
44+
For details, see Customize message format using macros and templates.
4545

4646
## Parser
4747

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

61-
For details, see [[Modifying messages using rewrite rules]].
61+
For details, see Modifying messages using rewrite rules.
6262

6363
## Log paths
6464

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

81-
For details, see [[Customize message format using macros and templates]].
81+
For details, see Customize message format using macros and templates.
8282

8383
## Option
8484

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

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

0 commit comments

Comments
 (0)