roarbaseclients(1)

📦 version 1.0~beta12, in ubuntu jammy

✨ roarbaseclients — the RoarAudio base clients, bestie edition ✨

okay so real talk: this is the manual page for roarcat and roarmon, aka the RoarAudio sound server base clients. it lives in the System Manager's Manual: roard section, and honestly? iconic little duo. let's get into it 💅

🌸 SYNOPSIS 🌸

roarcat [OPTIONS]... [FILE]

roarmon [OPTIONS]...

like, that's it. that's the whole vibe. roarcat optionally takes a FILE, roarmon doesn't take a file at all. slay.

🎀 DESCRIPTION 🎀

So these are some basic clients for RoarAudio. If you want the more complex ones, they're chilling in the SEE ALSO block below, go look. And if you're tryna control roard itself, that's a whole different girl — check roarctl(1). And for a simple Ogg Vorbis player, go see roarvorbis(1) (fun fact: ogg123 supports RoarAudio via the libao plugin 🫶).

Now the two mains:

  • roarcat — sends raw PCM audio data from a file or from stdin (like, a pipe) to the sound server. feeding the server. serving, literally.
  • roarmon — gets a copy of the audio data the server sends to the soundcard. this is the one you want if you're streaming to a server like icecast2(1). eavesdropping on the soundcard, but make it legal 💖

✨ GENERAL OPTIONS ✨

⚠️ NOTE: This list is incomplete! literally not all of it. In addition to this list, all three programs provide compatible options for esdcat and esdmon. You can just replace the "esd" in the name with "roar", or use symlinks. These options are for compatibility only and should not be used in new programs. periodt. don't do it.
  • --help — print some help text. that's the whole job. bless.

🔊 AUDIO OPTIONS 🔊

  • --rate RATE, -R RATE — set the server sample rate.
  • --bits BITS, -B BITS — set the server bits.
  • --chans CHANNELS, -C CHANNELS — set the server channels.

three little knobs, so much power 🔥

🌐 NETWORK OPTIONS 🌐

  • --server SERVER — the server to connect to. yeah. that one.

🦋 ENVIRONMENT VARIABLES 🦋

ngl, below are only the basic environment variables listed. for the complete list you gotta go see libroar(7). iykyk.

  • HOME — the user's home directory.
  • ROAR_SERVER — the address of the listening server. this may be in the form of host:port for TCP/IP connections, and /path/to/sock for UNIX Domain Sockets, or literally any other supported format. see roartips(7) for a full list. this is the same as the --server option, fr fr.

💀 BUGS 💀

There are a lot of bugs...

(i'm not even joking, that's the entire section. the audacity. the honesty. we respect it 😭)

👑 SEE ALSO 👑

roarctl(1), roarvorbis(1), roarfish(1), roartestclients(1), roartips(7), libroar(7), RoarAudio(7).

go read them. all of them. main character energy, every single one 💜

🌈 HISTORY 🌈

For history information see RoarAudio(7).

and that's a wrap, bestie!! this whole thing came to you from RoarAudio, dated July 2008 — a vintage baddie, honestly. stay hydrated, pipe responsibly, and remember: the bugs are part of the charm 🍓✨

📦 where this page comes from