From ecbe57e7be12452d6fe477f2154a6d93f60c41e0 Mon Sep 17 00:00:00 2001 From: Shawn Wallace Date: Tue, 5 Aug 2025 00:12:22 -0400 Subject: [PATCH] Document -listenfd support --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index cff0847..fdf5748 100644 --- a/README.md +++ b/README.md @@ -61,3 +61,11 @@ Additionally, satellite can *optionally* take advantage of the following protoco - Pointer constraints - Tablet input - Fractional scale + +## Compositor integration +Satellite supports passing through the `-listenfd` Xwayland argument. What this means is you can integrate satellite +(and by extension Xwayland) into your compositor, and do things like on demand activation. Note that you *must* pass +a display number to satellite as the first argument, and then the `-listenfd` argument. + +You can view [Niri's implementation of this integration](https://github.com/YaLTeR/niri/pull/1728/files) for understanding +how it should work.