section "general options"
-option "loglevel" l "set loglevel (0-6)" int typestr="level" default="4" no
-option "socket" s "well-known socket (default=/var/paraslash/audiod.socket.$HOSTNAME)" string typestr="filename" no
-option "tmpdir" d "directory for temporary socket (default=~/.paraslash)" string typestr="dirname" no
-option "timeout" t "maximum time in seconds to wait for server response before giving up" int typestr="seconds" default="1" no
-option "bufsize" b "size of internal buffer" int typestr="bytes" default="8192" no
+option "loglevel" l "set loglevel (0-6)" int typestr="level" default="4" optional
+option "socket" s "well-known socket (default=/var/paraslash/audiod.socket.$HOSTNAME)" string typestr="filename" optional
+option "tmpdir" d "directory for temporary socket (default=~/.paraslash)" string typestr="dirname" optional
+option "timeout" t "maximum time in seconds to wait for server response before giving up" int typestr="seconds" default="1" optional
+option "bufsize" b "size of internal buffer" int typestr="bytes" default="8192" optional
section "general options"
-option "user" u "run as user 'name'. Read the output of 'para_server -h' for a detailed information on this option." string typestr="name" no
-option "loglevel" l "set loglevel (0-6)" int typestr="level" default="4" no
+option "user" u "run as user 'name'. Read the output of 'para_server -h' for a detailed information on this option." string typestr="name" optional
+option "loglevel" l "set loglevel (0-6)" int typestr="level" default="4" optional
option "daemon" d "run as background daemon" flag off
option "force" F "force startup even if socket exits" flag off
-option "logfile" L "(default=stdout/stderr)" string typestr="filename" no
-option "mode" m "mode to use on startup (on/off/sb)" string typestr="mode" default="on" no
-option "socket" s "well-known socket to listen on (default=/var/paraslash/audiod_sock.<host_name>)" string typestr="filename" no
+option "logfile" L "(default=stdout/stderr)" string typestr="filename" optional
+option "mode" m "mode to use on startup (on/off/sb)" string typestr="mode" default="on" optional
+option "socket" s "well-known socket to listen on (default=/var/paraslash/audiod_sock.<host_name>)" string typestr="filename" optional
option "user_allow" -
specified at all, allow all users to
connect."
-int typestr="uid" default="-1" no multiple
+int typestr="uid" default="-1" optional multiple
section "stream i/o options."
-r 'mp3:http -i www.paraslash.org -p 8009'
"
-string typestr="receiver_spec" default="http" no multiple
+string typestr="receiver_spec" default="http" optional multiple
#################
option "no_default_filters" D "Configure filters manually.
Note that these options are ignored by default,
see --no_default_filters."
-string typestr="filter_spec" no multiple
+string typestr="filter_spec" optional multiple
#################
at runtime by the stream start time announced
by para_server, plus any offsets."
-string typestr="format:command" no multiple
+string typestr="format:command" optional multiple
#################
"Deactivate slot if idle for that many seconds"
-int typestr="seconds" default="30" no
+int typestr="seconds" default="30" optional
# file client.conf
-option "hostname" i "ip or host to connect" string typestr="host" default="localhost" no
-option "user" u "paraslash username" string typestr="username" default="<current user>" no
-option "server_port" p "port to connect" int typestr="port" default="2990" no
-option "key_file" k "(default='~/.paraslash/key.<user>')" string typestr="filename" no
-option "loglevel" l "set loglevel (0-6)" int typestr="number" default="5" no
-option "config_file" c "(default='~/.paraslash/client.conf')" string typestr="filename" no
+option "hostname" i "ip or host to connect" string typestr="host" default="localhost" optional
+option "user" u "paraslash username" string typestr="username" default="<current user>" optional
+option "server_port" p "port to connect" int typestr="port" default="2990" optional
+option "key_file" k "(default='~/.paraslash/key.<user>')" string typestr="filename" optional
+option "loglevel" l "set loglevel (0-6)" int typestr="number" default="5" optional
+option "config_file" c "(default='~/.paraslash/client.conf')" string typestr="filename" optional
option "plain" - "request an uncrypted session" flag off
section "The dynamic audio range compressor"
-option "blocksize" b "larger blocksize means fewer volume adjustments per time unit" int typestr="number" default="16" no
-option "aggressiveness" a "controls the maximum amount to amplify by" int typestr="number" default="2" no
-option "inertia" i "how much inertia ramping has" int typestr="number" default="6" no
-option "target_level" t "target signal level (0-32768)" int typestr="number" default="25000" no
-option "damp" d "if non-zero, scale down after normalizing" int typestr="number" default="0" no
+option "blocksize" b "larger blocksize means fewer volume adjustments per time unit" int typestr="number" default="16" optional
+option "aggressiveness" a "controls the maximum amount to amplify by" int typestr="number" default="2" optional
+option "inertia" i "how much inertia ramping has" int typestr="number" default="6" optional
+option "target_level" t "target signal level (0-32768)" int typestr="number" default="25000" optional
+option "damp" d "if non-zero, scale down after normalizing" int typestr="number" default="0" optional
section "options of the dccp receiver"
-option "host" i "ip or host" string default="localhost" no
-option "port" p "port to connect to" int default="5001" no
+option "host" i "ip or host" string default="localhost" optional
+option "port" p "port to connect to" int default="5001" optional
section "general options"
-option "mode" o "{sleep|fade|snooze}" string default="sleep" no
-option "config_file" c "(default='~/.paraslash/fade.conf')" string typestr="filename" no
-option "mixer_device" m "mixer device file" string typestr="device" default="/dev/mixer" no
+option "mode" o "{sleep|fade|snooze}" string default="sleep" optional
+option "config_file" c "(default='~/.paraslash/fade.conf')" string typestr="filename" optional
+option "mixer_device" m "mixer device file" string typestr="device" default="/dev/mixer" optional
section "sleep options (only relevant in sleep mode)"
-option "sleep_ivol" - "set initial volume before doing anything else" int typestr="volume" default="60" no
-option "fa_stream" - "fall asleep stream. Change to this stream right after setting the volume" string typestr="streamname" default="fa" no
-option "fa_fade" - "fall asleep fading time, no fading if set to 0" int typestr="seconds" default="1800" no
-option "fa_vol" - "volume to fade to" int typestr="volume" default="20" no
-option "sleep_stream" - "change to this stream after fading, stop playing if unset" string typestr="streamname" default="sleep" no
-option "wake_hour" H "(0-23)" int default="8" no
-option "wake_min" M "(0-59)" int default="0" no
-option "wake_stream" - "changed to on waketime" string typestr="streamname" default="wake" no
-option "wake_fade" - "no fading in if set to 0" int typestr="seconds" default="1200" no
-option "wake_vol" - "vol to fade to at waketime" int typestr="volume" default="80" no
+option "sleep_ivol" - "set initial volume before doing anything else" int typestr="volume" default="60" optional
+option "fa_stream" - "fall asleep stream. Change to this stream right after setting the volume" string typestr="streamname" default="fa" optional
+option "fa_fade" - "fall asleep fading time, no fading if set to 0" int typestr="seconds" default="1800" optional
+option "fa_vol" - "volume to fade to" int typestr="volume" default="20" optional
+option "sleep_stream" - "change to this stream after fading, stop playing if unset" string typestr="streamname" default="sleep" optional
+option "wake_hour" H "(0-23)" int default="8" optional
+option "wake_min" M "(0-59)" int default="0" optional
+option "wake_stream" - "changed to on waketime" string typestr="streamname" default="wake" optional
+option "wake_fade" - "no fading in if set to 0" int typestr="seconds" default="1200" optional
+option "wake_vol" - "vol to fade to at waketime" int typestr="volume" default="80" optional
section "snooze options"
-option "snooze_out_fade" - "fade out time" int typestr="seconds" default="30" no
-option "snooze_out_vol" - "vol to fade to before snooze" int typestr="volume" default="20" no
-option "snooze_time" - "delay" int typestr="seconds" default="600" no
-option "snooze_in_fade" - "fade in time" int typestr="seconds" default="180" no
-option "snooze_in_vol" - "vol to fade to after snooze" int typestr="volume" default="80" no
+option "snooze_out_fade" - "fade out time" int typestr="seconds" default="30" optional
+option "snooze_out_vol" - "vol to fade to before snooze" int typestr="volume" default="20" optional
+option "snooze_time" - "delay" int typestr="seconds" default="600" optional
+option "snooze_in_fade" - "fade in time" int typestr="seconds" default="180" optional
+option "snooze_in_vol" - "vol to fade to after snooze" int typestr="volume" default="80" optional
section "fade options"
-option "fade_vol" f "volume to fade to" int typestr="volume" default="50" no
-option "fade_time" t "time to fade in" int typestr="seconds" default="5" no
+option "fade_vol" f "volume to fade to" int typestr="volume" default="50" optional
+option "fade_time" t "time to fade in" int typestr="seconds" default="5" optional
-option "loglevel" l "set loglevel (0-6)" int typestr="level" default="4" no
+option "loglevel" l "set loglevel (0-6)" int typestr="level" default="4" optional
option "filter" f "Specify filter.
May be given multiple times to 'pipe' the stream
-f 'compress --inertia 5 --damp 2'
"
-string typestr="filter_spec" no multiple
+string typestr="filter_spec" optional multiple
option "list_filters" L "print list of available filters and exit" flag off
-option "filter_num" f "point of filter chain to grab" int typestr="num" default="1" no
-option "slot" s "only grab this slot; grab any slot if negative" int typestr="num" default="-1" no
-option "mode" m "sloppy, pedantic, or aggressive" string typestr="grab_mode" default="sloppy" no
-option "audio_format" a "only grab this type of input stream; grab any if empty" string typestr="name" default="" no
-option "input_grab" i "grab the filter input instead of its output" flag off no
-option "one_shot" o "stop grabbing if audio file changes" flag off no
+option "filter_num" f "point of filter chain to grab" int typestr="num" default="1" optional
+option "slot" s "only grab this slot; grab any slot if negative" int typestr="num" default="-1" optional
+option "mode" m "sloppy, pedantic, or aggressive" string typestr="grab_mode" default="sloppy" optional
+option "audio_format" a "only grab this type of input stream; grab any if empty" string typestr="name" default="" optional
+option "input_grab" i "grab the filter input instead of its output" flag off optional
+option "one_shot" o "stop grabbing if audio file changes" flag off optional
section "general options"
option "auto_decode" a "auto-decode audio stream" flag on
-option "config_file" c "(default='~/.paraslash/gui.conf')" string typestr="filename" no
-option "loglevel" l "set loglevel (0-6)" int typestr="level" default="4" no
-option "timeout" t "set timeout" int typestr="milliseconds" default="300" no
-option "stat_cmd" s "command to read server and audiod status data from" string typestr="command" default="para_audioc -t 100 stat" no
+option "config_file" c "(default='~/.paraslash/gui.conf')" string typestr="filename" optional
+option "loglevel" l "set loglevel (0-6)" int typestr="level" default="4" optional
+option "timeout" t "set timeout" int typestr="milliseconds" default="300" optional
+option "stat_cmd" s "command to read server and audiod status data from" string typestr="command" default="para_audioc -t 100 stat" optional
section "mapping keys to commands"
-option "key_map" k "Map key k to command c using mode m. Mode may be d, x or p for display, external and paraslash commands, respectively. Of course, this option may be given multiple times, one for each key mapping." string typestr="k:m:c" no multiple
+option "key_map" k "Map key k to command c using mode m. Mode may be d, x or p for display, external and paraslash commands, respectively. Of course, this option may be given multiple times, one for each key mapping." string typestr="k:m:c" optional multiple
section "options of the http receiver"
-option "host" i "ip or host" string default="localhost" no
-option "port" p "tcp port to connect to" int default="8000" no
+option "host" i "ip or host" string default="localhost" optional
+option "port" p "tcp port to connect to" int default="8000" optional
-option "bufsize" b "size of output buffer" int typestr="kilobyte" default="128" no
-option "initial_buffer" i "size of initial input buffer" int typestr="kilobyte" default="16" no
+option "bufsize" b "size of output buffer" int typestr="kilobyte" default="128" optional
+option "initial_buffer" i "size of initial input buffer" int typestr="kilobyte" default="16" optional
section "ortp options"
-option "host" i "ip or host to receive rtp packets from" string default="224.0.1.38" no
-option "port" p "udp port." int typestr="portnumber" default="1500" no
-option "jitter_compensation" j "non-zero values enable ortp's adaptive jitter compensation" int typestr="milliseconds" default="400" no
+option "host" i "ip or host to receive rtp packets from" string default="224.0.1.38" optional
+option "port" p "udp port." int typestr="portnumber" default="1500" optional
+option "jitter_compensation" j "non-zero values enable ortp's adaptive jitter compensation" int typestr="milliseconds" default="400" optional
section "general options"
-option "start_time" t "start playback at given time which must be in a:b format where a denotes seconds and b denotes microseconds since the epoch" string typestr="timeval" no
-option "device" d "set PCM device" string typestr="device" default="plughw:0,0" no
-option "channels" c "number of channels (only neccessary for raw audio)" int typestr="num" default="2" no
-option "sample_rate" s "force given sample rate (only neccessary for raw audio)" int typestr="num" default="44100" no
-option "bufsize" b "input buffer size" int typestr="kilobytes" default="64" no
-option "prebuffer" p "delay playback until buffer is filled" int typestr="percent" default="100" no
+option "start_time" t "start playback at given time which must be in a:b format where a denotes seconds and b denotes microseconds since the epoch" string typestr="timeval" optional
+option "device" d "set PCM device" string typestr="device" default="plughw:0,0" optional
+option "channels" c "number of channels (only neccessary for raw audio)" int typestr="num" default="2" optional
+option "sample_rate" s "force given sample rate (only neccessary for raw audio)" int typestr="num" default="44100" optional
+option "bufsize" b "input buffer size" int typestr="kilobytes" default="64" optional
+option "prebuffer" p "delay playback until buffer is filled" int typestr="percent" default="100" optional
-option "loglevel" l "set loglevel (0-6)" int typestr="level" default="4" no
+option "loglevel" l "set loglevel (0-6)" int typestr="level" default="4" optional
option "list_receivers" L "print list of available receivers" flag off
option "receiver" r "Select receiver.
-r 'http -i www.paraslash.org -p 8009'
"
-string typestr="receiver_spec" default="http" no
+string typestr="receiver_spec" default="http" optional
-# file sample1.ggo
option "fullscreen" f "Use fullscreeen mode" flag off
option "interactive" i "Activate interactive mode" flag off
-option "width" x "Specify screen width" int typestr="pixels" default="1024" no
-option "height" y "Specify screen height" int typestr="pixels" default="768" no
-option "config_file" c "(default='~/.paraslash/sdl_gui.conf')" string typestr="filename" no
-option "window-id" w "(currently ignored)" string typestr="filename" no
-option "stat_cmd" s "command to read server and audiod status data from" string typestr="command" default="para_audioc -t 100 stat" no
-option "pic_cmd" p "command to read pic from" string typestr="command" default="para_client pic" no
+option "width" x "Specify screen width" int typestr="pixels" default="1024" optional
+option "height" y "Specify screen height" int typestr="pixels" default="768" optional
+option "config_file" c "(default='~/.paraslash/sdl_gui.conf')" string typestr="filename" optional
+option "window-id" w "(currently ignored)" string typestr="filename" optional
+option "stat_cmd" s "command to read server and audiod status data from" string typestr="command" default="para_audioc -t 100 stat" optional
+option "pic_cmd" p "command to read pic from" string typestr="command" default="para_client pic" optional
section "General options"
-option "loglevel" l "set loglevel (0-6)" int typestr="level" default="4" no
-option "port" p "port to listen on" int typestr="portnumber" default="2990" no
+option "loglevel" l "set loglevel (0-6)" int typestr="level" default="4" optional
+option "port" p "port to listen on" int typestr="portnumber" default="2990" optional
option "daemon" d "run as background daemon" flag off
-option "user" u "run as user 'name'. para_server does not need any special privileges. If started as root (EUID == 0) this option must be given at the command line (not in the configuration file) so that para_server can drop the root privileges right after parsing the command line options, but before parsing the configuration file. In this case, real/effective/saved UID are all set to the UID of 'username'. As the configuration file is read afterwards, those options that have a default value depending on the UID (e.g. the home directory for the configuration file) are computed by using the uid of 'username'. This option has no effect if para_server ist started as a non-root user (i.e. EUID != 0)" string typestr="name" no
+option "user" u "run as user 'name'. para_server does not need any special privileges. If started as root (EUID == 0) this option must be given at the command line (not in the configuration file) so that para_server can drop the root privileges right after parsing the command line options, but before parsing the configuration file. In this case, real/effective/saved UID are all set to the UID of 'username'. As the configuration file is read afterwards, those options that have a default value depending on the UID (e.g. the home directory for the configuration file) are computed by using the uid of 'username'. This option has no effect if para_server ist started as a non-root user (i.e. EUID != 0)" string typestr="name" optional
section "Configuration files"
-option "logfile" L "(default=stdout/stderr)" string typestr="filename" no
-option "config_file" c "(default='~/.paraslash/server.conf'" string typestr="filename" no
-option "user_list" - "(default='~/.paraslash/server.users')" string typestr="filename" no
+option "logfile" L "(default=stdout/stderr)" string typestr="filename" optional
+option "config_file" c "(default='~/.paraslash/server.conf'" string typestr="filename" optional
+option "user_list" - "(default='~/.paraslash/server.users')" string typestr="filename" optional
section "audio file sender"
option "autoplay" a "start playing on startup" flag off
-option "announce_time" A "Delay betweeen announcing the stream and sending data" int typestr="milliseconds" default="300" no
-option "selector" S "(default=random)" string typestr="name" no
+option "announce_time" A "Delay betweeen announcing the stream and sending data" int typestr="milliseconds" default="300" optional
+option "selector" S "(default=random)" string typestr="name" optional
section "mysql selector:"
-option "mysql_host" - "mysql server" string default="localhost" no
-option "mysql_port" - "where mysql is listening" int default="3306" no
-option "mysql_user" - "default value: username from /etc/passwd" string no
-option "mysql_passwd" - "(required)" string no
-option "mysql_database" - "name of mysql database" string default="paraslash" no
-option "mysql_audio_file_dir" - "dir to search for audio files (required)" string no
-option "mysql_default_score" - "scoring rule to use if stream definition does not contain explicit score definition" string default="(LASTPLAYED() / 1440 - 1000 / (LASTPLAYED() + 1) - sqrt(NUMPLAYED()))" no
+option "mysql_host" - "mysql server" string default="localhost" optional
+option "mysql_port" - "where mysql is listening" int default="3306" optional
+option "mysql_user" - "default value: username from /etc/passwd" string optional
+option "mysql_passwd" - "(required)" string optional
+option "mysql_database" - "name of mysql database" string default="paraslash" optional
+option "mysql_audio_file_dir" - "dir to search for audio files (required)" string optional
+option "mysql_default_score" - "scoring rule to use if stream definition does not contain explicit score definition" string default="(LASTPLAYED() / 1440 - 1000 / (LASTPLAYED() + 1) - sqrt(NUMPLAYED()))" optional
section "random selector"
-option "random_dir" - "dir to search for audio files" string default="/home/music" no
+option "random_dir" - "dir to search for audio files" string default="/home/music" optional
section "http sender"
-option "http_port" - "tcp port for http streaming" int typestr="portnumber" default="8000" no
+option "http_port" - "tcp port for http streaming" int typestr="portnumber" default="8000" optional
option "http_default_deny" - "deny connections from hosts which are not explicitly allowed" flag off
-option "http_access" - "Add given host/network to access control list (whitelist if http_default_deny was given, blacklist otherwise) before opening the tcp port. This option can be given multiple times. Example: '192.168.0.0/24' whitelists/blacklists the 256 hosts 192.168.0.x" string typestr="a.b.c.d/n" no multiple
+option "http_access" - "Add given host/network to access control list (whitelist if http_default_deny was given, blacklist otherwise) before opening the tcp port. This option can be given multiple times. Example: '192.168.0.0/24' whitelists/blacklists the 256 hosts 192.168.0.x" string typestr="a.b.c.d/n" optional multiple
option "http_no_autostart" - "do not open tcp port on server startup" flag off
-option "http_max_clients" - "maximal simultaneous connections, non-positive value means unlimited" int typestr="number" default="-1" no
+option "http_max_clients" - "maximal simultaneous connections, non-positive value means unlimited" int typestr="number" default="-1" optional
section "dccp sender"
-option "dccp_port" - "port for dccp streaming" int typestr="portnumber" default="5001" no
+option "dccp_port" - "port for dccp streaming" int typestr="portnumber" default="5001" optional
section "ortp sender"
-option "ortp_target" - "Add given host/port to the list of targets. This option can be given multiple times. Example: '224.0.1.38:1500' instructs the ortp sender to send to udp port 1500 on host 224.0.1.38 (unassigned ip in the Local Network Control Block 224.0.0/24). This is useful for LAN-streaming." string typestr="a.b.c.d:p" no multiple
+option "ortp_target" - "Add given host/port to the list of targets. This option can be given multiple times. Example: '224.0.1.38:1500' instructs the ortp sender to send to udp port 1500 on host 224.0.1.38 (unassigned ip in the Local Network Control Block 224.0.0/24). This is useful for LAN-streaming." string typestr="a.b.c.d:p" optional multiple
option "ortp_no_autostart" - "do not start to send automatically" flag off
-option "ortp_default_port" - "default udp port if not specified" int typestr="portnumber" default="1500" no
-option "ortp_header_interval" H "time between extra header sends" int typestr="milliseconds" default="2000" no
-option "ortp_jitter_compensation" j "non-zero values enable ortp's adaptive jitter compensation" int typestr="milliseconds" default="400" no
+option "ortp_default_port" - "default udp port if not specified" int typestr="portnumber" default="1500" optional
+option "ortp_header_interval" H "time between extra header sends" int typestr="milliseconds" default="2000" optional
+option "ortp_jitter_compensation" j "non-zero values enable ortp's adaptive jitter compensation" int typestr="milliseconds" default="400" optional