Man Pages editing

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

@@ -15,18 +15,18 @@ description: >-
     {{ site.product.short_name }}.
 ---
 
-## Synopsis
+## SYNOPSIS
 
-dqtool \[command\] \[options\]
+dqtool [command] [options]
 
-## Description
+## DESCRIPTION
 
 {% include doc/admin-guide/manpages-intro.md %}
 
 The dqtool application is a utility that can be used to display and
 format the messages stored in a disk-buffer file.
 
-## The cat command
+## THE CAT COMMAND
 
 ```bash
 cat [options] [file]
@@ -41,40 +41,41 @@ particular log messages, for example, **dqtool cat /var/log/messages.lgs
 
 The cat command has the following options:
 
-- \--debug or -d
+`--debug` or `-d`
 
     Print diagnostic and debugging messages to stderr.
 
-- \--help or -h
+`--help` or `-h`
 
     Display a brief help message.
 
-- \--template=\<template\> or -t
+`--template=<template>` or `-t`
 
     Format the messages using the specified template.
 
-- \--verbose or -v
+`--verbose` or `-v`
 
     Print verbose messages to stderr.
 
-- \--version or -V
+`--version` or `-V`
 
     Display version information.
 
-### Example: The cat command
+### EXAMPLE:
 
 ```bash
-./dqtool cat ../var/syslog-ng-00000.qf
+/opt/syslog-ng/bin/dqtool/dqtool cat ../var/syslog-ng-00000.qf
 ```
 
 The output looks like:
-
+```config
 >Disk-buffer state loaded;
 >filename='../var/syslog-ng-00000.qf', qout_length='65', qbacklog_length='0', qoverflow_length='9205', qdisk_length='0'
 >Mar  3 10:52:05 tristram localprg[1234]: seq: 0000011630, runid: 1267609923, stamp: 2010-03-03T10:52:05 PADDPADDPADDPADDPADDPADDPADDPADDPADDPADDPADDPADDPADDPADDPADDPADDPADDPADDPADDPADDPADDPADDPADDPADDPADDPADD
 >Mar  3 10:52:05 tristram localprg[1234]: seq: 0000011631, runid: 1267609923, stamp: 2010-03-03T10:52:05 PADDPADDPADDPADDPADDPADDPADDPADDPADDPADDPADDPADDPADDPADDPADDPADDPADDPADDPADDPADDPADDPADDPADDPADDPADDPADD
+```
 
-## The relocate command
+## THE RELOCATE COMMAND
 
 ```config
 relocate [options] [files]
@@ -86,44 +87,44 @@ disk-queue) files. Note that this option modifies the persist file. Stop
 
 The relocate command has the following options:
 
-- \--all or -a
+`--all` or `-a`
 
     Relocate every disk-buffer file that is listed in the {{ site.product.short_name }}
     persist file.
 
-- \--new\_path or -n
+`--new_path` or `-n`
 
     The directory where you want to move the disk-bufffer files. For
     example: /var/disk-buffers
 
-- \--persist or -p
+`--persist` or `-p`
 
     The path to the {{ site.product.short_name }} persist file. The relocate command
     automatically updates the entries of the disk-buffer files in the
     persist file.
 
-### Examples
+### EXAMPLES:
 
 Relocate a single queue file:
 
 ```bash
-bin/dqtool relocate --new_path /tmp/dq --persist var/syslog-ng.persist /tmp/syslog-ng-00000.rqf
+/opt/syslog-ng/bin/dqtool relocate --new_path /tmp/dq --persist var/syslog-ng.persist /tmp/syslog-ng-00000.rqf
 ```
 
 Relocate multiple queue files:
 
 ```bash
-bin/dqtool relocate --new_path /tmp/dq --persist var/syslog-ng.persist /tmp/syslog-ng-00000.rqf /tmp/syslog-ng-00001.rqf
+/opt/syslog-ng/bin/dqtool relocate --new_path /tmp/dq --persist var/syslog-ng.persist /tmp/syslog-ng-00000.rqf /tmp/syslog-ng-00001.rqf
 ```
 
 Relocate every queue file:
 
 ```bash
-bin/dqtool relocate --new_path /tmp/dq --persist var/syslog-ng.persist --all
+/opt/syslog-ng/bin/dqtool relocate --new_path /tmp/dq --persist var/syslog-ng.persist --all
 ```
 
