Man Pages editing #242
Man Pages editing #242
Conversation
Signed-off-by: Zsolt Gyulai (zgyulai) <zsolt.gyulai@quest.com>
Signed-off-by: Zsolt Gyulai (zgyulai) <zsolt.gyulai@quest.com>
doc/_admin-guide/190_The_syslog-ng_manual_pages/001_dqtool_manual.md
Outdated
Show resolved
Hide resolved
doc/_admin-guide/190_The_syslog-ng_manual_pages/001_dqtool_manual.md
Outdated
Show resolved
Hide resolved
doc/_admin-guide/190_The_syslog-ng_manual_pages/001_dqtool_manual.md
Outdated
Show resolved
Hide resolved
doc/_admin-guide/190_The_syslog-ng_manual_pages/010_slogkey_manual.md
Outdated
Show resolved
Hide resolved
doc/_admin-guide/190_The_syslog-ng_manual_pages/011_slogverify_manual.md
Outdated
Show resolved
Hide resolved
doc/_admin-guide/190_The_syslog-ng_manual_pages/012_secure_logging_manual.md
Outdated
Show resolved
Hide resolved
doc/_admin-guide/190_The_syslog-ng_manual_pages/001_dqtool_manual.md
Outdated
Show resolved
Hide resolved
Signed-off-by: Zsolt Gyulai (zgyulai) <zsolt.gyulai@quest.com>
zsoltgyulai94
force-pushed
the
doc-align-man-pages
branch
from
7274570 to
ff1b201
Compare
Signed-off-by: Zsolt Gyulai (zgyulai) <zsolt.gyulai@quest.com>
zsoltgyulai94
force-pushed
the
doc-align-man-pages
branch
from
7878bd2 to
3237f96
Compare
There was a problem hiding this comment.
Please see once more the format of the 005_syslog-ng_manual.md as a reference how the pages should be formatted now.
If you open the currently generated pages side by side
e.g.
and
You can see the resulted differences of the different identintations, quoting, etc.
You also can use the markdown preview to see and compare the results before the html pages are generated
| `--dgram` or `-D` | ||
|
|
||
| Use datagram socket (UDP or unix-dgram) to send the messages to the | ||
| target. Requires the \--inet option as well. |
There was a problem hiding this comment.
esacping is not needed here, but usage of the `` pair might be used instead, like in the other cases
|
|
||
| ```bash | ||
| ./dqtool cat ../var/syslog-ng-00000.qf | ||
| /opt/syslog-ng/bin/dqtool/dqtool cat ../var/syslog-ng-00000.qf |
There was a problem hiding this comment.
all the examples on all the other man pages are using the binary names without path
e.g.
pdbtool match -p patterndb.xml -P sshd -M "Accepted publickey for myuser from 127.0.0.1 port 59357 ssh6"
i suggest using the same method e.g.
dqtool cat ../var/syslog-ng-00000.qf
i'd prefer the pure binary name, without any path prefix, but it is up to you, just please make this consistent
|
|
||
| ```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 |
|
|
||
| ```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 |
|
|
||
| ```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 |
| ## The cat command | ||
| ## THE CAT COMMAND | ||
|
|
||
| ```bash |
There was a problem hiding this comment.
please use the more generic shell markdown block hint here
Signed-off-by: Zsolt Gyulai (zgyulai) <zsolt.gyulai@quest.com>
2 participants
Aligning man pages to get them in a "porting-ready" state.