Currently some of these options use dashes to separate the words
while others use the underscore character instead. The auto-generated
--detailed-help option contains a dash, so the only consistent way
is to use dashes everywhere.
Hence this commit replaces all underscores in option names by dashes
and updates the documentation accordingly.
Fortunately, this does not require to change the code, because
gengetopt translates dashes into underscores in the generated C code.
It is, however, an API change, so this is 0.5.0 material.
13 files changed:
- overview.pdf is now based on dia, a simple diagram creation program.
The new version is much more detailed and contains descriptions of
the various programs of the paraslash package.
- overview.pdf is now based on dia, a simple diagram creation program.
The new version is much more detailed and contains descriptions of
the various programs of the paraslash package.
+ - The separator of all multi-word options has been changed from
+ underscore to dash. For example --log_color becomes --log-color.
--------------------------------------
0.4.13 (2013-07-29) "spectral gravity"
--------------------------------------
0.4.13 (2013-07-29) "spectral gravity"
include(loglevel.m4)
<qu>
include(loglevel.m4)
<qu>
#~~~~~~~~~~~~~~~~~~~~~
"print also the chunk table"
flag off
#~~~~~~~~~~~~~~~~~~~~~
"print also the chunk table"
flag off
flag off
details = "
Currently this option only affects the format of the chunk table,
flag off
details = "
Currently this option only affects the format of the chunk table,
- so it has no effect if --chunk_table is not given.
+ so it has no effect if --chunk-table is not given.
The human-readable output (the default) consists of one output
line per chunk and the output contains also the chunk number,
The human-readable output (the default) consists of one output
line per chunk and the output contains also the chunk number,
num_chunks - 1 inclusively where num_chunks is the total number
of chunks which is printed when using the --info option. If
chunk_num is negative, the given number of chunks are counted
num_chunks - 1 inclusively where num_chunks is the total number
of chunks which is printed when using the --info option. If
chunk_num is negative, the given number of chunks are counted
- backwards from the end of the file. For example --begin_chunk
+ backwards from the end of the file. For example --begin-chunk
-100 instructs para_afh to start output at chunk num_chunks
- 100. This is mainly useful for cutting off the end of an
audio file.
-100 instructs para_afh to start output at chunk num_chunks
- 100. This is mainly useful for cutting off the end of an
audio file.
int typestr = "chunk_num"
optional
details = "
int typestr = "chunk_num"
optional
details = "
- For the chunk_num argument the same rules as for --begin_chunk
+ For the chunk_num argument the same rules as for --begin-chunk
apply. The default is to write up to the last chunk.
"
apply. The default is to write up to the last chunk.
"
instructed to use also \"filename\" for connecting para_audiod.
"
instructed to use also \"filename\" for connecting para_audiod.
"
#~~~~~~~~~~~~~~~~~~~~
"allow this uid"
int typestr="uid"
#~~~~~~~~~~~~~~~~~~~~
"allow this uid"
int typestr="uid"
to connect to para_audiod.
"
to connect to para_audiod.
"
-option "clock_diff_count" -
+option "clock-diff-count" -
#~~~~~~~~~~~~~~~~~~~~~~~~~~
"sync clock on startup"
int typestr="count"
#~~~~~~~~~~~~~~~~~~~~~~~~~~
"sync clock on startup"
int typestr="count"
#~~~~~~~~~~~~~~~~~~~~~~
"time for client sync"
int typestr="milliseconds"
#~~~~~~~~~~~~~~~~~~~~~~
"time for client sync"
int typestr="milliseconds"
<qu>
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
<qu>
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 "server-port" p "port to connect" int typestr="port" default="2990" optional
+option "key-file" k "(default='~/.paraslash/key.<user>')" string typestr="filename" optional
</qu>
include(loglevel.m4)
</qu>
include(loglevel.m4)
default = "auto"
optional
default = "auto"
optional
#~~~~~~~~~~~~~~~~~~~
"select a color for one type of log message"
string typestr="color_spec"
#~~~~~~~~~~~~~~~~~~~
"select a color for one type of log message"
string typestr="color_spec"
- --log_color \"debug:green\"
- --log_color \"info:yellow bold\"
- --log_color \"notice:white red bold\"
+ --log-color \"debug:green\"
+ --log-color \"info:yellow bold\"
+ --log-color \"notice:white red bold\"
#~~~~~~~~~~~~~~~~~~~~~~
"target signal level (0-32768)"
int typestr="number"
#~~~~~~~~~~~~~~~~~~~~~~
"target signal level (0-32768)"
int typestr="number"
#~~~~~~~~~~~~~~~~~~~~~
"(default='</qu>DEFAULT_CONFIG_FILE<qu>')"
string typestr="filename"
#~~~~~~~~~~~~~~~~~~~~~
"(default='</qu>DEFAULT_CONFIG_FILE<qu>')"
string typestr="filename"
available themes is printed and the program terminates.
"
available themes is printed and the program terminates.
"
#~~~~~~~~~~~~~~~~~~
"command to read status items from"
string typestr = "command"
#~~~~~~~~~~~~~~~~~~
"command to read status items from"
string typestr = "command"
section "Mapping keys to commands"
#---------------------------------
section "Mapping keys to commands"
#---------------------------------
#~~~~~~~~~~~~~~~~~
"Map key k to command c using mode m."
#~~~~~~~~~~~~~~~~~
"Map key k to command c using mode m."
#~~~~~~~~~~~~~~~~~~~~~~
"(default='</qu>DEFAULT_HISTORY_FILE<qu>')"
string typestr = "filename"
#~~~~~~~~~~~~~~~~~~~~~~
"(default='</qu>DEFAULT_HISTORY_FILE<qu>')"
string typestr = "filename"
"randomize playlist at startup."
flag off
"randomize playlist at startup."
flag off
#~~~~~~~~~~~~~~~~~
"Map key k to a command."
#~~~~~~~~~~~~~~~~~
"Map key k to a command."
include(config_file.m4)
<qu>
include(config_file.m4)
<qu>
#~~~~~~~~~~~~~~~~~~~
"(default='~/.paraslash/server.users')"
#~~~~~~~~~~~~~~~~~~~
"(default='~/.paraslash/server.users')"
"start playing on startup"
flag off
"start playing on startup"
flag off
-option "autoplay_delay" -
+option "autoplay-delay" -
#~~~~~~~~~~~~~~~~~~~~~~~~
"time to wait before streaming"
int typestr="ms"
#~~~~~~~~~~~~~~~~~~~~~~~~
"time to wait before streaming"
int typestr="ms"
already up when para_server starts to stream. Of course, this
option depends on the autoplay option.
"
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"
#~~~~~~~~~~~~~~~~~~~~~~~
"grace time for clients"
section "audio file selector"
#############################
section "audio file selector"
#############################
-option "afs_database_dir" D
+option "afs-database-dir" D
#~~~~~~~~~~~~~~~~~~~~~~~~~~
"location of the database"
string typestr="path"
#~~~~~~~~~~~~~~~~~~~~~~~~~~
"location of the database"
string typestr="path"
file selector. The default is '~/.paraslash/afs_database-0.4'.
"
file selector. The default is '~/.paraslash/afs_database-0.4'.
"
#~~~~~~~~~~~~~~~~~~~~
"Command socket for afs"
string typestr="path"
#~~~~~~~~~~~~~~~~~~~~
"Command socket for afs"
string typestr="path"
audio file selector via a local socket. This option specifies
the location of that socket in the file system.
"
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."
#~~~~~~~~~~~~~~~~~~~~~~~~~~
"Mood or playlist to load on startup."
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:
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'.
"
loads the playlist named 'foo'.
"
#~~~~~~~~~~~~~~~~~~~
"tcp port for http streaming"
int typestr="portnumber"
#~~~~~~~~~~~~~~~~~~~
"tcp port for http streaming"
int typestr="portnumber"
http request message such as 'GET / HTTP/'.
"
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
#~~~~~~~~~~~~~~~~~~~~~~~~~~~
"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
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.
#~~~~~~~~~~~~~~~~~~~~~
"add an entry to the http ACL"
string typestr="a.b.c.d/n"
#~~~~~~~~~~~~~~~~~~~~~
"add an entry to the http ACL"
string typestr="a.b.c.d/n"
multiple
details="
Add given host/network to access control list (whitelist if
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
"
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
#~~~~~~~~~~~~~~~~~~~~~~~~~~~
"do not open tcp port on startup"
flag off
later time by using the sender command.
"
later time by using the sender command.
"
-option "http_max_clients" -
+option "http-max-clients" -
#~~~~~~~~~~~~~~~~~~~~~~~~~~
"maximal number of connections"
int typestr="number"
#~~~~~~~~~~~~~~~~~~~~~~~~~~
"maximal number of connections"
int typestr="number"
#~~~~~~~~~~~~~~~~~~~
"port for dccp streaming"
int typestr="portnumber"
default="8000"
optional
details="
#~~~~~~~~~~~~~~~~~~~
"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="
#~~~~~~~~~~~~~~~~~~~~~~~~~~~
"make the dccp ACL a whitelist"
flag off
details="
- See http_default_deny for details.
+ See http-default-deny for details.
#~~~~~~~~~~~~~~~~~~~~~
"add an entry to the dccp ACL"
string typestr="a.b.c.d/n"
optional
multiple
details="
#~~~~~~~~~~~~~~~~~~~~~
"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="
#~~~~~~~~~~~~~~~~~~~~~~~~~~
"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"
#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
"Upper bound for the FEC slice size"
int typestr = "size"
the MPS of an incoming connection can not be set.
"
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"
#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
"The number of non-redundant slices per FEC group"
int typestr = "num"
details = "
This determines the number of slices in each FEC group that are
necessary to decode the group. The given number must be smaller
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
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"
#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
"The total number of slices per FEC group"
int typestr = "num"
default = "4"
details = "
This value must be larger than the value given for above
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.
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.
section "udp sender"
####################
section "udp sender"
####################
#~~~~~~~~~~~~~~~~~~~~
"add udp target with optional port"
string typestr="host[:port]"
#~~~~~~~~~~~~~~~~~~~~
"add udp target with optional port"
string typestr="host[:port]"
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'
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);
The following examples are possible targets:
'10.10.1.2:8000' (host:port); '10.10.1.2' (with default port);
This option can be given multiple times, for multiple targets.
"
This option can be given multiple times, for multiple targets.
"
-option "udp_no_autostart" -
+option "udp-no-autostart" -
#~~~~~~~~~~~~~~~~~~~~~~~~~~
"do not start sending"
flag off
#~~~~~~~~~~~~~~~~~~~~~~~~~~
"do not start sending"
flag off
a later time by using the sender command.
"
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
#~~~~~~~~~~~~~~~~~~~~~~~~~~
"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
#~~~~~~~~~~~~~~~~~~~~~~~~~~
"outgoing udp multicast interface"
string
optional
-option "udp_header_interval" H
+option "udp-header-interval" H
#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
"duration for sending header"
int typestr = "ms"
#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
"duration for sending header"
int typestr = "ms"
audio formats, including mp3, don't need an audio file header.
"
audio formats, including mp3, don't need an audio file header.
"
#~~~~~~~~~~~~~~~~~
"set time to live value"
int typestr="num"
#~~~~~~~~~~~~~~~~~
"set time to live value"
int typestr="num"
sudo chown $LOGNAME /var/paraslash
sudo chown $LOGNAME /var/paraslash
-Alternatively, use the --afs_socket Option to specify a different
+Alternatively, use the --afs-socket Option to specify a different
location for the AFS command socket.
For this first try, we'll use the info loglevel to make the output
location for the AFS command socket.
For this first try, we'll use the info loglevel to make the output
At startup para_server reads the user list file which contains one
line per user. The default location of the user list file may be
At startup para_server reads the user list file which contains one
line per user. The default location of the user list file may be
-changed with the --user_list option.
+changed with the --user-list option.
There should be at least one user in this file. Each user must have
an RSA key pair. The public part of the key is needed by para_server
There should be at least one user in this file. Each user must have
an RSA key pair. The public part of the key is needed by para_server
allow para_audiod to obtain the Unix credentials of the connecting
process.
allow para_audiod to obtain the Unix credentials of the connecting
process.
-Use para_audiod's --user_allow option to allow connections only for
+Use para_audiod's --user-allow option to allow connections only for
a limited set of users.
-----------------------
a limited set of users.
-----------------------
-is executed, but this can be customized via the --stat_cmd option. In
+is executed, but this can be customized via the --stat-cmd option. In
particular it possible to use
para_client -- stat -p
particular it possible to use
para_client -- stat -p