.. -*- coding: utf-8; indent-tabs-mode: nil; -*-

.. local-bsdtools documentation master file, created by
   sphinx-quickstart on Sat Sep 17 21:32:09 2022.


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 regularly
- 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:`bsmtp2dma.conf(5)`
- :manpage:`local-bsdtools-periodic(5)`
- :manpage:`package-mapping.conf(5)`
- :manpage:`pkgtools.conf(5)`

- :manpage:`bsmtp2dma(8)`
- :manpage:`check-ports(8)`
- :manpage:`fjail(8)`

  * :manpage:`fjail-configure(8)`
  * :manpage:`fjail-copy(8)`
  * :manpage:`fjail-datasets(8)`
  * :manpage:`fjail-hostid(8)`
  * :manpage:`fjail-mount(8)`
  * :manpage:`fjail-populate(8)`
  * :manpage:`fjail-privs(8)`
  * :manpage:`fjail-umount(8)`

- :manpage:`fjail-copy(8)`

- :manpage:`ftjail(8)`

  * :manpage:`ftjail-build-etcupdate-current-tmpl(8)`
  * :manpage:`ftjail-check-freebsd-update(8)`    
  * :manpage:`ftjail-copy-skel(8)`
  * :manpage:`ftjail-datasets-tmpl(8)`
  * :manpage:`ftjail-freebsd-update(8)`
  * :manpage:`ftjail-interlink-tmpl(8)`
  * :manpage:`ftjail-mount-tmpl(8)`
  * :manpage:`ftjail-populate-tmpl(8)`
  * :manpage:`ftjail-snapshot-tmpl(8)`
  * :manpage:`ftjail-umount-tmpl(8)`

- :manpage:`fpkg(8)`

- :manpage:`fports(8)`  

- :manpage:`fbhyve(8)`

- :manpage:`fwireguard(8)`

- :manpage:`fzfs(8)`

  * :manpage:`fzfs-clone-tree(8)`
  * :manpage:`fzfs-copy-tree(8)`
  * :manpage:`fzfs-create-tree(8)`
  * :manpage:`fzfs-mount(8)`
  * :manpage:`fzfs-umount(8)`


Environment
-----------

Because the tools use different helper tools like :command:`zfs` or
:command:`pkg` the relevant environment variables according to this tools
also do apply generally.


History
-------

:Version: @(#)@@SIMPLEVERSIONTAG@@
:ID:      $HGid$