.. -*- 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.