com_ff(): Fix bad grammar in help text.

[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 5ac7f16afa6888f97488e8c5d4dd6a7db0d94a64..2a39907cee624219d1fb166b07dbf84288f67bb4 100644 (file)
--- a/m4/lls/server_cmd.suite.m4
+++ b/m4/lls/server_cmd.suite.m4
@@ -124,18 +124,18 @@ aux_info_prefix = Permissions:
                summary = enable verbose mode
 
 [subcommand ff]
-       purpose = jump N seconds forward or backward
-       synopsis = n[-]
+       purpose = jump forward or backward in the current audio file
+       synopsis = seconds
        aux_info = VSS_READ | VSS_WRITE
        [description]
-               This sets the 'R' (reposition request) bit of the vss status flags
-               which enqueues a request to jump n seconds forwards or backwards.
+               This enqueues a request to reposition the audio stream according to
+               the argument, which may be a signed or an unsigned integer. Negative
+               values correspond to backward jumps.
 
-               Example:
-
-                    para_client ff 30-
-
-               jumps 30 seconds backwards.
+               If a negative number is given whose absolute value exceeds the current
+               postition of the stream, a jump to the beginning of the audio file
+               is performed. If a positive amount of seconds is given which exceeds
+               the remaining time of the audio file, the next audio file is loaded.
 
        [/description]
 
@@ -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
@@ -219,13 +220,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
@@ -414,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, status, on, off, allow, deny, add, delete.
+
+               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.
+
+               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
 
-                      help, on, off, add, delete, allow, deny, status.
+               Add an UDP unicast for a client to the target list of the UDP sender:
 
-               The help command prints the help text of the given sender. If no
-               command is given the list of available senders is shown.
+                       sender udp add client.foo.org
 
-               Example:
+               Start UDP multicast, using the default multicast address:
 
-                       para_client sender http help
+                       sender udp add 224.0.1.38
 
        [/description]
 
@@ -482,11 +501,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]