Skip to content

docs: document GUAKE_ENABLE_WAYLAND in the FAQ - #2362

Open
shaktimaan00 wants to merge 1 commit into
Guake:masterfrom
shaktimaan00:docs/guake-enable-wayland
Open

shaktimaan00 wants to merge 1 commit into
Guake:masterfrom
shaktimaan00:docs/guake-enable-wayland

Conversation

@shaktimaan00

Copy link
Copy Markdown

The Wayland note in the FAQ only covers the manual keybinding workaround. There is nothing that explains the GUAKE_ENABLE_WAYLAND switch at all, so people end up reading guake/main.py or guessing (see the last few comments on #1976).

I added a subsection under "Note on Wayland" covering:

  • what the variable does: Guake starts with GDK_BACKEND=x11, setting the variable flips it to wayland.
  • that only its presence is checked, so GUAKE_ENABLE_WAYLAND=0 enables Wayland too. That one is easy to get wrong.
  • where to set it. A shell rc file is not enough for the instance GNOME starts at login; ~/.config/environment.d/ is read early enough. Editing ~/.config/autostart/guake.desktop only holds until the next start, since refresh_user_start() rewrites it from the packaged template while "Start Guake at login" is on.
  • what it means for the hotkey: we cannot grab global keys on Wayland, so the shortcut has to come from the desktop, and if the "problem happened when binding" notification shows up on every launch, show-hide can be set to disabled.

Checked against the code paths in guake/main.py, guake/keybindings.py (empty/disabled values are skipped before binding) and guake/prefs.py. Docs build is clean: rst parsed and rendered without warnings. No code changed, so make check and make test are unaffected; the reno note is there for the changelog.

closes #1976

The FAQ only talks about the manual keybinding workaround, nothing
explains the GUAKE_ENABLE_WAYLAND switch itself. Spell out that Guake
defaults to the X11 GDK backend, that presence of the variable (not its
value) is what counts, where to put it so the instance started at login
sees it, and what it means for the show/hide key.

closes Guake#1976
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document GUAKE_ENABLE_WAYLAND

1 participant