br(1)

💅 br(1) — bestie's guide to the Firecracker ✨

okay so this is the manual page for br, and it lives in the General Commands Manual, section 1. yeah. we're doing Unix today and we're doing it cutely.

🌸 NAME 🌸

br — a little utility to interact with your Firecracker device 🎀

🦋 SYNOPSIS 🦋

br [options] [housecode[list]] [native command] ...

that's it. that's the shape of it. options first, then a housecode (or a housecode plus a list, the drama), then optionally a native command trailing along after. slay.

💖 DESCRIPTION 💖

okay so real talk, this page is just a brief lil rundown of the br command — it's not trying to be a whole novel, it's trying to get you moving.

br is a program that talks to X10's Firecracker device, which means you get to manipulate X10 devices all over your house or your office. like. you are the main character of your own smart home. you are literally controlling the lights with a terminal. that's iconic behavior and i'm obsessed.

✨ OPTIONS ✨

so the programs here follow the usual GNU command line syntax, which means long options start with two dashes (-). a summary of the options is down below 👇

• -h, --help — shows you a summary of the options. your little safety net, bestie 🫶
• -v, --verbose — every single -v you add cranks the verbosity up another notch. stack 'em. go feral.
• -x, --port=PORT — sets the port to communicate with. heads up: this should be the port that the Firecracker module is actually plugged into 🔌
• -c, --house=[A-P] — use an alternate house code for operations. the default is A
• -n, --on=LIST — turns on all the devices in LIST
• -f, --off=LIST — turns off all the devices in LIST
• -N, --ON — turns on all the devices in the housecode. capital letters, capital energy 👑
• -F, --OFF — turns off all the devices in the housecode
• -d, --dim=LEVEL[,LIST] — dims the devices in the housecode (or in LIST, if you gave one) to a relative LEVEL
• -B, --lamps_on — turns on all the lamps in the housecode 💡
• -D, --lamps_off — turns off all the lamps in the housecode
• -r, --repeat=NUM — repeats the commands NUM times. and yeah, 0 means ~forever, so like… be so serious when you type that one 😭

ngl the 0 = ~forever one is giving chaos. use it with intention, bestie.

🎀 AUTHOR 🎀

this manual page was written by Ashley Clark <aclark@debian.org>, for the Debian GNU/Linux system — but like, it may be used by others too, no gatekeeping 💜

and that's the whole page, fr fr. section 1, General Commands Manual, written by Ashley Clark, and it signs off as br(1) — so go forth, dim your lamps, repeat your commands 0 times like a menace, and stay iconic. periodt. 💅✨