WESTON-DEBUG(1)

💖 WESTON-DEBUG 💖

okay so bestie, this is the weston-debug manual page, from the General Commands Manual section — it's a tool for getting debug messages from the compositor, and honestly? it's giving backstage pass energy 🎀

---

✨ NAME ✨

weston-debug — a tool for getting debug messages from compositor 🫶

---

🌸 SYNOPSIS 🌸

weston-debug [options] [names]

---

🦋 DESCRIPTION 🦋

so weston-debug is a debugging tool that uses the weston_debug_v1 interface to get the debug messages from the compositor. and here's the tea: the compositor sorts those debug messages into different debug streams (think logs, proto, list, etc., 💅) and the compositor requires a file descriptor to actually stream the messages out. no fd, no vibes. periodt.

this tool takes a file name or a file descriptor (not both, bestie — pick a lane 💀) plus any debug stream names you want, straight from your command line arguments, and it subscribes the streams you asked for from the compositor using that weston_debug_v1 interface. once the subscription goes through, the compositor starts writing the debug messages to the shared file descriptor. iconic behavior tbh 🌈

and if you give it no file name and no file descriptor argument at all? don't stress — it just uses the stdout file descriptor. main character default energy ✨

---

💅 OPTIONS 💅

weston-debug accepts the following command line options, and yes we're going through all of them:

• -h, --help — prints the help text and exits with success. respectful, courteous, a little legend 🎀
• -l, --list — lists all the available debug streams that the compositor supports. lowkey the vibe check of this whole tool. ngl you can use this together with --all or with a list of debug stream names 👑
• -a, --all — binds all the debug streams the compositor is offering. no stream left behind fr fr. heads up though: it's mutually exclusive with explicitly specifying stream names 🙈
• -o FILE, --output FILE — sends the output to the file named FILE. use - for stdout. and stdout is the default, so if you don't specify it you already know. mutually exclusive with -f — you simply cannot have both, bestie 😭
• -f FD, --outfd FD — sends the output to the file descriptor FD. stdout (1) is the default. mutually exclusive with -o — again, one or the other, no cheating 💀
• [names] — a list of debug streams to bind to. mutually exclusive with --all. that's it, that's the whole thing 🦋

ok so the biggest warning here: -o/--output and -f/--outfd are mutually exclusive, and --all and [names] are mutually exclusive. the tool literally wants a file name or a file descriptor, not both. don't make it choose, it will absolutely be dramatic about it 💅

---

🌟 SEE ALSO 🌟

there are no SEE ALSO references on this page, bestie — this one stands on its own, solo main character style 💜

---

and that's the whole page!! this beauty is from Weston 16.0.0, dated 2018-09-11 — yeah she's a little vintage, and she ate anyway 👑✨ thanks for reading, ily, go bind some streams 🫶