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>2003-01-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">
  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</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-vc-vendor</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-vc-field=name</option></term>
 206         <listitem>
 207           <para>
 208             Show all Vorbis comment fields where the the field name matches
 209             'name'.
 210           </para>
 211         </listitem>
 212       </varlistentry>
 213       <varlistentry>
 214         <term><option>--remove-vc-field=name</option></term>
 215         <listitem>
 216           <para>
 217             Remove all Vorbis comment fields whose field name is 'name'.
 218           </para>
 219         </listitem>
 220       </varlistentry>
 221       <varlistentry>
 222         <term><option>--remove-vc-firstfield=name</option></term>
 223         <listitem>
 224           <para>
 225             Remove first Vorbis comment field whose field name is 'name'.
 226           </para>
 227         </listitem>
 228       </varlistentry>
 229       <varlistentry>
 230         <term><option>--remove-vc-all</option></term>
 231         <listitem>
 232           <para>
 233             Remove all Vorbis comment fields, leaving only the vendor string
 234             in the VORBIS_COMMENT block.
 235           </para>
 236         </listitem>
 237       </varlistentry>
 238       <varlistentry>
 239         <term><option>--set-vc-field=field</option></term>
 240         <listitem>
 241           <para>
 242             Add a Vorbis comment field.  The field must comply with the
 243             Vorbis comment spec, of the form "NAME=VALUE".  If there is
 244             currently no VORBIS_COMMENT block, one will be created.
 245           </para>
 246         </listitem>
 247       </varlistentry>
 248       <varlistentry>
 249         <term><option>--import-vc-from=file</option></term>
 250         <listitem>
 251           <para>
 252             Import Vorbis comments from a file.  Use '-' for stdin.  Each
 253             line should be of the form NAME=VALUE.  Multi-line comments
 254             are currently not supported.  Specify --remove-vc-all and/or
 255             --no-utf8-convert before --import-vc-from if necessary.
 256           </para>
 257         </listitem>
 258       </varlistentry>
 259       <varlistentry>
 260         <term><option>--export-vc-to=file</option></term>
 261         <listitem>
 262           <para>
 263             Export Vorbis comments to a file.  Use '-' for stdin.  Each
 264             line will be of the form NAME=VALUE.  Specify
 265             --no-utf8-convert if necessary.
 266           </para>
 267         </listitem>
 268       </varlistentry>
 269       <varlistentry>
 270         <term><option>--import-cuesheet-from=file</option></term>
 271         <listitem>
 272           <para>
 273             Import a cuesheet from a file.  Only one FLAC file may be
 274             specified.  A seekpoint will be added for each index point in
 275             the cuesheet to the SEEKTABLE unless --no-cued-seekpoints is
 276             specified.
 277           </para>
 278         </listitem>
 279       </varlistentry>
 280       <varlistentry>
 281         <term><option>--export-cuesheet-to=file</option></term>
 282         <listitem>
 283           <para>
 284             Export CUESHEET block to a cuesheet file, suitable for use by
 285             CD authoring software.  Use '-' for stdin.  Only one FLAC file
 286             may be specified on the command line.
 287           </para>
 288         </listitem>
 289       </varlistentry>
 290       <varlistentry>
 291         <term><option>--add-replay-gain</option></term>
 292         <listitem>
 293           <para>
 294             Calculates the title and album gains/peaks of the given FLAC
 295             files as if all the files were part of one album, then stores
 296             them in the VORBIS_COMMENT block.  The tags are the same as
 297             those used by vorbisgain.  Existing ReplayGain tags will be
 298             replaced.  If only one FLAC file is given, the album and title
 299             gains will be the same.  Since this operation requires two
 300             passes, it is always executed last, after all other operations
 301             have been completed and written to disk.  All FLAC files
 302             specified must have the same resolution, sample rate, and
 303             number of channels.  The sample rate must be one of 8, 11.025,
 304             12, 16, 22.05, 24, 32, 44.1, or 48 kHz.
 305           </para>
 306         </listitem>
 307       </varlistentry>
 308       <varlistentry>
 309         <term><option>--add-seekpoint</option>={<replaceable>#</replaceable>|<replaceable>X</replaceable>|<replaceable>#x</replaceable>|<replaceable>#s</replaceable>}</term>
 310         <listitem>
 311           <para>
 312             Add seek points to a SEEKTABLE block.  Using #, a seek point at
 313             that sample number is added.  Using X, a placeholder point is
 314             added at the end of a the table.  Using #x, # evenly spaced seek
 315             points will be added, the first being at sample 0.  Using #s, a
 316             seekpoint will be added every # seconds (# does not have to be a
 317             whole number; it can be, for example, 9.5, meaning a seekpoint
 318             every 9.5 seconds).  If no SEEKTABLE block exists, one will be
 319             created.  If one already exists, points will be added to the
 320             existing table, and any duplicates will be turned into placeholder
 321             points.  You may use many --add-seekpoint options; the resulting
 322             SEEKTABLE will be the unique-ified union of all such values.
 323             Example: --add-seekpoint=100x --add-seekpoint=3.5s will add 100
 324             evenly spaced seekpoints and a seekpoint every 3.5 seconds.
 325           </para>
 326         </listitem>
 327       </varlistentry>
 328       <varlistentry>
 329         <term><option>--add-padding=length</option></term>
 330         <listitem>
 331           <para>
 332             Add a padding block of the given length (in bytes).  The overall
 333             length of the new block will be 4 + length; the extra 4 bytes is
 334             for the metadata block header.
 335           </para>
 336         </listitem>
 337       </varlistentry>
 338     </variablelist>
 339   </refsect1>
 340   <refsect1>
 341     <title>MAJOR OPERATIONS</title>
 342
 343     <variablelist>
 344       <varlistentry>
 345         <term><option>--list</option></term>
 346         <listitem>
 347           <para>
 348             List the contents of one or more metadata blocks to stdout.  By
 349             default, all metadata blocks are listed in text format.  Use the
 350             following options to change this behavior:
 351           </para>
 352           <variablelist>
 353             <varlistentry>
 354               <term><option>--block-number=#[,#[...]]</option></term>
 355               <listitem>
 356                 <para>
 357                   An optional comma-separated list of block numbers to display.
 358                   The first block, the STREAMINFO block, is block 0.
 359                 </para>
 360               </listitem>
 361             </varlistentry>
 362             <varlistentry>
 363               <term><option>--block-type=type[,type[...]]</option></term>
 364               <listitem><para></para></listitem>
 365             </varlistentry>
 366             <varlistentry>
 367               <term><option>--except-block-type=type[,type[...]]</option></term>
 368               <listitem>
 369                 <para>
 370                   An optional comma-separated list of block types to included
 371                   or ignored with this option.  Use only one of --block-type or
 372                   --except-block-type.  The valid block types are: STREAMINFO,
 373                   PADDING, APPLICATION, SEEKTABLE, VORBIS_COMMENT.  You may
 374                   narrow down the types of APPLICATION blocks displayed as
 375                   follows:
 376                 </para>
 377                 <para>
 378         APPLICATION:abcd        The APPLICATION block(s) whose textual repre-
 379                                 sentation of the 4-byte ID is "abcd"
 380         APPLICATION:0xXXXXXXXX  The APPLICATION block(s) whose hexadecimal big-
 381                                 endian representation of the 4-byte ID is
 382                                 "0xXXXXXXXX".  For the example "abcd" above the
 383                                 hexadecimal equivalalent is 0x61626364
 384                 </para>
 385                 <note>
 386                   <para>
 387                     if both --block-number and --[except-]block-type are
 388                     specified, the result is the logical AND of both
 389                     arguments.</para></note>
 390               </listitem>
 391             </varlistentry>
 392             <varlistentry>
 393               <term><option>--application-data-format=hexdump|text</option></term>
 394               <listitem>
 395                 <para>
 396                   If the application block you are displaying contains binary
 397                   data but your --data-format=text, you can display a hex dump
 398                   of the application data contents instead using
 399                   --application-data-format=hexdump.
 400                 </para>
 401               </listitem>
 402             </varlistentry>
 403           </variablelist>
 404         </listitem>
 405       </varlistentry>
 406       <varlistentry>
 407         <term><option>--remove</option></term>
 408         <listitem>
 409           <para>
 410             Remove one or more metadata blocks from the metadata.  Unless
 411             --dont-use-padding is specified, the blocks will be replaced with
 412             padding.  You may not remove the STREAMINFO block.
 413           </para>
 414           <variablelist>
 415             <varlistentry>
 416               <term><option>--block-number=#[,#[...]]</option></term>
 417               <listitem><para></para></listitem>
 418             </varlistentry>
 419             <varlistentry>
 420               <term><option>--block-type=type[,type[...]]</option></term>
 421               <listitem><para></para></listitem>
 422             </varlistentry>
 423             <varlistentry>
 424               <term><option>--except-block-type=type[,type[...]]</option></term>
 425               <listitem>
 426                 <para>See --list above for usage.</para>
 427                 <note>
 428                   <para>
 429                     if both --block-number and --[except-]block-type are
 430                     specified, the result is the logical AND of both arguments.
 431                   </para></note>
 432               </listitem>
 433             </varlistentry>
 434           </variablelist>
 435         </listitem>
 436       </varlistentry>
 437       <varlistentry>
 438         <term><option>--remove-all</option></term>
 439         <listitem>
 440           <para>
 441             Remove all metadata blocks (except the STREAMINFO block) from the
 442             metadata.  Unless --dont-use-padding is specified, the blocks will
 443             be replaced with padding.
 444           </para>
 445         </listitem>
 446       </varlistentry>
 447       <varlistentry>
 448         <term><option>--merge-padding</option></term>
 449         <listitem>
 450           <para>
 451             Merge adjacent PADDING blocks into single blocks.
 452           </para>
 453         </listitem>
 454       </varlistentry>
 455       <varlistentry>
 456         <term><option>--sort-padding</option></term>
 457         <listitem>
 458           <para>
 459             Move all PADDING blocks to the end of the metadata and merge them
 460             into a single block.
 461           </para>
 462         </listitem>
 463       </varlistentry>
 464     </variablelist>
 465   </refsect1>
 466
 467   <refsect1>
 468     <title>SEE ALSO</title>
 469
 470     <para>flac(1).</para>
 471   </refsect1>
 472 </refentry>
 473
 474 <!-- Keep this comment at the end of the file
 475 Local variables:
 476 mode: sgml
 477 sgml-omittag:t
 478 sgml-shorttag:t
 479 sgml-minimize-attributes:nil
 480 sgml-always-quote-attributes:t
 481 sgml-indent-step:2
 482 sgml-indent-data:t
 483 sgml-parent-document:nil
 484 sgml-default-dtd-file:nil
 485 sgml-exposed-tags:nil
 486 sgml-local-catalogs:nil
 487 sgml-local-ecat-files:nil
 488 End:
 489 -->