SHOUT(1)

πŸ’– SHOUT(1) β€” the manual, but make it cute πŸ’–

okay so bestie, welcome to the General Commands Manual entry for shout β€” yes the name is literally in ALL CAPS, it's giving main character energy and honestly? slay. Sit down, grab a strawberry πŸ“, and let's get you streaming.


✨ NAME ✨

shout β€” Icecast source client πŸ‘‘


✨ SYNOPSIS ✨

shout [OPTIONS]

✨ DESCRIPTION ✨

So here's the vibe: shout reads data from standard input and streams it to Icecast. That's it. That's the whole thing. You feed it bytes on stdin, it yeets them at Icecast. No cap. πŸ¦‹


✨ OPTIONS ✨

Every single flag, no gatekeeping, we're going through ALL of them πŸ’…

  • --format format β€” Sets the stream format. It can be "ogg", "mp3", or "webm". Default is "ogg".
  • -H host β€” See --host (same thing, shorter name, we love an alias ✨)
  • -h β€” See --help
  • --help β€” Shows help. Iconic of it.
  • --host host β€” Sets the destination host. Default is "localhost".
  • --mount string β€” Sets the mountpoint. Default is "/example.ogg".
  • -P port β€” See --port
  • --pass string β€” Sets the source password. Default is "hackme". (Yes really. Change it bestie, I'm begging 😭)
  • --port port β€” Sets the destination port. Symbolic names are supported. Default is 8000.
  • --proto protocol β€” Sets the protocol. Default is "http".
  • --station-description string β€” Sets the stream description.
  • --station-genre string β€” Sets the stream genre.
  • --station-meta key=value β€” Sets meta information. Both key and value are arbitrary strings, so go feral πŸŽ€
  • --station-name string β€” Sets the stream name.
  • --station-url string β€” Sets the stream URL.
  • --tls-mode tls-mode β€” Sets the TLS mode. This can be "disabled", "auto", "auto_no_plain", "rfc2818", or "rfc2817". Default is "auto".
Heads up: when libshout is built without TLS support, only "disabled" and "auto" are supported. That's it, those two, the rest are not invited to the party πŸ™ˆ
  • --usage usage{,usage} β€” Sets the stream usages. This can be:
    • "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".

✨ NOTES ✨

okay this part is lowkey fun: if this binary is symlinked, or hardlinked, to the name "oggfwd", it provides drop-in compatibility with oggfwd(1). So like, one binary, two identities, very shapeshifter of it 🧚✨


and that's the whole page bestie, you're officially certified 🫢

This one came from Debian, dated Dec 16, 2020. Go stream something iconic. Periodt. πŸ’…πŸŒˆβ­