changeset 409:4219294c2930

Prepare the skeleton of man pages for all the configuration files used: - bsmdp2dma.conf - package-mapping.conf - pkgtools.conf
author Franz Glasner <fzglas.hg@dom66.de>
date Tue, 28 Feb 2023 09:22:26 +0100
parents bb0a0384b5da
children 6604ceca9d1d
files docs/conf.py docs/man/index.rst docs/man/man5/bsmtp2dma.conf.rst docs/man/man5/package-mapping.conf.rst docs/man/man5/pkgtools.conf.rst docs/man/man8/local-bsdtools.rst pkg-plist
diffstat 7 files changed, 57 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/docs/conf.py	Mon Feb 27 12:38:12 2023 +0100
+++ b/docs/conf.py	Tue Feb 28 09:22:26 2023 +0100
@@ -73,6 +73,9 @@
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
+    ("man/man5/bsmtp2dma.conf", "bsmtp2dma.conf", 'Configuration of bsmtp2dma', [author], 5),
+    ("man/man5/package-mapping.conf", "package-mapping.conf", 'Configuration of check-ports', [author], 5),
+    ("man/man5/pkgtools.conf", "pkgtools.conf", 'Configuration for pkgtools and check-ports', [author], 5),
     ("man/man5/local-bsdtools-periodic", "local-bsdtools-periodic", 'Configuration of periodic scripts installed by local-bsdtools v%s' % release, [author], 5),
     ("man/man8/local-bsdtools", "local-bsdtools", 'FreeBSD administration helper tools v%s' % release, [author], 8),
     ("man/man8/bsmtp2dma", "bsmtp2dma", "Bacula compatible mail submission program", [author], 8),
--- a/docs/man/index.rst	Mon Feb 27 12:38:12 2023 +0100
+++ b/docs/man/index.rst	Tue Feb 28 09:22:26 2023 +0100
@@ -37,4 +37,7 @@
 
 .. toctree::
 
+   man5/bsmtp2dma.conf
    man5/local-bsdtools-periodic
+   man5/package-mapping.conf
+   man5/pkgtools.conf
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/man/man5/bsmtp2dma.conf.rst	Tue Feb 28 09:22:26 2023 +0100
@@ -0,0 +1,15 @@
+.. -*- coding: utf-8; indent-tabs-mode: nil; -*-
+
+bsmtp2dma.conf
+==============
+
+Description
+-----------
+
+Used by :manpage:`bsmtp2dma(8)`.
+
+
+See Also
+--------
+
+:manpage:`bsmtp2dma(8)`
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/man/man5/package-mapping.conf.rst	Tue Feb 28 09:22:26 2023 +0100
@@ -0,0 +1,15 @@
+.. -*- coding: utf-8; indent-tabs-mode: nil; -*-
+
+package-mapping.conf
+====================
+
+Description
+-----------
+
+Used by :manpage:`check-ports(8)`.
+
+
+See Also
+--------
+
+:manpage:`check-ports(8)`
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/man/man5/pkgtools.conf.rst	Tue Feb 28 09:22:26 2023 +0100
@@ -0,0 +1,15 @@
+.. -*- coding: utf-8; indent-tabs-mode: nil; -*-
+
+pkgtools.conf
+=============
+
+Description
+-----------
+
+Sourced in by :manpage:`fpkg(8)` and :manpage:`check-ports(8)`.
+
+
+See Also
+--------
+
+:manpage:`check-ports(8)`, :manpage:`fpkg(8)`
--- a/docs/man/man8/local-bsdtools.rst	Mon Feb 27 12:38:12 2023 +0100
+++ b/docs/man/man8/local-bsdtools.rst	Tue Feb 28 09:22:26 2023 +0100
@@ -32,7 +32,10 @@
 See Also
 --------
 
+- :manpage:`bsmtp2dma.conf(5)`
 - :manpage:`local-bsdtools-periodic(5)`
+- :manpage:`package-mapping.conf(5)`
+- :manpage:`pkgtools.conf(5)`
 
 - :manpage:`bsmtp2dma(8)`
 - :manpage:`check-ports(8)`
--- a/pkg-plist	Mon Feb 27 12:38:12 2023 +0100
+++ b/pkg-plist	Tue Feb 28 09:22:26 2023 +0100
@@ -8,7 +8,10 @@
 sbin/ftjail
 sbin/fpkg
 sbin/fzfs
+%%DOCS%%man/man5/bsmtp2dma.conf.5.gz
 %%DOCS%%man/man5/local-bsdtools-periodic.5.gz
+%%DOCS%%man/man5/package-mapping.conf.5.gz
+%%DOCS%%man/man5/pkgtools.conf.5.gz
 %%DOCS%%man/man8/local-bsdtools.8.gz
 %%DOCS%%man/man8/bsmtp2dma.8.gz
 %%DOCS%%man/man8/check-ports.8.gz