xbps.d(5)

XBPS-D(5) File Formats Manual XBPS-D(5)

NAME

xbps.dXBPS configuration directory

SYNOPSIS

  • /etc/xbps.d/*.conf
  • /usr/share/xbps.d/*.conf

DESCRIPTION

The xbps.d configuration directory sets properties for the XBPS package manager. The configuration directory, by default set to /etc/xbps.d overrides settings from files available in the system configuration directory, by default set to /usr/share/xbps.d.

Files in the configuration directory have preference over files in the system configuration directory.

Only files with the .conf extension will be processed in alphabetical order.

The configuration files can set various keywords, using the syntax `key=value`. No whitespace between the key and its value is allowed, nor trailing whitespaces after its value. Multiple entries are permitted for the ignorepkg, include, noextract, preserve, repository and virtualpkg keywords, but each entry must specify only one value.

KEYWORDS

architecture=string
Overrides the native machine architecture, as reported by uname(2).
bestmatching=true|false
When this keyword is enabled, a package with the greatest version available in all registered repositories will be chosen. This will be applied to dependencies as well.
cachedir=path
Sets the default cache directory to store downloaded binary packages from remote repositories, as well as its signatures. If path starts with '/' it's an absolute path, otherwise it will be relative to rootdir.
ignorepkg=pkgname
Declares an ignored package. If a package depends on an ignored package the dependency is always satisfied, without installing the ignored package. It does not disable checks for introduced incompatibilities like shared library dependencies.
noextract=pattern
Skip extraction of matching files. Patterns starting with a exclamation mark negate the previous match, a single backslash can be used to escape the exclamation mark.

In the following example all files matching the first pattern will not be extracted, but files that also match the second pattern will still be extracted.

noextract=/usr/bin/f*
 
noextract=!/usr/bin/foo
 
include=path/file.conf
Imports settings from the specified configuration file. NOTE only one level of nesting is allowed.
preserve=path
If set ignores modifications to the specified files, while unpacking packages. Absolute path to a file and file globbing are supported, example:

preserve=/usr/bin/foo
 
preserve=/etc/foo/*.conf
 
keepconf=true|false
If set to false (default), xbps will overwrite configuration files that have not been changed since installation with their new version (if available).

If set to true, xbps will not overwrite configuration files that have not been changed since installation. Instead, the new version (if available) is saved next to the configuration file as <name>.new-<version>.

repository=url
Declares a package repository. The url argument accepts local and remote repositories. A complete url or absolute path to the directory that stores the <arch>-repodata archive is expected. Note that remote repositories must be signed using xbps-rindex(1), example:

repository=https://repo-default.voidlinux.org/current
 
repository=/hostdir/binpkgs
 
rootdir=path
Sets the default root directory.
staging=true|false
Enables or disables the use of staged packages in remote repositories.
syslog=true|false
Enables or disables syslog logging. Enabled by default.
virtualpkg=[vpkgname|vpkgver]:pkgname
Declares a virtual package. A virtual package declaration is composed by two components delimited by a colon, example:

virtualpkg=cron-daemon:dcron
Any request to the cron-daemon virtual package will be resolved to the dcron real package.

The first component expects a virtual package name and optionally its version component. The second component expects a package name to match the real package.

ENVIRONMENT

XBPS_ARCH
Overrides uname(2) machine result with this value. Useful to install packages with a fake architecture.
XBPS_TARGET_ARCH
Sets the target architecture to this value. This variable differs from XBPS_ARCH in that it allows you to install packages partially, because configuration phase is skipped (the target binaries might not be compatible with the native architecture).

FILES

/etc/xbps.d
Default configuration directory.
/usr/share/xbps.d
Default system configuration directory.
/var/db/xbps/.<pkgname>-files.plist
Package files metadata.
/var/db/xbps/pkgdb-0.38.plist
Default package database (0.38 format). Keeps track of installed packages and properties.
/var/cache/xbps
Default cache directory to store downloaded binary packages.
/usr/share/xbps.d/xbps.conf
Annotated sample configuration file.

SEE ALSO

xbps-alternatives(1), xbps-checkvers(1), xbps-create(1), xbps-dgraph(1), xbps-digest(1), xbps-fbulk(1), xbps-fetch(1), xbps-install(1), xbps-pkgdb(1), xbps-query(1), xbps-reconfigure(1), xbps-remove(1), xbps-rindex(1), xbps-uchroot(1), xbps-uunshare(1)

AUTHORS

Juan Romero Pardines <xtraeme@gmail.com>

BUGS

Probably, but I try to make this not happen. Use it under your own responsibility and enjoy your life.

Report bugs at https://github.com/void-linux/xbps/issues

February 9, 2023 Linux 6.12.85-6.12-alt1