-## Files
+## FILES
 
-dqtool
+/opt/syslog-ng/bin/dqtool
 
 {% include doc/admin-guide/manpages-footnote.md %}

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

@@ -14,13 +14,13 @@ description: >-
     loggen --- Generate syslog messages at a specified rate
 ---
 
-## Synopsis
+## SYNOPSIS
 
-loggen \[options\]
+loggen [options]
 
-target \[port\]
+target [port]
 
-## Description
+## DESCRIPTION
 
 {% include doc/admin-guide/manpages-intro.md %}
 
@@ -47,159 +47,164 @@ statistics:
 - bandwidth: The average bandwidth used for sending the messages in
     kilobytes/second.
 
-## Options
+## OPTIONS
 
-- \--active-connections \<number-of-connections\>
+`--active-connections <number-of-connections>`
 
     Number of connections loggen will use to send messages to the
     destination. This option is usable only when using TCP or TLS
     connections to the destination. Default value: 1
 
     The loggen utility waits until every connection is established
-    before starting to send messages. See also the \--idle-connections
+    before starting to send messages. See also the `--idle-connections`
     option.
 
-- \--csv or -C
+`--csv` or `-C`
 
     Send the statistics of the sent messages to stdout as CSV. This can
     be used for plotting the message rate.
 
-- \--dgram or -D
+`--dgram` or `-D`
 
     Use datagram socket (UDP or unix-dgram) to send the messages to the
     target. Requires the \--inet option as well.
 
-- dont-parse or -d
+`--dont-parse` or `-d`
 
     Do not parse the lines read from the input files, send them as
     received.
 
-- \--help or -h
+`--help` or `-h`
 
     Display a brief help message.
 
-- \--idle-connection \<number-of-connections\>
+`--idle-connection <number-of-connections>`
 
     Number of idle connections loggen will establish to the destination.
     Note that loggen will not send any messages on idle connections, but
     the connection is kept open using keep-alive messages. This option
     is usable only when using TCP or TLS connections to the destination.
-    See also the \--active-connections option. Default value: 0
+    See also the --active-connections option. Default value: 0
 
-- \--inet or -i
+`--inet` or `-i`
 
     Use the TCP (by default) or UDP (when used together with the
     \--dgram option) protocol to send the messages to the target.
 
-- \--interval \<seconds\> or -I \<seconds\>
+`--interval <seconds>` or `-I <seconds>`
 
     The number of seconds loggen will run. Default value: 10
 
-    NOTE: When \--interval and \--number are used together, loggen will
-    send messages until the period set in \--interval expires or the
-    amount of messages set in \--number is reached, whichever happens
+    NOTE: When `--interval` and `--number` are used together, loggen will
+    send messages until the period set in `--interval` expires or the
+    amount of messages set in `--number` is reached, whichever happens
     first.
 
-- \--ipv6 or -6
+`--ipv6` or `-6`
 
     Specify the destination using its IPv6 address. Note that the
     destination must have a real IPv6 address.
 
-- \--loop-reading or -l
+`--loop-reading` or `-l`
 
-    Read the file specified in \--read-file option in loop: loggen will
+    Read the file specified in `--read-file` option in loop: loggen will
     start reading from the beginning of the file when it reaches the end
     of the file.
 
-- \--number \<number-of-messages\> or -n \<number-of-messages\>
+`--number <number-of-messages>` or `-n <number-of-messages>`
 
     Number of messages to generate.
 
-    NOTE: When \--interval and \--number are used together, loggen will
-    send messages until the period set in \--interval expires or the
-    amount of messages set in \--number is reached, whichever happens
+    NOTE: When `--interval` and `--number` are used together, loggen will
+    send messages until the period set in `--interval` expires or the
+    amount of messages set in `--number` is reached, whichever happens
     first.
 
-- \--no-framing or -F
+`--no-framing` or `-F`
 
     Do not use the framing of the IETF-syslog protocol style, even if
