~ubuntu-branches/ubuntu/raring/flac/raring

« back to all changes in this revision

Viewing changes to doc/html/documentation_tools_metaflac.html

  • Committer: Bazaar Package Importer
  • Author(s): Joshua Kwan
  • Date: 2007-05-29 22:56:36 UTC
  • mfrom: (1.1.4 upstream)
  • Revision ID: james.westby@ubuntu.com-20070529225636-ljeff8xxip09qaap
Tags: 1.1.4-1
* New upstream release. closes: #405167, #411311
  - libOggFLAC and libOggFLAC++ have been merged into libFLAC, so
    remove their corresponding packages.
  - Because of the API changes required to effect the above, there has
    been yet another soname bump. libflac7 -> libflac8 and
    libflac++5 -> libflac++6. Emails have been dispatched to the
    maintainers of dependent packages.
* Some notes on patches that were removed:
  - 02_stdin_stdout, 06_manpage_mention_utf8_convert: merged upstream
  - 08_manpage_warnings: Upstream has changed the manpage so it defintely
    can't fit in in 80 cols, so just forget about it. We'll live.
  - 05_eof_warnings_are_errors: Upstream decided to add a -w option to
    flac to treat all warnings as errors. I am going to defer to that
    for now, but if people think it's stupid let me know and I'll port
    the patch forward.
  - 04_stack_smasher: was a backport from 1.1.3, so it's obsolete.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 
2
<!-- Copyright (c) 2000,2001,2002,2003,2004,2005,2006,2007  Josh Coalson -->
 
3
<!-- Permission is granted to copy, distribute and/or modify this document -->
 
4
<!-- under the terms of the GNU Free Documentation License, Version 1.1 -->
 
5
<!-- or any later version published by the Free Software Foundation; -->
 
6
<!-- with no invariant sections. -->
 
7
<!-- A copy of the license can be found at http://www.gnu.org/copyleft/fdl.html -->
 
8
<html>
 
9
<head>
 
10
        <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
 
11
        <meta name="author" content="Josh Coalson" />
 
12
        <meta name="description" content="A free, open source codec for lossless audio compression and decompression" />
 
13
        <meta name="keywords" content="free,lossless,audio,codec,encoder,decoder,compression,compressor,archival,archive,archiving,backup,music" />
 
14
        <link rel="shortcut icon" type="image/x-icon" href="favicon.ico" />
 
15
        <link rel="stylesheet" type="text/css" href="flac.css" />
 
16
        <title>FLAC - documentation</title>
 
17
</head>
 
18
 
 
19
<body>
 
20
 
 
21
<div class="logo">
 
22
        <a href="http://flac.sourceforge.net/"><img src="images/logo130.gif" alt="FLAC Logo" align="middle" border="0" hspace="0" /></a>
 
23
</div>
 
24
 
 
25
<div class="above_nav"></div>
 
26
 
 
27
<div class="navbar">
 
28
        &nbsp;<a href="index.html">home</a>&nbsp;&nbsp;|
 
29
        &nbsp;<a href="faq.html">faq</a>&nbsp;&nbsp;|
 
30
        &nbsp;<a href="news.html">news</a>&nbsp;&nbsp;|
 
31
        &nbsp;<a href="download.html">download</a>&nbsp;&nbsp;|
 
32
        &nbsp;<a href="documentation.html">documentation</a>&nbsp;&nbsp;|
 
33
        &nbsp;<a href="comparison.html">comparison</a>&nbsp;&nbsp;|
 
34
        &nbsp;<a href="changelog.html">changelog</a>&nbsp;&nbsp;|
 
35
        &nbsp;<a href="links.html">links</a>&nbsp;&nbsp;|
 
36
        &nbsp;<a href="developers.html">developers</a>&nbsp;
 
37
</div>
 
38
 
 
39
<div class="langbar">
 
40
        &nbsp;english&nbsp;&nbsp;|
 
41
        &nbsp;<a href="ru/documentation.html">russian</a>&nbsp;
 
42
</div>
 
43
 
 
44
<div class="below_nav"></div>
 
45
 
 
46
<div class="box">
 
47
        <div class="box_title">
 
48
                <a name="metaflac">metaflac</a>
 
49
        </div>
 
50
        <div class="box_header"></div>
 
51
        <div class="box_body">
 
52
                <a name="toc"><font size="+1"><b><u>Table of Contents</u></b></font></a>
 
53
                <ul>
 
54
                        <li><a href="#usage">General Usage</a></li>
 
55
                        <li><a href="#global_options">Global Options</a></li>
 
