OGGFWD(1)

💖 OGGFWD — like, the manual, but make it make sense 💖

okay bestie so listen. oggfwd is the actual name of this iconic little utility (manual page name oggfwd, section 1, general commands manual, iykyk). and the whole thing is basically: pipe an Ogg stream from stdin to an Icecast server. that's it. that's the girl. 🎀

---

✨ SYNOPSIS ✨

oggfwd [-hp] [-m metadata file] [-d description] [-g genre] [-n name]
       [-u URL] [-T TLS mode] address port password mountpoint

like. look at her. she's got range. 🦋

---

🌸 DESCRIPTION 🌸

so oggfwd is a minimal source client for Icecast servers — minimal in the "she does one thing and she does it flawlessly" way, not the "she's underbaked" way. 💅

she reads an Ogg stream from stdin and forwards it to a server that you specify on the command line. that's the entire personality. no notes.

now here's the part where you have to actually pay attention, because the order is not negotiable:

address, port, password and mountpoint are all mandatory arguments, and you have to give them in that order. like, exactly that order. the vibes do not bend on this one. 🙈

Optional command line parameters 🫶

• -m metadata file — sets a file that holds stream meta data. like her little diary of stream info. 📓
• -d description — sets the stream description. tell the people what they're listening to. 🎤
• -g genre — sets the stream genre. tagging the vibe, essential. 🌈
• -h — prints a short usage summay. yes, that's how the original spells it, and we're keeping it, character for character, periodt. 💀
• -n name — sets the stream (i.e. radio) name. her government name, her stage name. 👑
• -p — allows the stream to be made public in stream directories. main character energy, activated. ✨
• -u URL — sets the stream URL. where the people can find her. 🔗
• -T TLS mode — this sets the TLS (encryption) mode. valid values are:
  • "disabled" — no encryption. naked and unafraid. 💀
  • "auto" — any encryption if available. ⭐
  • "auto_no_plain" — any encryption. 🔥
  • "rfc2818" — encryption based on RFC2818. 🧚
  • "rfc2817" — encryption based on RFC2817. 🧚

and for most users, the default mode "auto" should work just fine. like, don't overthink her, she's got you. 🫶

---

also, tiny iconic detail: oggfwd reacts to the hangup signal, SIGHUP, by printing the amount of bytes read from stdin to stdout at the next given opportunity. and how fast she reacts depends on the stream's current bitrate. so like... she's not ignoring you, she's just busy, bestie. 😭

---

🔥 EXAMPLES 🔥

Example one: to forward a public Ogg stream with the name “Test radio” to an Icecast server, one would pipe that stream to an oggfwd command line such as:

oggfwd -p -n "Test radio" radio.example.com 8000 password /stream.ogg

Example two: encode an Ogg Vorbis stream, dump it to disk and stream it at the same time:

oggenc - < input.wav | tee streamdump.ogg \
    | oggfwd radio.example.com 8000 password /stream.ogg

the way that second one does two things at once?? multitasking queen. 💅 and yes, that backslash is a real line continuation, keep it. 🎀

---

👑 AUTHORS 👑

programming by:

• J^ <j@v2v.cc>
• rafael2k <rafael@riseup.net>
• Moritz Grimm <gtgbr@gmx.net>

and this manual was contributed by Moritz Grimmi (yes, "Grimmi", that's literally what it says, we don't edit the icons) and updated by Philipp Schafft. ✨

---

💀 CAVEATS 💀

okay this one is important, look at me:

since the password to the Icecast server is given in clear text on the command line, other (local) users will probably be able to see it very easily.

so like... it's giving "everyone in the group chat can read your DMs". no cap. be aware. 🚨

---

anyway that's the whole page, bestie, you're basically an Icecast DJ now, go stream something. 🦋🌸💖

this page comes from Debian, dated April 12, 2015 — mwah, thanks for reading, love u, bye! 🎀✨