|
| 1 | +# XDG Desktop Portals |
| 2 | + |
| 3 | +Some applications, including [Flatpak](../external-applications.md#flatpak), use |
| 4 | +[XDG Desktop Portals](https://github.com/flatpak/xdg-desktop-portal) to provide |
| 5 | +access to various system interfaces, including file open and save dialogs, the |
| 6 | +clipboard, screencasting, opening URLs, and more. |
| 7 | + |
| 8 | +## Installation |
| 9 | + |
| 10 | +XDG Desktop Portals require a [user D-Bus session |
| 11 | +bus](../session-management.md#d-bus). Install `xdg-desktop-portal` and one or |
| 12 | +more backends: |
| 13 | + |
| 14 | +| Backend | Notes | |
| 15 | +|----------------------------|--------------------------------------------------------------------------------| |
| 16 | +| `xdg-desktop-portal-gnome` | Provides most common and GNOME-specific interfaces (GTK+ UI) | |
| 17 | +| `xdg-desktop-portal-gtk` | Provides most common interfaces (GTK+ UI) | |
| 18 | +| `xdg-desktop-portal-kde` | Provides most common and KDE-specific interfaces (Qt/KF5 UI) | |
| 19 | +| `xdg-desktop-portal-lxqt` | Only provides a file chooser (based on libfm-qt) | |
| 20 | +| `io.elementary.files` | Only provides a file chooser | |
| 21 | +| `xdg-desktop-portal-wlr` | Only provides a screenshot and screencasting interface for wlroots compositors | |
| 22 | + |
| 23 | +If unsure what to choose, `xdg-desktop-portal-gtk` is a good default choice. |
| 24 | + |
| 25 | +## Configuration |
| 26 | + |
| 27 | +In most cases, the default configuration, located at |
| 28 | +`/usr/share/xdg-desktop-portal/portals.conf`, should suffice. If necessary, this |
| 29 | +configuration can be overridden for specific desktop environments and portal |
| 30 | +interfaces by creating `$XDG_CURRENT_DESKTOP-portals.conf` or `portals.conf` at |
| 31 | +the system or user level as described in |
| 32 | +[portals.conf(5)](https://man.voidlinux.org/portals.conf.5). |
0 commit comments