add item for --not-utf8-convert; fix typos
[flac.git] / man / metaflac.sgml
1 <!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
2
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:
7
8 manpage.1: manpage.sgml
9         docbook-to-man $< > $@
10   -->
11
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>.
17   -->
18
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">
31 ]>
32
33 <refentry>
34   <refentryinfo>
35     <address>
36       &manemail;
37     </address>
38     <author>
39       &manfirstname;
40       &mansurname;
41     </author>
42     <copyright>
43       <year>2002,2003,2004,2005</year>
44       <holder>&manusername;</holder>
45     </copyright>
46     &mandate;
47   </refentryinfo>
48   <refmeta>
49     &manucpackage;
50
51     &mansection;
52   </refmeta>
53   <refnamediv>
54     <refname>&manpackage;</refname>
55
56     <refpurpose>
57       program to list, add, remove, or edit metadata in one or more FLAC files.
58     </refpurpose>
59   </refnamediv>
60   <refsynopsisdiv>
61     <cmdsynopsis>
62       <command>&manpackage;</command>
63
64       <group choice="opt"><arg><replaceable>options</replaceable></arg></group>
65       <group choice="opt">
66         <arg><replaceable>operations</replaceable></arg></group>
67       <arg rep="repeat" choice="req"><replaceable>FLACfile</replaceable></arg>
68     </cmdsynopsis>
69   </refsynopsisdiv>
70   <refsect1>
71     <title>DESCRIPTION</title>
72
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>
76
77   </refsect1>
78   <refsect1>
79     <title>OPTIONS</title>
80
81     <variablelist>
82       <varlistentry>
83         <term><option>--preserve-modtime</option></term>
84         <listitem>
85           <para>
86             Preserve the original modification time in spite of edits.
87           </para>
88         </listitem>
89       </varlistentry>
90       <varlistentry>
91         <term><option>--with-filename</option></term>
92         <listitem>
93           <para>
94             Prefix each output line with the FLAC file name (the default if
95             more than one FLAC file is specified).
96           </para>
97         </listitem>
98       </varlistentry>
99       <varlistentry>
100         <term><option>--no-filename</option></term>
101         <listitem>
102           <para>
103             Do not prefix each output line with the FLAC file name (the default
104             if only one FLAC file is specified).
105           </para>
106         </listitem>
107       </varlistentry>
108       <varlistentry>
109         <term><option>--no-utf8-convert</option></term>
110         <listitem>
111           <para>
112             Do not convert tags from UTF-8 to local charset, or vice versa. This is
113             useful for scripts.
114           </para>
115         </listitem>
116       </varlistentry>
117       <varlistentry>
118         <term><option>--dont-use-padding</option></term>
119         <listitem>
120           <para>
121             By default metaflac tries to use padding where possible to avoid
122             rewriting the entire file if the metadata size changes.  Use this
123             option to tell metaflac to not take advantage of padding this way.
124           </para>
125         </listitem>
126       </varlistentry>
127     </variablelist>
128   </refsect1>
129   <refsect1>
130     <title>SHORTHAND OPERATIONS</title>
131
132     <variablelist>
133       <varlistentry>
134         <term><option>--show-md5sum</option></term>
135         <listitem>
136           <para>
137             Show the MD5 signature from the STREAMINFO block.
138           </para>
139         </listitem>
140       </varlistentry>
141       <varlistentry>
142         <term><option>--show-min-blocksize</option></term>
143         <listitem>
144           <para>
145             Show the minimum block size from the STREAMINFO block.
146           </para>
147         </listitem>
148       </varlistentry>
149       <varlistentry>
150         <term><option>--show-max-blocksize</option></term>
151         <listitem>
152           <para>
153             Show the maximum block size from the STREAMINFO block.
154           </para>
155         </listitem>
156       </varlistentry>
157       <varlistentry>
158         <term><option>--show-min-framesize</option></term>
159         <listitem>
160           <para>
161             Show the minimum frame size from the STREAMINFO block.
162           </para>
163         </listitem>
164       </varlistentry>
165       <varlistentry>
166         <term><option>--show-max-framesize</option></term>
167         <listitem>
168           <para>
169             Show the maximum frame size from the STREAMINFO block.
170           </para>
171         </listitem>
172       </varlistentry>
173       <varlistentry>
174         <term><option>--show-sample-rate</option></term>
175         <listitem>
176           <para>
177             Show the sample rate from the STREAMINFO block.
178           </para>
179         </listitem>
180       </varlistentry>
181       <varlistentry>
182         <term><option>--show-channels</option></term>
183         <listitem>
184           <para>
185             Show the number of channels from the STREAMINFO block.
186           </para>
187         </listitem>
188       </varlistentry>
189       <varlistentry>
190         <term><option>--show-bps</option></term>
191         <listitem>
192           <para>
193             Show the # of bits per sample from the STREAMINFO block.
194           </para>
195         </listitem>
196       </varlistentry>
197       <varlistentry>
198         <term><option>--show-total-samples</option></term>
199         <listitem>
200           <para>
201             Show the total # of samples from the STREAMINFO block.
202           </para>
203         </listitem>
204       </varlistentry>
205       <varlistentry>
206         <term><option>--show-vendor-tag</option></term>
207         <listitem>
208           <para>
209             Show the vendor string from the VORBIS_COMMENT block.
210           </para>
211         </listitem>
212       </varlistentry>
213       <varlistentry>
214         <term><option>--show-tag=name</option></term>
215         <listitem>
216           <para>
217             Show all tags where the the field name matches 'name'.
218           </para>
219         </listitem>
220       </varlistentry>
221       <varlistentry>
222         <term><option>--remove-tag=name</option></term>
223         <listitem>
224           <para>
225             Remove all tags whose field name is 'name'.
226           </para>
227         </listitem>
228       </varlistentry>
229       <varlistentry>
230         <term><option>--remove-first-tag=name</option></term>
231         <listitem>
232           <para>
233             Remove first tag whose field name is 'name'.
234           </para>
235         </listitem>
236       </varlistentry>
237       <varlistentry>
238         <term><option>--remove-all-tags</option></term>
239         <listitem>
240           <para>
241             Remove all tags, leaving only the vendor string.
242           </para>
243         </listitem>
244       </varlistentry>
245       <varlistentry>
246         <term><option>--set-tag=field</option></term>
247         <listitem>
248           <para>
249             Add a tag.  The field must comply with the
250             Vorbis comment spec, of the form "NAME=VALUE".  If there is
251             currently no tag block, one will be created.
252           </para>
253         </listitem>
254       </varlistentry>
255       <varlistentry>
256         <term><option>--set-tag-from-file=field</option></term>
257         <listitem>
258           <para>
259             Like --set-tag, except the VALUE is a filename whose
260             contents will be read verbatim to set the tag value.
261             Unless --no-utf8-convert is specified, the contents will be
262             converted to UTF-8 from the local charset.  This can be used
263             to store a cuesheet in a tag (e.g.
264             --set-tag-from-file="CUESHEET=image.cue").  Do not try to
265             store binary data in tag fields!  Use APPLICATION blocks for
266             that.
267           </para>
268         </listitem>
269       </varlistentry>
270       <varlistentry>
271         <term><option>--import-tags-from=file</option></term>
272         <listitem>
273           <para>
274             Import tags from a file.  Use '-' for stdin.  Each
275             line should be of the form NAME=VALUE.  Multi-line comments
276             are currently not supported.  Specify --remove-all-tags and/or
277             --no-utf8-convert before --import-tags-from if necessary.  If
278             FILE is '-' (stdin), only one FLAC file may be specified.
279           </para>
280         </listitem>
281       </varlistentry>
282       <varlistentry>
283         <term><option>--export-tags-to=file</option></term>
284         <listitem>
285           <para>
286             Export tags to a file.  Use '-' for stdout.  Each
287             line will be of the form NAME=VALUE.  Specify
288             --no-utf8-convert if necessary.
289           </para>
290         </listitem>
291       </varlistentry>
292       <varlistentry>
293         <term><option>--import-cuesheet-from=file</option></term>
294         <listitem>
295           <para>
296             Import a cuesheet from a file.  Use '-' for stdin.  Only one
297             FLAC file may be specified.  A seekpoint will be added for each
298             index point in the cuesheet to the SEEKTABLE unless
299             --no-cued-seekpoints is specified.
300           </para>
301         </listitem>
302       </varlistentry>
303       <varlistentry>
304         <term><option>--export-cuesheet-to=file</option></term>
305         <listitem>
306           <para>
307             Export CUESHEET block to a cuesheet file, suitable for use by
308             CD authoring software.  Use '-' for stdout.  Only one FLAC file
309             may be specified on the command line.
310           </para>
311         </listitem>
312       </varlistentry>
313       <varlistentry>
314         <term><option>--import-picture-from</option>=<replaceable>SPECIFICATION</replaceable></term>
315         <listitem>
316           <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>
317           <para>[TYPE]|MIME-TYPE|[DESCRIPTION]|[WIDTHxHEIGHTxDEPTH[/COLORS]]|FILE</para>
318           <para>TYPE is optional; it is a number from one of:</para>
319           <para>0: Other</para>
320           <para>1: 32x32 pixels 'file icon' (PNG only)</para>
321           <para>2: Other file icon</para>
322           <para>3: Cover (front)</para>
323           <para>4: Cover (back)</para>
324           <para>5: Leaflet page</para>
325           <para>6: Media (e.g. label side of CD)</para>
326           <para>7: Lead artist/lead performer/soloist</para>
327           <para>8: Artist/performer</para>
328           <para>9: Conductor</para>
329           <para>10: Band/Orchestra</para>
330           <para>11: Composer</para>
331           <para>12: Lyricist/text writer</para>
332           <para>13: Recording Location</para>
333           <para>14: During recording</para>
334           <para>15: During performance</para>
335           <para>16: Movie/video screen capture</para>
336           <para>17: A bright coloured fish</para>
337           <para>18: Illustration</para>
338           <para>19: Band/artist logotype</para>
339           <para>20: Publisher/Studio logotype</para>
340           <para>The default is 3 (front cover).  There may only be one picture each of type 1 and 2 in a file.</para>
341
342           <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 --&gt; to mean that FILE is actually a URL to an image, though this use is discouraged.</para>
343
344           <para>DESCRIPTION is optional; the default is an empty string.</para>
345
346           <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>
347
348           <para>FILE is the path to the picture file to be imported, or the URL if MIME type is --&gt;</para>
349
350           <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>
351
352           <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>
353         </listitem>
354       </varlistentry>
355       <varlistentry>
356         <term><option>--export-picture-to=file</option></term>
357         <listitem>
358           <para>
359             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.
360           </para>
361         </listitem>
362       </varlistentry>
363       <varlistentry>
364         <term><option>--add-replay-gain</option></term>
365         <listitem>
366           <para>
367             Calculates the title and album gains/peaks of the given FLAC
368             files as if all the files were part of one album, then stores
369             them in the VORBIS_COMMENT block.  The tags are the same as
370             those used by vorbisgain.  Existing ReplayGain tags will be
371             replaced.  If only one FLAC file is given, the album and title
372             gains will be the same.  Since this operation requires two
373             passes, it is always executed last, after all other operations
374             have been completed and written to disk.  All FLAC files
375             specified must have the same resolution, sample rate, and
376             number of channels.  The sample rate must be one of 8, 11.025,
377             12, 16, 22.05, 24, 32, 44.1, or 48 kHz.
378           </para>
379         </listitem>
380       </varlistentry>
381       <varlistentry>
382         <term><option>--remove-replay-gain</option></term>
383         <listitem>
384           <para>
385             Removes the ReplayGain tags.
386           </para>
387         </listitem>
388       </varlistentry>
389       <varlistentry>
390         <term><option>--add-seekpoint</option>={<replaceable>#</replaceable>|<replaceable>X</replaceable>|<replaceable>#x</replaceable>|<replaceable>#s</replaceable>}</term>
391         <listitem>
392           <para>
393             Add seek points to a SEEKTABLE block.  Using #, a seek point at
394             that sample number is added.  Using X, a placeholder point is
395             added at the end of a the table.  Using #x, # evenly spaced seek
396             points will be added, the first being at sample 0.  Using #s, a
397             seekpoint will be added every # seconds (# does not have to be a
398             whole number; it can be, for example, 9.5, meaning a seekpoint
399             every 9.5 seconds).  If no SEEKTABLE block exists, one will be
400             created.  If one already exists, points will be added to the
401             existing table, and any duplicates will be turned into placeholder
402             points.  You may use many --add-seekpoint options; the resulting
403             SEEKTABLE will be the unique-ified union of all such values.
404             Example: --add-seekpoint=100x --add-seekpoint=3.5s will add 100
405             evenly spaced seekpoints and a seekpoint every 3.5 seconds.
406           </para>
407         </listitem>
408       </varlistentry>
409       <varlistentry>
410         <term><option>--add-padding=length</option></term>
411         <listitem>
412           <para>
413             Add a padding block of the given length (in bytes).  The overall
414             length of the new block will be 4 + length; the extra 4 bytes is
415             for the metadata block header.
416           </para>
417         </listitem>
418       </varlistentry>
419     </variablelist>
420   </refsect1>
421   <refsect1>
422     <title>MAJOR OPERATIONS</title>
423
424     <variablelist>
425       <varlistentry>
426         <term><option>--list</option></term>
427         <listitem>
428           <para>
429             List the contents of one or more metadata blocks to stdout.  By
430             default, all metadata blocks are listed in text format.  Use the
431             following options to change this behavior:
432           </para>
433           <variablelist>
434             <varlistentry>
435               <term><option>--block-number=#[,#[...]]</option></term>
436               <listitem>
437                 <para>
438                   An optional comma-separated list of block numbers to display.
439                   The first block, the STREAMINFO block, is block 0.
440                 </para>
441               </listitem>
442             </varlistentry>
443             <varlistentry>
444               <term><option>--block-type=type[,type[...]]</option></term>
445               <listitem><para></para></listitem>
446             </varlistentry>
447             <varlistentry>
448               <term><option>--except-block-type=type[,type[...]]</option></term>
449               <listitem>
450                 <para>
451                   An optional comma-separated list of block types to be included
452                   or ignored with this option.  Use only one of --block-type or
453                   --except-block-type.  The valid block types are: STREAMINFO,
454                   PADDING, APPLICATION, SEEKTABLE, VORBIS_COMMENT.  You may
455                   narrow down the types of APPLICATION blocks displayed as
456                   follows:
457                 </para>
458                 <para>
459         APPLICATION:abcd        The APPLICATION block(s) whose textual repre-
460                                 sentation of the 4-byte ID is "abcd"
461         APPLICATION:0xXXXXXXXX  The APPLICATION block(s) whose hexadecimal big-
462                                 endian representation of the 4-byte ID is
463                                 "0xXXXXXXXX".  For the example "abcd" above the
464                                 hexadecimal equivalalent is 0x61626364
465                 </para>
466                 <note>
467                   <para>
468                     if both --block-number and --[except-]block-type are
469                     specified, the result is the logical AND of both
470                     arguments.</para></note>
471               </listitem>
472             </varlistentry>
473             <varlistentry>
474               <term><option>--application-data-format=hexdump|text</option></term>
475               <listitem>
476                 <para>
477                   If the application block you are displaying contains binary
478                   data but your --data-format=text, you can display a hex dump
479                   of the application data contents instead using
480                   --application-data-format=hexdump.
481                 </para>
482               </listitem>
483             </varlistentry>
484           </variablelist>
485         </listitem>
486       </varlistentry>
487       <varlistentry>
488         <term><option>--remove</option></term>
489         <listitem>
490           <para>
491             Remove one or more metadata blocks from the metadata.  Unless
492             --dont-use-padding is specified, the blocks will be replaced with
493             padding.  You may not remove the STREAMINFO block.
494           </para>
495           <variablelist>
496             <varlistentry>
497               <term><option>--block-number=#[,#[...]]</option></term>
498               <listitem><para></para></listitem>
499             </varlistentry>
500             <varlistentry>
501               <term><option>--block-type=type[,type[...]]</option></term>
502               <listitem><para></para></listitem>
503             </varlistentry>
504             <varlistentry>
505               <term><option>--except-block-type=type[,type[...]]</option></term>
506               <listitem>
507                 <para>See --list above for usage.</para>
508                 <note>
509                   <para>
510                     if both --block-number and --[except-]block-type are
511                     specified, the result is the logical AND of both arguments.
512                   </para></note>
513               </listitem>
514             </varlistentry>
515           </variablelist>
516         </listitem>
517       </varlistentry>
518       <varlistentry>
519         <term><option>--remove-all</option></term>
520         <listitem>
521           <para>
522             Remove all metadata blocks (except the STREAMINFO block) from the
523             metadata.  Unless --dont-use-padding is specified, the blocks will
524             be replaced with padding.
525           </para>
526         </listitem>
527       </varlistentry>
528       <varlistentry>
529         <term><option>--merge-padding</option></term>
530         <listitem>
531           <para>
532             Merge adjacent PADDING blocks into single blocks.
533           </para>
534         </listitem>
535       </varlistentry>
536       <varlistentry>
537         <term><option>--sort-padding</option></term>
538         <listitem>
539           <para>
540             Move all PADDING blocks to the end of the metadata and merge them
541             into a single block.
542           </para>
543         </listitem>
544       </varlistentry>
545     </variablelist>
546   </refsect1>
547   
548   <refsect1>
549     <title>SEE ALSO</title>
550
551     <para>flac(1).</para>
552   </refsect1>
553 </refentry>
554
555 <!-- Keep this comment at the end of the file
556 Local variables:
557 mode: sgml
558 sgml-omittag:t
559 sgml-shorttag:t
560 sgml-minimize-attributes:nil
561 sgml-always-quote-attributes:t
562 sgml-indent-step:2
563 sgml-indent-data:t
564 sgml-parent-document:nil
565 sgml-default-dtd-file:nil
566 sgml-exposed-tags:nil
567 sgml-local-catalogs:nil
568 sgml-local-ecat-files:nil
569 End:
570 -->