.\" Automatically generated by Pandoc 2.9.2.1
.\"
.TH "LIQUIDSOAP" "1" "Jul 24, 2019" "Liquidsoap 1.4.3" "Liquidsoap 1.4.3"
.hy
.SH NAME
.PP
liquidsoap - a multimedia streaming language
.SH SYNOPSIS
.PP
liquidsoap [ \f[I]options\f[R] ] [ \f[I]script\f[R] |
\f[I]expression\f[R] ]
.SH DESCRIPTION
.PP
Liquidsoap is a programming language for describing multimedia streaming
systems.
It is very flexible, making simple things simple but giving a lot of
control for advanced uses.
Liquidsoap supports audio, video and MIDI streams, and a wide range of
input/output operators including Icecast and various soundcard APIs.
It can perform a broad range of signal processing, combine streams in
various ways, support custom transitions, generate sound
procedurally\&... and all this can be assembled as you wish.
Input files can be accessed remotely, or even be synthesized on the fly
using external scripts such as speech synthesis.
Finally, interaction with a running liquidsoap instance is possible via
telnet or socket.
.PP
Liquidsoap scripts passed on the command line will be evaluated: they
shall be used to define the streaming system to be ran.
It is possible to pass multiple scripts; they will all be ran
successively, and definitions from one script can be used in subsequent
ones.
A script will be read from standard input if \f[C]-\f[R] is given as
script filename.
Information about scripting liquidsoap is available on our website:
.
.PP
If the parameter is not a file it will be treated as an expression which
will be executed.
It is a convenient way to test simple one-line scripts.
When running only one-liners, the default is to log messages directly on
stdout rather than to a file.
.SH OPTIONS
.TP
-
Read script from standard input.
.TP
--
Stop parsing the command-line and pass subsequent items to the script.
.TP
--debug
Print debugging log messages.
.TP
--dynamic-plugins-dir \f[I]path\f[R]
Directory where to look for plugins.
.TP
--errors-as-warnings
Issue warnings instead of fatal errors for unused variables and ignored
expressions.
If you are not sure about it, it is better to not use it.
.TP
--interactive
Start an interactive interpreter.
.TP
--list-plugins
List all plugins (builtin scripting values, supported formats and
protocols).
.TP
--list-plugins-xml
List all plugins (builtin scripting values, supported formats and
protocols), output as XML.
.TP
--no-pervasives
Do not load pervasive script libraries.
.TP
--version
Display Liquidsoap\[cq]s version.
.TP
-c, --check
Check and evaluate scripts but do not perform any streaming.
.TP
-cl, --check-lib
Like --check but treats all scripts and expressions as libraries, so
that unused toplevel variables are not reported.
.TP
-d, --daemon
Run in daemon mode.
.TP
-f, --force-start
For advanced dynamic uses: force liquidsoap to start even when no active
source is initially defined.
.TP
-h \f[I]plugin\f[R]
Print the description of a plugin, eg.
a builtin scripting function.
.TP
-i
Display inferred types.
.TP
-p, \[en]parse-only
Parse scripts but do not type-check and run them.
.TP
-q, --quiet
Do not print log messages on standard output.
.TP
-r \f[I]filename\f[R]
Process a request.
.TP
-T, --disable-telnet
Disable the telnet server.
.TP
-U, --disable-unix-socket
Disable the unix socket.
.TP
-t, --enable-telnet
Enable the telnet server.
.TP
-u, --enable-unix-socket
Enable the unix socket.
.TP
-v, --verbose
Print log messages on standard output.
.TP
--conf-descr-key \f[I]key\f[R]
Describe a configuration key.
.TP
--conf-descr
Show all configuration keys with their documentation.
.TP
--conf-descr-liqi
Show all configuration keys with their documentation in liqi
(documentation wiki) format.
.TP
--conf-dump
Dump the configuration state
.PP
-help, --help Display this list of options
.SH SEE ALSO
.PP
Our website and the HTML documentation coming
with your distribution of Liquidsoap.
.SH AUTHOR
.PP
The savonet team.