minor formatting
[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>2004-09-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</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>--dont-use-padding</option></term>
110         <listitem>
111           <para>
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.
115           </para>
116         </listitem>
117       </varlistentry>
118     </variablelist>
119   </refsect1>
120   <refsect1>
121     <title>SHORTHAND OPERATIONS</title>
122
123     <variablelist>
124       <varlistentry>
125         <term><option>--show-md5sum</option></term>
126         <listitem>
127           <para>
128             Show the MD5 signature from the STREAMINFO block.
129           </para>
130         </listitem>
131       </varlistentry>
132       <varlistentry>
133         <term><option>--show-min-blocksize</option></term>
134         <listitem>
135           <para>
136             Show the minimum block size from the STREAMINFO block.
137           </para>
138         </listitem>
139       </varlistentry>
140       <varlistentry>
141         <term><option>--show-max-blocksize</option></term>
142         <listitem>
143           <para>
144             Show the maximum block size from the STREAMINFO block.
145           </para>
146         </listitem>
147       </varlistentry>
148       <varlistentry>
149         <term><option>--show-min-framesize</option></term>
150         <listitem>
151           <para>
152             Show the minimum frame size from the STREAMINFO block.
153           </para>
154         </listitem>
155       </varlistentry>
156       <varlistentry>
157         <term><option>--show-max-framesize</option></term>
158         <listitem>
159           <para>
160             Show the maximum frame size from the STREAMINFO block.
161           </para>
162         </listitem>
163       </varlistentry>
164       <varlistentry>
165         <term><option>--show-sample-rate</option></term>
166         <listitem>
167           <para>
168             Show the sample rate from the STREAMINFO block.
169           </para>
170         </listitem>
171       </varlistentry>
172       <varlistentry>
173         <term><option>--show-channels</option></term>
174         <listitem>
175           <para>
176             Show the number of channels from the STREAMINFO block.
177           </para>
178         </listitem>
179       </varlistentry>
180       <varlistentry>
181         <term><option>--show-bps</option></term>
182         <listitem>
183           <para>
184             Show the # of bits per sample from the STREAMINFO block.
185           </para>
186         </listitem>
187       </varlistentry>
188       <varlistentry>
189         <term><option>--show-total-samples</option></term>
190         <listitem>
191           <para>
192             Show the total # of samples from the STREAMINFO block.
193           </para>
194         </listitem>
195       </varlistentry>
196       <varlistentry>
197         <term><option>--show-vendor-tag</option></term>
198         <listitem>
199           <para>
200             Show the vendor string from the VORBIS_COMMENT block.
201           </para>
202         </listitem>
203       </varlistentry>
204       <varlistentry>
205         <term><option>--show-tag=name</option></term>
206         <listitem>
207           <para>
208             Show all tags where the the field name matches 'name'.
209           </para>
210         </listitem>
211       </varlistentry>
212       <varlistentry>
213         <term><option>--remove-tag=name</option></term>
214         <listitem>
215           <para>
216             Remove all tags whose field name is 'name'.
217           </para>
218         </listitem>
219       </varlistentry>
220       <varlistentry>
221         <term><option>--remove-first-tag=name</option></term>
222         <listitem>
223           <para>
224             Remove first tag whose field name is 'name'.
225           </para>
226         </listitem>
227       </varlistentry>
228       <varlistentry>
229         <term><option>--remove-all-tags</option></term>
230         <listitem>
231           <para>
232             Remove all tags, leaving only the vendor string.
233           </para>
234         </listitem>
235       </varlistentry>
236       <varlistentry>
237         <term><option>--set-tag=field</option></term>
238         <listitem>
239           <para>
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.
243           </para>
244         </listitem>
245       </varlistentry>
246       <varlistentry>
247         <term><option>--import-tags-from=file</option></term>
248         <listitem>
249           <para>
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.
254           </para>
255         </listitem>
256       </varlistentry>
257       <varlistentry>
258         <term><option>--export-tags-to=file</option></term>
259         <listitem>
260           <para>
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.
264           </para>
265         </listitem>
266       </varlistentry>
267       <varlistentry>
268         <term><option>--import-cuesheet-from=file</option></term>
269         <listitem>
270           <para>
271             Import a cuesheet from a file.  Only one FLAC file may be
272             specified.  A seekpoint will be added for each index point in
273             the cuesheet to the SEEKTABLE unless --no-cued-seekpoints is
274             specified.
275           </para>
276         </listitem>
277       </varlistentry>
278       <varlistentry>
279         <term><option>--export-cuesheet-to=file</option></term>
280         <listitem>
281           <para>
282             Export CUESHEET block to a cuesheet file, suitable for use by
283             CD authoring software.  Use '-' for stdin.  Only one FLAC file
284             may be specified on the command line.
285           </para>
286         </listitem>
287       </varlistentry>
288       <varlistentry>
289         <term><option>--add-replay-gain</option></term>
290         <listitem>
291           <para>
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.
303           </para>
304         </listitem>
305       </varlistentry>
306       <varlistentry>
307         <term><option>--add-seekpoint</option>={<replaceable>#</replaceable>|<replaceable>X</replaceable>|<replaceable>#x</replaceable>|<replaceable>#s</replaceable>}</term>
308         <listitem>
309           <para>
310             Add seek points to a SEEKTABLE block.  Using #, a seek point at
311             that sample number is added.  Using X, a placeholder point is
312             added at the end of a the table.  Using #x, # evenly spaced seek
313             points will be added, the first being at sample 0.  Using #s, a
314             seekpoint will be added every # seconds (# does not have to be a
315             whole number; it can be, for example, 9.5, meaning a seekpoint
316             every 9.5 seconds).  If no SEEKTABLE block exists, one will be
317             created.  If one already exists, points will be added to the
318             existing table, and any duplicates will be turned into placeholder
319             points.  You may use many --add-seekpoint options; the resulting
320             SEEKTABLE will be the unique-ified union of all such values.
321             Example: --add-seekpoint=100x --add-seekpoint=3.5s will add 100
322             evenly spaced seekpoints and a seekpoint every 3.5 seconds.
323           </para>
324         </listitem>
325       </varlistentry>
326       <varlistentry>
327         <term><option>--add-padding=length</option></term>
328         <listitem>
329           <para>
330             Add a padding block of the given length (in bytes).  The overall
331             length of the new block will be 4 + length; the extra 4 bytes is
332             for the metadata block header.
333           </para>
334         </listitem>
335       </varlistentry>
336     </variablelist>
337   </refsect1>
338   <refsect1>
339     <title>MAJOR OPERATIONS</title>
340
341     <variablelist>
342       <varlistentry>
343         <term><option>--list</option></term>
344         <listitem>
345           <para>
346             List the contents of one or more metadata blocks to stdout.  By
347             default, all metadata blocks are listed in text format.  Use the
348             following options to change this behavior:
349           </para>
350           <variablelist>
351             <varlistentry>
352               <term><option>--block-number=#[,#[...]]</option></term>
353               <listitem>
354                 <para>
355                   An optional comma-separated list of block numbers to display.
356                   The first block, the STREAMINFO block, is block 0.
357                 </para>
358               </listitem>
359             </varlistentry>
360             <varlistentry>
361               <term><option>--block-type=type[,type[...]]</option></term>
362               <listitem><para></para></listitem>
363             </varlistentry>
364             <varlistentry>
365               <term><option>--except-block-type=type[,type[...]]</option></term>
366               <listitem>
367                 <para>
368                   An optional comma-separated list of block types to included
369                   or ignored with this option.  Use only one of --block-type or
370                   --except-block-type.  The valid block types are: STREAMINFO,
371                   PADDING, APPLICATION, SEEKTABLE, VORBIS_COMMENT.  You may
372                   narrow down the types of APPLICATION blocks displayed as
373                   follows:
374                 </para>
375                 <para>
376         APPLICATION:abcd        The APPLICATION block(s) whose textual repre-
377                                 sentation of the 4-byte ID is "abcd"
378         APPLICATION:0xXXXXXXXX  The APPLICATION block(s) whose hexadecimal big-
379                                 endian representation of the 4-byte ID is
380                                 "0xXXXXXXXX".  For the example "abcd" above the
381                                 hexadecimal equivalalent is 0x61626364
382                 </para>
383                 <note>
384                   <para>
385                     if both --block-number and --[except-]block-type are
386                     specified, the result is the logical AND of both
387                     arguments.</para></note>
388               </listitem>
389             </varlistentry>
390             <varlistentry>
391               <term><option>--application-data-format=hexdump|text</option></term>
392               <listitem>
393                 <para>
394                   If the application block you are displaying contains binary
395                   data but your --data-format=text, you can display a hex dump
396                   of the application data contents instead using
397                   --application-data-format=hexdump.
398                 </para>
399               </listitem>
400             </varlistentry>
401           </variablelist>
402         </listitem>
403       </varlistentry>
404       <varlistentry>
405         <term><option>--remove</option></term>
406         <listitem>
407           <para>
408             Remove one or more metadata blocks from the metadata.  Unless
409             --dont-use-padding is specified, the blocks will be replaced with
410             padding.  You may not remove the STREAMINFO block.
411           </para>
412           <variablelist>
413             <varlistentry>
414               <term><option>--block-number=#[,#[...]]</option></term>
415               <listitem><para></para></listitem>
416             </varlistentry>
417             <varlistentry>
418               <term><option>--block-type=type[,type[...]]</option></term>
419               <listitem><para></para></listitem>
420             </varlistentry>
421             <varlistentry>
422               <term><option>--except-block-type=type[,type[...]]</option></term>
423               <listitem>
424                 <para>See --list above for usage.</para>
425                 <note>
426                   <para>
427                     if both --block-number and --[except-]block-type are
428                     specified, the result is the logical AND of both arguments.
429                   </para></note>
430               </listitem>
431             </varlistentry>
432           </variablelist>
433         </listitem>
434       </varlistentry>
435       <varlistentry>
436         <term><option>--remove-all</option></term>
437         <listitem>
438           <para>
439             Remove all metadata blocks (except the STREAMINFO block) from the
440             metadata.  Unless --dont-use-padding is specified, the blocks will
441             be replaced with padding.
442           </para>
443         </listitem>
444       </varlistentry>
445       <varlistentry>
446         <term><option>--merge-padding</option></term>
447         <listitem>
448           <para>
449             Merge adjacent PADDING blocks into single blocks.
450           </para>
451         </listitem>
452       </varlistentry>
453       <varlistentry>
454         <term><option>--sort-padding</option></term>
455         <listitem>
456           <para>
457             Move all PADDING blocks to the end of the metadata and merge them
458             into a single block.
459           </para>
460         </listitem>
461       </varlistentry>
462     </variablelist>
463   </refsect1>
464   
465   <refsect1>
466     <title>SEE ALSO</title>
467
468     <para>flac(1).</para>
469   </refsect1>
470 </refentry>
471
472 <!-- Keep this comment at the end of the file
473 Local variables:
474 mode: sgml
475 sgml-omittag:t
476 sgml-shorttag:t
477 sgml-minimize-attributes:nil
478 sgml-always-quote-attributes:t
479 sgml-indent-step:2
480 sgml-indent-data:t
481 sgml-parent-document:nil
482 sgml-default-dtd-file:nil
483 sgml-exposed-tags:nil
484 sgml-local-catalogs:nil
485 sgml-local-ecat-files:nil
486 End:
487 -->