roarfilt(1)

📦 version 1.0~beta12, in ubuntu jammy

💖 roarfilt — the manual page, bestie edition 💖

okay so this is the manual page for roarfilt (that's the roarfilt(1) page, section 1 of the System Manager's Manual, in case the vibe check required receipts ✨). She's a RoarAudio sound server audio filter client, and she's here to glow up your audio before it hits the soundcard. no cap. 🎀

✨ SYNOPSIS ✨

roarfilt [OPTIONS]...

that's it. that's the whole summoning ritual. options in, filtered audio out. 💅

🌸 DESCRIPTION 🌸

So what does she do? She filters the audio data before it gets sent to the soundcard. that's the whole job. she catches your sound mid-journey and is like "hmm, not on my watch, let me adjust this" and then sends it on its merry way. main character energy, honestly. 🦋

💜 GENERAL OPTIONS 💜

⚠️ NOTE: This list is incomplete! like, genuinely, it's not the whole picture. On top of what's written here, this program also gives you compatible options for esdfilt. You can literally just take the "esd" in the name and swap it for "roar", or use symlinks. But — and listen — those options are for compatibility only and should not be used in new programs. it's giving "we keep it around for the old heads." periodt. 🙈
  • --help — prints some help text. the classic. the icon. when in doubt, ask for help. 👑

🎧 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. ✨

🌈 NETWORK OPTIONS 🌈

  • --server SERVER — the server to connect to. who are we talking to today bestie 💖

🕰️ OLD ROARFILT OPTIONS 🕰️

these are the OG volume moves. volume core, if you will. 🔊

  • --half — half the volume. ✂️
  • --double — double the volume. 📈
  • --amp n, --mul n — amplify volume by n. 💥
  • --div n — divide volume by n. ➗

🧚 FILTER OPTIONS 🧚

the actual filter toolbox. this is where the magic happens, fr fr. 🌟

  • --filter name — this adds a new filter of name name. 🎀
  • --ffreq freq — this sets a frequency for the filter. 🎵
  • --fmul mult — this sets a multiplier for the filter. ✖️
  • --fdiv div — this sets a divider for the filter. ➗
  • --fn N — this sets the filter's N value. 🔢
  • --flimit limit — this sets the filter's limit value. 🚧
  • --fmode mode — set filter mode parameter. This sets the filter mode. Symbolic values are currently not supported. so like, numbers only, bestie, no cute names yet 😭
  • --fq Q — this sets the filter quality. 💎

🌿 ENVIRONMENT VARIABLES 🌿

below is only the basic environment variables, listed out. for a complete list, go see libroar(7). iykyk 📚

  • HOME — the users home directory. 🏠
  • ROAR_SERVER — the address of the listening server. This may be in form of host:port for TCP/IP connections and /path/to/sock for UNIX Domain Sockets or any other supported format. See roartips(7) for a full list. This is the same as the --server option. 🔌

💀 BUGS 💀

There are a lot of bugs...

(that's the whole section. she said what she said. not me reading that and feeling seen 😭)

👀 SEE ALSO 👀

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

go read those too, they're the rest of the friend group 🫶

📜 HISTORY 📜

For history information see RoarAudio(7). 🕰️

and that's the page, bestie!! this whole thing is brought to you by RoarAudio, dated October 2013 💖✨ mwah, go filter something iconic 🎀🦋💅

📦 where this page comes from