Skip to content

Commit 310c410

Browse files
HofiOneHofiOne
committed
manpages: update the manpages input markdown files
Signed-off-by: Hofi <hofione@gmail.com>
1 parent a1b6259 commit 310c410

16 files changed

+280
-232
lines changed

‎_data/link_aliases.yml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@
33
# Any not enclosed strings will be matched exactly like written.
44
#
55

6+
adm-guide:
7+
aliases: [ "/[Aa]dministration [Gg]uide/", "/[Aa]dministrator [Gg]uide/", "/syslog-ng OSE [Aa]dministration [Gg]uide", "/syslog-ng OSE [Aa]dministrator [Gg]uide" ]
8+
69
adm-temp-macro-ose:
710
aliases: [ "/[Mm]acros/" ]
811

‎_data/navigation.yml‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1068,29 +1068,29 @@ admin-guide-nav:
10681068
url: /admin-guide/190_The_syslog-ng_manual_pages/README
10691069
subnav:
10701070
- title: "The dqtool tool manual page"
1071-
url: /admin-guide/190_The_syslog-ng_manual_pages/000_dqtool
1071+
url: /admin-guide/190_The_syslog-ng_manual_pages/001_dqtool_manual
10721072
- title: "The loggen manual page"
1073-
url: /admin-guide/190_The_syslog-ng_manual_pages/001_loggen
1073+
url: /admin-guide/190_The_syslog-ng_manual_pages/002_loggen_manual
10741074
- title: "The pdbtool manual page"
1075-
url: /admin-guide/190_The_syslog-ng_manual_pages/002_pdbtool
1075+
url: /admin-guide/190_The_syslog-ng_manual_pages/003_pdbtool_manual
10761076
- title: "The secure-logging manual page"
1077-
url: /admin-guide/190_The_syslog-ng_manual_pages/003_secure_logging_manual
1077+
url: /admin-guide/190_The_syslog-ng_manual_pages/004_secure_logging_manual
10781078
- title: "The slogencrypt manual page"
1079-
url: /admin-guide/190_The_syslog-ng_manual_pages/004_slogencrypt_manual
1079+
url: /admin-guide/190_The_syslog-ng_manual_pages/005_slogencrypt_manual
10801080
- title: "The slogkey manual page"
1081-
url: /admin-guide/190_The_syslog-ng_manual_pages/005_slogkey_manual
1081+
url: /admin-guide/190_The_syslog-ng_manual_pages/006_slogkey_manual
10821082
- title: "The slogverify manual page"
1083-
url: /admin-guide/190_The_syslog-ng_manual_pages/006_slogverify_manual
1083+
url: /admin-guide/190_The_syslog-ng_manual_pages/007_slogverify_manual
10841084
- title: "The {{ site.product.short_name }} control tool manual page"
1085-
url: /admin-guide/190_The_syslog-ng_manual_pages/007_syslog-ng_control_tool
1085+
url: /admin-guide/190_The_syslog-ng_manual_pages/008_syslog-ng_control_tool_manual
10861086
- title: "The syslog-debun manual page"
1087-
url: /admin-guide/190_The_syslog-ng_manual_pages/008_syslog_debun_tool
1087+
url: /admin-guide/190_The_syslog-ng_manual_pages/009_syslog_debun_tool_manual
10881088
- title: "The {{ site.product.short_name }} manual page"
1089-
url: /admin-guide/190_The_syslog-ng_manual_pages/009_syslog-ng_manual
1089+
url: /admin-guide/190_The_syslog-ng_manual_pages/010_syslog-ng_manual
10901090
- title: "The syslog-ng.conf manual page"
1091-
url: /admin-guide/190_The_syslog-ng_manual_pages/010_syslog-ng_conf
1091+
url: /admin-guide/190_The_syslog-ng_manual_pages/011_syslog-ng_conf
10921092
- title: "The persist-tool manual page"
1093-
url: /admin-guide/190_The_syslog-ng_manual_pages/011_persist-tool
1093+
url: /admin-guide/190_The_syslog-ng_manual_pages/012_persist-tool_manual
10941094
- title: "About us"
10951095
url: /admin-guide/200_About/README
10961096
subnav:

