SYSUPGRADE.CONF(5)

NAME
sysupgrade.conf - configuration file to control NetBSD system upgrades

DESCRIPTION
Configuration files for sysupgrade(8) are simple shell scripts that set, or explicitly clear, a collection of known configuration variables.

The following configuration variables are recognized:

AUTOCLEAN
    Whether to automatically delete the downloaded files or not as part of the ‘auto’ command.

    If you set ETCUPDATE to false, you will probably want to disable autocleaning. This will let you run the ‘etcupdate’ command on your own at a later stage reusing the same distribution sets used to upgrade the system.

    Default: yes.

CACHEDIR
    Path to the local directory into which distribution sets are temporarily fetched while applying a system upgrade. Note that all sysupgrade.conf commands that need access to the distribution sets (pretty much all of them) will read from this directory. If you plan on issuing different upgrade steps at different times, this directory should persist across the different executions.

    Default: /var/cache/sysupgrade

DESTDIR
    Path to the root of the system to be upgraded. This is prepended to all other paths affected by sysupgrade(8) and can be used to perform upgrades of non-live systems or for testing purposes.

    Default: not set (which means / is affected).

ETCUPDATE
    Whether to run etcupdate(8) as part of an automated upgrade. You may want to disable this because this is the only interactive step in the upgrade process.

    If set to false, the ‘auto’ subcommand will skip this step. In this case, you are also recommended to set AUTOCLEAN to ‘no’ so that you are not required to redownload the distribution files just to run etcupdate(8) later.

    Default: yes.

KERNEL
    Name of the kernel to install. There must be a ‘netbsd-<KERNEL>.gz’ file in the release directory matching this name.

    If this is set to the magic value ‘AUTO’, sysupgrade(8) will attempt to automatically determine the name of the current kernel by using config(1) on <DESTDIR>/netbsd. If the guessing fails, an error is raised to prevent installing a mismatching kernel.

    Default: AUTO.

POSTINSTALL_AUTOFIX
    Whitespace-separated list of postinstall(8) checks that will be unconditionally fixed as part of an upgrade.

    It is recommended that you include ‘obsolete’ in this list at the very least: this check often fails because it is common for newer releases to drop existing files, and fixing it should be harmless. Note that old shared libraries are never cleaned by this check, so existing third-party binaries should not stop working even after auto-fixing this check.

    Default: empty.

RELEASEDIR
    Location of the release directory (which must hold a binary/sets/ subdirectory). This can be either a local path or a URL.

    If the location is a URL, any of the HTTP, FTP or SSH protocols are supported. In the case of SSH, the URL takes the form: ‘ssh://[user[:password]@]<host>/<absolute_path>’, which is different to the syntax accepted by scp(1).

    Default: not set.

SETS
    Whitespace-separated list of distribution sets to install. If this is set to the magic value ‘AUTO’, the list of sets is determined from the files in <DESTDIR>/etc/mtree.

    This list cannot include any ‘kern-*’ sets; the kernel to be installed is determined by the KERNEL variable.

    The presence of any configuration sets (such as ‘etc’ or ‘xetc’) in this list enables the etcupdate and postinstall steps in the automated upgrade procedure.

    The presence of a modules set enables the modules step in the automated upgrade procedure.

    Default: AUTO.

ARCHIVE_EXTENSION

    Archive file extension of the sets. Can be either ‘tgz’ or ‘tar.xz’.

    Default: depends on CPU architecture.

SEE ALSO
sysupgrade(8)