X-Git-Url: http://git.tuebingen.mpg.de/?a=blobdiff_plain;f=m4%2Flls%2Fserver_cmd.suite.m4;h=8200c6249449f81b5743775f04796462fc912b83;hb=a07746d8f55d0655510cad2448ef552288338c69;hp=2145c516a5a5f0f0666bf75419ffd44d38ce311a;hpb=1f12ea375358a0b30689e01efe82796ea4fcb14f;p=paraslash.git

diff --git a/m4/lls/server_cmd.suite.m4 b/m4/lls/server_cmd.suite.m4
index 2145c516..8200c624 100644
--- 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
@@ -168,6 +169,8 @@ aux_info_prefix = Permissions:
 		playlists. Otherwise only the given tables are created.
 	[/description]
 
+m4_include(`com_ll.m4')
+
 [subcommand jmp]
 	purpose = reposition the current stream
 	non-opts-name = n
@@ -407,20 +410,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
 
-		       help, on, off, add, delete, allow, deny, status.
+		Show the access control list and the number of connected clients of
+		the http 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 http status
 
-		Example:
+		Senders may be activated and deactivated independently of each
+		other. The following command switches off the dccp sender:
 
-			para_client sender http help
+			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:
+
+			sender udp add 224.0.1.38
 
 	[/description]
 
@@ -474,14 +502,6 @@ aux_info_prefix = Permissions:
 		the vss status flags, effectively stopping playback.
 	[/description]
 
-[subcommand tasks]
-	purpose = list active server tasks
-	aux_info = NO_PERMISSION_REQUIRED
-	[description]
-		For each task, print ID, status and name. This is mostly useful
-		for debugging.
-	[/description]
-
 [subcommand term]
 	purpose = ask the server to terminate
 	aux_info = VSS_READ | VSS_WRITE