‎_includes/doc/admin-guide/manpages-footnote.md‎

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,19 @@
1-
## See also
1+
**NOTE:**
2+
If you experience any problems or need help with {{ site.product.short_name }}, see the *{{ site.product.short_name }} Administration Guide*[1], or visit the *{{ site.product.short_name }} mailing list*[2].
3+
For news and notifications about {{ site.product.short_name }}, visit the *{{ site.product.short_name }} blogs*[3].
4+
{: .notice--info}
25

3-
The syslog-ng.conf manual page
4-
The {{ site.product.short_name }} manual page
6+
## AUTHOR
7+
This manual page was generated from the *{{ site.product.short_name }} Administration Guide*[1], which was written by several contributors to whom we'd like to extend our sincere thanks.
58

6-
>**NOTE:**
7-
>If you experience any problems or need help with {{ site.product.short_name }}, visit
8-
>the {{ site.product.short_name }} mailing list.
9-
>
10-
>For news and notifications about {{ site.product.short_name }}, visit the syslog-ng blogs.
11-
{: .notice--info}
9+
## COPYRIGHT
10+
## NOTES
11+
12+
[1] `{{ site.product.short_name }} Administration Guide`
13+
https://syslog-ng.github.io/admin-guide/README
14+
15+
[2] `{{ site.product.short_name }} mailing list`
16+
https://lists.balabit.hu/mailman/listinfo/syslog-ng
17+
18+
[3] `{{ site.product.short_name }} blogs`
19+
https://syslog-ng.com/blog/

doc/_admin-guide/190_The_syslog-ng_manual_pages/000_dqtool.md renamed to doc/_admin-guide/190_The_syslog-ng_manual_pages/001_dqtool_manual.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,14 @@
11
---
2+
# NOTE: In case of manpages these have multiple purpose
3+
# - manid -> if presented, the page treated as a manpage, also represents the section number of the command in the manpage
4+
# - manname -> will be rendered as the name of the command followed by manid as the section number in the manpage
5+
# - title -> will be rendered as description / manual name. (the .TH macro’s 4th argument (the “manual name”).
6+
# - description -> will be rendered as a top NAME section in the manpage
7+
#
28
title: The dqtool tool manual page
39
app: dqtool
10+
manid: 1
11+
manname: dqtool
412
id: adm-man-dqtool
513
description: >-
614
dqtool --- Display the contents of a disk-buffer file created with

doc/_admin-guide/190_The_syslog-ng_manual_pages/001_loggen.md renamed to doc/_admin-guide/190_The_syslog-ng_manual_pages/002_loggen_manual.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,15 @@
11
---
2+
# NOTE: In case of manpages these have multiple purpose
3+
# - manid -> if presented, the page treated as a manpage, also represents the section number of the command in the manpage
4+
# - manname -> will be rendered as the name of the command followed by manid as the section number in the manpage
5+
# - title -> will be rendered as description / manual name. (the .TH macro’s 4th argument (the “manual name”).
6+
# - description -> will be rendered as a top NAME section in the manpage
7+
#
28
title: The loggen manual page
39
app: loggen
410
id: adm-man-loggen
11+
manid: 2
12+
manname: loggen
513
description: >-
614
loggen --- Generate syslog messages at a specified rate
715
---

doc/_admin-guide/190_The_syslog-ng_manual_pages/002_pdbtool.md renamed to doc/_admin-guide/190_The_syslog-ng_manual_pages/003_pdbtool_manual.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,14 @@
11
---
2+
# NOTE: In case of manpages these have multiple purpose
3+
# - manid -> if presented, the page treated as a manpage, also represents the section number of the command in the manpage
4+
# - manname -> will be rendered as the name of the command followed by manid as the section number in the manpage
5+
# - title -> will be rendered as description / manual name. (the .TH macro’s 4th argument (the “manual name”).
6+
# - description -> will be rendered as a top NAME section in the manpage
7+
#
28
title: The pdbtool manual page
39
id: adm-man-pdbtool
10+
manid: 3
11+
manname: pdbtool
412
description: >-
513
pdbtool --- An application to test and convert {{ site.product.short_name }} pattern
614
database rules

