X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=m4%2Fgengetopt%2Fserver.m4;h=6aca7bac7f41ddb9a37d4ec96e329a210e275f1f;hp=8707554f7719ace121dae2701e179c22ab687184;hb=5e8d8a8eea6de9459ebdf4498f9f061c84bfa63a;hpb=e2eebf654cae2fc004cee516a0e165127c0214ca diff --git a/m4/gengetopt/server.m4 b/m4/gengetopt/server.m4 index 8707554f..6aca7bac 100644 --- a/m4/gengetopt/server.m4 +++ b/m4/gengetopt/server.m4 @@ -1,6 +1,6 @@ args "--conf-parser --no-handle-version --no-handle-help" -purpose "Manage and stream audio files." +purpose "Manage and stream audio files" include(header.m4) define(CURRENT_PROGRAM,para_server) @@ -18,6 +18,7 @@ include(color.m4) include(daemon.m4) include(user.m4) include(group.m4) +include(priority.m4) option "port" p @@ -42,7 +43,7 @@ include(logfile.m4) include(config_file.m4) -option "user_list" - +option "user-list" - #~~~~~~~~~~~~~~~~~~~ "(default='~/.paraslash/server.users')" @@ -60,7 +61,7 @@ option "autoplay" a "start playing on startup" flag off -option "autoplay_delay" - +option "autoplay-delay" - #~~~~~~~~~~~~~~~~~~~~~~~~ "time to wait before streaming" int typestr="ms" @@ -76,7 +77,7 @@ details=" already up when para_server starts to stream. Of course, this option depends on the autoplay option. " -option "announce_time" A +option "announce-time" A #~~~~~~~~~~~~~~~~~~~~~~~ "grace time for clients" @@ -95,7 +96,7 @@ details=" section "audio file selector" ############################# -option "afs_database_dir" D +option "afs-database-dir" D #~~~~~~~~~~~~~~~~~~~~~~~~~~ "location of the database" string typestr="path" @@ -105,7 +106,7 @@ details=" file selector. The default is '~/.paraslash/afs_database-0.4'. " -option "afs_socket" s +option "afs-socket" s #~~~~~~~~~~~~~~~~~~~~ "Command socket for afs" string typestr="path" @@ -117,7 +118,7 @@ details=" audio file selector via a local socket. This option specifies the location of that socket in the file system. " -option "afs_initial_mode" i +option "afs-initial-mode" i #~~~~~~~~~~~~~~~~~~~~~~~~~~ "Mood or playlist to load on startup." @@ -128,7 +129,7 @@ details=" The argument of this option must be prefixed with either 'p/' or 'm/' to indicate whether a playlist or a mood should be loaded. Example: - --afs_initial_mode p/foo + --afs-initial-mode p/foo loads the playlist named 'foo'. " @@ -137,7 +138,7 @@ section "http sender" ##################### -option "http_port" - +option "http-port" - #~~~~~~~~~~~~~~~~~~~ "tcp port for http streaming" int typestr="portnumber" @@ -149,20 +150,20 @@ details=" http request message such as 'GET / HTTP/'. " -option "http_default_deny" - +option "http-default-deny" - #~~~~~~~~~~~~~~~~~~~~~~~~~~~ "make the http ACL a whitelist" flag off details=" The default is to use blacklists instead, i.e. connections to the http sender are allowed unless the connecting host - matches a pattern given by a http_access option. This allows + matches a pattern given by a http-access option. This allows to use access control the other way round: Connections are denied from hosts which are not explicitly allowed by one or - more http_access options. + more http-access options. " -option "http_access" - +option "http-access" - #~~~~~~~~~~~~~~~~~~~~~ "add an entry to the http ACL" string typestr="a.b.c.d/n" @@ -170,13 +171,13 @@ optional multiple details=" Add given host/network to access control list (whitelist if - http_default_deny was given, blacklist otherwise) before + 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 " -option "http_no_autostart" - +option "http-no-autostart" - #~~~~~~~~~~~~~~~~~~~~~~~~~~~ "do not open tcp port on startup" flag off @@ -186,7 +187,7 @@ details=" later time by using the sender command. " -option "http_max_clients" - +option "http-max-clients" - #~~~~~~~~~~~~~~~~~~~~~~~~~~ "maximal number of connections" int typestr="number" @@ -204,45 +205,45 @@ section "dccp sender" ##################### -option "dccp_port" - +option "dccp-port" - #~~~~~~~~~~~~~~~~~~~ "port for dccp streaming" int typestr="portnumber" default="8000" optional details=" - See http_port for details. + See http-port for details. " -option "dccp_default_deny" - +option "dccp-default-deny" - #~~~~~~~~~~~~~~~~~~~~~~~~~~~ "make the dccp ACL a whitelist" flag off details=" - See http_default_deny for details. + See http-default-deny for details. " -option "dccp_access" - +option "dccp-access" - #~~~~~~~~~~~~~~~~~~~~~ "add an entry to the dccp ACL" string typestr="a.b.c.d/n" optional multiple details=" - See http_access for details. + See http-access for details. " -option "dccp_max_clients" - +option "dccp-max-clients" - #~~~~~~~~~~~~~~~~~~~~~~~~~~ "maximal number of connections" int typestr="number" default="-1" optional details=" - See http_max_clients for details. + See http-max-clients for details. " -option "dccp_max_slice_size" - +option "dccp-max-slice-size" - #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ "Upper bound for the FEC slice size" int typestr = "size" @@ -261,7 +262,7 @@ details = " the MPS of an incoming connection can not be set. " -option "dccp_data_slices_per_group" - +option "dccp-data-slices-per-group" - #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ "The number of non-redundant slices per FEC group" int typestr = "num" @@ -270,13 +271,13 @@ default = "3" details = " This determines the number of slices in each FEC group that are necessary to decode the group. The given number must be smaller - than the value of the dccp_slices_per_group option below. + than the value of the dccp-slices-per-group option below. Note that the duration of a FEC group is proportional to the - product dccp_max_slice_size * dccp_data_slices_per_group. + product dccp-max-slice-size * dccp-data-slices-per-group. " -option "dccp_slices_per_group" - +option "dccp-slices-per-group" - #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ "The total number of slices per FEC group" int typestr = "num" @@ -284,7 +285,7 @@ optional default = "4" details = " This value must be larger than the value given for above - dccp_data_slices_per_group above. The difference being the + dccp-data-slices-per-group above. The difference being the number of redundant slices per group, i.e. the number of data packets that may be lost without causing interruptions of the resulting audio stream. @@ -296,7 +297,7 @@ details = " section "udp sender" #################### -option "udp_target" - +option "udp-target" - #~~~~~~~~~~~~~~~~~~~~ "add udp target with optional port" string typestr="host[:port]" @@ -306,7 +307,7 @@ details=" Add given host/port to the list of targets. The 'host' argument can be either an IPv4/v6 address or hostname (RFC 3986 syntax). The 'port' argument is an optional port number. If the 'port' - part is absent, the 'udp_default_port' value is used. + part is absent, the 'udp-default-port' value is used. The following examples are possible targets: '10.10.1.2:8000' (host:port); '10.10.1.2' (with default port); @@ -317,7 +318,7 @@ details=" This option can be given multiple times, for multiple targets. " -option "udp_no_autostart" - +option "udp-no-autostart" - #~~~~~~~~~~~~~~~~~~~~~~~~~~ "do not start sending" flag off @@ -326,20 +327,20 @@ details=" a later time by using the sender command. " -option "udp_default_port" - +option "udp-default-port" - #~~~~~~~~~~~~~~~~~~~~~~~~~~ "udp port to send to" int typestr="port" default="8000" optional -option "udp_mcast_iface" - +option "udp-mcast-iface" - #~~~~~~~~~~~~~~~~~~~~~~~~~~ "outgoing udp multicast interface" string optional -option "udp_header_interval" H +option "udp-header-interval" H #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ "duration for sending header" int typestr = "ms" @@ -357,7 +358,7 @@ details = " audio formats, including mp3, don't need an audio file header. " -option "udp_ttl" t +option "udp-ttl" t #~~~~~~~~~~~~~~~~~ "set time to live value" int typestr="num"