WAYFIRE(1)

✨ WAYFIRE ✨

okay bestie, buckle up, because we're about to talk about wayfire, and it's genuinely one of the most iconic things on your whole system 💅

---

🌸 NAME 🌸

wayfire — a modular and extensible wayland compositor. yes that's the whole vibe. modular. extensible. slay.

---

🎀 SYNOPSIS 🎀

wayfire [-c, --config config_file] [-B, --config-backend config_backend]
        [-d, --debug] [-D, --damage-debug] [-h, --help]
        [-R, --damage-renderer] [-v, --version]

like. look at that. every flag in its little bracket house. 🏠

---

🦋 DESCRIPTION 🦋

so wayfire is a wayland compositor, right? and the whole thing about it — the moment, the ~main character energy~ — is that it focuses on modularity and extensibility. how? by giving you a small core compositor implementation where literally all the major functionality is provided by plugins. tiny core, big plugin energy. it's giving "I do nothing but I make it possible for everyone else to do everything." 👑

and the default plugins? they provide 3D effects similar to compiz. we're talking 3D cube, wobbly windows, blur, fish eye, etc. the fish eye one. bestie. the FISH EYE. 🐟👁️ iconic behavior, no cap.

the optional flags are described as follows:

⭐ the flags, one by one, no skipping, I promise ⭐

• -c, --config config_file — start wayfire with an alternative configuration file. and here's where it looks by default, in order: first the ${WAYFIRE_CONFIG_FILE} environment variable, then the paths ${XDG_CONFIG_HOME}/wayfire/wayfire.ini, ${HOME}/.config/wayfire/wayfire.ini, ${XDG_CONFIG_HOME}/wayfire.ini, and ${HOME}/.config/wayfire.ini. so it checks env var first, then goes down that list. ✨
• -B, --config-backend config_backend — specify which config backend to use. that's it, that's the whole thing.
• -d, --debug — turn on debug logging. the logs get chatty. 🗣️
• -D, --damage-debug — turn on additional debug for damaged regions. extra detail, specifically about damage.
• -h, --help — print a short help message. the quick version. 🫶
• -R, --damage-renderer — rerender damaged regions. just. do it again. 💅
• -v, --version — print the version. ⭐

---

💜 ENVIRONMENT VARIABLES 💜

wayfire respects the following environment variables (respects. as it should 😌):

• WAYFIRE_CONFIG_FILE — the config file to use. that's the one. 🎀
• WAYFIRE_PLUGIN_XML_PATH — a string of paths, separated by :, in which to look for plugin configuration files. by default wayfire looks for configuration files in /usr/share/wayfire/metadata and ${XDG_DATA_HOME}/wayfire/metadata. ✨
• WAYFIRE_PLUGIN_PATH — a string of paths, separated by :, in which to look for plugins. by default wayfire looks for plugins in /usr/lib/wayfire and ${XDG_DATA_HOME}/wayfire/plugins. 🌸
• _WAYFIRE_SOCKET — socket override, used to communicate with a specific wayfire instance via the IPC. super useful in case of multiple running instances of wayfire. yes, the leading underscore is real. it's part of the name. don't touch it. 🙈

and then — plot twist — wayfire also sets the following environment variables for you:

• WAYFIRE_SOCKET — the socket to use when communicating with wayfire. 🦋
• WAYLAND_DISPLAY — the wayland display currently in effect.
• CONFIG_FILE_ENV — which config file is being used. 🎀
• _JAVA_AWT_WM_NONREPARENTING — needed for java based windows, and it is set to 1. bestie the java windows need this. it's set to 1. periodt. ☕
• DISPLAY
• XCURSOR_SIZE
• XCURSOR_THEME

— variables for use with legacy xwayland(1) windows. the old-school ones. still gotta support them. 🫶

---

🌈 SEE ALSO 🌈

• xwayland(1)

that's the whole list. just the one. quality over quantity i guess 💅

---

heads up bestie: those default config search paths and plugin/metadata directories are exactly as written above — don't freestyle them, ok? ${WAYFIRE_CONFIG_FILE} gets checked first for the config file. iykyk. ✨

---

and that's the page, fr fr. this one shipped as part of Debian, dated May 21, 2023 🎀 thanks for reading my little manual-page TED talk, go forth and wobble some windows 🦋💖✨