From: Andre Noll <maan@tuebingen.mpg.de>
Date: Mon, 12 Mar 2018 17:32:52 +0000 (+0100)
Subject: recv: Add description of para_recv.
X-Git-Tag: v0.6.2~27
X-Git-Url: http://git.tue.mpg.de/?a=commitdiff_plain;h=6d1f3b4963dd2e6e9be9e7f6859815d5f7aa8575;p=paraslash.git

recv: Add description of para_recv.

para_recv is the only executable whose man page has no short
description at the beginning.
---

diff --git a/m4/lls/recv.suite.m4 b/m4/lls/recv.suite.m4
index 793a2f5f..571cd45a 100644
--- a/m4/lls/recv.suite.m4
+++ b/m4/lls/recv.suite.m4
@@ -2,7 +2,16 @@ m4_define(PROGRAM, para_recv)
 [suite recv]
 version-string = GIT_VERSION()
 [supercommand para_recv]
-	purpose = a command line HTTP/DCCP/UDP stream grabber
+	purpose = receive an audio stream
+	[description]
+		para_recv starts one paraslash receiver (http, dccp, udp or afh)
+		to produce an audio stream in the same way para_audiod would download
+		the stream from para_server (http, dccp or udp) or para_server makes a
+		stream out of an audio file (afh). This is mostly useful for debugging.
+
+		Regardless of which receiver was started, the audio stream is written
+		to stdout.
+	[/description]
 	m4_include(common-option-section.m4)
 	m4_include(help.m4)
 	m4_include(detailed-help.m4)