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

annotate docs/man/man8/local-bsdtools.rst @ 462:bfa134565e0e

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Begin the manual pages for fwireguard
author Franz Glasner <fzglas.hg@dom66.de>
date Tue, 11 Jun 2024 09:44:10 +0200
parents bf0d63c8e682
children 6ecd16725818
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
283
1fc3b04b39fa Build and package manual pages for fzfs, fzfs-mount and fzfs-umount.
Franz Glasner <fzglas.hg@dom66.de>
parents: 279
diff changeset
1 .. -*- coding: utf-8; indent-tabs-mode: nil; -*-
1fc3b04b39fa Build and package manual pages for fzfs, fzfs-mount and fzfs-umount.
Franz Glasner <fzglas.hg@dom66.de>
parents: 279
diff changeset
2
279
86d8929e4747 Add the Sphinx documentation sources as generated by sphinx-quickstart
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
3 .. local-bsdtools documentation master file, created by
86d8929e4747 Add the Sphinx documentation sources as generated by sphinx-quickstart
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
4 sphinx-quickstart on Sat Sep 17 21:32:09 2022.
283
1fc3b04b39fa Build and package manual pages for fzfs, fzfs-mount and fzfs-umount.
Franz Glasner <fzglas.hg@dom66.de>
parents: 279
diff changeset
5
279
86d8929e4747 Add the Sphinx documentation sources as generated by sphinx-quickstart
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
6
283
1fc3b04b39fa Build and package manual pages for fzfs, fzfs-mount and fzfs-umount.
Franz Glasner <fzglas.hg@dom66.de>
parents: 279
diff changeset
7 local-bsdtools
1fc3b04b39fa Build and package manual pages for fzfs, fzfs-mount and fzfs-umount.
Franz Glasner <fzglas.hg@dom66.de>
parents: 279
diff changeset
8 ==============
279
86d8929e4747 Add the Sphinx documentation sources as generated by sphinx-quickstart
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
9
370
6d62096c3714 Give a overview description in local-bsdtools(8)
Franz Glasner <fzglas.hg@dom66.de>
parents: 369
diff changeset
10 Description
6d62096c3714 Give a overview description in local-bsdtools(8)
Franz Glasner <fzglas.hg@dom66.de>
parents: 369
diff changeset
11 -----------
6d62096c3714 Give a overview description in local-bsdtools(8)
Franz Glasner <fzglas.hg@dom66.de>
parents: 369
diff changeset
12
6d62096c3714 Give a overview description in local-bsdtools(8)
Franz Glasner <fzglas.hg@dom66.de>
parents: 369
diff changeset
13 A collection of helper tools specific for FreeBSD.
6d62096c3714 Give a overview description in local-bsdtools(8)
Franz Glasner <fzglas.hg@dom66.de>
parents: 369
diff changeset
14
6d62096c3714 Give a overview description in local-bsdtools(8)
Franz Glasner <fzglas.hg@dom66.de>
parents: 369
diff changeset
15 They help with
6d62096c3714 Give a overview description in local-bsdtools(8)
Franz Glasner <fzglas.hg@dom66.de>
parents: 369
diff changeset
16
6d62096c3714 Give a overview description in local-bsdtools(8)
Franz Glasner <fzglas.hg@dom66.de>
parents: 369
diff changeset
17 - managing the installed ports and packages
6d62096c3714 Give a overview description in local-bsdtools(8)
Franz Glasner <fzglas.hg@dom66.de>
parents: 369
diff changeset
18 - creating, installing and updating jails
6d62096c3714 Give a overview description in local-bsdtools(8)
Franz Glasner <fzglas.hg@dom66.de>
parents: 369
diff changeset
19 - creating, installing and updating "thin jails"
6d62096c3714 Give a overview description in local-bsdtools(8)
Franz Glasner <fzglas.hg@dom66.de>
parents: 369
diff changeset
20 - recursively mounting of ZFS dataset hierarchies
6d62096c3714 Give a overview description in local-bsdtools(8)
Franz Glasner <fzglas.hg@dom66.de>
parents: 369
diff changeset
21
387
9921352225a9 Weekly periodic script to execute an action when any of given files are readable.
Franz Glasner <fzglas.hg@dom66.de>
parents: 386
diff changeset
22 The package contains also a set of daily periodic scripts to
370
6d62096c3714 Give a overview description in local-bsdtools(8)
Franz Glasner <fzglas.hg@dom66.de>
parents: 369
diff changeset
23
402
1ccd7bf1ed06 Make ZFS uppercased in output messages and in the documentation
Franz Glasner <fzglas.hg@dom66.de>
parents: 395
diff changeset
24 - trim ZFS pools regularly
370
6d62096c3714 Give a overview description in local-bsdtools(8)
Franz Glasner <fzglas.hg@dom66.de>
parents: 369
diff changeset
25 - update the IPv6 neighbour cache
391
8b1740deedbb Refactor: Renamed the weekly 800.local-certbot-post-deploy to a daily 720.local-triggered-action.
Franz Glasner <fzglas.hg@dom66.de>
parents: 387
diff changeset
26 - handle (file-)triggered actions (e.g. to indirectly handle certbot
8b1740deedbb Refactor: Renamed the weekly 800.local-certbot-post-deploy to a daily 720.local-triggered-action.
Franz Glasner <fzglas.hg@dom66.de>
parents: 387
diff changeset
27 deploy actions)
387
9921352225a9 Weekly periodic script to execute an action when any of given files are readable.
Franz Glasner <fzglas.hg@dom66.de>
parents: 386
diff changeset
28
9921352225a9 Weekly periodic script to execute an action when any of given files are readable.
Franz Glasner <fzglas.hg@dom66.de>
parents: 386
diff changeset
29 All the periodic scripts are disabled by default.
370
6d62096c3714 Give a overview description in local-bsdtools(8)
Franz Glasner <fzglas.hg@dom66.de>
parents: 369
diff changeset
30
279
86d8929e4747 Add the Sphinx documentation sources as generated by sphinx-quickstart
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
31
283
1fc3b04b39fa Build and package manual pages for fzfs, fzfs-mount and fzfs-umount.
Franz Glasner <fzglas.hg@dom66.de>
parents: 279
diff changeset
32 See Also
1fc3b04b39fa Build and package manual pages for fzfs, fzfs-mount and fzfs-umount.
Franz Glasner <fzglas.hg@dom66.de>
parents: 279
diff changeset
33 --------
279
86d8929e4747 Add the Sphinx documentation sources as generated by sphinx-quickstart
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
34
409
4219294c2930 Prepare the skeleton of man pages for all the configuration files used:
Franz Glasner <fzglas.hg@dom66.de>
parents: 404
diff changeset
35 - :manpage:`bsmtp2dma.conf(5)`
404
6c0c9159744d Move the manual pages for the periodic scripts into man secition 5
Franz Glasner <fzglas.hg@dom66.de>
parents: 402
diff changeset
36 - :manpage:`local-bsdtools-periodic(5)`
409
4219294c2930 Prepare the skeleton of man pages for all the configuration files used:
Franz Glasner <fzglas.hg@dom66.de>
parents: 404
diff changeset
37 - :manpage:`package-mapping.conf(5)`
4219294c2930 Prepare the skeleton of man pages for all the configuration files used:
Franz Glasner <fzglas.hg@dom66.de>
parents: 404
diff changeset
38 - :manpage:`pkgtools.conf(5)`
395
64d73ad6e37d Begin a manpage for all install periodic scripts
Franz Glasner <fzglas.hg@dom66.de>
parents: 391
diff changeset
39
284
106cd5d9da7e Put all manual pages into section 8 (FreeBSD System Manager's Manual)
Franz Glasner <fzglas.hg@dom66.de>
parents: 283
diff changeset
40 - :manpage:`bsmtp2dma(8)`
106cd5d9da7e Put all manual pages into section 8 (FreeBSD System Manager's Manual)
Franz Glasner <fzglas.hg@dom66.de>
parents: 283
diff changeset
41 - :manpage:`check-ports(8)`
106cd5d9da7e Put all manual pages into section 8 (FreeBSD System Manager's Manual)
Franz Glasner <fzglas.hg@dom66.de>
parents: 283
diff changeset
42 - :manpage:`fjail(8)`
315
9c5b76df4f9d Begin manual pages for the "fjail" command
Franz Glasner <fzglas.hg@dom66.de>
parents: 314
diff changeset
43
9c5b76df4f9d Begin manual pages for the "fjail" command
Franz Glasner <fzglas.hg@dom66.de>
parents: 314
diff changeset
44 * :manpage:`fjail-configure(8)`
370
6d62096c3714 Give a overview description in local-bsdtools(8)
Franz Glasner <fzglas.hg@dom66.de>
parents: 369
diff changeset
45 * :manpage:`fjail-copy(8)`
315
9c5b76df4f9d Begin manual pages for the "fjail" command
Franz Glasner <fzglas.hg@dom66.de>
parents: 314
diff changeset
46 * :manpage:`fjail-datasets(8)`
9c5b76df4f9d Begin manual pages for the "fjail" command
Franz Glasner <fzglas.hg@dom66.de>
parents: 314
diff changeset
47 * :manpage:`fjail-hostid(8)`
9c5b76df4f9d Begin manual pages for the "fjail" command
Franz Glasner <fzglas.hg@dom66.de>
parents: 314
diff changeset
48 * :manpage:`fjail-mount(8)`
9c5b76df4f9d Begin manual pages for the "fjail" command
Franz Glasner <fzglas.hg@dom66.de>
parents: 314
diff changeset
49 * :manpage:`fjail-populate(8)`
9c5b76df4f9d Begin manual pages for the "fjail" command
Franz Glasner <fzglas.hg@dom66.de>
parents: 314
diff changeset
50 * :manpage:`fjail-privs(8)`
9c5b76df4f9d Begin manual pages for the "fjail" command
Franz Glasner <fzglas.hg@dom66.de>
parents: 314
diff changeset
51 * :manpage:`fjail-umount(8)`
9c5b76df4f9d Begin manual pages for the "fjail" command
Franz Glasner <fzglas.hg@dom66.de>
parents: 314
diff changeset
52
369
3a902f0d3351 FIX: Consistently format the list in local-bsdtools(8)
Franz Glasner <fzglas.hg@dom66.de>
parents: 315
diff changeset
53 - :manpage:`fjail-copy(8)`
370
6d62096c3714 Give a overview description in local-bsdtools(8)
Franz Glasner <fzglas.hg@dom66.de>
parents: 369
diff changeset
54
284
106cd5d9da7e Put all manual pages into section 8 (FreeBSD System Manager's Manual)
Franz Glasner <fzglas.hg@dom66.de>
parents: 283
diff changeset
55 - :manpage:`ftjail(8)`
303
2ad545b9031c FIX: Add missing subcommand manpages to the local-bsdtools(8) manpage
Franz Glasner <fzglas.hg@dom66.de>
parents: 294
diff changeset
56
370
6d62096c3714 Give a overview description in local-bsdtools(8)
Franz Glasner <fzglas.hg@dom66.de>
parents: 369
diff changeset
57 * :manpage:`ftjail-build-etcupdate-current-tmpl(8)`
303
2ad545b9031c FIX: Add missing subcommand manpages to the local-bsdtools(8) manpage
Franz Glasner <fzglas.hg@dom66.de>
parents: 294
diff changeset
58 * :manpage:`ftjail-copy-skel(8)`
2ad545b9031c FIX: Add missing subcommand manpages to the local-bsdtools(8) manpage
Franz Glasner <fzglas.hg@dom66.de>
parents: 294
diff changeset
59 * :manpage:`ftjail-datasets-tmpl(8)`
371
910d0bd96ebe FIX: Add ftjail-frebsd-update(8) into local-bsdtools(8) also
Franz Glasner <fzglas.hg@dom66.de>
parents: 370
diff changeset
60 * :manpage:`ftjail-freebsd-update(8)`
303
2ad545b9031c FIX: Add missing subcommand manpages to the local-bsdtools(8) manpage
Franz Glasner <fzglas.hg@dom66.de>
parents: 294
diff changeset
61 * :manpage:`ftjail-interlink-tmpl(8)`
2ad545b9031c FIX: Add missing subcommand manpages to the local-bsdtools(8) manpage
Franz Glasner <fzglas.hg@dom66.de>
parents: 294
diff changeset
62 * :manpage:`ftjail-mount-tmpl(8)`
307
23bcbbbd99ea FIX: Rename "ftjail-populate.rst" to "ftjail-populate-tmpl"
Franz Glasner <fzglas.hg@dom66.de>
parents: 303
diff changeset
63 * :manpage:`ftjail-populate-tmpl(8)`
303
2ad545b9031c FIX: Add missing subcommand manpages to the local-bsdtools(8) manpage
Franz Glasner <fzglas.hg@dom66.de>
parents: 294
diff changeset
64 * :manpage:`ftjail-snapshot-tmpl(8)`
2ad545b9031c FIX: Add missing subcommand manpages to the local-bsdtools(8) manpage
Franz Glasner <fzglas.hg@dom66.de>
parents: 294
diff changeset
65 * :manpage:`ftjail-umount-tmpl(8)`
2ad545b9031c FIX: Add missing subcommand manpages to the local-bsdtools(8) manpage
Franz Glasner <fzglas.hg@dom66.de>
parents: 294
diff changeset
66
284
106cd5d9da7e Put all manual pages into section 8 (FreeBSD System Manager's Manual)
Franz Glasner <fzglas.hg@dom66.de>
parents: 283
diff changeset
67 - :manpage:`fpkg(8)`
462
bfa134565e0e Begin the manual pages for fwireguard
Franz Glasner <fzglas.hg@dom66.de>
parents: 420
diff changeset
68
bfa134565e0e Begin the manual pages for fwireguard
Franz Glasner <fzglas.hg@dom66.de>
parents: 420
diff changeset
69 - :manpage:`fwireguard(8)`
bfa134565e0e Begin the manual pages for fwireguard
Franz Glasner <fzglas.hg@dom66.de>
parents: 420
diff changeset
70
284
106cd5d9da7e Put all manual pages into section 8 (FreeBSD System Manager's Manual)
Franz Glasner <fzglas.hg@dom66.de>
parents: 283
diff changeset
71 - :manpage:`fzfs(8)`
279
86d8929e4747 Add the Sphinx documentation sources as generated by sphinx-quickstart
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
72
420
bf0d63c8e682 Begin fzfs-copy-tree: man page structure done
Franz Glasner <fzglas.hg@dom66.de>
parents: 409
diff changeset
73 * :manpage:`fzfs-copy-tree(8)`
380
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents: 371
diff changeset
74 * :manpage:`fzfs-create-tree(8)`
284
106cd5d9da7e Put all manual pages into section 8 (FreeBSD System Manager's Manual)
Franz Glasner <fzglas.hg@dom66.de>
parents: 283
diff changeset
75 * :manpage:`fzfs-mount(8)`
106cd5d9da7e Put all manual pages into section 8 (FreeBSD System Manager's Manual)
Franz Glasner <fzglas.hg@dom66.de>
parents: 283
diff changeset
76 * :manpage:`fzfs-umount(8)`
283
1fc3b04b39fa Build and package manual pages for fzfs, fzfs-mount and fzfs-umount.
Franz Glasner <fzglas.hg@dom66.de>
parents: 279
diff changeset
77
1fc3b04b39fa Build and package manual pages for fzfs, fzfs-mount and fzfs-umount.
Franz Glasner <fzglas.hg@dom66.de>
parents: 279
diff changeset
78
1fc3b04b39fa Build and package manual pages for fzfs, fzfs-mount and fzfs-umount.
Franz Glasner <fzglas.hg@dom66.de>
parents: 279
diff changeset
79 Environment
1fc3b04b39fa Build and package manual pages for fzfs, fzfs-mount and fzfs-umount.
Franz Glasner <fzglas.hg@dom66.de>
parents: 279
diff changeset
80 -----------
1fc3b04b39fa Build and package manual pages for fzfs, fzfs-mount and fzfs-umount.
Franz Glasner <fzglas.hg@dom66.de>
parents: 279
diff changeset
81
1fc3b04b39fa Build and package manual pages for fzfs, fzfs-mount and fzfs-umount.
Franz Glasner <fzglas.hg@dom66.de>
parents: 279
diff changeset
82 Because the tools use different helper tools like :command:`zfs` or
1fc3b04b39fa Build and package manual pages for fzfs, fzfs-mount and fzfs-umount.
Franz Glasner <fzglas.hg@dom66.de>
parents: 279
diff changeset
83 :command:`pkg` the relevant environment variables according to this tools
314
90c512baf109 Wording
Franz Glasner <fzglas.hg@dom66.de>
parents: 308
diff changeset
84 also do apply generally.
385
d058f55fffea Expand some keyword in the mail manual page also
Franz Glasner <fzglas.hg@dom66.de>
parents: 380
diff changeset
85
d058f55fffea Expand some keyword in the mail manual page also
Franz Glasner <fzglas.hg@dom66.de>
parents: 380
diff changeset
86
d058f55fffea Expand some keyword in the mail manual page also
Franz Glasner <fzglas.hg@dom66.de>
parents: 380
diff changeset
87 History
d058f55fffea Expand some keyword in the mail manual page also
Franz Glasner <fzglas.hg@dom66.de>
parents: 380
diff changeset
88 -------
d058f55fffea Expand some keyword in the mail manual page also
Franz Glasner <fzglas.hg@dom66.de>
parents: 380
diff changeset
89
386
84d2735fe7f6 Simplified version tagging a lot: it is also faster now.
Franz Glasner <fzglas.hg@dom66.de>
parents: 385
diff changeset
90 :Version: @(#)@@SIMPLEVERSIONTAG@@
385
d058f55fffea Expand some keyword in the mail manual page also
Franz Glasner <fzglas.hg@dom66.de>
parents: 380
diff changeset
91 :ID: $HGid$