X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=m4%2Flls%2Fserver_cmd.suite.m4;h=079589d1f36eee98fb9a0c1252906b5d9b1e43a4;hp=9378b7c325fa2ef246462f90b20b79ae04fe8ec9;hb=ece3b9ff875a28473a4f840bb016f8debb2531fc;hpb=bb91597b9ecf650a63a40753f7f7c771576d252e diff --git a/m4/lls/server_cmd.suite.m4 b/m4/lls/server_cmd.suite.m4 index 9378b7c3..079589d1 100644 --- a/m4/lls/server_cmd.suite.m4 +++ b/m4/lls/server_cmd.suite.m4 @@ -144,10 +144,11 @@ aux_info_prefix = Permissions: non-opts-name = [command] aux_info = NO_PERMISSION_REQUIRED [description] - Without any arguments, help prints a list of available commands. When - called with a command name as first argument, it prints the description - of this command. + When executed without any arguments, the available server commands + are listed. Otherwise, if the first argument is the name of a server + command, the description of this command is shown. [/description] + m4_include(`long-help.m4') [subcommand hup] purpose = reload config file, log file and user list @@ -407,20 +408,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]