doc: Move sender examples to manual page.

[paraslash.git] / m4 / lls / server_cmd.suite.m4

diff --git a/m4/lls/server_cmd.suite.m4 b/m4/lls/server_cmd.suite.m4
index 2145c516a5a5f0f0666bf75419ffd44d38ce311a..96ce53020e756c37dd90c6ae1887f9d58623ab72 100644 (file)
--- a/m4/lls/server_cmd.suite.m4
+++ b/m4/lls/server_cmd.suite.m4
@@ -407,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]
 
@@ -475,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]