-    the \--syslog-proto option is set.
+    the `--syslog-proto` option is set.
 
-- \--quiet or -Q
+`--quiet` or `-Q`
 
     Display statistics only when loggen is finished. If not set, the
     statistics are displayed every second.
 
-- \--permanent or -T
+`--permanent` or `-T`
 
     Keep sending logs indefinitely, without time limit.
 
-- \--rate \<message/second\> or -r \<message/second\>
+`--rate <message/second>` or `-r <message/second>`
 
     The number of messages generated per second for every active
     connection. Default value: 1000
 
     If you want to change the message rate while loggen is running, send
     SIGUSR1 to double the message rate, or SIGUSR2 to halve it:
 
-    kill -USR1 \<loggen-pid\>kill -USR2 \<loggen-pid\>
+    kill `-USR1 <loggen-pid>kill` `-USR2 <loggen-pid>`
 
-- \--read-file \<filename\> or -R \<filename\>
+`--read-file <filename>` or `-R <filename>`
 
     Read the messages from a file and send them to the target. See also
-    the \--skip-tokens option.
+    the `--skip-tokens` option.
 
     Specify - as the input file to read messages from the standard input
     (stdio). Note that when reading messages from the standard input,
     loggen can only use a single thread. The -R -parameters must be
-    placed at end of command, like: loggen 127.0.0.1 1061 \--read-file -
+    placed at end of command, like: loggen 127.0.0.1 1061 `--read-file` -
 
-- \--sdata \<data-to-send\> or -p \<data-to-send\>
+`--sdata <data-to-send>` or `-p <data-to-send>`
 
-    Send the argument of the \--sdata option as the `SDATA` part of
+    Send the argument of the `--sdata` option as the `SDATA` part of
     IETF-syslog (RFC-5424 formatted) messages. Use it together with the
-    \--syslog-proto option. For example: **\--sdata \"\[test
-    name=\\\"value\\\"\]**
+    `--syslog-proto` option. 
+
+    For example: 
 
-- \--size \<message-size\> or -s \<message-size\>
+    ```config
+    --sdata "[test name=\"value\"]
+    ```
+
+`--size <message-size>` or `-s <message-size>`
 
     The size of a syslog message in bytes. Default value: 256. Minimum
     value: 127 bytes, maximum value: 8192 bytes.
 
-- \--skip-tokens \<number\>
+`--skip-tokens <number>`
 
     Skip the specified number of space-separated tokens (words) at the
     beginning of every line. For example, if the messages in the file
-    look like foo bar message, \--skip-tokens 2 skips the foo bar part
+    look like foo bar message, --skip-tokens 2 skips the foo bar part
     of the line, and sends only the message part. Works only when used
-    together with the \--read-file parameter. Default value: 0
+    together with the --read-file parameter. Default value: 0
 
-- \--stream or -S
+`--stream` or `-S`
 
     Use a stream socket (TCP or unix-stream) to send the messages to the
     target.
 
-- \--syslog-proto or -P
+`--syslog-proto` or `-P`
 
     Use the new IETF-syslog message format. By
     default, loggen uses the legacy BSD-syslog message format.
     See also the \--no-framing option.
 
-- \--unix \</path/to/socket\> or -x \</path/to/socket\>
+`--unix </path/to/socket>` or `-x </path/to/socket>`
 
     Use a UNIX domain socket to send the messages to the target.
 
-- \--use-ssl or -U
+`--use-ssl` or `-U`
 
     Use an SSL-encrypted channel to send the messages to the target.
     Note that it is not possible to check the certificate of the target,
     or to perform mutual authentication.
 
-- \--version or -V
+`--version` or `-V`
 
     Display version number of syslog-ng.
 
-### Examples
+### EXAMPLES:
 
 The following command generates 100 messages per second for ten minutes,
 and sends them to port 2010 of the localhost via TCP. Each message is
@@ -241,7 +246,7 @@ localhost:
 loggen 127.0.0.1 1061 --read-file -
 ```
 
-## Files
+## FILES
 
 /opt/syslog-ng/bin/loggen