Convert audioc to lopsub.
[paraslash.git] / m4 / gengetopt / afh_recv.m4
index ba9c9da..28a0a9e 100644 (file)
@@ -1,8 +1,8 @@
 args "--no-version --no-help"
 
-include(header.m4)
-<qu>
-text "
+purpose "Make an audio stream from a local file"
+
+description "
        The afh (audio format handler) receiver can be used to write
        selected parts of the given audio file without decoding
        the data.
@@ -10,9 +10,10 @@ text "
        The selected parts of the content of the audio file are passed
        to the child nodes of the buffer tree. Only complete chunks
        with respect of the underlying audio format are passed.
-
 "
 
+include(header.m4)
+<qu>
 option "filename" f
 #~~~~~~~~~~~~~~~~~~
 "file to open"
@@ -21,19 +22,19 @@ required
 
 option "begin-chunk" b
 #~~~~~~~~~~~~~~~~~~~~~
-"skip a number of chunks"
+"skip the beginning of the file"
 int typestr = "chunk_num"
 default = "0"
 optional
 details = "
        The chunk_num argument must be between -num_chunks and
-       num_chunks - 1 inclusively where num_chunks is the total number
-       of chunks which is printed when using the --info option. If
-       chunk_num is negative, the given number of chunks are counted
-       backwards from the end of the file. For example --begin_chunk
-       -100 instructs para_afh to start output at chunk num_chunks
-       - 100. This is mainly useful for cutting off the end of an
-       audio file.
+       num_chunks - 1, inclusively, where num_chunks is the total
+       number of chunks of the audio file given by the argument to
+       --filename. If chunk_num is negative, the given number of
+       chunks are counted backwards from the end of the file. For
+       example --begin-chunk -100 instructs the afh receiver to
+       start output at chunk num_chunks - 100. This is useful for
+       selecting the last part of an audio file.
 "
 
 option "end-chunk" e
@@ -42,7 +43,7 @@ option "end-chunk" e
 int typestr = "chunk_num"
 optional
 details = "
-       For the chunk_num argument the same rules as for --begin_chunk
+       For the chunk_num argument the same rules as for --begin-chunk
        apply. The default is to write up to the last chunk.
 "