X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=audiod.ggo;h=94bf59d012a9837a29a3e6089555051700379e8c;hp=cafc851921eb2b650cc510185bfda7d77d25da10;hb=b564291f5f15b5bd4a319ea59875023551a705cc;hpb=2ed89c59f0efcd0a2763f47c7d3455663241e623 diff --git a/audiod.ggo b/audiod.ggo index cafc8519..94bf59d0 100644 --- a/audiod.ggo +++ b/audiod.ggo @@ -1,100 +1,184 @@ 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 "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.)" string typestr="filename" no +#~~~~~~~~~~~~~~~~~~~~~~~~ + +option "user" u +#~~~~~~~~~~~~~~ + +"run as user 'name'. Read the output of +'para_server -h' for more information on this +option." + + string typestr="name" + optional + +option "group" g +#~~~~~~~~~~~~~~~ + +"set group id to 'group'. Read the output of +'para_server -h' for more information on this +option." + + string typestr="group" + 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 exists" + + flag off + +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.)" + + string typestr="filename" + optional option "user_allow" - +#~~~~~~~~~~~~~~~~~~~~ "allow this user to connect to para_audiod. May be specified multiple times. If not -specified at all, allow all users to +specified at all, all users are allowed to connect." -int typestr="uid" default="-1" no multiple + int typestr="uid" + default="-1" + optional + multiple -section "stream i/o options." -################# -option "receiver" r "Select receiver. -May be given multiple times, once for each -supported audio format. receiver_spec -consists of an audio format, the receiver -name and any options for that receiver, -seperated by colons. +section "stream i/o options." +#~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +option "receiver" r +#~~~~~~~~~~~~~~~~~~ + +"Select receiver. May be given multiple +times, once for each supported audio format. +'receiver_spec' consists of an audio format and +the receiver name, separated by a colon, and +any options for that receiver, seperated by +whitespace. If any receiver options are +present, the whole receiver argument must be +quoted. Example: --r mp3:http:-i:www.paraslash.org:-p:8009 +-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. +option "no_default_filters" D +#~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -If (and only if) this option is set, the ---filter options take effect. Otherwise, the -compiled-in default filters mp3dec (oggdec) -and wav are activated for mp3 (ogg) streams." +"Configure filters manually. If (and only +if) this option is set, the --filter options +take effect. Otherwise, the compiled-in +default filters mp3dec (oggdec) and wav are +activated for mp3 (ogg) streams." -flag off -################# + flag off -option "filter" f "Select filter(s) manually. -May be given multiple times. filter_spec -consists of an audio format, the name of the -filter, and any options for that filter, -separated by colons. +option "filter" f +#~~~~~~~~~~~~~~~~ + +"Select filter(s) manually. May be given +multiple times. filter_spec consists of an +audio format, the name of the filter, and any +options for that filter. Examples: - -f mp3:mp3dec - -f:mp3:compress:--anticlip:--volume:2 + -f 'mp3:mp3dec' + -f 'mp3:compress --inertia 5 --damp 2' Note that these options are ignored by default, see --no_default_filters." -string typestr="filter_spec" no multiple +string typestr="filter_spec" optional multiple -################# -option "stream_write_cmd" w +option "writer" w +#~~~~~~~~~~~~~~~~~~~~~~~~~~ "Specify stream writer. -May be given multiple times, once for each -supported audio format. Default value is -'para_play' for both mp3 and ogg. You can use -the START_TIME() macro for these commands. -Each occurence of START_TIME() gets replaced -at runtime by the stream start time announced -by para_server, plus any offsets." +May be given multiple times, even multiple +times for the same audio format. Default +value is 'alsa' for all supported audio +formats. Example: + + -w 'aac:osx' -string typestr="format:command" no multiple +" + string typestr="writer_spec" + optional + multiple -################# option "stream_delay" - +#~~~~~~~~~~~~~~~~~~~~~~ "Time to add to para_server's start_time. -Amount of time to be added to the server -stream start time for stream_write_cmd if -START_TIME() was given. Useful for -syncronizing the audio output of clients." - -int typestr="milliseconds" default="200" no +Amount of time to be added to the server, before data is sent to +the writer. Useful for syncronizing the audio output of clients." -################# + int typestr="milliseconds" + default="200" + optional option "stream_timeout" - +#~~~~~~~~~~~~~~~~~~~~~~~~ -"Deactivate slot if idle for that many seconds" +"Deactivate slot if idle for that many +seconds" -int typestr="seconds" default="30" no + int typestr="seconds" + default="30" + optional