LIQUIDSOAP(1)

πŸ’– LIQUIDSOAP πŸ’–

okay bestie, welcome to liquidsoap β€” the manual page, but make it cute. it's a multimedia streaming language and it's honestly iconic. let's get into it πŸŽ€


✨ NAME ✨

liquidsoap β€” a multimedia streaming language πŸŽ§πŸ“‘


🌸 SYNOPSIS 🌸

liquidsoap [ options ] [ script | expression ]

πŸ’… DESCRIPTION πŸ’…

So. liquidsoap is a programming language for describing multimedia streaming systems. it's super flexible β€” like, simple things stay simple but you get SO much control if you're doing advanced stuff. it supports audio, video and MIDI streams, plus a whole range of input/output operators including Icecast and various soundcard APIs. it can do a broad range of signal processing, combine streams in all kinds of ways, support custom transitions, generate sound procedurally… and babe, all of it can be assembled however you want. no cap. πŸ”₯

input files can be accessed remotely, or even synthesized on the fly using external scripts like speech synthesis. and finally, you can interact with a running liquidsoap instance via telnet or socket. main character energy tbh. πŸ‘‘

Scripts passed on the command line get evaluated β€” they're what defines the streaming system you're gonna run. you can pass multiple scripts too! they all run successively, and definitions from one script can be used in subsequent ones. if you give - as the script filename, a script gets read from standard input. info about scripting liquidsoap lives on the website: http://liquidsoap.info/. πŸ¦‹

If the parameter isn't a file, it gets treated as an expression that will be executed. it's a convenient way to test simple one-line scripts. and when you're running only one-liners, the default is to log messages directly on stdout rather than to a file. cute, right? ✨


🌈 OPTIONS 🌈

  • - β€” read the script from standard input πŸ“₯
  • -- β€” stop parsing the command-line and pass the subsequent items to the script βœ‹
  • --build-config β€” display liquidsoap's build configuration πŸ› οΈ
  • --cache-only β€” parse, type-check and save the script's cache, but do not run it πŸ’Ύ
  • --cache-stdlib β€” generate the standard library cache πŸ“š
  • --debug β€” print debugging log messages πŸ›
  • --debug-errors β€” debug errors (show a stacktrace instead of printing a message) πŸ’€
  • --debug-lang β€” debug the language implementation πŸ”
  • --debug-levels β€” debug typing levels πŸ“Ά
  • --debug-subtyping β€” debug subtyping 🧬
  • --disable-deprecated β€” do not load wrappers for deprecated operators 🚫
  • --enable-deprecated β€” load wrappers for deprecated operators βœ…
  • --interactive β€” start an interactive interpreter πŸ’¬
  • --list-deprecated-functions-md β€” documentation of all deprecated functions in markdown πŸ“
  • --list-extra-functions-md β€” documentation of all extra functions in markdown πŸ“
  • --list-functions β€” list all functions πŸ“‹
  • --list-functions-by-category β€” list all functions, sorted by category πŸ—‚οΈ
  • --list-functions-json β€” documentation of all functions in JSON format 🧾
  • --list-functions-md β€” documentation of all functions in markdown format πŸ“„
  • --list-plugins β€” list all plugins (builtin scripting values, supported formats and protocols) πŸ”Œ
  • --list-portaudio-devices β€” list all available portaudio devices πŸŽ›οΈ
  • --list-protocols-md β€” documentation of all protocols in markdown πŸ“‘
  • --list-settings β€” display configuration keys in markdown format βš™οΈ
  • --no-cache β€” disable cache πŸš«πŸ’Ύ
  • --no-deprecated β€” deprecated: use --disable-deprecated ⚠️
  • --no-external-plugins β€” disable external plugins πŸ”ŒπŸš«
  • --no-fallible-check β€” ignore fallible sources πŸ™ˆ
  • --no-stdlib β€” do not load stdlib script libraries πŸ“šπŸš«
  • --opam-config β€” print out opam's liquidsoap.config, for internal use 🧰
  • --print-json-term β€” parse and output the script as normalized JSON. the JSON format is used internally to format code 🧾
  • --profile β€” profile execution ⏱️
  • --raw-errors β€” in normal executions, exceptions raised during the script are translated into user-friendly errors. use this option to let the original error surface. this is useful when debugging πŸ”₯πŸ›
  • --safe β€” disable the effects of --unsafe πŸ›‘οΈ
  • --stdlib β€” override the location of the standard library πŸ“šπŸ“
  • --strict β€” execute script code in strict mode, issuing fatal errors instead of warnings in some cases. currently: unused variables and ignored expressions 😀
  • --unsafe β€” faster startup using unsafe features ⚑
  • --version β€” display liquidsoap's version 🏷️
  • -T, --disable-telnet β€” disable the telnet server πŸ“΅
  • -U, --disable-unix-socket β€” disable the unix socket πŸ“΅
  • -c, --check β€” parse, type-check but do not evaluate the script βœ…
  • -d, --daemon β€” run in daemon mode πŸ‘»
  • -f, --force-start β€” for advanced dynamic uses: force liquidsoap to start even when no active source is initially defined πŸš€
  • -h β€” get help about a scripting value: source, operator, builtin or library function, etc. πŸ†˜
  • -i β€” display inferred types 🏷️
  • -p, --parse-only β€” parse script but do not type-check and run them πŸ“–
  • -q, --quiet β€” do not print log messages on standard output 🀫
  • -r, --request β€” process a file request and print the metadata πŸ—‚οΈ
  • -t, --enable-telnet β€” enable the telnet server πŸ“ž
  • -u, --enable-unix-socket β€” enable the unix socket πŸ”Œ
  • -v, --verbose β€” print log messages on standard output πŸ—£οΈ
  • -help β€” display this list of options πŸ“œ
  • --help β€” display this list of options πŸ“œ

🫢 SEE ALSO 🫢

Our website http://liquidsoap.info/ and the HTML documentation that comes with your distribution of liquidsoap. go read it, it's giving homework but in a fun way πŸ’–


πŸ‘‘ AUTHOR πŸ‘‘

The savonet team. 🫑


and that's the whole vibe, bestie ✨ this was Liquidsoap @version@, dated Jul 24, 2019 β€” take care of her, she's iconic πŸ’…πŸŽ€πŸŒˆ

πŸ“¦ where this page comes from