add --warnings-as-errors option to flac; for picture importing, allow MIME type in...

[platform/upstream/flac.git] / man / flac.sgml

diff --git a/man/flac.sgml b/man/flac.sgml
index 0ef9b5f..ef6a65d 100644 (file)
--- a/man/flac.sgml
+++ b/man/flac.sgml
@@ -4,7 +4,7 @@
   <!ENTITY dhfirstname "<firstname>Matt</firstname>">
   <!ENTITY dhsurname   "<surname>Zimmerman</surname>">
   <!-- Please adjust the date whenever revising the manpage. -->
-  <!ENTITY dhdate      "<date>Feb 2, 2005</date>">
+  <!ENTITY dhdate      "<date>Nov 4, 2006</date>">
   <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
        allowed: see man(7), man(1). -->
   <!ENTITY dhsection   "<manvolnum>1</manvolnum>">
@@ -45,12 +45,13 @@
   <refsynopsisdiv>
     <cmdsynopsis>
       <command>flac</command>
-      <arg choice=opt><replaceable>options</replaceable></arg>
+      <arg choice=opt><replaceable>OPTIONS</replaceable></arg>
       <group rep=repeat>
        <arg><replaceable>infile.wav</replaceable></arg>
        <arg><replaceable>infile.aiff</replaceable></arg>
        <arg><replaceable>infile.raw</replaceable></arg>
        <arg><replaceable>infile.flac</replaceable></arg>
+       <arg><replaceable>infile.ogg</replaceable></arg>
        <arg>-</arg>
       </group>
     </cmdsynopsis>
@@ -62,7 +63,11 @@
        <arg>-a</arg> <arg>--analyze</arg>
       </group>
       <arg choice=opt><replaceable>OPTIONS</replaceable></arg>
-      <arg choice=opt rep=repeat><replaceable>infile.flac</replaceable></arg>
+      <group rep=repeat>
+       <arg><replaceable>infile.flac</replaceable></arg>
+       <arg><replaceable>infile.ogg</replaceable></arg>
+       <arg>-</arg>
+      </group>
     </cmdsynopsis>
   </refsynopsisdiv>
   <refsect1>
@@ -153,6 +158,14 @@
        </varlistentry>
 
        <varlistentry>
+         <term><option>-w</option>, <option>--warnings-as-errors</option>
+         </term>
+         <listitem>
+           <para>Treat all warnings as errors (which cause flac to terminate with a non-zero exit code).</para>
+         </listitem>
+       </varlistentry>
+
+       <varlistentry>
          <term><option>-f</option>, <option>--force</option>
          </term>
          <listitem>
@@ -298,11 +311,11 @@
        </varlistentry>
 
        <varlistentry>
-         <term><option>--picture</option>=<replaceable>SPECIFICATION</replaceable></term>
+         <term><option>--picture</option>={<replaceable>FILENAME</replaceable>|<replaceable>SPECIFICATION</replaceable>}</term>
 
          <listitem>
-           <para>Import a picture and store it in a PICTURE metadata block.  More than one --picture 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>
-           <para>[TYPE]|MIME-TYPE|[DESCRIPTION]|[WIDTHxHEIGHTxDEPTH[/COLORS]]|FILE</para>
+           <para>Import a picture and store it in a PICTURE metadata block.  More than one --picture 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>
+           <para>[TYPE]|[MIME-TYPE]|[DESCRIPTION]|[WIDTHxHEIGHTxDEPTH[/COLORS]]|FILE</para>
            <para>TYPE is optional; it is a number from one of:</para>
            <para>0: Other</para>
            <para>1: 32x32 pixels 'file icon' (PNG only)</para>
@@ -327,7 +340,7 @@
            <para>20: Publisher/Studio logotype</para>
            <para>The default is 3 (front cover).  There may only be one picture each of type 1 and 2 in a file.</para>
 
-           <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>
+           <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>
 
            <para>DESCRIPTION is optional; the default is an empty string.</para>
 
@@ -385,7 +398,7 @@
          <term><option>-b</option> <replaceable>#</replaceable>, <option>--blocksize</option>=<replaceable>#</replaceable></term>
 
          <listitem>
-           <para>Specify the block size in samples.  The default is 1152 for -l 0, else 4608; must be one of 192, 576, 1152, 2304, 4608, 256, 512, 1024, 2048, 4096, 8192, 16384, or 32768 (unless --lax is used)</para>
+           <para>Specify the block size in samples.  Subset streams must use one of 192, 576, 1152, 2304, 4608, 256, 512, 1024, 2048, 4096 (and 8192 or 16384 if the sample rate is &gt;48kHz).</para>
          </listitem>
        </varlistentry>
 
@@ -529,7 +542,7 @@
          <term><option>-l</option> <replaceable>#</replaceable>, <option>--max-lpc-order</option>=<replaceable>#</replaceable></term>
 
          <listitem>
-           <para>Set the maximum LPC order; 0 means use only the fixed predictors</para>
+           <para>Specifies the maximum LPC order. This number must be &lt;= 32. For Subset streams, it must be &lt;=12 if the sample rate is &lt;=48kHz. If 0, the encoder will not attempt generic linear prediction, and use only fixed predictors. Using fixed predictors is faster but usually results in files being 5-10% larger.</para>
          </listitem>
        </varlistentry>
 
@@ -651,6 +664,7 @@
          <term><option>--no-seektable</option></term>
          <term><option>--no-silent</option></term>
          <term><option>--no-verify</option></term>
+         <term><option>--no-warnings-as-errors</option></term>
          <listitem>
            <para>These flags can be used to invert the sense of the corresponding normal option.</para>
          </listitem>