Mercurial > hgrepos > FreeBSD > ports > sysutils > local-bsdtools
changeset 321:1f457667f0e7
Begin a more detailed manual page for "fpkg"
| author | Franz Glasner <fzglas.hg@dom66.de> |
|---|---|
| date | Sun, 27 Nov 2022 20:14:10 +0100 |
| parents | 8675e1b7950c |
| children | 08d67640721b |
| files | docs/conf.py docs/man/index8.rst docs/man/man8/fpkg.rst pkg-plist |
| diffstat | 4 files changed, 136 insertions(+), 3 deletions(-) [+] |
line wrap: on
line diff
--- a/docs/conf.py Sun Nov 27 17:24:05 2022 +0100 +++ b/docs/conf.py Sun Nov 27 20:14:10 2022 +0100 @@ -80,14 +80,15 @@ #("man/man8/fjail-hostid", "fjail-hostid", "Compute a proposal for a new BSD Host UUID and ID", [author], 8), #("man/man8/fjail-mount", "fjail-mount", "Recursively mount a ZFS dataset and its children", [author], 8), #("man/man8/fjail-populate", "fjail-populate", "Populate a directory with content from a FreeBSD base.txz", [author], 8), - #("man/man8/fjail-privs", "fjail-privs", "Adjust some privileges within a mounted jail", [author], 8), + #("man/man8/fjail-privs", "fjail-privs", "Adjust some privileges within a mounted jail", [author], 8), #("man/man8/fjail-umount", "fjail-umount", "Recursively unmount a ZFS datasets and its children", [author], 8), + ("man/man8/fpkg", "fpkg", "A frontend for some pkg(8) commands that also operate on running jails", [author], 8), ("man/man8/ftjail", "ftjail", "Management of Thin Jails", [author], 8), - ("man/man8/ftjail-build-etcupdate-current-tmpl", "ftjail-build-etcupdate-current-tmpl", "Build a \"current\" tree suitable for the default and extract mode of \"etcupdate\"", [author], 8), + ("man/man8/ftjail-build-etcupdate-current-tmpl", "ftjail-build-etcupdate-current-tmpl", "Build a \"current\" tree suitable for the default and extract mode of \"etcupdate\"", [author], 8), ("man/man8/ftjail-copy-skel", "ftjail-copy-skel", "Recursively copy skeleton contents", [author], 8), ("man/man8/ftjail-datasets-tmpl", "ftjail-datasets-tmpl", "Create ZFS datasets for new Thin Jails using base and skeleton", [author], 8), ("man/man8/ftjail-interlink-tmpl", "ftjail-interlink-tmpl", "Create proper symlinks for \"skeleton\" style Thin Jails", [author], 8), - ("man/man8/ftjail-mount-tmpl", "ftjail-mount-tmpl", "Canonically mount the RO base and the RW skeleton of a Thin Jail", [author], 8), + ("man/man8/ftjail-mount-tmpl", "ftjail-mount-tmpl", "Canonically mount the RO base and the RW skeleton of a Thin Jail", [author], 8), ("man/man8/ftjail-populate-tmpl", "ftjail-populate-tmpl", "Populate a prepared directory structure with the contents of a FreeBSD base system", [author], 8), ("man/man8/ftjail-snapshot-tmpl", "ftjail-snapshot-tmpl", "Recursively create ZFS snapshots of the RO base datasets and the RW skeleton datasets", [author], 8), ("man/man8/ftjail-umount-tmpl", "ftjail-umount-tmpl", "Unmount mounted Thin Jail template datasets", [author], 8),
--- a/docs/man/index8.rst Sun Nov 27 17:24:05 2022 +0100 +++ b/docs/man/index8.rst Sun Nov 27 20:14:10 2022 +0100 @@ -11,6 +11,7 @@ man8/local-bsdtools man8/bsmtp2dma man8/fjail + man8/fpkg man8/ftjail man8/ftjail-build-etcupdate-current-tmpl man8/ftjail-copy-skel
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/man/man8/fpkg.rst Sun Nov 27 20:14:10 2022 +0100 @@ -0,0 +1,130 @@ +.. -*- coding: utf-8; indent-tabs-mode: nil; -*- + +fpkg +==== + +Synopsis +-------- + +**fpkg -hV** + +**fpkg subcommand** + + +Description +----------- + +A :manpage:`pkg(8)` frontend for common operations that also operates +in all running and compatible jails. + +The following global options are implemented: + +.. program:: fpkg + +.. option:: -h + + Print a short usage message to stdout and exit. + +.. option:: -V + + Print the program name and version number to stdout and exit. + +A "compatible jail" is a jail that's output of +:command:`freebsd-version -u` is the same as the host's. + + +Subcommands +----------- + +:manpage:`fpkg-audit(8)` + + Call :command:`pkg audit` on the local host and all running + visible and compatible jails. + +:manpage:`fpkg-check-fast-track(8)` + + Check packages installed from the LocalBSDPorts repository against + the repositories `FreeBSD` and `LocalBSDPorts` on the local host + and all visible and compatible jails + +:manpage:`fpkg-check-upgrade(8)` + + Call :command:`pkg upgrade -n` on the local host and all running + visible and compatible jails. + +:manpage:`fpkg-config(8)` + + Retrieve the value of a given :manpage:`pkg(8)` configuration + option on the local host and all running visible and + compatible jails (:command:`pkg config`). + +:manpage:`fpkg-update(8)` + + Call :command:`pkg update` on the local host and all running + visible and compatible jails. + +:manpage:`fpkg-upgrade(8)` + + Call :command:`pkg upgrade` on the local host and all running + visible and compatible jails. + +:manpage:`fpkg-uversion(8)` + + Call :command:`freebsd-version -u` on the local host and all + running visible and compatible jails. + +:manpage:`fpkg-vv(8)` + + Call :command:`pkg -vv` on the local host and all running visible + and compatible jails. + + +Environment +----------- + +.. envvar:: FPKG_AUDIT_FLAGS + + Additional flags given to :command:`pkg audit` (Default: ``-Fr``). + +.. envvar:: FPKG_UPDATE_FLAGS + + Additional flags given to :command:`pkg update` (Default: empty). + +.. envvar:: FPKG_UPGRADE_FLAGS + + Additional flags given to :command:`pkg upgrade` and + :command:`pkg upgrade -n` (Default: empty). + +.. envvar:: FPKG_SIGN + + Marker for the begin of an output group (local host or jail) + (Default: "===> "). + +.. envvar:: FPKG_SKIPSIGN + + Marker for the begin of a skipped output group (Default: "----> "). + +.. envvar:: FREEBSD_REPO + + The name of the (official) FreeBSD package repository (Default: + ``FreeBSD``). + +.. envvar:: LOCALBSDPORTS_REPO + + Repository with ports with default port OPTIONS (i.e. unchanged) + but with newer package versions as the "FreeBSD" repository. Some sort + of fast-track repository. + +All other environment variables that affect :manpage:`pkg(8)` are +effective also. + + +Files +----- + +If there is a :file:`/usr/local/etc/local-bsdtools/pkgtools.conf` then +this file is sourced in. All environment variables that are documented +in `Environment`_ can be set in this file also. + +This configuration file is a Bourne shell (:command:`/bin/sh`) +compatible file.
--- a/pkg-plist Sun Nov 27 17:24:05 2022 +0100 +++ b/pkg-plist Sun Nov 27 20:14:10 2022 +0100 @@ -9,6 +9,7 @@ %%DOCS%%man/man8/local-bsdtools.8.gz %%DOCS%%man/man8/bsmtp2dma.8.gz %%DOCS%%man/man8/fjail.8.gz +%%DOCS%%man/man8/fpkg.8.gz %%DOCS%%man/man8/ftjail.8.gz %%DOCS%%man/man8/ftjail-build-etcupdate-current-tmpl.8.gz %%DOCS%%man/man8/ftjail-copy-skel.8.gz