56
                        <li><a href="#shorthand_operations">Shorthand Operations</a></li>
 
57
                        <li><a href="#major_operations">Major Operations</a></li>
 
58
                        <li><a href="#option_index">Option Index</a></li>
 
59
                </ul>
 
60
                <a name="usage"><font size="+1"><b><u>General Usage</u></b></font></a><br />
 
61
                <br />
 
62
                <span class="commandname">metaflac</span> is the command-line <span class="code">.flac</span> file metadata editor.  You can use it to list the contents of metadata blocks, edit, delete or insert blocks, and manage padding.<br />
 
63
                <br />
 
64
                <span class="commandname">metaflac</span> takes a set of "options" (though some are not optional) and a set of FLAC files to operate on.  There are three kinds of "options":
 
65
                <ul>
 
66
                        <li>
 
67
                                Major operations, which specify a mode of operation like listing blocks, removing blocks, etc.  These will have sub-operations describing exactly what is to be done.
 
68
                        </li>
 
69
                        <li>
 
70
                                Shorthand operations, which are convenient synonyms for major operations.  For example, there is a shorthand operation <span class="argument">--show-sample-rate</span> that shows just the sample rate field from the <span class="code">STREAMINFO</span> metadata block.
 
71
                        </li>
 
72
                        <li>
 
73
                                Global options, which affect all the operations.
 
74
                        </li>
 
75
                </ul>
 
76
                All of these are described in the tables below.  At least one shorthand or major operation must be supplied.  You can use multiple shorthand operations to do more than one thing to a file or set of files.  Most of the common things to do to metadata have shorthand operations.  As an example, here is how to show the MD5 signatures for a set of three FLAC files:<br />
 
77
                <br />
 
78
                <span class="code">metaflac --show-md5sum file1.flac file2.flac file3.flac</span><br />
 
79
                <br />
 
80
                Another example; this removes all DESCRIPTION and COMMENT tags in a set of FLAC files, and uses the <span class="argument">--preserve-modtime</span> global option to keep the FLAC file modification times the same (usually when files are edited the modification time is set to the current time):<br />
 
81
                <br />
 
82
                <span class="code">metaflac --preserve-modtime --remove-tag=DESCRIPTION --remove-tag=COMMENT file1.flac file2.flac file3.flac</span><br />
 
83
                <br />
 
84
 
 
85
                <table width="100%" border="0" cellspacing="0" cellpadding="0" bgcolor="#EEEED4"><tr><td>
 
86
                <table width="100%" border="1" bgcolor="#EEEED4">
 
87
                        <tr>
 
88
                                <td colspan="2" bgcolor="#D3D4C5">
 
89
                                        <a name="global_options"><font size="+1"><b>Global Options</b></font></a>
 
90
                                </td>
 
91
                        </tr>
 
92
                        <tr>
 
93
                                <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC">
 
94
                                        <a name="metaflac_options_preserve_modtime" />
 
95
                                        <span class="argument">--preserve-modtime</span>
 
96
                                </td>
 
97
                                <td>
 
98
                                        Preserve the original modification time in spite of edits.
 
99
                                </td>
 
100
                        </tr>
 
101
                        <tr>
 
102
                                <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC">
 
103
                                        <a name="metaflac_options_with_filename" />
 
104
                                        <span class="argument">--with-filename</span>
 
105
                                </td>
 
106
                                <td>
 
107
                                        Prefix each output line with the FLAC file name (the default if more than one FLAC file is specified).
 
108
                                </td>
 
109
                        </tr>
 
110
                        <tr>
 
111
                                <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC">
 
112
                                        <a name="metaflac_options_no_filename" />
 
113
                                        <span class="argument">--no-filename</span>
 
114
                                </td>
 
115
                                <td>
 
116
                                        Do not prefix each output line with the FLAC file name (the default if only one FLAC file is specified)
 
117
                                </td>
 
118
                        </tr>
 
119
                        <tr>
 
120
                                <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC">
 
121
                                        <a name="metaflac_options_no_utf8_convert" />
 
122
                                        <span class="argument">--no-utf8-convert</span>
 
123
                                </td>
 
124
                                <td>
 
125
                                        Do not convert tags from UTF-8 to local charset, or vice versa.  This is useful for scripts.
 
126
                                </td>
 
127
                        </tr>
 
128
                        <tr>
 
129
                                <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC">
 
130
                                        <a name="metaflac_options_dont_use_padding" />
 
131
                                        <span class="argument">--dont-use-padding</span>
 
132
                                </td>
 
133
                                <td>
 
