doc: Rewrite udp sender description
authorAndre Noll <maan@systemlinux.org>
Sun, 7 Apr 2013 03:06:39 +0000 (03:06 +0000)
committerAndre Noll <maan@systemlinux.org>
Thu, 13 Jun 2013 16:29:02 +0000 (18:29 +0200)
This text was rather badly written. Replace it with better English.

m4/gengetopt/server.m4

index 24d344e..d1293a0 100644 (file)
@@ -340,18 +340,19 @@ optional
 option "udp_header_interval" H
 #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 "duration for sending header"
-int typestr="ms"
-default="2000"
+int typestr = "ms"
+default = "2000"
 optional
-details="
+details = "
        As the udp sender has no idea about connected clients it
        sends the audio file header periodically if necessary. This
-       option is used to specify the duration of the interval between
-       sending the header. Shorter values decrease the average time
-       clients have to wait before being able to start playback,
-       but this also increases the amount network traffic. Note
-       that this affects only ogg vorbis streams as this is the only
-       audio format that needs an audio file header.
+       option specifies the duration between subsequent headers are
+       sent. Smaller values decrease the average time clients have
+       to wait before starting playback, larger values decrease
+       network traffic.
+
+       Note that this affects only ogg/* and wma streams. Other
+       audio formats, including mp3, don't need an audio file header.
 "
 
 option "udp_ttl" t