Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Environment Variables

Wayscriber supports optional environment overrides.

Core overrides

  • WAYSCRIBER_NO_TRAY=1 disables the system tray in daemon mode.
  • WAYSCRIBER_TRAY_FORCE_PIXMAP=1 disables themed tray icons (useful for Noctalia/Quickshell).
  • WAYSCRIBER_RESUME_SESSION=1/0 forces session resume on or off for the current run.
  • WAYSCRIBER_CONFIGURATOR=/path/to/wayscriber-configurator sets the configurator path.
  • WAYSCRIBER_DISABLE_UPDATE_CHECK=1 stops the background update check for this run. It overrides [updates] check in config.toml; wayscriber --check-update still works. See Updating.

Interface language

  • WAYSCRIBER_LANGUAGE=auto|en|zh-CN selects the interface language for every process that inherits it. Precedence is --language > WAYSCRIBER_LANGUAGE > [ui] language. auto follows LANGUAGE, LC_ALL, LC_MESSAGES, then LANG, and falls back to English when no translated locale matches.
  • WAYSCRIBER_LOCALE_DIR=/path/to/locales selects a directory of catalogs to merge over the built-in translations. By default it is $XDG_DATA_HOME/wayscriber/locales, usually ~/.local/share/wayscriber/locales. For Simplified Chinese, edit zh-CN.toml in that directory.

Catalogs are read once per process, before translated chrome is built. Restart an existing process to pick up a catalog edit. Overrides must be regular files, not symlinks or FIFOs, and at most 1 MiB per catalog. Invalid overrides leave the built-in translations available.

Build-time variables

These are read when Wayscriber is compiled, not when it runs.

  • WAYSCRIBER_NO_UPDATE_CHECK=1 removes the update check from the build entirely; no config or environment setting can re-enable it.
  • WAYSCRIBER_INSTALL_SOURCE=apt|rpm|aur|nix|tarball|source records how the package was installed, so the update notice opens the matching instructions.

Desktop integration

  • WAYSCRIBER_ENABLE_PORTAL_SHORTCUTS=1 opts the daemon into KDE/portal global shortcut handling.
  • WAYSCRIBER_PORTAL_SHORTCUT=Meta+Shift+D stores the shortcut label used by the portal setup.

Logging

  • WAYSCRIBER_LOG_FILE=/path/or/dir writes overlay logs to a specific file or directory.
  • WAYSCRIBER_LOG_MAX_SIZE_MB=10 caps each log file before rotating to a new one.

GNOME and xdg-shell fallback

  • WAYSCRIBER_XDG_OUTPUT=NAME selects a preferred output by name.
  • WAYSCRIBER_XDG_FULLSCREEN=1 requests fullscreen overlay.
  • WAYSCRIBER_XDG_FULLSCREEN_FORCE=1 forces fullscreen even if GNOME warns about opacity.

UI and debug

  • WAYSCRIBER_FORCE_INLINE_TOOLBARS=1 forces inline toolbars.
  • WAYSCRIBER_TOOLBAR_BACKEND=auto|gtk|builtin overrides the configured toolbar frontend.
  • WAYSCRIBER_TOOLBAR_DRAG_PREVIEW=0 disables inline toolbar drag preview.
  • WAYSCRIBER_TOOLBAR_POINTER_LOCK=1 enables pointer-lock drag path (experimental).
  • WAYSCRIBER_TOOLBAR_DRAG_THROTTLE_MS=12 throttles toolbar drag updates; set 0 to disable throttling.
  • WAYSCRIBER_TOOLBAR_DRAG_HANDOFF_MS=250 controls the drag handoff timeout.
  • WAYSCRIBER_DEBUG_DAMAGE=1 enables debug damage output.
  • WAYSCRIBER_DEBUG_TOOLBAR_DRAG=1 enables toolbar drag logging.
  • WAYSCRIBER_DEBUG_TOOLBAR_COLOR=1 enables toolbar color-picker logging.
  • RUST_LOG=info enables Rust logging (use wayscriber=debug for app-level logs).