PHOC(1)

💖 PHOC(1) — aka the manual page bestie 💖

okay so welcome to phoc(1), the manual page for phoc — a Wayland compositor for mobile devices 🫶 this is the whole thing, every flag, every env var, no skips, no cap.

---

✨ NAME ✨

phoc — a Wayland compositor for mobile devices 📱💅

---

🌸 SYNOPSIS 🌸

phoc [OPTIONS...]

---

🦋 DESCRIPTION 🦋

So phoc is a Wayland compositor for mobile devices, and it's built on the wlroots library. That's the whole vibe. It's super often paired up with the phosh mobile shell — they're like the iconic duo 💞 — but here's the thing, phoc works perfectly fine on its own too. It does not need phosh to function. Main character energy fr fr. 👑

---

💅 OPTIONS 💅

• -h, --help — prints the help and then dips out (exits).
• -C, --config FILE — the path to the configuration file. default is phoc.ini.
• -E, --exec EXECUTABLE — the executable (session) that gets run at startup, like your little launch-day bestie.
• --socket — the Wayland socket to listen on for client connections 🔌
• -S, --shell — whether to expect a shell to attach.
• -X, --xwayland — whether to start XWayland.
• --no-xwayland — whether to disable XWayland.
• --version — shows version information 🎀

---

🎀 CONFIGURATION 🎀

Configuration gets read from phoc.ini, hwdb, gsettings and $XDG_STATE_HOME/outputs.gvdb. That's four sources, she's reading all of them, periodt.

• For the deets on output configuration → see phoc.ini(5)
• For the deets on wakeup key configuration via hwdb → see gmobile.udev(5)
• For the deets on the gsettings that phoc handles → see phoc.gsettings(5)
• For the deets on output states → see phoc-outputs-states

---

🌈 ENVIRONMENT VARIABLES 🌈

phoc honors the following environment variables, bestie:

• WLR_BACKENDS — the backends the wlroots library should use when phoc launches. See <https://gitlab.freedesktop.org/wlroots/wlroots/-/blob/master/docs/env_vars.md>
• WLR_RENDERER — the renderer the wlroots library should use when phoc launches. See <https://gitlab.freedesktop.org/wlroots/wlroots/-/blob/master/docs/env_vars.md>
• G_MESSAGES_DEBUG, G_DEBUG and other environment variables supported by glib. <https://docs.gtk.org/glib/running.html>
• PHOC_DEBUG — a comma separated list of debugging flags. Some of them can also be toggled at runtime, see DBUS INTERFACE below. 👇
  • help — show a list of available debug flags
  • auto-maximize — maximize toplevels
  • damage-tracking — debug damage tracking (can be toggled at runtime)
  • damage-whole — damage the whole output on each frame (can be toggled at runtime)
  • fake-builtin — handle virtual outputs like builtin displays
  • no-quit — don't quit when the session ends
  • touch-points — debug touch points (can be toggled at runtime)
  • layer-shell — debug layer shell
  • cutouts — debug display cutouts and notches (can be toggled at runtime)
  • disable-animations — disable animations
  • force-shell-reveal — always reveal the shell over fullscreen apps
  • ignore-state — ignore any saved output state

---

🧚 UDEV PROPERTIES 🧚

besides the udev properties for wakeup keys that are documented over in gmobile.udev(5), phoc also uses ID_INPUT_KEYBOARD to identify hardware keyboards ⌨️. and yeah — you can use hwdb to override these. slay.

---

💜 DBUS INTERFACE 💜

phoc lets you enable and disable certain debug flags at runtime via DBus. so iconic of her.

to see a list of the available flags, use:

busctl --user introspect mobi.phosh.Phoc.DebugControl /mobi/phosh/Phoc/DebugControl mobi.phosh.Phoc.DebugControl

to toggle individual values:

busctl --user set-property mobi.phosh.Phoc.DebugControl /mobi/phosh/Phoc/DebugControl mobi.phosh.Phoc.DebugControl TouchPoints b true
busctl --user set-property mobi.phosh.Phoc.DebugControl /mobi/phosh/Phoc/DebugControl mobi.phosh.Phoc.DebugControl DamageTracking b true
busctl --user set-property mobi.phosh.Phoc.DebugControl /mobi/phosh/Phoc/DebugControl mobi.phosh.Phoc.DebugControl LogDomains as 1 all
busctl --user set-property mobi.phosh.Phoc.DebugControl /mobi/phosh/Phoc/DebugControl mobi.phosh.Phoc.DebugControl LogDomains as 2 phoc-seat phoc-layer-surface

⚠️ important bestie: the flags are not considered stable API, so they can change between releases. don't build your whole life on them, iykyk 😭

---

⭐ See also ⭐

phoc.ini(5) phoc.gsettings(5) phoc-outputs-states(1) gmobile.udev(5) phosh(1) busctl

---

and that's the whole page!! 🎀 the footer on this one is just phoc() — like, no version number, no date, that's it, she's mysterious 💀 but you got every option, every env var, every flag, all of it. ur so welcome, go be a compositor girlboss 👑💖