Mercurial > hgrepos > FreeBSD > ports > sysutils > local-bsdtools
changeset 294:c2e2fed957ed
- Compute a dynmic list of manual pages
- Move the sources of the manual pages into a section-specific subdir
| author | Franz Glasner <fzglas.hg@dom66.de> |
|---|---|
| date | Sun, 18 Sep 2022 15:32:22 +0200 |
| parents | 73ac6bec36fe |
| children | 11e6e3442df0 |
| files | Makefile docs/conf.py docs/index.rst docs/man/ftjail-copy-skel.rst docs/man/ftjail.rst docs/man/fzfs-mount.rst docs/man/fzfs-umount.rst docs/man/fzfs.rst docs/man/index.rst docs/man/index8.rst docs/man/local-bsdtools.rst docs/man/man8/ftjail-copy-skel.rst docs/man/man8/ftjail.rst docs/man/man8/fzfs-mount.rst docs/man/man8/fzfs-umount.rst docs/man/man8/fzfs.rst docs/man/man8/local-bsdtools.rst |
| diffstat | 17 files changed, 271 insertions(+), 269 deletions(-) [+] |
line wrap: on
line diff
--- a/Makefile Sun Sep 18 14:47:41 2022 +0200 +++ b/Makefile Sun Sep 18 15:32:22 2022 +0200 @@ -27,6 +27,8 @@ SRC= ${.CURDIR} +MANPAGES8= ${:!${LS} -1 "${.CURDIR}/docs/man/man8"!} + HGCANONICALPATH?= default HGREVISION= ${:!hg id -R "${SRC}" -q!} HGDATE= ${:!hg log -R "${SRC}" -r "${HGREVISION:S/+//}" --template '{date|isodatesec}'!} @@ -83,8 +85,8 @@ .endfor post-install-DOCS-on: -.for _mp in local-bsdtools.8 ftjail.8 ftjail-copy-skel.8 fzfs.8 fzfs-mount.8 fzfs-umount.8 - ${INSTALL_DATA} ${WRKSRC}/docs/_build/man/${_mp} ${STAGEDIR}${LOCALBASE}/man/man8/${_mp} +.for _mp in ${MANPAGES8:R} + ${INSTALL_DATA} ${WRKSRC}/docs/_build/man/${_mp}.8 ${STAGEDIR}${LOCALBASE}/man/man8/${_mp}.8 .endfor .include <bsd.port.mk>
--- a/docs/conf.py Sun Sep 18 14:47:41 2022 +0200 +++ b/docs/conf.py Sun Sep 18 15:32:22 2022 +0200 @@ -71,12 +71,12 @@ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - ("man/local-bsdtools", "local-bsdtools", 'FreeBSD specific administration helper tools v%s' % release, [author], 8), - ("man/ftjail", "ftjail", "Management helper for thin jails", [author], 8), - ("man/ftjail-copy-skel", "ftjail-copy-skel", "Recursively copy skeleton contents", [author], 8), - ("man/fzfs", "fzfs", "A ZFS management helper tool", [author], 8), - ("man/fzfs-mount", "fzfs-mount", "Mount ZFS datasets recursively", [author], 8), - ("man/fzfs-umount", "fzfs-umount", "Unmount ZFS datasets recursively", [author], 8), + ("man/man8/local-bsdtools", "local-bsdtools", 'FreeBSD specific administration helper tools v%s' % release, [author], 8), + ("man/man8/ftjail", "ftjail", "Management helper for thin jails", [author], 8), + ("man/man8/ftjail-copy-skel", "ftjail-copy-skel", "Recursively copy skeleton contents", [author], 8), + ("man/man8/fzfs", "fzfs", "A ZFS management helper tool", [author], 8), + ("man/man8/fzfs-mount", "fzfs-mount", "Mount ZFS datasets recursively", [author], 8), + ("man/man8/fzfs-umount", "fzfs-umount", "Unmount ZFS datasets recursively", [author], 8), ]
--- a/docs/index.rst Sun Sep 18 14:47:41 2022 +0200 +++ b/docs/index.rst Sun Sep 18 15:32:22 2022 +0200 @@ -9,4 +9,4 @@ .. toctree:: - man/index + man/index8
--- a/docs/man/ftjail-copy-skel.rst Sun Sep 18 14:47:41 2022 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,61 +0,0 @@ -.. -*- coding: utf-8; indent-tabs-mode: nil; -*- - -ftjail-copy-skel -================ - -Synopsis --------- - -**fzfs copy-skel** [**-A**] [**-L**] [**-M** `mountpoint`] [**-P**] [**-u**] `source-dataset` `snapshot-name` `target-dataset` - - -Description ------------ - -Recursively copy the snapshot `snapshot-name` of the RW skeleton dataset -`source-dataset` into dataset `target-dataset`. - -Apply knowledge of the type and typical layout of the RW skeleton -(e.g. handle the intermediate dataset of :file:`usr` properly). - - -Options -------- - -.. program:: ftjail copy-skel - -.. option:: -A - - Set the ZFS property `canmount=noauto` for all datasets in the - target dataset. - -.. option:: -L - - Copy dataset properties optimized for employing a :file:`skeleton` - subdirectory. - -.. option:: -M mountpoint - - Set the `mountpoint` property for the TARGET-DS to `mountpoint`. - All children will be set to inherit it. - -.. option:: -P - - Copy dataset properties optimized for direct mounts of skeleton - children over an already mounted base. - -.. option:: -u - - Do not mount the target dataset `target-dataset` automatically. - - -Environment ------------ - -All environment variables that affect :command:`zfs` are effective also. - - -See Also --------- - -:manpage:`ftjail(8)`
--- a/docs/man/ftjail.rst Sun Sep 18 14:47:41 2022 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,56 +0,0 @@ -.. -*- coding: utf-8; indent-tabs-mode: nil; -*- - -ftjail -====== - -Synopsis --------- - -**ftjail -hV** - -**ftjail subcommand** - - -Subcommands ------------ - -:manpage:`ftjail-datasets-tmpl(8)` - - Create the ZFS template datasets - -:manpage:`ftjail-mount-tmpl(8)` - - Canonically mount the RO base and the RW skeleton - -:manpage:`ftjail-umount-tmpl(8)` - - Unmount mounted template datasets - -:manpage:`ftjail-interlink-tmpl(8)` - - Create symbolic links between the RO base and the RW skeleton - -:manpage:`ftjail-populate(8)` - - Populate a mounted base and skeleton - -:manpage:`ftjail-snapshot-tmpl(8)` - - Create a ZFS snapshot for base and skeleton - -:manpage:`ftjail-copy-skel(8)` - - Copy a ZFS skeleton recursively - - -Implementation Notes --------------------- - -All commands with the exception of :command:`ftjail populate` require -ZFS as filesystem. - - -Environment ------------ - -All environment variables that affect :command:`zfs` are effective also.
--- a/docs/man/fzfs-mount.rst Sun Sep 18 14:47:41 2022 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,50 +0,0 @@ -.. -*- coding: utf-8; indent-tabs-mode: nil; -*- - -fzfs-mount -========== - -Synopsis --------- - -**fzfs mount** [**-O**] [**-N**] [**-P**] [**-n**] [**-u**] `dataset` [`mountpoint`] - - -Description ------------ - -Mount the ZFS dataset `dataset` and all its children to mountpoint -`mountpoint`. - - -Options -------- - -.. program:: fzfs mount - -.. option:: -O - - Also mount datasets at mountpoints outside of their "natural" - and inherited mountpoints. - -.. option:: -N - - Mount at their "natural" configured ZFS mountpoints - (the `mountpoint` argument is not required in this case). - -.. option:: -P - - Do not mount the given parent `dataset` but only its children. - -.. option:: -n - - Do not really mount anything but show what would be mounted where. - -.. option:: -u - - Alias of :option:`-n` - - -See Also --------- - -:manpage:`fzfs-umount(8)`
--- a/docs/man/fzfs-umount.rst Sun Sep 18 14:47:41 2022 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,23 +0,0 @@ -.. -*- coding: utf-8; indent-tabs-mode: nil; -*- - -fzfs-umount -=========== - -Synopsis --------- - -**fzfs umount** `dataset` - -**fzfs unmount** `dataset` - - -Description ------------ - -Unmount the mounted `dataset` and all its children. - - -See Also --------- - -:manpage:`fzfs-mount(8)`
--- a/docs/man/fzfs.rst Sun Sep 18 14:47:41 2022 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,23 +0,0 @@ -.. -*- coding: utf-8; indent-tabs-mode: nil; -*- - -fzfs -==== - -Synopsis --------- - -**fzfs -hV** - -**fzfs subcommand** - - -Subcommands ------------ - -:manpage:`fzfs-mount(8)` - - Recursively mount a ZFS dataset and its children - -:manpage:`fzfs-umount(8)` - - Recursively unmount a ZFS datasets and its children
--- a/docs/man/index.rst Sun Sep 18 14:47:41 2022 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,17 +0,0 @@ -.. -*- coding: utf-8; indent-tabs-mode: nil; -*- - -.. local-bsdtools documentation master file, created by - sphinx-quickstart on Sat Sep 17 21:32:09 2022. - - -Collection of Manual Pages -========================== - -.. toctree:: - - local-bsdtools - ftjail - ftjail-copy-skel - fzfs - fzfs-mount - fzfs-umount
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/man/index8.rst Sun Sep 18 15:32:22 2022 +0200 @@ -0,0 +1,17 @@ +.. -*- coding: utf-8; indent-tabs-mode: nil; -*- + +.. local-bsdtools documentation master file, created by + sphinx-quickstart on Sat Sep 17 21:32:09 2022. + + +Collection of Manual Pages +========================== + +.. toctree:: + + man8/local-bsdtools + man8/ftjail + man8/ftjail-copy-skel + man8/fzfs + man8/fzfs-mount + man8/fzfs-umount
--- a/docs/man/local-bsdtools.rst Sun Sep 18 14:47:41 2022 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,30 +0,0 @@ -.. -*- 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 -============== - - -See Also --------- - -- :manpage:`bsmtp2dma(8)` -- :manpage:`check-ports(8)` -- :manpage:`fjail(8)` -- :manpage:`ftjail(8)` -- :manpage:`fpkg(8)` -- :manpage:`fzfs(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 apply generally.
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/man/man8/ftjail-copy-skel.rst Sun Sep 18 15:32:22 2022 +0200 @@ -0,0 +1,61 @@ +.. -*- coding: utf-8; indent-tabs-mode: nil; -*- + +ftjail-copy-skel +================ + +Synopsis +-------- + +**fzfs copy-skel** [**-A**] [**-L**] [**-M** `mountpoint`] [**-P**] [**-u**] `source-dataset` `snapshot-name` `target-dataset` + + +Description +----------- + +Recursively copy the snapshot `snapshot-name` of the RW skeleton dataset +`source-dataset` into dataset `target-dataset`. + +Apply knowledge of the type and typical layout of the RW skeleton +(e.g. handle the intermediate dataset of :file:`usr` properly). + + +Options +------- + +.. program:: ftjail copy-skel + +.. option:: -A + + Set the ZFS property `canmount=noauto` for all datasets in the + target dataset. + +.. option:: -L + + Copy dataset properties optimized for employing a :file:`skeleton` + subdirectory. + +.. option:: -M mountpoint + + Set the `mountpoint` property for the TARGET-DS to `mountpoint`. + All children will be set to inherit it. + +.. option:: -P + + Copy dataset properties optimized for direct mounts of skeleton + children over an already mounted base. + +.. option:: -u + + Do not mount the target dataset `target-dataset` automatically. + + +Environment +----------- + +All environment variables that affect :command:`zfs` are effective also. + + +See Also +-------- + +:manpage:`ftjail(8)`
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/man/man8/ftjail.rst Sun Sep 18 15:32:22 2022 +0200 @@ -0,0 +1,56 @@ +.. -*- coding: utf-8; indent-tabs-mode: nil; -*- + +ftjail +====== + +Synopsis +-------- + +**ftjail -hV** + +**ftjail subcommand** + + +Subcommands +----------- + +:manpage:`ftjail-datasets-tmpl(8)` + + Create the ZFS template datasets + +:manpage:`ftjail-mount-tmpl(8)` + + Canonically mount the RO base and the RW skeleton + +:manpage:`ftjail-umount-tmpl(8)` + + Unmount mounted template datasets + +:manpage:`ftjail-interlink-tmpl(8)` + + Create symbolic links between the RO base and the RW skeleton + +:manpage:`ftjail-populate(8)` + + Populate a mounted base and skeleton + +:manpage:`ftjail-snapshot-tmpl(8)` + + Create a ZFS snapshot for base and skeleton + +:manpage:`ftjail-copy-skel(8)` + + Copy a ZFS skeleton recursively + + +Implementation Notes +-------------------- + +All commands with the exception of :command:`ftjail populate` require +ZFS as filesystem. + + +Environment +----------- + +All environment variables that affect :command:`zfs` are effective also.
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/man/man8/fzfs-mount.rst Sun Sep 18 15:32:22 2022 +0200 @@ -0,0 +1,50 @@ +.. -*- coding: utf-8; indent-tabs-mode: nil; -*- + +fzfs-mount +========== + +Synopsis +-------- + +**fzfs mount** [**-O**] [**-N**] [**-P**] [**-n**] [**-u**] `dataset` [`mountpoint`] + + +Description +----------- + +Mount the ZFS dataset `dataset` and all its children to mountpoint +`mountpoint`. + + +Options +------- + +.. program:: fzfs mount + +.. option:: -O + + Also mount datasets at mountpoints outside of their "natural" + and inherited mountpoints. + +.. option:: -N + + Mount at their "natural" configured ZFS mountpoints + (the `mountpoint` argument is not required in this case). + +.. option:: -P + + Do not mount the given parent `dataset` but only its children. + +.. option:: -n + + Do not really mount anything but show what would be mounted where. + +.. option:: -u + + Alias of :option:`-n` + + +See Also +-------- + +:manpage:`fzfs-umount(8)`
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/man/man8/fzfs-umount.rst Sun Sep 18 15:32:22 2022 +0200 @@ -0,0 +1,23 @@ +.. -*- coding: utf-8; indent-tabs-mode: nil; -*- + +fzfs-umount +=========== + +Synopsis +-------- + +**fzfs umount** `dataset` + +**fzfs unmount** `dataset` + + +Description +----------- + +Unmount the mounted `dataset` and all its children. + + +See Also +-------- + +:manpage:`fzfs-mount(8)`
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/man/man8/fzfs.rst Sun Sep 18 15:32:22 2022 +0200 @@ -0,0 +1,23 @@ +.. -*- coding: utf-8; indent-tabs-mode: nil; -*- + +fzfs +==== + +Synopsis +-------- + +**fzfs -hV** + +**fzfs subcommand** + + +Subcommands +----------- + +:manpage:`fzfs-mount(8)` + + Recursively mount a ZFS dataset and its children + +:manpage:`fzfs-umount(8)` + + Recursively unmount a ZFS datasets and its children
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/man/man8/local-bsdtools.rst Sun Sep 18 15:32:22 2022 +0200 @@ -0,0 +1,30 @@ +.. -*- 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 +============== + + +See Also +-------- + +- :manpage:`bsmtp2dma(8)` +- :manpage:`check-ports(8)` +- :manpage:`fjail(8)` +- :manpage:`ftjail(8)` +- :manpage:`fpkg(8)` +- :manpage:`fzfs(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 apply generally.