afh_recv: Replace ggo text section by description.
[paraslash.git] / m4 / gengetopt / afh_recv.m4
1 args "--no-version --no-help"
2
3 description "
4 The afh (audio format handler) receiver can be used to write
5 selected parts of the given audio file without decoding
6 the data.
7
8 The selected parts of the content of the audio file are passed
9 to the child nodes of the buffer tree. Only complete chunks
10 with respect of the underlying audio format are passed.
11 "
12
13 include(header.m4)
14 <qu>
15 option "filename" f
16 #~~~~~~~~~~~~~~~~~~
17 "file to open"
18 string typestr = "filename"
19 required
20
21 option "begin-chunk" b
22 #~~~~~~~~~~~~~~~~~~~~~
23 "skip a number of chunks"
24 int typestr = "chunk_num"
25 default = "0"
26 optional
27 details = "
28 The chunk_num argument must be between -num_chunks and
29 num_chunks - 1 inclusively where num_chunks is the total number
30 of chunks which is printed when using the --info option. If
31 chunk_num is negative, the given number of chunks are counted
32 backwards from the end of the file. For example --begin_chunk
33 -100 instructs para_afh to start output at chunk num_chunks
34 - 100. This is mainly useful for cutting off the end of an
35 audio file.
36 "
37
38 option "end-chunk" e
39 #~~~~~~~~~~~~~~~~~~~
40 "only write up to chunk chunk_num"
41 int typestr = "chunk_num"
42 optional
43 details = "
44 For the chunk_num argument the same rules as for --begin_chunk
45 apply. The default is to write up to the last chunk.
46 "
47
48 option "just-in-time" j
49 #~~~~~~~~~~~~~~~~~~~~~~
50 "use timed writes"
51 flag off
52 details = "
53 Write the specified chunks of data 'just in time', i.e. the
54 write of each chunk is delayed until the time it is needed
55 by the decoder/player in order to guarantee an uninterrupted
56 audio stream. This may be useful for third-party software
57 that is capable of reading from stdin.
58 "
59
60 option "no-header" H
61 #~~~~~~~~~~~~~~~~~~~
62 "do not write an audio file header"
63 flag off
64 details = "
65 If an audio format needs information about the audio file
66 in a format-specific header in order to be understood by
67 the decoding software, a suitable header is automatically
68 send. This option changes the default behaviour, i.e. no
69 header is written.
70 "
71
72 </qu>