134
                                        By default <span class="commandname">metaflac</span> tries to use padding where possible to avoid rewriting the entire file if the metadata size changes.  Use this option to tell metaflac to not take advantage of padding this way.
 
135
                                </td>
 
136
                        </tr>
 
137
                </table>
 
138
                </td></tr></table>
 
139
 
 
140
                <br />
 
141
 
 
142
                <table width="100%" border="0" cellspacing="0" cellpadding="0" bgcolor="#EEEED4"><tr><td>
 
143
                <table width="100%" border="1" bgcolor="#EEEED4">
 
144
                        <tr>
 
145
                                <td colspan="2" bgcolor="#D3D4C5">
 
146
                                        <a name="shorthand_operations"><font size="+1"><b>Shorthand Operations</b></font></a>
 
147
                                </td>
 
148
                        </tr>
 
149
                        <tr>
 
150
                                <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC">
 
151
                                        <a name="metaflac_shorthand_show_md5sum" />
 
152
                                        <span class="argument">--show-md5sum</span>
 
153
                                </td>
 
154
                                <td>
 
155
                                        Show the MD5 signature from the <span class="code">STREAMINFO</span> block.
 
156
                                </td>
 
157
                        </tr>
 
158
                        <tr>
 
159
                                <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC">
 
160
                                        <a name="metaflac_shorthand_show_min_blocksize" />
 
161
                                        <span class="argument">--show-min-blocksize</span>
 
162
                                </td>
 
163
                                <td>
 
164
                                        Show the minimum block size from the <span class="code">STREAMINFO</span> block.
 
165
                                </td>
 
166
                        </tr>
 
167
                        <tr>
 
168
                                <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC">
 
169
                                        <a name="metaflac_shorthand_show_max_blocksize" />
 
170
                                        <span class="argument">--show-max-blocksize</span>
 
171
                                </td>
 
172
                                <td>
 
173
                                        Show the maximum block size from the <span class="code">STREAMINFO</span> block.
 
174
                                </td>
 
175
                        </tr>
 
176
                        <tr>
 
177
                                <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC">
 
178
                                        <a name="metaflac_shorthand_show_min_framesize" />
 
179
                                        <span class="argument">--show-min-framesize</span>
 
180
                                </td>
 
181
                                <td>
 
182
                                        Show the minimum frame size from the <span class="code">STREAMINFO</span> block.
 
183
                                </td>
 
184
                        </tr>
 
185
                        <tr>
 
186
                                <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC">
 
187
                                        <a name="metaflac_shorthand_show_max_framesize" />
 
188
                                        <span class="argument">--show-max-framesize</span>
 
189
                                </td>
 
190
                                <td>
 
191
                                        Show the maximum frame size from the <span class="code">STREAMINFO</span> block.
 
192
                                </td>
 
193
                        </tr>
 
194
                        <tr>
 
195
                                <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC">
 
196
                                        <a name="metaflac_shorthand_show_sample_rate" />
 
197
                                        <span class="argument">--show-sample-rate</span>
 
198
                                </td>
 
199
                                <td>
 
200
                                        Show the sample rate from the <span class="code">STREAMINFO</span> block.
 
201
                                </td>
 
202
                        </tr>
 
203
                        <tr>
 
204
                                <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC">
 
205
                                        <a name="metaflac_shorthand_show_channels" />
 
206
                                        <span class="argument">--show-channels</span>
 
207
                                </td>
 
208
                                <td>
 
209
                                        Show the number of channels from the <span class="code">STREAMINFO</span> block.
 
210
                                </td>
 
211
                        </tr>
 
212
                        <tr>
 
213
                                <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC">
 
214
                                        <a name="metaflac_shorthand_show_bps" />
 
215
                                        <span class="argument">--show-bps</span>
 
216
                                </td>
 
217
                                <td>
 
218
                                        Show the # of bits per sample from the <span class="code">STREAMINFO</span> block.
 
219
                                </td>
 
220
                        </tr>
 
221
                        <tr>
 
222
                                <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC">
 
223
                                        <a name="metaflac_shorthand_show_total_samples" />
 
224
                                        <span class="argument">--show-total-samples</span>
 
225
                                </td>
 
226
                                <td>
 
227
                                        Show the total # of samples from the <span class="code">STREAMINFO</span> block.
 
228
                                </td>
 
229
                        </tr>
 
230
                        <tr>
 
231
                                <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC">
 
232
                                        <a name="metaflac_shorthand_show_vendor_tag" />
 
233
                                        <span class="argument">--show-vendor-tag</span>
 
