~ubuntu-branches/ubuntu/trusty/flac/trusty-updates

« back to all changes in this revision

Viewing changes to man/metaflac.sgml

  • Committer: Bazaar Package Importer
  • Author(s): Marc 'HE' Brockschmidt
  • Date: 2008-03-16 18:02:56 UTC
  • mfrom: (1.1.5 upstream) (8.1.2 gutsy)
  • Revision ID: james.westby@ubuntu.com-20080316180256-qhf3wk704rp165pm
Tags: 1.2.1-1.2
* Non-maintainer upload.
* Fix gcc-4.3 FTBFS, patch by KiBi (Closes: #455304)

Show diffs side-by-side

added added

removed removed

Lines of Context:
20
20
  <!ENTITY manfirstname "<firstname>dann</firstname>">
21
21
  <!ENTITY mansurname   "<surname>frazier</surname>">
22
22
  <!-- Please adjust the date whenever revising the manpage. -->
23
 
  <!ENTITY mandate      "<date>2005-02-02</date>">
 
23
  <!ENTITY mandate      "<date>2006-11-14</date>">
24
24
  <!-- SECTION should be 1-8, maybe with subsection. Other parameters are
25
25
       allowed: see man(7), man(1). -->
26
26
  <!ENTITY mansection   "<manvolnum>1</manvolnum>">
106
106
        </listitem>
107
107
      </varlistentry>
108
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, and setting tags in situations where the locale is wrong.
 
114
          </para>
 
115
        </listitem>
 
116
      </varlistentry>
 
117
      <varlistentry>
109
118
        <term><option>--dont-use-padding</option></term>
110
119
        <listitem>
111
120
          <para>
244
253
        </listitem>
245
254
      </varlistentry>
246
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>
247
271
        <term><option>--import-tags-from=file</option></term>
248
272
        <listitem>
249
273
          <para>
250
274
            Import tags from a file.  Use '-' for stdin.  Each
251
275
            line should be of the form NAME=VALUE.  Multi-line comments
252
276
            are currently not supported.  Specify --remove-all-tags and/or
253
 
            --no-utf8-convert before --import-tags-from if necessary.
 
277
            --no-utf8-convert before --import-tags-from if necessary.  If
 
278
            FILE is '-' (stdin), only one FLAC file may be specified.
254
279
          </para>
255
280
        </listitem>
256
281
      </varlistentry>
258
283
        <term><option>--export-tags-to=file</option></term>
259
284
        <listitem>
260
285
          <para>
261
 
            Export tags to a file.  Use '-' for stdin.  Each
 
286
            Export tags to a file.  Use '-' for stdout.  Each
262
287
            line will be of the form NAME=VALUE.  Specify
263
288
            --no-utf8-convert if necessary.
264
289
          </para>
286
311
        </listitem>
287
312
      </varlistentry>
288
313
      <varlistentry>
 
314
        <term><option>--import-picture-from</option>={<replaceable>FILENAME</replaceable>|<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.  Either a filename for the picture file or a more complete specification form can be used.  The SPECIFICATION is a string whose parts are separated by | (pipe) characters.  Some parts may be left empty to invoke default values.  FILENAME is just shorthand for "||||FILENAME".  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 optional; if left blank, it will be detected from the file.  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>
289
364
        <term><option>--add-replay-gain</option></term>
290
365
        <listitem>
291
366
          <para>
292
367
            Calculates the title and album gains/peaks of the given FLAC
293
368
            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
 
369
            them as FLAC tags.  The tags are the same as
295
370
            those used by vorbisgain.  Existing ReplayGain tags will be
296
371
            replaced.  If only one FLAC file is given, the album and title
297
372
            gains will be the same.  Since this operation requires two
304
379
        </listitem>
305
380
      </varlistentry>
306
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>
307
390
        <term><option>--add-seekpoint</option>={<replaceable>#</replaceable>|<replaceable>X</replaceable>|<replaceable>#x</replaceable>|<replaceable>#s</replaceable>}</term>
308
391
        <listitem>
309
392
          <para>