Skip to content

Commit ff1b201

Browse files
committed
Edits based on review.
Signed-off-by: Zsolt Gyulai (zgyulai) <zsolt.gyulai@quest.com>
1 parent 78f79b5 commit ff1b201

10 files changed

+142
-142
lines changed

doc/_admin-guide/190_The_syslog-ng_manual_pages/001_dqtool_manual.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -41,23 +41,23 @@ particular log messages, for example, **dqtool cat /var/log/messages.lgs
4141

4242
The cat command has the following options:
4343

44-
- `--debug` or `-d`
44+
`--debug` or `-d`
4545

4646
Print diagnostic and debugging messages to stderr.
4747

48-
- `--help` or `-h`
48+
`--help` or `-h`
4949

5050
Display a brief help message.
5151

52-
- `--template=<template>` or `-t`
52+
`--template=<template>` or `-t`
5353

5454
Format the messages using the specified template.
5555

56-
- `--verbose` or `-v`
56+
`--verbose` or `-v`
5757

5858
Print verbose messages to stderr.
5959

60-
- `--version` or `-V`
60+
`--version` or `-V`
6161

6262
Display version information.
6363

@@ -87,17 +87,17 @@ disk-queue) files. Note that this option modifies the persist file. Stop
8787

8888
The relocate command has the following options:
8989

90-
- `--all` or `-a`
90+
`--all` or `-a`
9191

9292
Relocate every disk-buffer file that is listed in the {{ site.product.short_name }}
9393
persist file.
9494

95-
- `--new_path` or `-n`
95+
`--new_path` or `-n`
9696

9797
The directory where you want to move the disk-bufffer files. For
9898
example: /var/disk-buffers
9999

100-
- `--persist` or `-p`
100+
`--persist` or `-p`
101101

102102
The path to the {{ site.product.short_name }} persist file. The relocate command
103103
automatically updates the entries of the disk-buffer files in the
@@ -125,6 +125,6 @@ bin/dqtool relocate --new_path /tmp/dq --persist var/syslog-ng.persist --all
125125

126126
## FILES
127127

128-
dqtool
128+
/opt/syslog-ng/bin/dqtool
129129

130130
{% include doc/admin-guide/manpages-footnote.md %}

doc/_admin-guide/190_The_syslog-ng_manual_pages/002_loggen_manual.md

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ statistics:
4949

5050
## 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
@@ -59,39 +59,39 @@ statistics:
5959
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.
8787
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

@@ -100,18 +100,18 @@ statistics:
100100
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

110110
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

@@ -120,21 +120,21 @@ statistics:
120120
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
126126
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
@@ -144,7 +144,7 @@ statistics:
144144

145145
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
150150
the `--skip-tokens` option.
@@ -154,7 +154,7 @@ statistics:
154154
loggen can only use a single thread. The -R -parameters must be
155155
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

159159
Send the argument of the `--sdata` option as the `SDATA` part of
160160
IETF-syslog (RFC-5424 formatted) messages. Use it together with the
@@ -166,41 +166,41 @@ statistics:
166166
--sdata "[test name=\"value\"]
167167
```
168168

169-
- `--size <message-size>` or `-s <message-size>`
169+
`--size <message-size>` or `-s <message-size>`
170170

171171
The size of a syslog message in bytes. Default value: 256. Minimum
172172
value: 127 bytes, maximum value: 8192 bytes.
173173

174-
- `--skip-tokens <number>`
174+
`--skip-tokens <number>`
175175

176176
Skip the specified number of space-separated tokens (words) at the
177177
beginning of every line. For example, if the messages in the file
178178
look like foo bar message, --skip-tokens 2 skips the foo bar part
179179
of the line, and sends only the message part. Works only when used
180180
together with the --read-file parameter. Default value: 0
181181

182-
- `--stream` or `-S`
182+
`--stream` or `-S`
183183

184184
Use a stream socket (TCP or unix-stream) to send the messages to the
185185
target.
186186

187-
- `--syslog-proto` or `-P`
187+
`--syslog-proto` or `-P`
188188

189189
Use the new IETF-syslog message format. By
190190
default, loggen uses the legacy BSD-syslog message format.
191191
See also the \--no-framing option.
192192

193-
- `--unix </path/to/socket>` or `-x </path/to/socket>`
193+
`--unix </path/to/socket>` or `-x </path/to/socket>`
194194

195195
Use a UNIX domain socket to send the messages to the target.
196196

197-
- `--use-ssl` or `-U`
197+
`--use-ssl` or `-U`
198198

199199
Use an SSL-encrypted channel to send the messages to the target.
200200
Note that it is not possible to check the certificate of the target,
201201
or to perform mutual authentication.
202202

203-
- `--version` or `-V`
203+
`--version` or `-V`
204204

205205
Display version number of syslog-ng.
206206

0 commit comments

Comments
 (0)