changeset 370:6d62096c3714

Give a overview description in local-bsdtools(8)
author Franz Glasner <fzglas.hg@dom66.de>
date Sat, 18 Feb 2023 17:45:40 +0100
parents 3a902f0d3351
children 910d0bd96ebe
files docs/man/man8/local-bsdtools.rst
diffstat 1 files changed, 22 insertions(+), 3 deletions(-) [+]
line wrap: on
line diff
--- a/docs/man/man8/local-bsdtools.rst	Sat Feb 18 17:30:38 2023 +0100
+++ b/docs/man/man8/local-bsdtools.rst	Sat Feb 18 17:45:40 2023 +0100
@@ -7,6 +7,25 @@
 local-bsdtools
 ==============
 
+Description
+-----------
+
+A collection of helper tools specific for FreeBSD.
+
+They help with
+
+- managing the installed ports and packages
+- creating, installing and updating jails
+- creating, installing and updating "thin jails"
+- recursively mounting of ZFS dataset hierarchies
+
+The package contains also a set of (daily) periodic scripts to
+
+- trim ZFS pools
+- update the IPv6 neighbour cache
+
+The periodic scripts are disabled by default.
+
 
 See Also
 --------
@@ -16,7 +35,7 @@
 - :manpage:`fjail(8)`
 
   * :manpage:`fjail-configure(8)`
-  * :manpage:`fjail-copy(8)`    
+  * :manpage:`fjail-copy(8)`
   * :manpage:`fjail-datasets(8)`
   * :manpage:`fjail-hostid(8)`
   * :manpage:`fjail-mount(8)`
@@ -25,10 +44,10 @@
   * :manpage:`fjail-umount(8)`
 
 - :manpage:`fjail-copy(8)`
-    
+
 - :manpage:`ftjail(8)`
 
-  * :manpage:`ftjail-build-etcupdate-current-tmpl(8)`  
+  * :manpage:`ftjail-build-etcupdate-current-tmpl(8)`
   * :manpage:`ftjail-copy-skel(8)`
   * :manpage:`ftjail-datasets-tmpl(8)`
   * :manpage:`ftjail-interlink-tmpl(8)`