234
                                </td>
 
235
                                <td>
 
236
                                        Show the vendor string from the <span class="code">VORBIS_COMMENT</span> block.
 
237
                                </td>
 
238
                        </tr>
 
239
                        <tr>
 
240
                                <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC">
 
241
                                        <a name="metaflac_shorthand_show_tag" />
 
242
                                        <span class="argument">--show-tag=NAME</span>
 
243
                                </td>
 
244
                                <td>
 
245
                                        Show all tags where the the field name matches <span class="argument">NAME</span>.
 
246
                                </td>
 
247
                        </tr>
 
248
                        <tr>
 
249
                                <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC">
 
250
                                        <a name="metaflac_shorthand_remove_tag" />
 
251
                                        <span class="argument">--remove-tag=NAME</span>
 
252
                                </td>
 
253
                                <td>
 
254
                                        Remove all tags whose field name is <span class="argument">NAME</span>.
 
255
                                </td>
 
256
                        </tr>
 
257
                        <tr>
 
258
                                <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC">
 
259
                                        <a name="metaflac_shorthand_remove_first_tag" />
 
260
                                        <span class="argument">--remove-first-tag=NAME</span>
 
261
                                </td>
 
262
                                <td>
 
263
                                        Remove first tag whose field name is <span class="argument">NAME</span>.
 
264
                                </td>
 
265
                        </tr>
 
266
                        <tr>
 
267
                                <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC">
 
268
                                        <a name="metaflac_shorthand_remove_all_tags" />
 
269
                                        <span class="argument">--remove-all-tags</span>
 
270
                                </td>
 
271
                                <td>
 
272
                                        Remove all tags, leaving only the vendor string.
 
273
                                </td>
 
274
                        </tr>
 
275
                        <tr>
 
276
                                <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC">
 
277
                                        <a name="metaflac_shorthand_set_tag" />
 
278
                                        <span class="argument">--set-tag=FIELD</span>
 
279
                                </td>
 
280
                                <td>
 
281
                                        Add a tag.  The <span class="argument">FIELD</span> must comply with the Vorbis comment spec, of the form <span class="argument">NAME=VALUE</span>.  If there is currently no tag block, one will be created.
 
282
                                </td>
 
283
                        </tr>
 
284
                        <tr>
 
285
                                <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC">
 
286
                                        <a name="metaflac_shorthand_set_tag_from_file" />
 
287
                                        <span class="argument">--set-tag-from-file=FIELD</span>
 
288
                                </td>
 
289
                                <td>
 
290
                                        Like <a href="#metaflac_shorthand_set_tag"><span class="argument">--set-tag</span></a>, except the VALUE is a filename whose contents will be read verbatim to set the tag value.  Unless <a href="#metaflac_options_no_utf8_convert"><span class="argument">--no-utf8-convert</span></a> is specified, the contents will be converted to UTF-8 from the local charset.  This can be used to store a cuesheet in a tag (e.g. <span class="argument">--set-tag-from-file="CUESHEET=image.cue"</span>).  Do not try to store binary data in tag fields!  Use APPLICATION blocks for that.
 
291
                                </td>
 
292
                        </tr>
 
293
                        <tr>
 
294
                                <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC">
 
295
                                        <a name="metaflac_shorthand_import_tags_from" />
 
296
                                        <span class="argument">--import-tags-from=FILE</span>
 
297
                                </td>
 
298
                                <td>
 
299
                                        Import tags from a file.  Use <span class="argument">-</span> for stdin.  Each line should be of the form <span class="argument">NAME=VALUE</span>.  Multi-line comments are currently not supported.  Specify <span class="argument">--remove-all-tags</span> and/or <a href="#metaflac_options_no_utf8_convert"><span class="argument">--no-utf8-convert</span></a> before <span class="argument">--import-tags-from</span> if necessary.  If <span class="argument">FILE</span> is <span class="argument">-</span> (stdin), only one FLAC file may be specified.
 
300
                                </td>
 
301
                        </tr>
 
302
                        <tr>
 
303
                                <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC">
 
304
                                        <a name="metaflac_shorthand_export_tags_to" />
 
305
                                        <span class="argument">--export-tags-to=FILE</span>
 
306
                                </td>
 
307
                                <td>
 
308
                                        Export tags to a file.  Use <span class="argument">-</span> for stdin.  Each line will be of the form <span class="argument">NAME=VALUE</span>.  Specify <a href="#metaflac_options_no_utf8_convert"><span class="argument">--no-utf8-convert</span></a> if necessary.
 
309
                                </td>
 
