XBRLAPI(1)

📦
version 6.9.1 · 7 versions
, in arch rolling, ubuntu stonking

✨ XBRLAPI ✨

okay bestie, this is the BrlAPI User's Manual page for xbrlapi, and it's literally the X11 BrlAPI helper for Linux/Unix 💅 and yes, I'm gonna walk you through every single flag, no cap.

🌸 NAME 🌸

xbrlapi — X11 BrlAPI helper for Linux/Unix

🦋 SYNOPSIS 🦋

xbrlapi [option ...]

💖 DESCRIPTION 💖

so what does xbrlapi actually do, you ask? 🫶 it connects to a BrlAPI server so it can hand over the ID of the X11 window that currently has focus. that's the whole gig, it's giving matchmaker but for windows and braille servers.

it also simulates X keysyms from braille key presses — because otherwise brltty would have to fake them using a qwerty keyboard, and, like, no ❌.

and here's the vibe: by default it puts itself in the background, unless you pass option -n. so if you're like "wait why is my terminal free again" — that's why, babe, it daemonized itself ✨

👑 OPTIONS 👑

heads up before we dive in: options are processed sequentially from left to right. if an option is specified more than once, or in case of a conflict, the rightmost specification takes precedence. so the last one wins, periodt 💅

the following options are supported:

  • -b [host][:port] (--brlapi=) — which BrlAPI server to connect to. that's the one, bestie 🎯
  • -a string (--auth=) — the BrlAPI authorization/authentication string 🔐
  • -d display (--display=) — the X display to connect to. if you don't specify it, the content of the DISPLAY environment variable gets used instead 🌈
  • -n (--no-daemon) — keeps xbrlapi in the foreground. main character stays on screen, no hiding 🎀
  • -q (--quiet) — do not write any text to the braille device. shhh 🤫
  • -h (--help) — prints a command line usage summary and then exits 🫶
  • -H (--full-help) — prints a thorough command line usage summary and then exits. the deluxe version, the director's cut, the extended edition 💖

🔥 SEE ALSO 🔥

for more details on the purpose of xbrlapi, see BrlAPI's on-line manual at:

[http://brltty.app/doc/Manual-BrlAPI/English/BrlAPI-3.html]

and that's the whole page, bestie, you ate it 💅✨ this was BrlAPI 0.8.8, dated April 2026 — mwah, go forth and focus those windows 🦋🎀

📦 where this page comes from