doc/_admin-guide/190_The_syslog-ng_manual_pages/003_secure_logging_manual.md renamed to doc/_admin-guide/190_The_syslog-ng_manual_pages/004_secure_logging_manual.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,14 @@
11
---
2+
# NOTE: In case of manpages these have multiple purpose
3+
# - manid -> if presented, the page treated as a manpage, also represents the section number of the command in the manpage
4+
# - manname -> will be rendered as the name of the command followed by manid as the section number in the manpage
5+
# - title -> will be rendered as description / manual name. (the .TH macro’s 4th argument (the “manual name”).
6+
# - description -> will be rendered as a top NAME section in the manpage
7+
#
28
title: The secure-logging manual page
39
id: adm-man-sec-log
10+
manid: 4
11+
manname: slog
412
description: >-
513
secure-logging --- Provides forward integrity and confidentiality for system logs.
614
---

doc/_admin-guide/190_The_syslog-ng_manual_pages/004_slogencrypt_manual.md renamed to doc/_admin-guide/190_The_syslog-ng_manual_pages/005_slogencrypt_manual.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,14 @@
11
---
2+
# NOTE: In case of manpages these have multiple purpose
3+
# - manid -> if presented, the page treated as a manpage, also represents the section number of the command in the manpage
4+
# - manname -> will be rendered as the name of the command followed by manid as the section number in the manpage
5+
# - title -> will be rendered as description / manual name. (the .TH macro’s 4th argument (the “manual name”).
6+
# - description -> will be rendered as a top NAME section in the manpage
7+
#
28
title: The slogencrypt manual page
39
id: adm-man-slogscr
10+
manid: 5
11+
manname: slogencrypt
412
description: >-
513
slogencrypt --- Encrypts existing plain text log files using the {{ site.product.short_name }} secure logging environment.
614
---

doc/_admin-guide/190_The_syslog-ng_manual_pages/005_slogkey_manual.md renamed to doc/_admin-guide/190_The_syslog-ng_manual_pages/006_slogkey_manual.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,14 @@
11
---
2+
# NOTE: In case of manpages these have multiple purpose
3+
# - manid -> if presented, the page treated as a manpage, also represents the section number of the command in the manpage
4+
# - manname -> will be rendered as the name of the command followed by manid as the section number in the manpage
5+
# - title -> will be rendered as description / manual name. (the .TH macro’s 4th argument (the “manual name”).
6+
# - description -> will be rendered as a top NAME section in the manpage
7+
#
28
title: The slogkey manual page
39
id: adm-man-slogkey
10+
manid: 6
11+
manname: slogkey
412
description: >-
513
slogkey --- Manages the cryptographic keys for use with the {{ site.product.short_name }} secure logging environment.
614
---

doc/_admin-guide/190_The_syslog-ng_manual_pages/006_slogverify_manual.md renamed to doc/_admin-guide/190_The_syslog-ng_manual_pages/007_slogverify_manual.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,14 @@
11
---
2+
# NOTE: In case of manpages these have multiple purpose
3+
# - manid -> if presented, the page treated as a manpage, also represents the section number of the command in the manpage
4+
# - manname -> will be rendered as the name of the command followed by manid as the section number in the manpage
5+
# - title -> will be rendered as description / manual name. (the .TH macro’s 4th argument (the “manual name”).
6+
# - description -> will be rendered as a top NAME section in the manpage
7+
#
28
title: The slogverify manual page
39
id: adm-man-slogver
10+
manid: 7
11+
manname: slogverify
412
description: >-
513
slogverify --- Verifies cryptographically secured logs.
614
---

0 commit comments

Comments
 (0)