recv: Add description of para_recv.
authorAndre Noll <maan@tuebingen.mpg.de>
Mon, 12 Mar 2018 17:32:52 +0000 (18:32 +0100)
committerAndre Noll <maan@tuebingen.mpg.de>
Sun, 1 Apr 2018 12:21:05 +0000 (14:21 +0200)
para_recv is the only executable whose man page has no short
description at the beginning.

m4/lls/recv.suite.m4

index 793a2f5..571cd45 100644 (file)
@@ -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)