310
                        </tr>
 
311
                        <tr>
 
312
                                <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC">
 
313
                                        <a name="metaflac_shorthand_import_cuesheet_from" />
 
314
                                        <span class="argument">--import-cuesheet-from=FILE</span>
 
315
                                </td>
 
316
                                <td>
 
317
                                        Import a cuesheet from a file.  Use <span class="argument">-</span> for stdin.  Only one FLAC file may be specified.  A seekpoint will be added for each index point in the cuesheet to the <span class="code">SEEKTABLE</span> unless <span class="argument">--no-cued-seekpoints</span> is specified.
 
318
                                </td>
 
319
                        </tr>
 
320
                        <tr>
 
321
                                <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC">
 
322
                                        <a name="metaflac_shorthand_export_cuesheet_to" />
 
323
                                        <span class="argument">--export-cuesheet-to=FILE</span>
 
324
                                </td>
 
325
                                <td>
 
326
                                        Export <span class="code">CUESHEET</span> block to a cuesheet file, suitable for use by CD authoring software.  Use <span class="argument">-</span> for stdout.  Only one FLAC file may be specified on the command line.
 
327
                                </td>
 
328
                        </tr>
 
329
                        <tr>
 
330
                                <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC">
 
331
                                        <a name="metaflac_shorthand_import_picture_from" />
 
332
                                        <span class="argument">--import-picture-from={FILENAME|SPECIFICATION}</span>
 
333
                                </td>
 
334
                                <td>
 
335
                                        Import a picture and store it in a <a href="format.html#def_PICTURE"><span class="code">PICTURE</span></a> metadata block.  See the <span class="commandname">flac</span> option <span class="argument"><a href="documentation_tools_flac.html#flac_options_picture">--picture</a></span> for an explanation of the <span class="argument">SPECIFICATION</span> syntax.
 
336
                                </td>
 
337
                        </tr>
 
338
                        <tr>
 
339
                                <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC">
 
340
                                        <a name="metaflac_shorthand_export_picture_to" />
 
341
                                        <span class="argument">--export-picture-to=FILE</span>
 
342
                                </td>
 
343
                                <td>
 
344
                                        Export <span class="code">PICTURE</span> block to a file.  Use <span class="argument">-</span> for stdout.  Only one FLAC file may be specified on the command line.  The first <span class="code">PICTURE</span> block will be exported unless <span class="argument">--export-picture-to</span> is preceded by a <span class="argument">--block-number=#</span> option to specify the exact metadata block to extract.  Note that the block number is the one shown by --list.
 
345
                                </td>
 
346
                        </tr>
 
347
                        <tr>
 
348
                                <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC">
 
349
                                        <a name="metaflac_shorthand_add_replay_gain" />
 
350
                                        <span class="argument">--add-replay-gain</span>
 
351
                                </td>
 
352
                                <td>
 
353
                                        Calculates the title and album gains/peaks of the given FLAC files as if all the files were part of one album, then stores them in the <span class="code">VORBIS_COMMENT</span> block.  The tags are the same as those used by <span class="commandname">vorbisgain</span>.  Existing ReplayGain tags will be replaced.  If only one FLAC file is given, the album and title gains will be the same.  Since this operation requires two passes, it is always executed last, after all other operations have been completed and written to disk.  All FLAC files specified must have the same resolution, sample rate, and number of channels.  The sample rate must be one of 8, 11.025, 12, 16, 22.05, 24, 32, 44.1, or 48 kHz.
 
354
                                </td>
 
355
                        </tr>
 
356
                        <tr>
 
357
                                <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC">
 
358
                                        <a name="metaflac_shorthand_remove_replay_gain" />
 
359
                                        <span class="argument">--remove-replay-gain</span>
 
360
                                </td>
 
361
                                <td>
 
362
                                        Removes the ReplayGain tags.
 
363
                                </td>
 
364
                        </tr>
 
365
                        <tr>
 
366
                                <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC">
 
367
                                        <a name="metaflac_shorthand_add_seekpoint" />
 
