annotate docs/man/index.rst @ 723:a97ec3f07bdb

farray.sh: REFACTOR: More flexible metadata retrieval. Using an array or alist variable name or token value (with prefix) is now supported in every function. This is possible because the value prefixes contain questin marks (?) which are not allowed in shell variable names. This again is a major precondition for recursive data structures (arrays/alists in arrays/alists).
author Franz Glasner <fzglas.hg@dom66.de>
date Sat, 05 Oct 2024 21:55:55 +0200
parents 260a81d769a6
children 56ab5c012d5f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
286
258a1dfd52eb Separate manual page documentation and "normal" HTML documentation.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
1 .. -*- coding: utf-8; indent-tabs-mode: nil; -*-
258a1dfd52eb Separate manual page documentation and "normal" HTML documentation.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
2
288
c9f14ccd581e Wording in documentation title
Franz Glasner <fzglas.hg@dom66.de>
parents: 286
diff changeset
3 Collection of Manual Pages
c9f14ccd581e Wording in documentation title
Franz Glasner <fzglas.hg@dom66.de>
parents: 286
diff changeset
4 ==========================
286
258a1dfd52eb Separate manual page documentation and "normal" HTML documentation.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
5
295
11e6e3442df0 Manual page for "ftjail snapshot-tmpl"
Franz Glasner <fzglas.hg@dom66.de>
parents: 294
diff changeset
6 System Administration Tools
11e6e3442df0 Manual page for "ftjail snapshot-tmpl"
Franz Glasner <fzglas.hg@dom66.de>
parents: 294
diff changeset
7 ---------------------------
11e6e3442df0 Manual page for "ftjail snapshot-tmpl"
Franz Glasner <fzglas.hg@dom66.de>
parents: 294
diff changeset
8
286
258a1dfd52eb Separate manual page documentation and "normal" HTML documentation.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
9 .. toctree::
258a1dfd52eb Separate manual page documentation and "normal" HTML documentation.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
10
294
c2e2fed957ed - Compute a dynmic list of manual pages
Franz Glasner <fzglas.hg@dom66.de>
parents: 293
diff changeset
11 man8/local-bsdtools
317
ebe98c3b0835 A manpage for bsmtp2dma.
Franz Glasner <fzglas.hg@dom66.de>
parents: 315
diff changeset
12 man8/bsmtp2dma
349
f98622ae852c Begin the manual page for check-ports.
Franz Glasner <fzglas.hg@dom66.de>
parents: 347
diff changeset
13 man8/check-ports
467
6ecd16725818 Begin refactoring bhyve into fbhyve.
Franz Glasner <fzglas.hg@dom66.de>
parents: 462
diff changeset
14 man8/fbhyve
315
9c5b76df4f9d Begin manual pages for the "fjail" command
Franz Glasner <fzglas.hg@dom66.de>
parents: 308
diff changeset
15 man8/fjail
327
37eb955f2395 FIX: Put fjail-hostid and fjail-configure into the Sphinx index also
Franz Glasner <hg@dom66.de>
parents: 321
diff changeset
16 man8/fjail-configure
347
673505e96cea Implement a "fjail freebsd-update": update "normal" jails and other directories where an OS is mounted
Franz Glasner <hg@dom66.de>
parents: 334
diff changeset
17 man8/fjail-freebsd-update
327
37eb955f2395 FIX: Put fjail-hostid and fjail-configure into the Sphinx index also
Franz Glasner <hg@dom66.de>
parents: 321
diff changeset
18 man8/fjail-hostid
321
1f457667f0e7 Begin a more detailed manual page for "fpkg"
Franz Glasner <fzglas.hg@dom66.de>
parents: 317
diff changeset
19 man8/fpkg
462
bfa134565e0e Begin the manual pages for fwireguard
Franz Glasner <fzglas.hg@dom66.de>
parents: 420
diff changeset
20 man8/fwireguard
294
c2e2fed957ed - Compute a dynmic list of manual pages
Franz Glasner <fzglas.hg@dom66.de>
parents: 293
diff changeset
21 man8/ftjail
308
2102b46566f0 Implement "ftjail build-etcupdate-curent-tmpl".
Franz Glasner <fzglas.hg@dom66.de>
parents: 307
diff changeset
22 man8/ftjail-build-etcupdate-current-tmpl
658
260a81d769a6 Implemented "ftjail check-freebsd-update": thorough check for preconditions to a successful run of "ftjail freebsd-update".
Franz Glasner <fzglas.hg@dom66.de>
parents: 520
diff changeset
23 man8/ftjail-check-freebsd-update
294
c2e2fed957ed - Compute a dynmic list of manual pages
Franz Glasner <fzglas.hg@dom66.de>
parents: 293
diff changeset
24 man8/ftjail-copy-skel
300
901b0e3c0dab All manual pages for ftjail done
Franz Glasner <fzglas.hg@dom66.de>
parents: 297
diff changeset
25 man8/ftjail-datasets-tmpl
334
fdbb78c54ffb Begin the "ftjail freebsd-update" command
Franz Glasner <fzglas.hg@dom66.de>
parents: 327
diff changeset
26 man8/ftjail-freebsd-update
300
901b0e3c0dab All manual pages for ftjail done
Franz Glasner <fzglas.hg@dom66.de>
parents: 297
diff changeset
27 man8/ftjail-interlink-tmpl
327
37eb955f2395 FIX: Put fjail-hostid and fjail-configure into the Sphinx index also
Franz Glasner <hg@dom66.de>
parents: 321
diff changeset
28 man8/ftjail-mount-tmpl
307
23bcbbbd99ea FIX: Rename "ftjail-populate.rst" to "ftjail-populate-tmpl"
Franz Glasner <fzglas.hg@dom66.de>
parents: 300
diff changeset
29 man8/ftjail-populate-tmpl
295
11e6e3442df0 Manual page for "ftjail snapshot-tmpl"
Franz Glasner <fzglas.hg@dom66.de>
parents: 294
diff changeset
30 man8/ftjail-snapshot-tmpl
327
37eb955f2395 FIX: Put fjail-hostid and fjail-configure into the Sphinx index also
Franz Glasner <hg@dom66.de>
parents: 321
diff changeset
31 man8/ftjail-umount-tmpl
294
c2e2fed957ed - Compute a dynmic list of manual pages
Franz Glasner <fzglas.hg@dom66.de>
parents: 293
diff changeset
32 man8/fzfs
520
7d08fd78775c fzfs: implement "fzfs clone-tree".
Franz Glasner <fzglas.hg@dom66.de>
parents: 467
diff changeset
33 man8/fzfs-clone-tree
420
bf0d63c8e682 Begin fzfs-copy-tree: man page structure done
Franz Glasner <fzglas.hg@dom66.de>
parents: 409
diff changeset
34 man8/fzfs-copy-tree
380
6be930eb7490 Implement the "fzfs create-tree" command
Franz Glasner <fzglas.hg@dom66.de>
parents: 349
diff changeset
35 man8/fzfs-create-tree
294
c2e2fed957ed - Compute a dynmic list of manual pages
Franz Glasner <fzglas.hg@dom66.de>
parents: 293
diff changeset
36 man8/fzfs-mount
c2e2fed957ed - Compute a dynmic list of manual pages
Franz Glasner <fzglas.hg@dom66.de>
parents: 293
diff changeset
37 man8/fzfs-umount
404
6c0c9159744d Move the manual pages for the periodic scripts into man secition 5
Franz Glasner <fzglas.hg@dom66.de>
parents: 395
diff changeset
38
6c0c9159744d Move the manual pages for the periodic scripts into man secition 5
Franz Glasner <fzglas.hg@dom66.de>
parents: 395
diff changeset
39
6c0c9159744d Move the manual pages for the periodic scripts into man secition 5
Franz Glasner <fzglas.hg@dom66.de>
parents: 395
diff changeset
40 Configuration
6c0c9159744d Move the manual pages for the periodic scripts into man secition 5
Franz Glasner <fzglas.hg@dom66.de>
parents: 395
diff changeset
41 -------------
6c0c9159744d Move the manual pages for the periodic scripts into man secition 5
Franz Glasner <fzglas.hg@dom66.de>
parents: 395
diff changeset
42
6c0c9159744d Move the manual pages for the periodic scripts into man secition 5
Franz Glasner <fzglas.hg@dom66.de>
parents: 395
diff changeset
43 .. toctree::
6c0c9159744d Move the manual pages for the periodic scripts into man secition 5
Franz Glasner <fzglas.hg@dom66.de>
parents: 395
diff changeset
44
409
4219294c2930 Prepare the skeleton of man pages for all the configuration files used:
Franz Glasner <fzglas.hg@dom66.de>
parents: 404
diff changeset
45 man5/bsmtp2dma.conf
404
6c0c9159744d Move the manual pages for the periodic scripts into man secition 5
Franz Glasner <fzglas.hg@dom66.de>
parents: 395
diff changeset
46 man5/local-bsdtools-periodic
409
4219294c2930 Prepare the skeleton of man pages for all the configuration files used:
Franz Glasner <fzglas.hg@dom66.de>
parents: 404
diff changeset
47 man5/package-mapping.conf
4219294c2930 Prepare the skeleton of man pages for all the configuration files used:
Franz Glasner <fzglas.hg@dom66.de>
parents: 404
diff changeset
48 man5/pkgtools.conf