From bfde1b7c9173b55cd85041150fe272b510b1c7a6 Mon Sep 17 00:00:00 2001 From: "Zsolt Gyulai (zgyulai)" Date: Wed, 3 Sep 2025 20:22:23 +0200 Subject: [PATCH 1/5] Started aligning man pages. Signed-off-by: Zsolt Gyulai (zgyulai) --- .../004_persist-tool_manual.md | 68 +++++++++---------- .../006_syslog-ng_conf.md | 18 ++--- 2 files changed, 43 insertions(+), 43 deletions(-) diff --git a/doc/_admin-guide/190_The_syslog-ng_manual_pages/004_persist-tool_manual.md b/doc/_admin-guide/190_The_syslog-ng_manual_pages/004_persist-tool_manual.md index 0cefb90..c26b99d 100644 --- a/doc/_admin-guide/190_The_syslog-ng_manual_pages/004_persist-tool_manual.md +++ b/doc/_admin-guide/190_The_syslog-ng_manual_pages/004_persist-tool_manual.md @@ -10,14 +10,14 @@ id: adm-man-persist-tool manid: 1 manname: persist-tool description: >- - persist-tool --- {{ site.product.short_name }} configuration file + persist-tool - {{ site.product.short_name }} configuration file --- -## Synopsis +## SYNOPSIS persist-tool [command] [options] -## Description +## DESCRIPTION This manual page is only an abstract. @@ -31,7 +31,7 @@ Limitations: * The persist-state functions can be used only with `SLP4` or newer persist files. Older persist files are not supported. * Wildcard characters are not supported in file and directory names. -## The dump command +## THE DUMP COMMAND dump [options] [persist_file] @@ -42,20 +42,20 @@ The `dump` command has the following options: Display a brief help message. -### Example: persist-tool dump + For example: -```config -persist-tool dump /opt/syslog-ng/var/syslog-ng.persist -``` + ```config + persist-tool dump /opt/syslog-ng/var/syslog-ng persist + ``` -A valid output is the following: + A valid output is the following: -```config -run_id = { "value": "00 00 00 00 0C 00 00 00 " } -host_id = { "value": "00 00 00 00 5F 49 2F 01 " } -``` + ```config + run_id = { "value": "00 00 00 00 0C 00 00 00 " } + host_id = { "value": "00 00 00 00 5F 49 2F 01 " } + ``` -## The add command +## THE ADD COMMAND add [options] [input_file] @@ -74,34 +74,34 @@ The `add` command has the following options: Optional parameter. The name of the persist file to generate. Default value: syslog-ng.persist. -### Example: add dump_persist + For example: -```config -/opt/syslog-ng/bin/persist-tool add dump_persist -o . -``` + ``` shell + /opt/syslog-ng/bin/persist-tool add dump_persist -o . + ``` -A valid output is the following: + A valid output is the following: -```config -log_reader_curpos(Application) OK -affile_sd_curpos(/var/aaa.txt) OK -``` + ```config + log_reader_curpos(Application) OK + affile_sd_curpos(/var/aaa.txt) OK + ``` -An invalid output is the following: + An invalid output is the following: -```config -log_reader_curpos(Application) OK -wrong -FAILED (error: Invalid entry syntax) -affile_sd_curpos(/var/aaa.txt) OK -``` + ```config + log_reader_curpos(Application) OK + wrong + FAILED (error: Invalid entry syntax) + affile_sd_curpos(/var/aaa.txt) OK + ``` -## Files +## FILES /opt/syslog-ng/bin/persist-tool -## See also +## SEE ALSO -The syslog-ng.conf manual page +`syslog-ng.conf`(5) -The syslog-ng OSE manual page \ No newline at end of file +{% include doc/admin-guide/manpages-footnote.md %} \ No newline at end of file diff --git a/doc/_admin-guide/190_The_syslog-ng_manual_pages/006_syslog-ng_conf.md b/doc/_admin-guide/190_The_syslog-ng_manual_pages/006_syslog-ng_conf.md index 1caa979..437127e 100644 --- a/doc/_admin-guide/190_The_syslog-ng_manual_pages/006_syslog-ng_conf.md +++ b/doc/_admin-guide/190_The_syslog-ng_manual_pages/006_syslog-ng_conf.md @@ -13,11 +13,11 @@ description: >- syslog-ng.conf - {{ site.product.short_name }} configuration file --- -## Synopsis +## SYNOPSIS syslog-ng.conf -## Description +## DESCRIPTION This manual page is only an abstract. @@ -30,7 +30,7 @@ and collect the log messages from the various applications, files, and other sources. The clients send all important log messages to the remote {{ site.product.short_name }} PE server, where the server sorts and stores them. -## Basic concepts of {{ site.product.short_name }} +## BASIC CONCEPTS OF {{ site.product.short_name }} The {{ site.product.short_name }} application reads incoming messages and forwards them to the selected destinations. The {{ site.product.short_name }} application can receive @@ -57,7 +57,7 @@ and rewriting rules. Parsers segment messages into different fields to help processing the messages, while rewrite rules modify the messages by adding, replacing, or removing parts of the messages. -## Configuring {{ site.product.short_name }} +## CONFIGURING {{ site.product.short_name }} - The main body of the configuration file consists of object definitions: sources, destinations, logpaths define which log @@ -212,7 +212,7 @@ configuration file using the following syntax: options { option1(params); option2(params); ... }; ``` -### Example: Using global options +For example: To disable domain name resolving, add the following line to the {{ site.product.short_name }} configuration file: @@ -224,7 +224,7 @@ options { use-dns(no); }; The sources, destinations, and filters available in {{ site.product.short_name }} are listed below. -## Table 1: Source drivers available in {{ site.product.short_name }} +## TABLE 1: SOURCE DRIVERS AVAILABLE IN {{ site.product.short_name }} |Name |Description |---|--- @@ -248,7 +248,7 @@ listed below. |unix-stream() |Opens the specified unix socket in SOCK_STREAM mode and listens for incoming messages. |stdin() |Collects messages from the standard input stream. -## Table 2: Destination drivers available in syslog-ng +## TABLE 2: DESTINATION DRIVERS AVAILABLE IN {{ site.product.short_name }} |Name |Description |---|--- @@ -276,7 +276,7 @@ listed below. |unix-stream()| Sends messages to the specified unix socket in SOCK_STREAM style (Linux). |usertty()| Sends messages to the terminal of the specified user, if the user is logged in. -## Table 3: Filter functi|ons available in {{ site.product.short_name }} +## TABLE 3: FILTER FUNCTIONS AVAILABLE IN {{ site.product.short_name }} |Name |Description |---------------------------- |------------- @@ -292,7 +292,7 @@ listed below. |source()| | Select messages of the specified {{ site.product.short_name }} source statement. |tags()| | Select messages having the specified tag. -## Files +## FILES /opt/syslog-ng/ From 78f79b5db2786cb286fb42d889db651abafe541f Mon Sep 17 00:00:00 2001 From: "Zsolt Gyulai (zgyulai)" Date: Mon, 8 Sep 2025 12:32:21 +0200 Subject: [PATCH 2/5] Edited man pages forfuture porting. Signed-off-by: Zsolt Gyulai (zgyulai) --- .../001_dqtool_manual.md | 35 ++--- .../002_loggen_manual.md | 103 +++++++------- .../003_pdbtool_manual.md | 130 +++++++++--------- .../004_persist-tool_manual.md | 2 +- .../007_syslog-ng_control_tool_manual.md | 48 +++---- .../008_syslog-ng_debun_tool_manual.md | 52 +++---- .../010_slogkey_manual.md | 15 +- .../011_slogverify_manual.md | 14 +- .../012_secure_logging_manual.md | 20 +-- 9 files changed, 210 insertions(+), 209 deletions(-) diff --git a/doc/_admin-guide/190_The_syslog-ng_manual_pages/001_dqtool_manual.md b/doc/_admin-guide/190_The_syslog-ng_manual_pages/001_dqtool_manual.md index d8881a3..b472ef5 100644 --- a/doc/_admin-guide/190_The_syslog-ng_manual_pages/001_dqtool_manual.md +++ b/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=\ or -t +- `--template=