@@ -14,13 +14,13 @@ description: >-
1414 loggen --- Generate syslog messages at a specified rate
1515---
1616
17- ## Synopsis
17+ ## SYNOPSIS
1818
19- loggen \ [ options\ ]
19+ loggen [ options]
2020
21- target \ [ port\ ]
21+ target [ port]
2222
23- ## Description
23+ ## DESCRIPTION
2424
2525{% include doc/admin-guide/manpages-intro.md %}
2626
@@ -47,159 +47,164 @@ statistics:
4747- bandwidth: The average bandwidth used for sending the messages in
4848 kilobytes/second.
4949
50- ## Options
50+ ## OPTIONS
5151
52- - \ - -active-connections \ < number-of-connections\>
52+ - ` --active-connections <number-of-connections> `
5353
5454 Number of connections loggen will use to send messages to the
5555 destination. This option is usable only when using TCP or TLS
5656 connections to the destination. Default value: 1
5757
5858 The loggen utility waits until every connection is established
59- before starting to send messages. See also the \ - -idle-connections
59+ before starting to send messages. See also the ` --idle-connections `
6060 option.
6161
62- - \ - -csv or -C
62+ - ` --csv ` or ` -C `
6363
6464 Send the statistics of the sent messages to stdout as CSV. This can
6565 be used for plotting the message rate.
6666
67- - \ - -dgram or -D
67+ - ` --dgram ` or ` -D `
6868
6969 Use datagram socket (UDP or unix-dgram) to send the messages to the
7070 target. Requires the \- -inet option as well.
7171
72- - dont-parse or -d
72+ - ` -- dont-parse` or ` -d `
7373
7474 Do not parse the lines read from the input files, send them as
7575 received.
7676
77- - \ - -help or -h
77+ - ` --help ` or ` -h `
7878
7979 Display a brief help message.
8080
81- - \ - -idle-connection \ < number-of-connections\>
81+ - ` --idle-connection <number-of-connections> `
8282
8383 Number of idle connections loggen will establish to the destination.
8484 Note that loggen will not send any messages on idle connections, but
8585 the connection is kept open using keep-alive messages. This option
8686 is usable only when using TCP or TLS connections to the destination.
87- See also the \ - -active-connections option. Default value: 0
87+ See also the --active-connections option. Default value: 0
8888
89- - \ - -inet or -i
89+ - ` --inet ` or ` -i `
9090
9191 Use the TCP (by default) or UDP (when used together with the
9292 \- -dgram option) protocol to send the messages to the target.
9393
94- - \ - -interval \ < seconds\> or -I \ < seconds\>
94+ - ` --interval <seconds> ` or ` -I <seconds> `
9595
9696 The number of seconds loggen will run. Default value: 10
9797
98- NOTE: When \ - -interval and \ - -number are used together, loggen will
99- send messages until the period set in \ - -interval expires or the
100- amount of messages set in \ - -number is reached, whichever happens
98+ NOTE: When ` --interval ` and ` --number ` are used together, loggen will
99+ send messages until the period set in ` --interval ` expires or the
100+ amount of messages set in ` --number ` is reached, whichever happens
101101 first.
102102
103- - \ - -ipv6 or -6
103+ - ` --ipv6 ` or ` -6 `
104104
105105 Specify the destination using its IPv6 address. Note that the
106106 destination must have a real IPv6 address.
107107
108- - \ - -loop-reading or -l
108+ - ` --loop-reading ` or ` -l `
109109
110- Read the file specified in \ - -read-file option in loop: loggen will
110+ Read the file specified in ` --read-file ` option in loop: loggen will
111111 start reading from the beginning of the file when it reaches the end
112112 of the file.
113113
114- - \ - -number \ < number-of-messages\> or -n \ < number-of-messages\>
114+ - ` --number <number-of-messages> ` or ` -n <number-of-messages> `
115115
116116 Number of messages to generate.
117117
118- NOTE: When \ - -interval and \ - -number are used together, loggen will
119- send messages until the period set in \ - -interval expires or the
120- amount of messages set in \ - -number is reached, whichever happens
118+ NOTE: When ` --interval ` and ` --number ` are used together, loggen will
119+ send messages until the period set in ` --interval ` expires or the
120+ amount of messages set in ` --number ` is reached, whichever happens
121121 first.
122122
123- - \ - -no-framing or -F
123+ - ` --no-framing ` or ` -F `
124124
125125 Do not use the framing of the IETF-syslog protocol style, even if
126- the \ - -syslog-proto option is set.
126+ the ` --syslog-proto ` option is set.
127127
128- - \ - -quiet or -Q
128+ - ` --quiet ` or ` -Q `
129129
130130 Display statistics only when loggen is finished. If not set, the
131131 statistics are displayed every second.
132132
133- - \ - -permanent or -T
133+ - ` --permanent ` or ` -T `
134134
135135 Keep sending logs indefinitely, without time limit.
136136
137- - \ - -rate \ < message/second\> or -r \ < message/second\>
137+ - ` --rate <message/second> ` or ` -r <message/second> `
138138
139139 The number of messages generated per second for every active
140140 connection. Default value: 1000
141141
142142 If you want to change the message rate while loggen is running, send
143143 SIGUSR1 to double the message rate, or SIGUSR2 to halve it:
144144
145- kill -USR1 \ < loggen-pid\ > kill -USR2 \ < loggen-pid\>
145+ kill ` -USR1 <loggen-pid>kill ` ` -USR2 <loggen-pid> `
146146
147- - \ - -read-file \ < filename\> or -R \ < filename\>
147+ - ` --read-file <filename> ` or ` -R <filename> `
148148
149149 Read the messages from a file and send them to the target. See also
150- the \ - -skip-tokens option.
150+ the ` --skip-tokens ` option.
151151
152152 Specify - as the input file to read messages from the standard input
153153 (stdio). Note that when reading messages from the standard input,
154154 loggen can only use a single thread. The -R -parameters must be
155- placed at end of command, like: loggen 127.0.0.1 1061 \ - -read-file -
155+ placed at end of command, like: loggen 127.0.0.1 1061 ` --read-file ` -
156156
157- - \ - -sdata \ < data-to-send\> or -p \ < data-to-send\>
157+ - ` --sdata <data-to-send> ` or ` -p <data-to-send> `
158158
159- Send the argument of the \ - -sdata option as the ` SDATA ` part of
159+ Send the argument of the ` --sdata ` option as the ` SDATA ` part of
160160 IETF-syslog (RFC-5424 formatted) messages. Use it together with the
161- \- -syslog-proto option. For example: ** \- -sdata \"\[ test
162- name=\\\" value\\\"\] **
161+ ` --syslog-proto ` option.
162+
163+ For example:
163164
164- - \- -size \< message-size\> or -s \< message-size\>
165+ ``` config
166+ --sdata "[test name=\"value\"]
167+ ```
168+
169+ - `--size <message-size>` or `-s <message-size>`
165170
166171 The size of a syslog message in bytes. Default value: 256. Minimum
167172 value: 127 bytes, maximum value: 8192 bytes.
168173
169- - \ - -skip-tokens \ < number\>
174+ - ` --skip-tokens <number>`
170175
171176 Skip the specified number of space-separated tokens (words) at the
172177 beginning of every line. For example, if the messages in the file
173- look like foo bar message, \ - -skip-tokens 2 skips the foo bar part
178+ look like foo bar message, --skip-tokens 2 skips the foo bar part
174179 of the line, and sends only the message part. Works only when used
175- together with the \ - -read-file parameter. Default value: 0
180+ together with the --read-file parameter. Default value: 0
176181
177- - \ - -stream or -S
182+ - ` --stream` or `-S`
178183
179184 Use a stream socket (TCP or unix-stream) to send the messages to the
180185 target.
181186
182- - \ - -syslog-proto or -P
187+ - ` --syslog-proto` or `-P`
183188
184189 Use the new IETF-syslog message format. By
185190 default, loggen uses the legacy BSD-syslog message format.
186191 See also the \--no-framing option.
187192
188- - \ - -unix \ < /path/to/socket\> or -x \ < /path/to/socket\>
193+ - ` --unix </path/to/socket>` or ` -x </path/to/socket>`
189194
190195 Use a UNIX domain socket to send the messages to the target.
191196
192- - \ - -use-ssl or -U
197+ - ` --use-ssl` or `-U`
193198
194199 Use an SSL-encrypted channel to send the messages to the target.
195200 Note that it is not possible to check the certificate of the target,
196201 or to perform mutual authentication.
197202
198- - \ - -version or -V
203+ - ` --version` or `-V`
199204
200205 Display version number of syslog-ng.
201206
202- ### Examples
207+ ### EXAMPLES:
203208
204209The following command generates 100 messages per second for ten minutes,
205210and sends them to port 2010 of the localhost via TCP. Each message is
@@ -241,7 +246,7 @@ localhost:
241246loggen 127.0.0.1 1061 --read-file -
242247```
243248
244- ## Files
249+ ## FILES
245250
246251/opt/syslog-ng/bin/loggen
247252
0 commit comments