SHOUT(1)

💖 SHOUT — bestie's guide to the shout command 💖

okay so, welcome to shout(1), a General Commands Manual situation, and honestly? it's giving "pipe audio into Icecast and let the internet hear it". let's go 🎀

✨ NAME ✨

shout — Icecast source client. that's it, that's the girl 💅

🌸 SYNOPSIS 🌸

shout [OPTIONS]

🦋 DESCRIPTION 🦋

so here's the tea, bestie: shout reads data from standard input and streams it straight to Icecast. that's the whole vibe. stdin in, radio out, no cap 🔥

👑 OPTIONS 👑

one bullet per option, all of them, no skipping, we don't do that here 💖

• --format format — sets the stream format. the options are "ogg", "mp3", or "webm". the default? "ogg". classic, iconic, we love her.
• -H host — shortie for --host, look down there ⬇️
• -h — shortie for --help, look down there ⬇️
• --help — shows help. when in doubt, ask for help, that's growth 🌱
• --host host — sets the destination host. default is "localhost", aka the girl next door.
• --mount string — sets the mountpoint. default is "/example.ogg".
• -P port — shortie for --port, look down there ⬇️
• --pass string — sets the source password. default is "hackme". yes, really, that's the default, and yes, please change it, i'm begging 🫶
• --port port — sets the destination port. symbolic names are supported (so like, service names, not just numbers, fancy 💅). default is 8000.
• --proto protocol — sets the protocol. default is "http".
• --station-description string — sets the stream description. tell the people what they're hearing ✨
• --station-genre string — sets the stream genre. genre tagging is self-care.
• --station-meta key=value — sets meta information. both key and value are arbitrary strings, so go feral, be weird, it's fine.
• --station-name string — sets the stream name. this is the main character title card 👑
• --station-url string — sets the stream URL. link the people to the place.
• --tls-mode tls-mode — sets the TLS mode. the options are "disabled", "auto", "auto_no_plain", "rfc2818", or "rfc2817". default is "auto". ⚠️ heads up though: when libshout is built without TLS support, only "disabled" and "auto" are actually supported. don't get caught out bestie.
• --usage usage{,usage} — sets the stream usages. it can be any of these, and you can comma-separate multiple of them (that's what the {,usage} is telling you 💖):
  • "audio" — for audio substreams
  • "visual" — for picture/video substreams (most often combined with "audio")
  • "text" — for text substreams that are not subtitles
  • "subtitle" — for subtitle substreams
  • "light" — for light control substreams
  • "ui" — for user interface data, such as DVD menus or buttons
  • "metadata" — for substreams that include metadata for the stream
  • "application" — for application specific data substreams
  • "control" — for substreams that control the infrastructure
  • "complex" — for substreams that are themself a mixture of other types
  • "other" — for substream of types not listed here
  • "unknown" — for streams that may contain additional substreams of unknown nature
  • "3d" — for streams that contain information for 3D playback
  • "4d" — for streams that contain information for 4D/XD playback
• --user string — sets the source user. default is "source". yes bestie, you are the source, you ARE the moment 🌈

🌟 NOTES 🌟

plot twist era: if this binary is symlinked, or hardlinked to the name "oggfwd", it gives you drop-in compatibly with oggfwd(1). one binary, two identities, shapeshifting queen 🧚

and that's the whole page, bestie! this lil Debian build is dated Dec 16, 2020, so go stream something beautiful, change that "hackme" password, and remember — you're the source client of your own destiny 💜✨