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>2006-11-14</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>--set-tag-from-file=field</option></term>
250 Like --set-tag, except the VALUE is a filename whose
251 contents will be read verbatim to set the tag value.
252 Unless --no-utf8-convert is specified, the contents will be
253 converted to UTF-8 from the local charset. This can be used
254 to store a cuesheet in a tag (e.g.
255 --set-tag-from-file="CUESHEET=image.cue"). Do not try to
256 store binary data in tag fields! Use APPLICATION blocks for
262 <term><option>--import-tags-from=file</option></term>
265 Import tags from a file. Use '-' for stdin. Each
266 line should be of the form NAME=VALUE. Multi-line comments
267 are currently not supported. Specify --remove-all-tags and/or
268 --no-utf8-convert before --import-tags-from if necessary. If
269 FILE is '-' (stdin), only one FLAC file may be specified.
274 <term><option>--export-tags-to=file</option></term>
277 Export tags to a file. Use '-' for stdin. Each
278 line will be of the form NAME=VALUE. Specify
279 --no-utf8-convert if necessary.
284 <term><option>--import-cuesheet-from=file</option></term>
287 Import a cuesheet from a file. Use '-' for stdin. Only one
288 FLAC file may be specified. A seekpoint will be added for each
289 index point in the cuesheet to the SEEKTABLE unless
290 --no-cued-seekpoints is specified.
295 <term><option>--export-cuesheet-to=file</option></term>
298 Export CUESHEET block to a cuesheet file, suitable for use by
299 CD authoring software. Use '-' for stdout. Only one FLAC file
300 may be specified on the command line.
305 <term><option>--import-picture-from</option>=<replaceable>SPECIFICATION</replaceable></term>
307 <para>Import a picture and store it in a PICTURE metadata block. More than one --import-picture-from command can be specified. The SPECIFICATION is a string whose parts are separated by | (pipe) characters. Some parts may be left empty to invoke default values. The format of SPECIFICATION is</para>
308 <para>[TYPE]|MIME-TYPE|[DESCRIPTION]|[WIDTHxHEIGHTxDEPTH[/COLORS]]|FILE</para>
309 <para>TYPE is optional; it is a number from one of:</para>
310 <para>0: Other</para>
311 <para>1: 32x32 pixels 'file icon' (PNG only)</para>
312 <para>2: Other file icon</para>
313 <para>3: Cover (front)</para>
314 <para>4: Cover (back)</para>
315 <para>5: Leaflet page</para>
316 <para>6: Media (e.g. label side of CD)</para>
317 <para>7: Lead artist/lead performer/soloist</para>
318 <para>8: Artist/performer</para>
319 <para>9: Conductor</para>
320 <para>10: Band/Orchestra</para>
321 <para>11: Composer</para>
322 <para>12: Lyricist/text writer</para>
323 <para>13: Recording Location</para>
324 <para>14: During recording</para>
325 <para>15: During performance</para>
326 <para>16: Movie/video screen capture</para>
327 <para>17: A bright coloured fish</para>
328 <para>18: Illustration</para>
329 <para>19: Band/artist logotype</para>
330 <para>20: Publisher/Studio logotype</para>
331 <para>The default is 3 (front cover). There may only be one picture each of type 1 and 2 in a file.</para>
333 <para>MIME-TYPE is mandatory; for best compatibility with players, use pictures with MIME type image/jpeg or image/png. The MIME type can also be --> to mean that FILE is actually a URL to an image, though this use is discouraged.</para>
335 <para>DESCRIPTION is optional; the default is an empty string.</para>
337 <para>The next part specfies the resolution and color information. If the MIME-TYPE is image/jpeg, image/png, or image/gif, you can usually leave this empty and they can be detected from the file. Otherwise, you must specify the width in pixels, height in pixels, and color depth in bits-per-pixel. If the image has indexed colors you should also specify the number of colors used. When manually specified, it is not checked against the file for accuracy.</para>
339 <para>FILE is the path to the picture file to be imported, or the URL if MIME type is --></para>
341 <para>For example, "|image/jpeg|||../cover.jpg" will embed the JPEG file at ../cover.jpg, defaulting to type 3 (front cover) and an empty description. The resolution and color info will be retrieved from the file itself.</para>
343 <para>The specification "4|-->|CD|320x300x24/173|http://blah.blah/backcover.tiff" will embed the given URL, with type 4 (back cover), description "CD", and a manually specified resolution of 320x300, 24 bits-per-pixel, and 173 colors. The file at the URL will not be fetched; the URL itself is stored in the PICTURE metadata block.</para>
347 <term><option>--export-picture-to=file</option></term>
350 Export PICTURE block to a file. Use '-' for stdout. Only one FLAC file may be specified on the command line. The first PICTURE block will be exported unless --export-picture-to is preceded by a --block-number=# option to specify the exact metadata block to extract. Note that the block number is the one shown by --list.
355 <term><option>--add-replay-gain</option></term>
358 Calculates the title and album gains/peaks of the given FLAC
359 files as if all the files were part of one album, then stores
360 them in the VORBIS_COMMENT block. The tags are the same as
361 those used by vorbisgain. Existing ReplayGain tags will be
362 replaced. If only one FLAC file is given, the album and title
363 gains will be the same. Since this operation requires two
364 passes, it is always executed last, after all other operations
365 have been completed and written to disk. All FLAC files
366 specified must have the same resolution, sample rate, and
367 number of channels. The sample rate must be one of 8, 11.025,
368 12, 16, 22.05, 24, 32, 44.1, or 48 kHz.
373 <term><option>--remove-replay-gain</option></term>
376 Removes the ReplayGain tags.
381 <term><option>--add-seekpoint</option>={<replaceable>#</replaceable>|<replaceable>X</replaceable>|<replaceable>#x</replaceable>|<replaceable>#s</replaceable>}</term>
384 Add seek points to a SEEKTABLE block. Using #, a seek point at
385 that sample number is added. Using X, a placeholder point is
386 added at the end of a the table. Using #x, # evenly spaced seek
387 points will be added, the first being at sample 0. Using #s, a
388 seekpoint will be added every # seconds (# does not have to be a
389 whole number; it can be, for example, 9.5, meaning a seekpoint
390 every 9.5 seconds). If no SEEKTABLE block exists, one will be
391 created. If one already exists, points will be added to the
392 existing table, and any duplicates will be turned into placeholder
393 points. You may use many --add-seekpoint options; the resulting
394 SEEKTABLE will be the unique-ified union of all such values.
395 Example: --add-seekpoint=100x --add-seekpoint=3.5s will add 100
396 evenly spaced seekpoints and a seekpoint every 3.5 seconds.
401 <term><option>--add-padding=length</option></term>
404 Add a padding block of the given length (in bytes). The overall
405 length of the new block will be 4 + length; the extra 4 bytes is
406 for the metadata block header.
413 <title>MAJOR OPERATIONS</title>
417 <term><option>--list</option></term>
420 List the contents of one or more metadata blocks to stdout. By
421 default, all metadata blocks are listed in text format. Use the
422 following options to change this behavior:
426 <term><option>--block-number=#[,#[...]]</option></term>
429 An optional comma-separated list of block numbers to display.
430 The first block, the STREAMINFO block, is block 0.
435 <term><option>--block-type=type[,type[...]]</option></term>
436 <listitem><para></para></listitem>
439 <term><option>--except-block-type=type[,type[...]]</option></term>
442 An optional comma-separated list of block types to be included
443 or ignored with this option. Use only one of --block-type or
444 --except-block-type. The valid block types are: STREAMINFO,
445 PADDING, APPLICATION, SEEKTABLE, VORBIS_COMMENT. You may
446 narrow down the types of APPLICATION blocks displayed as
450 APPLICATION:abcd The APPLICATION block(s) whose textual repre-
451 sentation of the 4-byte ID is "abcd"
452 APPLICATION:0xXXXXXXXX The APPLICATION block(s) whose hexadecimal big-
453 endian representation of the 4-byte ID is
454 "0xXXXXXXXX". For the example "abcd" above the
455 hexadecimal equivalalent is 0x61626364
459 if both --block-number and --[except-]block-type are
460 specified, the result is the logical AND of both
461 arguments.</para></note>
465 <term><option>--application-data-format=hexdump|text</option></term>
468 If the application block you are displaying contains binary
469 data but your --data-format=text, you can display a hex dump
470 of the application data contents instead using
471 --application-data-format=hexdump.
479 <term><option>--remove</option></term>
482 Remove one or more metadata blocks from the metadata. Unless
483 --dont-use-padding is specified, the blocks will be replaced with
484 padding. You may not remove the STREAMINFO block.
488 <term><option>--block-number=#[,#[...]]</option></term>
489 <listitem><para></para></listitem>
492 <term><option>--block-type=type[,type[...]]</option></term>
493 <listitem><para></para></listitem>
496 <term><option>--except-block-type=type[,type[...]]</option></term>
498 <para>See --list above for usage.</para>
501 if both --block-number and --[except-]block-type are
502 specified, the result is the logical AND of both arguments.
510 <term><option>--remove-all</option></term>
513 Remove all metadata blocks (except the STREAMINFO block) from the
514 metadata. Unless --dont-use-padding is specified, the blocks will
515 be replaced with padding.
520 <term><option>--merge-padding</option></term>
523 Merge adjacent PADDING blocks into single blocks.
528 <term><option>--sort-padding</option></term>
531 Move all PADDING blocks to the end of the metadata and merge them
540 <title>SEE ALSO</title>
542 <para>flac(1).</para>
546 <!-- Keep this comment at the end of the file
551 sgml-minimize-attributes:nil
552 sgml-always-quote-attributes:t
555 sgml-parent-document:nil
556 sgml-default-dtd-file:nil
557 sgml-exposed-tags:nil
558 sgml-local-catalogs:nil
559 sgml-local-ecat-files:nil