368
                                        <span class="argument">--add-seekpoint={#|X|#x|#s}</span>
 
369
                                </td>
 
370
                                <td>
 
371
                                        Add seek points to a <span class="code">SEEKTABLE</span> block:<br />
 
372
                                        <ul>
 
373
                                        <li>
 
374
                                                <span class="argument">#&nbsp;</span> : a specific sample number for a seek point
 
375
                                        </li>
 
376
                                        <li>
 
377
                                                <span class="argument">X&nbsp;</span> : a placeholder point (always goes at the end of the <span class="code">SEEKTABLE</span>)
 
378
                                        </li>
 
379
                                        <li>
 
380
                                                <span class="argument">#x</span> : # evenly spaced seekpoints, the first being at sample 0
 
381
                                        </li>
 
382
                                        <li>
 
383
                                                <span class="argument">#s</span> : a seekpoint every # seconds; # does not have to be a whole number, it can be, for example, <span class="argument">9.5</span>, meaning a seekpoint every 9.5 seconds
 
384
                                        </li>
 
385
                                        </ul>
 
386
                                        If no <span class="code">SEEKTABLE</span> block exists, one will be created.  If one already exists, points will be added to the existing table, and any duplicates will be turned into placeholder points.<br />
 
387
                                        You may use many <span class="argument">--add-seekpoint</span> options; the resulting <span class="code">SEEKTABLE</span> will be the unique-ified union of all such values.  Example: <span class="argument">--add-seekpoint=100x --add-seekpoint=3.5s</span> will add 100 evenly spaced seekpoints and a seekpoint every 3.5 seconds.<br />
 
388
                                </td>
 
389
                        </tr>
 
390
                        <tr>
 
391
                                <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC">
 
392
                                        <a name="metaflac_shorthand_add_padding" />
 
393
                                        <span class="argument">--add-padding=#</span>
 
394
                                </td>
 
395
                                <td>
 
396
                                        Add a padding block of the given length (in bytes).  The overall length of the new block will be 4 + length; the extra 4 bytes is for the metadata block header.
 
397
                                </td>
 
398
                        </tr>
 
399
                </table>
 
400
                </td></tr></table>
 
401
 
 
402
                <br />
 
403
 
 
404
                <table width="100%" border="0" cellspacing="0" cellpadding="0" bgcolor="#EEEED4"><tr><td>
 
405
                <table width="100%" border="1" bgcolor="#EEEED4">
 
406
                        <tr>
 
407
                                <td colspan="2" bgcolor="#D3D4C5">
 
408
                                        <a name="major_operations"><font size="+1"><b>Major Operations</b></font></a>
 
409
                                </td>
 
410
                        </tr>
 
411
                        <tr>
 
412
                                <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC">
 
413
                                        <a name="metaflac_operations_version" />
 
414
                                        <span class="argument">--version</span>
 
415
                                </td>
 
416
                                <td>
 
417
                                        Show the metaflac version number.
 
418
                                </td>
 
419
                        </tr>
 
420
                        <tr>
 
421
                                <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC">
 
422
                                        <a name="metaflac_operations_list" />
 
423
                                        <span class="argument">--list</span>
 
424
                                </td>
 
425
                                <td>
 
426
                                        List the contents of one or more metadata blocks to stdout.  By default, all metadata blocks are listed in text format.  Use the following options to change this behavior:<br />
 
427
                                        <br />
 
428
 
 
429
                                        <span class="argument">--block-number=#[,#[...]]</span><br />
 
430
                                        An optional comma-separated list of block numbers to display.  The first block, the <span class="code">STREAMINFO</span> block, is block 0.<br />
 
431
                                        <br />
 
432
 
 
433
                                        <span class="argument">--block-type=type[,type[...]]</span><br />
 
434
                                        <span class="argument">--except-block-type=type[,type[...]]</span><br />
 
435
                                        An optional comma-separated list of block types to be included or ignored with this option.  Use only one of <span class="argument">--block-type</span> or <span class="argument">--except-block-type</span>.  The valid block types are: <span class="code">STREAMINFO</span>, <span class="code">PADDING</span>, <span class="code">APPLICATION</span>, <span class="code">SEEKTABLE</span>, <span class="code">VORBIS_COMMENT</span>.  You may narrow down the types of <span class="code">APPLICATION</span> blocks displayed as follows:<br />
 
436
                                        <table border="1">
 
437
                                                <tr>
 
438
                                                        <td><span class="argument">APPLICATION:abcd</span></td>
 
439
                                                        <td>The <span class="code">APPLICATION</span> block(s) whose textual representation of the 4-byte ID is "abcd"</td>
 
440
                                                </tr>
 
441
                                                <tr>
 
442
                                                        <td><span class="argument">APPLICATION:0xXXXXXXXX</span></td>
 
443
                                                        <td>The <span class="code">APPLICATION</span> block(s) whose hexadecimal big- endian representation of the 4-byte ID is "0xXXXXXXXX".  For the example "abcd" above the hexadecimal equivalalent is 0x61626364</td>
 
444
                                                </tr>
 
445
                                        </table>
 
446
                                        <br />
 
447
 
 
448
                                        NOTE: if both <span class="argument">--block-number</span> and <span class="argument">--[except-]block-type</span> are specified, the result is the logical AND of both arguments.<br />
 
449
                                        <br />
 
450
 
 
451
                                        <span class="argument">--application-data-format=hexdump|text</span><br />
 
452
                                        If the application block you are displaying contains binary data but your <span class="argument">--data-format=text</span>, you can display a hex dump of the application data contents instead using <span class="argument">--application-data-format=hexdump</span>.
 
453
                                </td>
 
454
                        </tr>
 
455
                        <tr>
 
456
                                <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC">
 
457
                                        <a name="metaflac_operations_remove" />
 
458
                                        <span class="argument">--remove</span>
 
459
                                </td>
 
460
                                <td>
 
461
                                        Remove one or more metadata blocks from the metadata.  Unless <span class="argument">--dont-use-padding</span> is specified, the blocks will be replaced with padding.  You may not remove the <span class="code">STREAMINFO</span> block.<br />
 
462
                                        <br />
 
463
 
 
464
                                        <span class="argument">--block-number=#[,#[...]]</span><br />
 
465
                                        <span class="argument">--block-type=type[,type[...]]</span><br />
 
466
                                        <span class="argument">--except-block-type=type[,type[...]]</span><br />
 
467
                                        See <a href="#metaflac_operations_list"><span class="argument">--list</span></a> above for usage.<br />
 
468
                                        <br />
 
469
 
 
470
                                        NOTE: if both <span class="argument">--block-number</span> and <span class="argument">--[except-]block-type</span> are specified, the result is the logical AND of both arguments.
 
471
                                </td>
 
472
                        </tr>
 
473
                        <tr>
 
474
                                <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC">
 
475
                                        <a name="metaflac_operations_remove_all" />
 
476
                                        <span class="argument">--remove-all</span>
 
477
                                </td>
 
478
                                <td>
 
479
                                        Remove all metadata blocks (except the <span class="code">STREAMINFO</span> block) from the metadata.  Unless <span class="argument">--dont-use-padding</span> is specified, the blocks will be replaced with padding.
 
480
                                </td>
 
481
                        </tr>
 
482
                        <tr>
 
483
                                <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC">
 
484
                                        <a name="metaflac_operations_merge_padding" />
 
485
                                        <span class="argument">--merge-padding</span>
 
486
                                </td>
 
487
                                <td>
 
488
                                        Merge adjacent <span class="code">PADDING</span> blocks into single blocks.
 
489
                                </td>
 
490
                        </tr>
 
491
                        <tr>
 
492
                                <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC">
 
493
                                        <a name="metaflac_operations_sort_padding" />
 
494
                                        <span class="argument">--sort-padding</span>
 
495
                                </td>
 
496
                                <td>
 
497
                                        Move all <span class="code">PADDING</span> blocks to the end of the metadata and merge them into a single block.
 
498
                                </td>
 
499
                        </tr>
 
500
                </table>
 
501
                </td></tr></table>
 
502
 
 
503
                <br />
 
504
                <a name="option_index"><font size="+1"><b><u>Option Index</u></b></font></a><br />
 
505
                <br />
 
506
                <a href="#metaflac_shorthand_add_padding" /><span class="argument">--add-padding</span></a><br />
 
507
                <a href="#metaflac_shorthand_add_replay_gain" /><span class="argument">--add-replay-gain</span></a><br />
 
508
                <a href="#metaflac_shorthand_add_seekpoint" /><span class="argument">--add-seekpoint</span></a><br />
 
509
                <a href="#metaflac_options_dont_use_padding" /><span class="argument">--dont-use-padding</span></a><br />
 
510
                <a href="#metaflac_shorthand_export_cuesheet_to" /><span class="argument">--export-cuesheet-to</span></a><br />
 
511
                <a href="#metaflac_shorthand_export_picture_to" /><span class="argument">--export-picture-to</span></a><br />
 
512
                <a href="#metaflac_shorthand_export_tags_to" /><span class="argument">--export-tags-to</span></a><br />
 
513
                <a href="#metaflac_shorthand_import_cuesheet_from" /><span class="argument">--import-cuesheet-from</span></a><br />
 
514
                <a href="#metaflac_shorthand_import_picture_from" /><span class="argument">--import-picture-from</span></a><br />
 
515
                <a href="#metaflac_shorthand_import_tags_from" /><span class="argument">--import-tags-from</span></a><br />
 
516
                <a href="#metaflac_operations_list" /><span class="argument">--list</span></a><br />
 
517
                <a href="#metaflac_operations_merge_padding" /><span class="argument">--merge-padding</span></a><br />
 
518
                <a href="#metaflac_options_no_filename" /><span class="argument">--no-filename</span></a><br />
 
519
                <a href="#metaflac_options_no_utf8_convert" /><span class="argument">--no-utf8-convert</span></a><br />
 
520
                <a href="#metaflac_options_preserve_modtime" /><span class="argument">--preserve-modtime</span></a><br />
 
521
                <a href="#metaflac_shorthand_remove_all_tags" /><span class="argument">--remove-all-tags</span></a><br />
 
522
                <a href="#metaflac_operations_remove_all" /><span class="argument">--remove-all</span></a><br />
 
523
                <a href="#metaflac_shorthand_remove_first_tag" /><span class="argument">--remove-first-tag</span></a><br />
 
524
                <a href="#metaflac_shorthand_remove_replay_gain" /><span class="argument">--remove-replay-gain</span></a><br />
 
525
                <a href="#metaflac_shorthand_remove_tag" /><span class="argument">--remove-tag</span></a><br />
 
526
                <a href="#metaflac_operations_remove" /><span class="argument">--remove</span></a><br />
 
527
                <a href="#metaflac_shorthand_set_tag_from_file" /><span class="argument">--set-tag-from-file</span></a><br />
 
528
                <a href="#metaflac_shorthand_set_tag" /><span class="argument">--set-tag</span></a><br />
 
529
                <a href="#metaflac_shorthand_show_bps" /><span class="argument">--show-bps</span></a><br />
 
530
                <a href="#metaflac_shorthand_show_channels" /><span class="argument">--show-channels</span></a><br />
 
531
                <a href="#metaflac_shorthand_show_max_blocksize" /><span class="argument">--show-max-blocksize</span></a><br />
 
532
                <a href="#metaflac_shorthand_show_max_framesize" /><span class="argument">--show-max-framesize</span></a><br />
 
533
                <a href="#metaflac_shorthand_show_md5sum" /><span class="argument">--show-md5sum</span></a><br />
 
534
                <a href="#metaflac_shorthand_show_min_blocksize" /><span class="argument">--show-min-blocksize</span></a><br />
 
535
                <a href="#metaflac_shorthand_show_min_framesize" /><span class="argument">--show-min-framesize</span></a><br />
 
536
                <a href="#metaflac_shorthand_show_sample_rate" /><span class="argument">--show-sample-rate</span></a><br />
 
537
                <a href="#metaflac_shorthand_show_tag" /><span class="argument">--show-tag</span></a><br />
 
538
                <a href="#metaflac_shorthand_show_total_samples" /><span class="argument">--show-total-samples</span></a><br />
 
539
                <a href="#metaflac_shorthand_show_vendor_tag" /><span class="argument">--show-vendor-tag</span></a><br />
 
540
                <a href="#metaflac_operations_sort_padding" /><span class="argument">--sort-padding</span></a><br />
 
541
                <a href="#metaflac_operations_version" /><span class="argument">--version</span></a><br />
 
542
                <a href="#metaflac_options_with_filename" /><span class="argument">--with-filename</span></a><br />
 
543
 
 
544
        </div>
 
545
        <div class="box_footer"></div>
 
546
</div>
 
547
 
 
548
 
 
549
<div class="copyright">
 
550
        <!-- @@@ oh so hacky -->
 
551
        <table>
 
552
                <tr>
 
553
                        <td align="left">
 
554
                                Copyright (c) 2000,2001,2002,2003,2004,2005,2006,2007  Josh Coalson
 
555
                        </td>
 
556
                        <td width="1%" align="right">
 
557
                                <a href="http://sourceforge.net"><img src="http://sflogo.sourceforge.net/sflogo.php?group_id=13478&amp;type=1" width="88" height="31" border="0" alt="SourceForge.net Logo" /></a>
 
558
                        </td>
 
559
                        <td width="1%" align="right">
 
560
                                <a href="http://www.eff.org/cafe/"><img src="images/cafebug.gif" alt="CAFE Logo" border="0" /></a><br />
 
561
                        </td>
 
562
                        <td width="1%" align="right">
 
563
                                <a href="http://validator.w3.org/check?uri=referer"><img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" height="31" width="88" border="0" hspace="0" /></a>
 
564
                        </td>
 
565
                </tr>
 
566
        </table>
 
567
</div>
 
568
 
 
569
</body>
 
570
</html>