NAME

appjail-fetch — Fetch and extract components to create jails

SYNOPSIS

DESCRIPTION

The appjail fetch utility is responsible for creating a release, a directory that can be used to create jails, which can be created in different ways, such as using FreeBSD components, using debootstrap(8), using the FreeBSD source tree, and so on. This utility, in addition to creating releases, can destroy and list them.

Similar to how appjail-jail(1) handles jails, releases can be marked as dirty, meaning they can be removed if they were not created correctly. However, unlike appjail-jail(1), the user can't arbitrarily mark or unmark a release as dirty. A release marked dirty is useless in most cases and can be destroyed without user consent or you can use the individual destroy subcommand and create the release again.

When no command is specified, the default is whatever DEFAULT_FETCH_METHOD specifies, but of course you must use it explicitly if you want to use any of its arguments.

The options are as follows:

debootstrap [-A] [-a arch] [-c cache-start] [-m mirror] [-r name] [-S script] suite

debootstrap bootstraps a basic Debian system of suite into the release directory from mirror by running script.

You must install sysutils/debootstrap before using this method.

See debootstrap(8) for details.

-A

By default, APT:Cache-Start is increased. This option disables this behavior.

-a arch

Specify the architecture to use in the release. If this option is not set, the architecture specified by the DEBOOTSTRAP_ARCH parameter is used.

-c cache-start

See apt.conf(5) for a description of Cache-Start. If this option is not set, the value specified by the APT_CACHE_START parameter is used.

-m mirror

See debootstrap(8) for a description of MIRROR. If this option is not set, the mirror specified by the DEBOOTSTRAP_MIRROR parameter is used.

-r name

Release name. If this option is not set, the name specified by the DEFAULT_RELEASE parameter is used.

-S script

See debootstrap(8) for a description of SCRIPT. If this option is not set, the mirror specified by the DEBOOTSTRAP_SCRIPT parameter is used.

destroy [-fR] [-a arch] [-v version] release

Destroy release.

-f

Forcibly unmount file system. Ignored when ZFS is not enabled.

-R

Recursively destroy all dependents, including cloned file systems outside the target hierarchy. Ignored when ZFS is not enabled.

-a arch

Destroy release with the given architecture. If this option is not set, the architecture specified by the FREEBSD_ARCH parameter is used.

-v version

Destroy release with the given version. If this option is not set, the version specified by the FREEBSD_VERSION parameter is used.

empty [-a arch] [-v version] [name]

Create an empty release, that is, a directory with three files: .empty file, .done file, and release directory. .empty is a hint that commands like appjail-update(1) and appjail-upgrade(1) not update this release, since this method assumes you need this level of control. .done is to know if the release is dirty or not. And the release directory is where the files used to create jails should be.

-a arch

Specify the architecture to use in the release. If this option is not set, any is used since this method does not know which architecture is best in your case.

-v version

Specify the version to use in the release. If this option is not set, any is used since this method does not know which version is best in your case.

list arch[/version]

List current releases. You can limit the list by specifying arch, and version.

local [-C] [-a arch] [-r name] [-u url] [-v version] [component ...]

This is exactly the same as www, but use cp(1) to copy the components to be extracted from url. You must explicitly set at least url, as it might not be valid for this method.

src [-bDIkNR] [-a target[/target-arch]] [-j jobs] [-K kernel] [-s source-tree] [-|name] [args ...]

Create a release called name (or the name specified by the DEFAULT_RELEASE parameter when - is used) using a build from the FreeBSD source tree. args are arguments used by each make(1) call, and if they are not specified, arguments specified by the MAKEARGS parameter are used.

-b

Build the world and, if -k is specified, the kernel.

-D

Don't run delete-old and delete-old-libs targets.

-I

Don't run installworld target.

-k

Build and/or install the kernel. If -b is not specified, only installkernel will be executed.

-N

Don't run distribution target.

-R

Don't run distrib-dirs target.

-a target[/ar target-arch]

See TARGET/TARGET_ARCH in build(7). If this option is not set, the value specified by the TARGET_ARCH parameter is used.

-j jobs

Number of jobs to use. If this option is not set, the number of jobs specified by the JOBS parameter is used.

-K kernel

Kernel configuration file. If this option is not set, the kernel specified by the KERNEL parameter is used.

-s source-tree

Location of the FreeBSD source tree. If this option is not set, the location specified by the SRCDIR parameter is used.

www [-C] [-a arch] [-r name] [-u url] [-v version] [component ...]

Download FreeBSD components using the command specified by the WWW_CMD parameter. By default, when no components are specified, this method uses the COMPONENTS parameter.

-C

By default, the MANIFEST file is downloaded to check if the components are OK. This option disables this behavior.

-a arch

Specify the architecture to use in the release. If this option is not set, the architecture specified by the FREEBSD_ARCH parameter is used.

-r name

Release name. If this option is not set, the name specified by the DEFAULT_RELEASE parameter is used.

-u url

Site where the components will be downloaded. If this option is not set, the URL specified by the DOWNLOADURL parameter is used.

-v version

Specify the version to use in the release. If this option is not set, the version specified by the FREEBSD_VERSION parameter is used.

EXIT STATUS

The appjail fetch utility exits 0 on success, and >0 if an error occurs.

SEE ALSO

appjail-deleteOld(1) appjail-etcupdate(1) appjail-jail(1) appjail-quick(1) appjail-update(1) appjail-upgrade(1) appjail.conf(5) debootstrap(8)

AUTHORS

Jesús Daniel Colmenares Oviedo <DtxdF@disroot.org>