OBUS-GEN-INTERFACE(1)

OBUS-GEN-INTERFACE 💅✨

okay bestie, welcome to section 1 of the General Commands Manual, we're doing the whole glow-up on obus-gen-interface and honestly? it's giving code-gen icon energy 🎀

✨ NAME ✨

obus-gen-interface — convert D-Bus introspection files to ocaml code 🦋

🌸 SYNOPSIS 🌸

obus-gen-interface [ options ] input-file

💖 DESCRIPTION 💖

so basically obus-gen-interface takes a D-Bus introspection file and ✨manifest✨ an OCaml module out of it. no cap. the generated module is packed with your methods, signals and properties definitions, and it's lowkey mandatory — both the client-side code and the server-side code need it. everyone's depending on it, main character behaviour fr fr 👑

not me reminding you that the files obus-gen-interface generates are not meant to be edited. hands off bestie, they're not yours to touch 🙈 that's the whole point of generating them.

🎀 OPTIONS 🎀

• -o output-prefix — use this name as the output prefix. if you don't say anything it defaults to the input file name with its extension chopped off, plus "_interfaces" glued on the end. so for example, if your input file is called "foo.xml" (or "foo.obus"), then "obus-gen-interface" will generate "foo_interfaces.ml" and "foo_interfaces.mli". cute, consistent, slay 💅
• -keep-common — keeps the common interfaces, i.e. all interfaces starting with "org.freedesktop.DBus". by default they get dropped, so if you're wondering where they went… yeah, they were never there 🫶
• -mode {both|client|server} — sets the code generation mode. defaults to "both". in "client" mode only client-side code gets generated. in "server" mode only server-side code gets generated. in "both" mode you get client-side and server-side code generated. pick your fighter ✨
• -help or --help — displays a short usage summary and exits. your little safety blanket, bestie 🌈

👑 AUTHOR 👑

Jérémie Dimino <jeremie@dimino.org>

🌈 SEE ALSO 🌈

obus-introspect(1), obus-gen-client(1), obus-gen-server(1).

okay that's the whole page, you ate it, periodt 💖 this was the April 2010 era of OBUS-GEN-INTERFACE, part of the General Commands Manual fam — go forth and generate, bestie 🧚⭐