summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMavridis Philippe <mavridisf@gmail.com>2024-10-06 11:03:33 +0300
committerMavridis Philippe <mavridisf@gmail.com>2024-10-06 11:03:33 +0300
commit1cc658900d4c31c6e2315f45b38e5c50fcca5ff8 (patch)
treedfc895015f887d7e0024b40c0e39bd90871dce77
parent53725cd5c994db13e5f514966b41d3fe6aabc4e6 (diff)
downloadxdg-desktop-portal-tde-1cc658900d4c31c6e2315f45b38e5c50fcca5ff8.tar.gz
xdg-desktop-portal-tde-1cc658900d4c31c6e2315f45b38e5c50fcca5ff8.zip
Update README
Signed-off-by: Mavridis Philippe <mavridisf@gmail.com>
-rw-r--r--README.md26
1 files changed, 14 insertions, 12 deletions
diff --git a/README.md b/README.md
index e8fb07c..27c23a3 100644
--- a/README.md
+++ b/README.md
@@ -12,29 +12,31 @@ Read more about the portals API on its official [website](https://flatpak.github
## How do I use this?
Before using this, make sure you have the `xdg-desktop-portal` package installed and running on your system.
-Some applications respect the `GTK_USE_PORTAL=1` and `GDK_DEBUG=portals` environment variables (most GTK applications and
-some Chromium-based browsers, e.g. Vivaldi).
+- **GTK+3/4 applications**: environment variables `GDK_DEBUG=portals` or `GTK_USE_PORTAL=1`;
+- **Chromium-based browsers**: see GTK+ applications
+- **Mozilla Firefox**: In about:config set `widget.use-xdg-desktop-portal.file-picker` to 1 (also check out any options that start with widget.use-xdg-desktop-portal.* to enable more portals).
+- **Pale Moon**: [https://forum.palemoon.org/viewtopic.php?t=22985]
+- **Qt applications**: unknown
-To make Firefox use the Portals API, go to `about:config`, search for options that start with "widget.use-xdg-desktop-portal" and,
-if they are set to 2, set them to 1.
+**WARNING!** Some Gtk+ applications don't respect the `GTK_USE_PORTAL=1` and `GDK_DEBUG=portals` environment variables (e.g. Inkscape).
-## State of implementation
+## State of the implementation
-Currently implemented are the following interfaces:
+Currently implemented are the following interfaces (listed in alphabetical order):
* Account - request user information (user ID, full name, user icon)
* Email - request to send an e-mail via the system e-mail client
* FileChooser - request a file dialog
-The following implementations are planned (listed in no particular order):
-* Screenshot - request a screenshot
+The following implementations are considered (listed in alphabetical order):
+* Access - show a grant access dialog
* App Chooser - show a "Open with..." dialog for a file
* Clipboard - request clipboard access (*)
-* OpenURI - request to open a URL
+* Notification - show a notification
+* Print - request a file to be printed
+* Screenshot - request a screenshot
* Secret - integration with TDEWallet
-* Access - show a grant access dialog
* Wallpaper - request to change the user's wallpaper
-* Print - request a file to be printed
(*) Needs Session interface implementation
-Additionaly, it must be noted that the implementation does not currently support the Documents portal API (and therefore sandboxed applications).
+Additionally, it must be noted that the implementation does not currently support the Documents portal API (and therefore sandboxed applications).