Mercurial > hgrepos > FreeBSD > ports > sysutils > local-bsdtools

changeset 395:64d73ad6e37d

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Begin a manpage for all install periodic scripts
author Franz Glasner <fzglas.hg@dom66.de>
date Fri, 24 Feb 2023 09:33:54 +0100
parents 7c597ee2c8d9
children def510fe4e31
files docs/conf.py docs/man/index8.rst docs/man/man8/local-bsdtools-periodic.rst docs/man/man8/local-bsdtools.rst pkg-plist
diffstat 5 files changed, 38 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/docs/conf.py	Fri Feb 24 01:07:19 2023 +0100
+++ b/docs/conf.py	Fri Feb 24 09:33:54 2023 +0100
@@ -74,6 +74,7 @@
 # (source start file, name, description, authors, manual section).
 man_pages = [
     ("man/man8/local-bsdtools", "local-bsdtools", 'FreeBSD administration helper tools v%s' % release, [author], 8),
+    ("man/man8/local-bsdtools-periodic", "local-bsdtools-periodic", 'Periodic scripts installed by local-bsdtools v%s' % release, [author], 8),
     ("man/man8/bsmtp2dma", "bsmtp2dma", "Bacula compatible mail submission program", [author], 8),
     ("man/man8/check-ports", "check-ports", "Report the version status of installed packages and check for them also in repositories", [author], 8),
     ("man/man8/fjail", "fjail", "Management of jails", [author], 8),
--- a/docs/man/index8.rst	Fri Feb 24 01:07:19 2023 +0100
+++ b/docs/man/index8.rst	Fri Feb 24 09:33:54 2023 +0100
@@ -9,6 +9,7 @@
 .. toctree::
 
    man8/local-bsdtools
+   man8/local-bsdtools-periodic
    man8/bsmtp2dma
    man8/check-ports
    man8/fjail
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/man/man8/local-bsdtools-periodic.rst	Fri Feb 24 09:33:54 2023 +0100
@@ -0,0 +1,33 @@
+.. -*- coding: utf-8; indent-tabs-mode: nil; -*-
+
+
+local-bsdtools-periodic
+=======================
+
+Synopsis
+--------
+
+**daily/720.local-triggered-action**
+
+**daily/750.local-trim-zfs**
+
+**daily/800.local-ipv6-refresh**
+
+
+Description
+-----------
+
+The package contains a set of daily periodic scripts to
+
+- automatically trim ZFS pools
+- update the IPv6 neighbour cache
+- handle (file-)triggered actions (e.g. to indirectly handle certbot
+  deploy actions)
+
+All the periodic scripts are disabled by default.
+
+
+See Also
+--------
+
+:manpage:`local-bsdtools(8)`, :manpage:`periodic(8)`
--- a/docs/man/man8/local-bsdtools.rst	Fri Feb 24 01:07:19 2023 +0100
+++ b/docs/man/man8/local-bsdtools.rst	Fri Feb 24 09:33:54 2023 +0100
@@ -32,6 +32,8 @@
 See Also
 --------
 
+- :manpage:`local-bsdtools-periodic(8)`
+
 - :manpage:`bsmtp2dma(8)`
 - :manpage:`check-ports(8)`
 - :manpage:`fjail(8)`
--- a/pkg-plist	Fri Feb 24 01:07:19 2023 +0100
+++ b/pkg-plist	Fri Feb 24 09:33:54 2023 +0100
@@ -9,6 +9,7 @@
 sbin/fpkg
 sbin/fzfs
 %%DOCS%%man/man8/local-bsdtools.8.gz
+%%DOCS%%man/man8/local-bsdtools-periodic.8.gz
 %%DOCS%%man/man8/bsmtp2dma.8.gz
 %%DOCS%%man/man8/check-ports.8.gz
 %%DOCS%%man/man8/fjail.8.gz