The wma tagger.
[paraslash.git] / m4 / gengetopt / afh.m4
1 args "--unamed-opts=audio_file --no-handle-version --no-handle-help"
2
3 purpose "Print information about audio file(s)"
4
5 include(header.m4)
6 include(loglevel.m4)
7
8 <qu>
9
10 ###################################
11 section "printing meta information"
12 ###################################
13
14 option "chunk-table" c
15 #~~~~~~~~~~~~~~~~~~~~~
16 "print also the chunk table"
17 flag off
18 details = "
19 The 'chunk table' of an audio file is an array of offsets
20 within the audio file. Each offset corresponds to chunk
21 of encoded data. The exact meaning of 'chunk' depends on
22 the audio format.
23
24 Programs which are unaware of the particular audio format can
25 read the chunk table to obtain the timing information needed
26 to stream the file.
27 "
28
29 option "parser-friendly" p
30 #~~~~~~~~~~~~~~~~~~~~~~~~~
31 "do not use human-readable output format"
32 flag off
33 details = "
34 Currently this option only affects the format of the chunk table,
35 so it has no effect if --chunk-table is not given.
36
37 The human-readable output (the default) consists of one output
38 line per chunk and the output contains also the chunk number,
39 the duration and the size of each chunk. The parser-friendly
40 output prints only the offsets, in one line.
41 "
42
43 #############################
44 section "modifying meta tags"
45 #############################
46
47 option "modify" m
48 #~~~~~~~~~~~~~~~~
49 "modify (rather than print) tags"
50 flag off
51 details = "
52 When this option is given, para_afh creates the result file
53 as a temporary copy of the given file(s), but with meta
54 tags changed according to the options below. On errors,
55 the temporary file is removed, leaving the original file
56 unchanged. On success, if --backup is given, the original
57 file is moved away. Finally the temporary file is renamed to
58 the name of the original file.
59 "
60
61 option "backup" b
62 "create backup of the original file"
63 flag off
64 details = "
65 The backup suffix is '~', i.e. a single tilde character is appended
66 to the given file name.
67 "
68
69 option "year" y
70 #~~~~~~~~~~~~~~
71 "set the year tag"
72 string typestr="year"
73 optional
74
75 option "title" t
76 #~~~~~~~~~~~~~~~
77 "set the title tag"
78 string typestr="title"
79 optional
80
81 option "artist" a
82 #~~~~~~~~~~~~~~~~
83 "set the artist/author tag"
84 string typestr="artist"
85 optional
86
87 option "album" A
88 #~~~~~~~~~~~~~~~
89 "set the album tag"
90 string typestr="album"
91 optional
92
93 option "comment" C
94 #~~~~~~~~~~~~~~~~~
95 "set the comment tag"
96 string typestr="comment"
97 optional
98
99 </qu>