portals.conf - Man Page

XDG desktop portal configuration

Description

xdg-desktop-portal uses a configuration file to determine which portal backend should be used to provide the implementation for the requested interface.

The configuration file can be found in the following locations:

Additionally, every desktop environment can provide a portal configuration file named DESKTOP-portals.conf, where DESKTOP is the lowercase name also used in the XDG_CURRENT_DESKTOP environment variable.

File Format

The format of the portals configuration file is the same .ini format used by systemd unit files or application desktop files.

[preferred]

The main configuration group for preferred portals.

The following keys can be present in the preferred group:

default (string)

The default portal backend to use for every interface, unless the interface is listed explicitly.

org.freedesktop.impl.portal.* (string)

One of the valid portal interface implementations exposed by xdg-desktop-portal.

Each key in the group contains a semi-colon separated list of portal backend implementation, to be searched for an implementation of the requested interface, in the same order as specified in the configuration file. Additionally, the special values none and * can be used:

none

Do not provide a portal implementation for this interface.

Example

[preferred]
# Use xdg-desktop-portal-gtk for every portal interface...
default=gtk
# ... except for the Screencast interface
org.freedesktop.impl.portal.Screencast=gnome

Environment

XDG_CONFIG_HOME

The per-user portals.conf file is located in this directory. The default is $HOME/.config

See Also