From: Andre Noll <maan@tuebingen.mpg.de>
Date: Sun, 5 Nov 2017 16:36:15 +0000 (+0100)
Subject: doc: Move sender examples to manual page.
X-Git-Tag: v0.6.2~6^2~2
X-Git-Url: http://git.tue.mpg.de/?a=commitdiff_plain;h=db3c57973fd902e1881c520113444e94399552ec;p=paraslash.git

doc: Move sender examples to manual page.

The general paraslash user manual contains a couple of examples for
the sender subcommand of para_server. However, the para_server(1)
manual page is a better place for this, so this patch moves the
examples there. They have also been slightly reworded, and the help
text of the sender command has been clarified.
---

diff --git a/m4/lls/server_cmd.suite.m4 b/m4/lls/server_cmd.suite.m4
index 9378b7c3..96ce5302 100644
--- 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]
 
diff --git a/web/manual.md b/web/manual.md
index fb3a05f7..f041b3da 100644
--- a/web/manual.md
+++ b/web/manual.md
@@ -1541,27 +1541,6 @@ currently running server process.
 
 	para_client si
 
-The sender command of para_server prints information about senders,
-like the various access control lists, and it allows to (de-)activate
-senders and to change the access permissions at runtime.
-
--> List all senders
-
-	para_client sender
-
--> Obtain general help for the sender command:
-
-	para_client help sender
-
--> Get help for a specific sender (contains further examples):
-
-	s=http # or dccp or udp
-	para_client sender $s help
-
--> Show status of the http sender
-
-	para_client sender http status
-
 By default para_server activates both the HTTP and th DCCP sender on
 startup. This can be changed via command line options or para_server's
 config file.
@@ -1570,13 +1549,6 @@ config file.
 
 	para_server -h
 
-All senders share the "on" and "off" commands, so senders may be
-activated and deactivated independently of each other.
-
--> Switch off the http sender:
-
-	para_client sender http off
-
 -> Receive a DCCP stream using CCID2 and write the output into a file:
 
 	host=foo.org; ccid=2; filename=bar
@@ -1587,20 +1559,11 @@ receiver has its own set of command line options and its own command
 line parser, so arguments for the dccp receiver must be protected
 from being interpreted by para_recv.
 
--> Start UDP multicast, using the default multicast address:
-
-	para_client sender udp add 224.0.1.38
-
 -> Receive FEC-encoded multicast stream and write the output into a file:
 
 	filename=foo
 	para_recv -r udp > $filename
 
--> Add an UDP unicast for a client to the target list of the UDP sender:
-
-	t=client.foo.org
-	para_client sender udp add $t
-
 -> Receive this (FEC-encoded) unicast stream:
 
 	filename=foo