2018-12-12 11:46:19 +01:00
|
|
|
# xdg-desktop-portal-wlr
|
2018-12-12 22:29:57 +01:00
|
|
|
|
2021-04-17 11:58:29 +02:00
|
|
|
[](https://builds.sr.ht/~emersion/xdg-desktop-portal-wlr/commits?)
|
2020-03-10 13:40:27 +01:00
|
|
|
|
2019-12-09 12:45:30 +01:00
|
|
|
[xdg-desktop-portal] backend for wlroots
|
2018-12-12 22:29:57 +01:00
|
|
|
|
|
|
|
|
## Building
|
|
|
|
|
|
2020-04-29 19:50:53 +02:00
|
|
|
```sh
|
|
|
|
|
meson build
|
|
|
|
|
ninja -C build
|
|
|
|
|
```
|
2018-12-12 22:29:57 +01:00
|
|
|
|
|
|
|
|
## Installing
|
|
|
|
|
|
2020-04-29 19:50:53 +02:00
|
|
|
### From Source
|
|
|
|
|
|
|
|
|
|
```sh
|
|
|
|
|
ninja -C build install
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Distro Packages
|
|
|
|
|
|
2021-02-15 10:20:30 +01:00
|
|
|
[](https://repology.org/project/xdg-desktop-portal-wlr/versions)
|
2020-04-29 19:50:53 +02:00
|
|
|
|
|
|
|
|
|
|
|
|
|
## Running
|
2018-12-12 22:29:57 +01:00
|
|
|
|
2021-05-03 15:34:22 +02:00
|
|
|
Make sure `XDG_CURRENT_DESKTOP` is set. Make sure `WAYLAND_DISPLAY` and
|
|
|
|
|
`XDG_CURRENT_DESKTOP` are imported into D-Bus. If you're running Sway, this
|
|
|
|
|
can be added to your config file:
|
|
|
|
|
|
|
|
|
|
exec dbus-update-activation-environment --systemd WAYLAND_DISPLAY XDG_CURRENT_DESKTOP=sway
|
2018-12-12 22:29:57 +01:00
|
|
|
|
2020-04-29 19:50:53 +02:00
|
|
|
When correctly installed, xdg-desktop-portal should automatically invoke
|
|
|
|
|
xdg-desktop-portal-wlr when needed.
|
|
|
|
|
|
2021-03-08 19:33:12 +01:00
|
|
|
### Configuration
|
|
|
|
|
|
|
|
|
|
See `man 5 xdg-desktop-portal-wlr`.
|
|
|
|
|
|
|
|
|
|
### Manual startup
|
|
|
|
|
|
2021-05-03 15:22:04 +02:00
|
|
|
At the moment, some command line flags are available for development and
|
|
|
|
|
testing. If you need to use one of these flags, you can start an instance of
|
|
|
|
|
xdpw using the following command:
|
2020-04-29 19:50:53 +02:00
|
|
|
|
2021-05-03 15:22:04 +02:00
|
|
|
```sh
|
|
|
|
|
xdg-desktop-portal-wlr -r [OPTION...]
|
|
|
|
|
```
|
2020-04-29 19:50:53 +02:00
|
|
|
|
2021-05-03 15:22:04 +02:00
|
|
|
To list the available options, you can run `xdg-desktop-portal-wlr --help`.
|
2020-04-29 19:50:53 +02:00
|
|
|
|
|
|
|
|
## FAQ
|
|
|
|
|
|
|
|
|
|
Check out or [FAQ] for answers to commonly asked questions.
|
2018-12-12 22:29:57 +01:00
|
|
|
|
2020-04-29 19:50:53 +02:00
|
|
|
Please see the [screencast compatibility] guide for more information on
|
|
|
|
|
compatible applications and how to get them working.
|
2019-07-24 18:19:00 +02:00
|
|
|
|
2020-04-29 19:50:53 +02:00
|
|
|
If you have a question or problem that is not mentioned in those documents,
|
2021-05-26 08:35:38 +02:00
|
|
|
please open an issue or come chat with us in #sway on Libera Chat.
|
2019-07-24 18:19:00 +02:00
|
|
|
|
2020-04-29 19:50:53 +02:00
|
|
|
## Contributing
|
2019-07-24 18:19:00 +02:00
|
|
|
|
2020-04-29 19:50:53 +02:00
|
|
|
If you're interested in testing or development, check out
|
|
|
|
|
[CONTRIBUTING.md] for more information.
|
2019-07-24 18:19:00 +02:00
|
|
|
|
2018-12-12 22:29:57 +01:00
|
|
|
## License
|
|
|
|
|
|
|
|
|
|
MIT
|
2019-12-09 12:45:30 +01:00
|
|
|
|
|
|
|
|
[xdg-desktop-portal]: https://github.com/flatpak/xdg-desktop-portal
|
2020-04-29 19:50:53 +02:00
|
|
|
[FAQ]: https://github.com/emersion/xdg-desktop-portal-wlr/wiki/FAQ
|
|
|
|
|
[screencast compatibility]: https://github.com/emersion/xdg-desktop-portal-wlr/wiki/Screencast-Compatibility
|
|
|
|
|
[CONTRIBUTING.md]: CONTRIBUTING.md
|
