-
Notifications
You must be signed in to change notification settings - Fork 12
Man Pages editing #242
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
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>
## Files | ||
## FILES | ||
|
||
dqtool |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
please use the full path everywhere
/opt/syslog-ng/bin/dqtool
etc.
page generation will take care of the correct installation path replacement based on the "template" /opt/syslog-ng/ value
Relocate every queue file: | ||
|
||
```bash | ||
bin/dqtool relocate --new_path /tmp/dq --persist var/syslog-ng.persist --all |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
please use the full path everywhere
/opt/syslog-ng/bin/dqtool
etc.
page generation will take care of the correct installation path replacement based on the "template" /opt/syslog-ng/ value
### EXAMPLE: | ||
|
||
```bash | ||
./dqtool cat ../var/syslog-ng-00000.qf |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
please use the full path everywhere
/opt/syslog-ng/bin/dqtool
etc.
page generation will take care of the correct installation path replacement based on the "template" /opt/syslog-ng/ value
`/etc/syslog-ng.conf` | ||
|
||
## Additional Information | ||
## ADDITIONAL INFORMATION |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please replace these with the common footer ## SEE ALSO
`/etc/syslog-ng.conf` | ||
|
||
## Additional Information | ||
## ADDITIONAL INFORMATION |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please replace these with the common footer and ## SEE ALSO
`/etc/syslog-ng.conf` | ||
|
||
## Additional Information | ||
## ADDITIONAL INFORMATION |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please replace these with the common footer and ## SEE ALSO
The cat command has the following options: | ||
|
||
- \--debug or -d | ||
- `--debug` or `-d` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
please remove the enumerations everywhere in front of the options
just like I did in the doc/_admin-guide/190_The_syslog-ng_manual_pages/005_syslog-ng_manual.md
file
you can use a diff view to see all the changes I've applied
Signed-off-by: Zsolt Gyulai (zgyulai) <zsolt.gyulai@quest.com>
7274570
to
ff1b201
Compare
Aligning man pages to get them in a "porting-ready" state.