miral-s...mpositor(1)

💖 NAME 💖

miral-system-compositor — the Mir Display Server system compositor, bestie edition ✨

(also known as the Mir Display Server Demo Application manual, if u were wondering what that lil miral-s...mpositor(1) header thing was about 🎀)

🌸 SYNOPSIS 🌸

miral-system-compositor [options]

✨ DESCRIPTION ✨

okay so listen. miral-system-compositor is the thing u run when u wanna run miral-shell or miral-kiosk nested — and, if u need it, under a different user ID — on top of a Wayland based desktop session. it's giving "compositor inside a compositor", iconic honestly 💅

u can tweak how the Mir system compositor starts up in like three different ways, and here they all are:

• Command-line options: e.g. "--host-socket=/tmp/mir_socket".
• Environment variables: take the long form of the command line option, Capitalise it, prefix it with "MIR_SERVER_" and put "_" where the - was. E.g. "MIR_SERVER_HOST_SOCKET=/tmp/mir_socket". no cap, that's the whole trick 🦋
• Config file entries: just use the long form command line options straight up in the config file. E.g. "--host-socket=/tmp/mir_socket".

the config file (mir/mir-system-compositor.config) gets located via the XDG Base Directory Specification. so it's looking at $XDG_CONFIG_HOME or $HOME/.config, followed by $XDG_CONFIG_DIRS. she knows where she lives 💖

👑 OPTIONS 👑

here's the full menu bestie, don't skip a single one, i know it's long but we're gonna get through it together 🫶

• --host-socket <socket-filename> — the host socket filename. that's it, that's the whole vibe.
• -f [ --file ] <filename> — the socket filename. default is $XDG_RUNTIME_DIR/mir_socket or /tmp/<UID_NUMBER>-runtime-dir/mir_socket. pick ur home, queen 🌈
• --no-file — do not hand out a socket filename for client connections. she's booked and busy, no new clients today 🙈
• --arw-file — sets socket file permissions to globally read-writeable (equivalent to chmod a=rw). everybody gets a key 🔑
• -p [ --prompt-file ] — provide a "..._trusted" filename for prompt helper connections.
• --platform-graphics-lib <platform_library> — the library to use for platform graphics support (default: autodetect). let her figure it out herself, she's smart ⭐
• --platform-input-lib <input_library> — the library to use for platform input support (default: input-stub.so).
• --platform-path arg (=/usr/lib/x86_64-linux-gnu/mir/server-platform) — directory to look for platform libraries (default: /usr/lib/<multi-arch>/mir/server-platform). yes the multi-arch thing is a placeholder, don't @ me 💀
• -i [ --enable-input ] {0,1} — enable input (default: 1, meaning: enabled). she's listening 👂
• --compositor-report {log,lttng,off} (=off) — compositor reporting, either of log, lttng or off (default: off).
• --connector-report {log,lttng,off} — how to handle the Connector report, either of log, lttng or off (default: off).
• --display-report {log,lttng,off} — how to handle the Display report, either of log, lttng or off (default: off).
• --input-report {log,lttng,off} — how to handle to Input report, either of log, lttng or off (default: off).
• --legacy-input-report {log,off} — how to handle the Legacy Input report, either of log or off (default: off).
• --seat-report {log,off} — how to handle to Seat report, either of log or off (default: off).
• --session-mediator-report {log,lttng,off} — how to handle the SessionMediator report, either of log, lttng or off (default: off).
• --msg-processor-report {log,lttng,off} — how to handle the MessageProcessor report, either of log, lttng or off (default: off).
• --scene-report {log,lttng,off} — how to handle the scene report, either of log, lttng or off (default: off).
• --shared-library-prober-report {log,lttng,off} — how to handle the SharedLibraryProber report, either of log, lttng or off (default: log). look at her being the only one defaulting to log, main character energy fr fr 👑
• --shell-report {log,off} — how to handle the Shell report, either of log or off (default: off).
• --composite-delay <msecs> — compositor frame delay in milliseconds (like, how long to wait for new frames from clients before compositing). higher values = lower latency, but highkey risky, she might start frame skipping on u 😭. a negative value means decide automatically (default: 0).
• --name <name> — when nested, the name Mir uses when registering with the host. her government name 📛
• --nested-passthrough {0,1} — when nested, attempt to pass a client's graphics content directly to the host to avoid a composition pass (default: 1). skipping the middleman, efficiency queen 💅
• --offscreen — render to offscreen buffers instead of the real outputs. not everything needs to be perceived bestie 🦋
• --enable-touchspots — display visualization of touchspots (e.g. for screencasting). so ur viewers can see where u tapped 🎀
• --cursor {auto,null,software} — cursor (mouse pointer) to use (default: auto).
• --enable-key-repeat {0,1} — enable server generated key repeat (default: 1).
• --on-fatal-error-except — on "fatal error" conditions (e.g. drivers behaving in unexpected ways) throw an exception (instead of a core dump). graceful girlie under pressure ✨
• --debug — enable extra development debugging. heads up tho: this is only interesting for people doing Mir server or client development. if that's not u, this is not ur moment 🙈
• --enable-mirclient — enable the deprecated mirclient socket (for running old clients). deprecated!! she's a legacy queen, use with awareness 💀
• --console-provider arg (=auto) — console device handling, i.e. how Mir handles console-related tasks (device handling, VT switching, etc.). the possible values are:
  • logind — use logind
  • vt — use the Linux VT subsystem. Requires root privileges. ok so this one's serious, no cap 🔥
  • none — support no console-related tasks. useful for nested platforms which do not need raw device access and which don't have a VT concept
  • auto — detect the appropriate provider.
• --vt {0,1} — VT to run on, or 0 to use the current one (default: 0).

using this option requires --console-provider=vt. no VT provider, no VT option, that's the rule 💅

• --bypass {0,1} — [platform-specific] utilize the bypass optimization for fullscreen surfaces (default: 1).
• --x11-output <sizes> — [mir-on-X specific] colon separated list of WIDTHxHEIGHT sizes for "output" windows (default: 1280x1024).
• --wayland-host <socket-name> — socket name for host compositor.
• --startup-apps <list-of-applications> — colon separated list of startup applications. the entourage arriving with her 💖
• --env-hacks <env-vars> — colon separated list of environment variable settings.
• --disable-quit — disable Ctrl-Alt-Shift-BkSp to quit. she simply will not be leaving, sorry 🫶
• -h [ --help ] — show help text and exit. the classic, the icon, the moment ✨

🌈 SEE ALSO 🌈

miral-shell(1), miral-kiosk(1) — go say hi to the sisters, they're all in the same friend group 🦋

💜 AUTHOR 💜

the Mir Display Server has been written by the Mir Server Team at Canonical Ltd. legends, honestly 👑

and this man page has been written for the Debian project by Mike Gabriel <mike.gabriel@das-netzwerkteam.de>, and may be re-used by others. slay, Mike, we love a reusable license moment 🎀

and that's the whole page bestie!! version 1.8.0, dated April 2020, from the Mir Display Server Demo Application manual. go forth and nest ur compositors responsibly 💖✨🎀