Rename struct audio format to audio_format_handler

[paraslash.git] / audiod.ggo

diff --git a/audiod.ggo b/audiod.ggo
index 8b0249c11a2c6a8d49562b01e0d9e4f056c518c2..dd385a16c09d0ecc070d3ef9af396256fe70c963 100644 (file)
--- a/audiod.ggo
+++ b/audiod.ggo
@@ -1,61 +1,140 @@
 section "general options"
 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" 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" 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" 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.<host_name>)"
+
+       string typestr="filename"
+       optional

 
 option "user_allow" -
 
 option "user_allow" -

+#~~~~~~~~~~~~~~~~~~~~

 
 "allow this user to connect to para_audiod.
 May be specified multiple times. If not
 
 "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."
 
 connect."
 

-int typestr="uid" default="-1" optional 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 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.
+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'
 "
 
 
 Example:
 
 -r 'mp3:http -i www.paraslash.org -p 8009'
 "
 

-string typestr="receiver_spec" default="http" optional 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.
+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:
 
 Examples:

-       -f mp3:mp3dec
+       -f 'mp3:mp3dec'

        -f 'mp3:compress --inertia 5 --damp 2'
 
 Note that these options are ignored by default,
        -f 'mp3:compress --inertia 5 --damp 2'
 
 Note that these options are ignored by default,


@@ -63,25 +142,28 @@ see --no_default_filters."
 
 string typestr="filter_spec" optional multiple
 
 
 string typestr="filter_spec" optional multiple
 

-#################

 
 option "stream_write_cmd" w
 
 option "stream_write_cmd" w

+#~~~~~~~~~~~~~~~~~~~~~~~~~~

 
 "Specify stream writer.
 
 May be given multiple times, once for each
 supported audio format. Default value is
 
 "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."
+'para_write -w alsa' 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."

 
 

-string typestr="format:command" optional multiple
+       string typestr="format:command"
+       optional
+       multiple

 
 

-#################

 
 option "stream_delay" -
 
 option "stream_delay" -

+#~~~~~~~~~~~~~~~~~~~~~~

 
 "Time to add to para_server's start_time.
 
 
 "Time to add to para_server's start_time.
 


@@ -90,12 +172,16 @@ stream start time for stream_write_cmd if
 START_TIME() was given. Useful for
 syncronizing the audio output of clients."
 
 START_TIME() was given. Useful for
 syncronizing the audio output of clients."
 

-int typestr="milliseconds" default="200" no
-
-#################
+       int typestr="milliseconds"
+       default="200"
+       optional

 
 option "stream_timeout" -
 
 option "stream_timeout" -

+#~~~~~~~~~~~~~~~~~~~~~~~~

 
 

-"Deactivate slot if idle for that many seconds"
+"Deactivate slot if idle for that many
+seconds"

 
 

-int typestr="seconds" default="30" optional
+       int typestr="seconds"
+       default="30"
+       optional