A volunteer wrote this man page and submitted it to the Debian bug tracking
system. I have not had the time to review it, and I don't really use
metaflac anyway (yet). It would be nice if 1.0.5 could ship with a full set
of man pages.
--
- mdz
--- Begin Message ---
<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
<!-- Process this file with docbook-to-man to generate an nroff manual
page: `docbook-to-man manpage.sgml > manpage.1'. You may view
the manual page with: `docbook-to-man manpage.sgml | nroff -man |
less'. A typical entry in a Makefile or Makefile.am is:
manpage.1: manpage.sgml
docbook-to-man $< > $@
-->
<!-- This is based on an example constructed by Colin Watson
<email>[EMAIL PROTECTED]</email>, based on a man page template
provided by Tom Christiansen <email>[EMAIL PROTECTED]</email>
and a DocBook man page example by Craig Small
<email>[EMAIL PROTECTED]</email>.
-->
<!-- Fill in the various UPPER CASE things here. -->
<!ENTITY manfirstname "<firstname>dann</firstname>">
<!ENTITY mansurname "<surname>frazier</surname>">
<!-- Please adjust the date whenever revising the manpage. -->
<!ENTITY mandate "<date>2002-11-30</date>">
<!-- SECTION should be 1-8, maybe with subsection. Other parameters are
allowed: see man(7), man(1). -->
<!ENTITY mansection "<manvolnum>1</manvolnum>">
<!ENTITY manemail "<email>[EMAIL PROTECTED]</email>">
<!ENTITY manusername "dannf">
<!ENTITY manucpackage "<refentrytitle>METAFLAC</refentrytitle>">
<!ENTITY manpackage "metaflac">
]>
<refentry>
<refentryinfo>
<address>
&manemail;
</address>
<author>
&manfirstname;
&mansurname;
</author>
<copyright>
<year>2002</year>
<holder>&manusername;</holder>
</copyright>
&mandate;
</refentryinfo>
<refmeta>
&manucpackage;
&mansection;
</refmeta>
<refnamediv>
<refname>&manpackage;</refname>
<refpurpose>
program to list, add, remove, or edit metadata in one or more FLAC files.
</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>&manpackage;</command>
<group choice="opt"><arg><replaceable>options</replaceable></arg></group>
<group choice="opt">
<arg><replaceable>operations</replaceable></arg></group>
<arg rep="repeat" choice="req"><replaceable>FLACfile</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para>Use <command>&manpackage;</command> to list, add, remove, or edit
metadata in one or more FLAC files. You may perform one major operation,
or many shorthand operations at a time.</para>
</refsect1>
<refsect1>
<title>OPTIONS</title>
<variablelist>
<varlistentry>
<term><option>--preserve-modtime</option></term>
<listitem>
<para>
Preserve the original modification time in spite of edits.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--with-filename</option></term>
<listitem>
<para>
Prefix each output line with the FLAC file name (the default if
more than one FLAC file is specified).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--no-filename</option></term>
<listitem>
<para>
Do not prefix each output line with the FLAC file name (the default
if only one FLAC file is specified).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--dont-use-padding</option></term>
<listitem>
<para>
By default metaflac tries to use padding where possible to avoid
rewriting the entire file if the metadata size changes. Use this
option to tell metaflac to not take advantage of padding this way.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>SHORTHAND OPERATIONS</title>
<variablelist>
<varlistentry>
<term><option>--show-md5sum</option></term>
<listitem>
<para>
Show the MD5 signature from the STREAMINFO block.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--show-min-blocksize</option></term>
<listitem>
<para>
Show the minimum block size from the STREAMINFO block.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--show-max-blocksize</option></term>
<listitem>
<para>
Show the maximum block size from the STREAMINFO block.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--show-min-framesize</option></term>
<listitem>
<para>
Show the minimum frame size from the STREAMINFO block.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--show-max-framesize</option></term>
<listitem>
<para>
Show the maximum frame size from the STREAMINFO block.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--show-sample-rate</option></term>
<listitem>
<para>
Show the sample rate from the STREAMINFO block.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--show-channels</option></term>
<listitem>
<para>
Show the number of channels from the STREAMINFO block.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--show-bps</option></term>
<listitem>
<para>
Show the # of bits per sample from the STREAMINFO block.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--show-total-samples</option></term>
<listitem>
<para>
Show the total # of samples from the STREAMINFO block.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--show-vc-vendor</option></term>
<listitem>
<para>
Show the vendor string from the VORBIS_COMMENT block.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--show-vc-field=name</option></term>
<listitem>
<para>
Show all Vorbis comment fields where the the field name matches
'name'.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--remove-vc-field=name</option></term>
<listitem>
<para>
Remove all Vorbis comment fields whose field name is 'name'.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--remove-vc-firstfield=name</option></term>
<listitem>
<para>
Remove first Vorbis comment field whose field name is 'name'.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--remove-vc-all</option></term>
<listitem>
<para>
Remove all Vorbis comment fields, leaving only the vendor string
in the VORBIS_COMMENT block.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--set-vc-field=field</option></term>
<listitem>
<para>
Add a Vorbis comment field. The field must comply with the
Vorbis comment spec, of the form "NAME=VALUE". If there is
currently no VORBIS_COMMENT block, one will be created.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--add-padding=length</option></term>
<listitem>
<para>
Add a padding block of the given length (in bytes). The overall
length of the new block will be 4 + length; the extra 4 bytes is
for the metadata block header.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>MAJOR OPERATIONS</title>
<variablelist>
<varlistentry>
<term><option>--list</option></term>
<listitem>
<para>
List the contents of one or more metadata blocks to stdout. By
default, all metadata blocks are listed in text format. Use the
following options to change this behavior:
</para>
<variablelist>
<varlistentry>
<term><option>--block-number=#[,#[...]]</option></term>
<listitem>
<para>
An optional comma-separated list of block numbers to display.
The first block, the STREAMINFO block, is block 0.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--block-type=type[,type[...]]</option></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><option>--except-block-type=type[,type[...]]</option></term>
<listitem>
<para>
An optional comma-separated list of block types to included
or ignored with this option. Use only one of --block-type or
--except-block-type. The valid block types are: STREAMINFO,
PADDING, APPLICATION, SEEKTABLE, VORBIS_COMMENT. You may
narrow down the types of APPLICATION blocks displayed as
follows:
</para>
<para>
APPLICATION:abcd The APPLICATION block(s) whose textual repre-
sentation of the 4-byte ID is "abcd"
APPLICATION:0xXXXXXXXX The APPLICATION block(s) whose hexadecimal big-
endian representation of the 4-byte ID is
"0xXXXXXXXX". For the example "abcd" above the
hexadecimal equivalalent is 0x61626364
</para>
<note>
<para>
if both --block-number and --[except-]block-type are
specified, the result is the logical AND of both
arguments.</para></note>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--application-data-format=hexdump|text</option></term>
<listitem>
<para>
If the application block you are displaying contains binary
data but your --data-format=text, you can display a hex dump
of the application data contents instead using
--application-data-format=hexdump.
</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--remove</option></term>
<listitem>
<para>
Remove one or more metadata blocks from the metadata. Unless
--dont-use-padding is specified, the blocks will be replaced with
padding. You may not remove the STREAMINFO block.
</para>
<variablelist>
<varlistentry>
<term><option>--block-number=#[,#[...]]</option></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><option>--block-type=type[,type[...]]</option></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><option>--except-block-type=type[,type[...]]</option></term>
<listitem>
<para>See --list above for usage.</para>
<note>
<para>
if both --block-number and --[except-]block-type are
specified, the result is the logical AND of both arguments.
</para></note>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--remove-all</option></term>
<listitem>
<para>
Remove all metadata blocks (except the STREAMINFO block) from the
metadata. Unless --dont-use-padding is specified, the blocks will
be replaced with padding.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--merge-padding</option></term>
<listitem>
<para>
Merge adjacent PADDING blocks into single blocks.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--sort-padding</option></term>
<listitem>
<para>
Move all PADDING blocks to the end of the metadata and merge them
into a single block.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<para>flac(1).</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:2
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:nil
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->
--- End Message ---
