X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=m4%2Flls%2Fserver_cmd.suite.m4;h=96ce53020e756c37dd90c6ae1887f9d58623ab72;hp=751998adb992523fcdd62394f5a40be18ae05b4e;hb=f4019242252bf8e7594a72efdac6214a5abd4364;hpb=bd28ec9a64884d70917c4fdea1a3a70c91758f83 diff --git a/m4/lls/server_cmd.suite.m4 b/m4/lls/server_cmd.suite.m4 index 751998ad..96ce5302 100644 --- a/m4/lls/server_cmd.suite.m4 +++ b/m4/lls/server_cmd.suite.m4 @@ -219,13 +219,6 @@ aux_info_prefix = Permissions: also given), chunk time and chunk offsets. [/help] - [option full-path] - short_opt = F - summary = list full paths, match full paths against patterns - [help] - This option is the default, so it does nothing. Deprecated as of - v0.6.0, scheduled for removal in v0.6.1. - [/help] [option basename] short_opt = b summary = list and match basenames only @@ -259,8 +252,8 @@ aux_info_prefix = Permissions: --listing-mode, this argument may either be a single character or a word, according to the following list. - path (p). Sort alphabetically by path or basename (see -p). This is - the default if --sort is not given. + path (p). Sort alphabetically by path or basename, depending on + whether -b is given. This is the default if --sort is not given. score (s). Iterate over the entries of the score table, rather than the audio file table. This sort order implies --admissible, since @@ -284,6 +277,8 @@ aux_info_prefix = Permissions: audio-format (a) + hash (h) + If --sort is not given, path sort is implied. [/help] @@ -412,20 +407,45 @@ aux_info_prefix = Permissions: [subcommand sender] purpose = control paraslash senders - synopsis = [sender cmd [arguments]] + synopsis = [sender subcmd [arguments]] aux_info = VSS_READ | VSS_WRITE [description] - Send a command to a specific sender. The following commands are - available, but not all senders support every command. + This command executes a subcommand for the given sender, which is + one of "http", "dccp" or "udp". Various subcommands exist to print + information about the sender, to activate and deactivate the sender, + and to change the access permissions and targets. The following + subcommands are available: - help, on, off, add, delete, allow, deny, status. + help, status, on, off, allow, deny, add, delete. - The help command prints the help text of the given sender. If no - command is given the list of available senders is shown. + All senders support the first four commands. The "allow" and "deny" + commands are supported by the http and the dccp senders while "add" + and "delete" are only supported by the udp sender. If no sender is + given, the list of available senders is shown. - Example: + Examples: + + Get help for the udp sender (contains further examples): + + sender udp help + + Show the access control list and the number of connected clients of + the http sender: + + sender http status + + Senders may be activated and deactivated independently of each + other. The following command switches off the dccp sender: + + sender dccp off + + Add an UDP unicast for a client to the target list of the UDP sender: + + sender udp add client.foo.org + + Start UDP multicast, using the default multicast address: - para_client sender http help + sender udp add 224.0.1.38 [/description] @@ -480,11 +500,12 @@ aux_info_prefix = Permissions: [/description] [subcommand tasks] - purpose = list active server tasks + purpose = list active server tasks (deprecated) aux_info = NO_PERMISSION_REQUIRED [description] - For each task, print ID, status and name. This is mostly useful - for debugging. + This used to print the ID, the status and the name of each task, + mainly for debugging purposes. As of version 0.6.2, the subcommand + prints nothing. It will be removed in 0.7.0. Don't use. [/description] [subcommand term]