1 <!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
3 <!-- Process this file with docbook-to-man to generate an nroff manual
4 page: `docbook-to-man manpage.sgml > manpage.1'. You may view
5 the manual page with: `docbook-to-man manpage.sgml | nroff -man |
6 less'. A typical entry in a Makefile or Makefile.am is:
8 manpage.1: manpage.sgml
12 <!-- This is based on an example constructed by Colin Watson
13 <email>cjwatson@debian.org</email>, based on a man page template
14 provided by Tom Christiansen <email>tchrist@jhereg.perl.com</email>
15 and a DocBook man page example by Craig Small
16 <email>csmall@debian.org</email>.
19 <!-- Fill in the various UPPER CASE things here. -->
20 <!ENTITY manfirstname "<firstname>dann</firstname>">
21 <!ENTITY mansurname "<surname>frazier</surname>">
22 <!-- Please adjust the date whenever revising the manpage. -->
23 <!ENTITY mandate "<date>2005-02-02</date>">
24 <!-- SECTION should be 1-8, maybe with subsection. Other parameters are
25 allowed: see man(7), man(1). -->
26 <!ENTITY mansection "<manvolnum>1</manvolnum>">
27 <!ENTITY manemail "<email>dannf@debian.org</email>">
28 <!ENTITY manusername "dannf">
29 <!ENTITY manucpackage "<refentrytitle>METAFLAC</refentrytitle>">
30 <!ENTITY manpackage "metaflac">
43 <year>2002,2003,2004,2005</year>
44 <holder>&manusername;</holder>
54 <refname>&manpackage;</refname>
57 program to list, add, remove, or edit metadata in one or more FLAC files.
62 <command>&manpackage;</command>
64 <group choice="opt"><arg><replaceable>options</replaceable></arg></group>
66 <arg><replaceable>operations</replaceable></arg></group>
67 <arg rep="repeat" choice="req"><replaceable>FLACfile</replaceable></arg>
71 <title>DESCRIPTION</title>
73 <para>Use <command>&manpackage;</command> to list, add, remove, or edit
74 metadata in one or more FLAC files. You may perform one major operation,
75 or many shorthand operations at a time.</para>
79 <title>OPTIONS</title>
83 <term><option>--preserve-modtime</option></term>
86 Preserve the original modification time in spite of edits.
91 <term><option>--with-filename</option></term>
94 Prefix each output line with the FLAC file name (the default if
95 more than one FLAC file is specified).
100 <term><option>--no-filename</option></term>
103 Do not prefix each output line with the FLAC file name (the default
104 if only one FLAC file is specified).
109 <term><option>--dont-use-padding</option></term>
112 By default metaflac tries to use padding where possible to avoid
113 rewriting the entire file if the metadata size changes. Use this
114 option to tell metaflac to not take advantage of padding this way.
121 <title>SHORTHAND OPERATIONS</title>
125 <term><option>--show-md5sum</option></term>
128 Show the MD5 signature from the STREAMINFO block.
133 <term><option>--show-min-blocksize</option></term>
136 Show the minimum block size from the STREAMINFO block.
141 <term><option>--show-max-blocksize</option></term>
144 Show the maximum block size from the STREAMINFO block.
149 <term><option>--show-min-framesize</option></term>
152 Show the minimum frame size from the STREAMINFO block.
157 <term><option>--show-max-framesize</option></term>
160 Show the maximum frame size from the STREAMINFO block.
165 <term><option>--show-sample-rate</option></term>
168 Show the sample rate from the STREAMINFO block.
173 <term><option>--show-channels</option></term>
176 Show the number of channels from the STREAMINFO block.
181 <term><option>--show-bps</option></term>
184 Show the # of bits per sample from the STREAMINFO block.
189 <term><option>--show-total-samples</option></term>
192 Show the total # of samples from the STREAMINFO block.
197 <term><option>--show-vendor-tag</option></term>
200 Show the vendor string from the VORBIS_COMMENT block.
205 <term><option>--show-tag=name</option></term>
208 Show all tags where the the field name matches 'name'.
213 <term><option>--remove-tag=name</option></term>
216 Remove all tags whose field name is 'name'.
221 <term><option>--remove-first-tag=name</option></term>
224 Remove first tag whose field name is 'name'.
229 <term><option>--remove-all-tags</option></term>
232 Remove all tags, leaving only the vendor string.
237 <term><option>--set-tag=field</option></term>
240 Add a tag. The field must comply with the
241 Vorbis comment spec, of the form "NAME=VALUE". If there is
242 currently no tag block, one will be created.
247 <term><option>--import-tags-from=file</option></term>
250 Import tags from a file. Use '-' for stdin. Each
251 line should be of the form NAME=VALUE. Multi-line comments
252 are currently not supported. Specify --remove-all-tags and/or
253 --no-utf8-convert before --import-tags-from if necessary.
258 <term><option>--export-tags-to=file</option></term>
261 Export tags to a file. Use '-' for stdin. Each
262 line will be of the form NAME=VALUE. Specify
263 --no-utf8-convert if necessary.
268 <term><option>--import-cuesheet-from=file</option></term>
271 Import a cuesheet from a file. Use '-' for stdin. Only one
272 FLAC file may be specified. A seekpoint will be added for each
273 index point in the cuesheet to the SEEKTABLE unless
274 --no-cued-seekpoints is specified.
279 <term><option>--export-cuesheet-to=file</option></term>
282 Export CUESHEET block to a cuesheet file, suitable for use by
283 CD authoring software. Use '-' for stdout. Only one FLAC file
284 may be specified on the command line.
289 <term><option>--add-replay-gain</option></term>
292 Calculates the title and album gains/peaks of the given FLAC
293 files as if all the files were part of one album, then stores
294 them in the VORBIS_COMMENT block. The tags are the same as
295 those used by vorbisgain. Existing ReplayGain tags will be
296 replaced. If only one FLAC file is given, the album and title
297 gains will be the same. Since this operation requires two
298 passes, it is always executed last, after all other operations
299 have been completed and written to disk. All FLAC files
300 specified must have the same resolution, sample rate, and
301 number of channels. The sample rate must be one of 8, 11.025,
302 12, 16, 22.05, 24, 32, 44.1, or 48 kHz.
307 <term><option>--remove-replay-gain</option></term>
310 Removes the ReplayGain tags.
315 <term><option>--add-seekpoint</option>={<replaceable>#</replaceable>|<replaceable>X</replaceable>|<replaceable>#x</replaceable>|<replaceable>#s</replaceable>}</term>
318 Add seek points to a SEEKTABLE block. Using #, a seek point at
319 that sample number is added. Using X, a placeholder point is
320 added at the end of a the table. Using #x, # evenly spaced seek
321 points will be added, the first being at sample 0. Using #s, a
322 seekpoint will be added every # seconds (# does not have to be a
323 whole number; it can be, for example, 9.5, meaning a seekpoint
324 every 9.5 seconds). If no SEEKTABLE block exists, one will be
325 created. If one already exists, points will be added to the
326 existing table, and any duplicates will be turned into placeholder
327 points. You may use many --add-seekpoint options; the resulting
328 SEEKTABLE will be the unique-ified union of all such values.
329 Example: --add-seekpoint=100x --add-seekpoint=3.5s will add 100
330 evenly spaced seekpoints and a seekpoint every 3.5 seconds.
335 <term><option>--add-padding=length</option></term>
338 Add a padding block of the given length (in bytes). The overall
339 length of the new block will be 4 + length; the extra 4 bytes is
340 for the metadata block header.
347 <title>MAJOR OPERATIONS</title>
351 <term><option>--list</option></term>
354 List the contents of one or more metadata blocks to stdout. By
355 default, all metadata blocks are listed in text format. Use the
356 following options to change this behavior:
360 <term><option>--block-number=#[,#[...]]</option></term>
363 An optional comma-separated list of block numbers to display.
364 The first block, the STREAMINFO block, is block 0.
369 <term><option>--block-type=type[,type[...]]</option></term>
370 <listitem><para></para></listitem>
373 <term><option>--except-block-type=type[,type[...]]</option></term>
376 An optional comma-separated list of block types to be included
377 or ignored with this option. Use only one of --block-type or
378 --except-block-type. The valid block types are: STREAMINFO,
379 PADDING, APPLICATION, SEEKTABLE, VORBIS_COMMENT. You may
380 narrow down the types of APPLICATION blocks displayed as
384 APPLICATION:abcd The APPLICATION block(s) whose textual repre-
385 sentation of the 4-byte ID is "abcd"
386 APPLICATION:0xXXXXXXXX The APPLICATION block(s) whose hexadecimal big-
387 endian representation of the 4-byte ID is
388 "0xXXXXXXXX". For the example "abcd" above the
389 hexadecimal equivalalent is 0x61626364
393 if both --block-number and --[except-]block-type are
394 specified, the result is the logical AND of both
395 arguments.</para></note>
399 <term><option>--application-data-format=hexdump|text</option></term>
402 If the application block you are displaying contains binary
403 data but your --data-format=text, you can display a hex dump
404 of the application data contents instead using
405 --application-data-format=hexdump.
413 <term><option>--remove</option></term>
416 Remove one or more metadata blocks from the metadata. Unless
417 --dont-use-padding is specified, the blocks will be replaced with
418 padding. You may not remove the STREAMINFO block.
422 <term><option>--block-number=#[,#[...]]</option></term>
423 <listitem><para></para></listitem>
426 <term><option>--block-type=type[,type[...]]</option></term>
427 <listitem><para></para></listitem>
430 <term><option>--except-block-type=type[,type[...]]</option></term>
432 <para>See --list above for usage.</para>
435 if both --block-number and --[except-]block-type are
436 specified, the result is the logical AND of both arguments.
444 <term><option>--remove-all</option></term>
447 Remove all metadata blocks (except the STREAMINFO block) from the
448 metadata. Unless --dont-use-padding is specified, the blocks will
449 be replaced with padding.
454 <term><option>--merge-padding</option></term>
457 Merge adjacent PADDING blocks into single blocks.
462 <term><option>--sort-padding</option></term>
465 Move all PADDING blocks to the end of the metadata and merge them
474 <title>SEE ALSO</title>
476 <para>flac(1).</para>
480 <!-- Keep this comment at the end of the file
485 sgml-minimize-attributes:nil
486 sgml-always-quote-attributes:t
489 sgml-parent-document:nil
490 sgml-default-dtd-file:nil
491 sgml-exposed-tags:nil
492 sgml-local-catalogs:nil
493 sgml-local-ecat-files:nil