include/share/Makefile.am : Add win_utf8_io.h.
[platform/upstream/flac.git] / man / flac.sgml
index 21822c7..df69aa6 100644 (file)
       <arg choice=opt><replaceable>OPTIONS</replaceable></arg>
       <group rep=repeat>
        <arg><replaceable>infile.wav</replaceable></arg>
+       <arg><replaceable>infile.rf64</replaceable></arg>
        <arg><replaceable>infile.aiff</replaceable></arg>
        <arg><replaceable>infile.raw</replaceable></arg>
        <arg><replaceable>infile.flac</replaceable></arg>
+       <arg><replaceable>infile.oga</replaceable></arg>
        <arg><replaceable>infile.ogg</replaceable></arg>
        <arg>-</arg>
       </group>
@@ -65,6 +67,7 @@
       <arg choice=opt><replaceable>OPTIONS</replaceable></arg>
       <group rep=repeat>
        <arg><replaceable>infile.flac</replaceable></arg>
+       <arg><replaceable>infile.oga</replaceable></arg>
        <arg><replaceable>infile.ogg</replaceable></arg>
        <arg>-</arg>
       </group>
        </varlistentry>
 
        <varlistentry>
+         <term><option>--no-utf8-convert</option>
+         </term>
+         <listitem>
+           <para>Do not convert tags from local charset to UTF-8.  This is useful for scripts, and setting tags in situations where the locale is wrong.  This option must appear before any tag options!</para>
+         </listitem>
+       </varlistentry>
+
+       <varlistentry>
          <term><option>-w</option>, <option>--warnings-as-errors</option>
          </term>
          <listitem>
        </varlistentry>
 
        <varlistentry>
+         <term><option>--preserve-modtime</option>
+         </term>
+         <listitem>
+           <para>Output files have their timestamps/permissions set to match those of their inputs (this is default).  Use --no-preserve-modtime to make output files have the current time and default permissions.</para>
+         </listitem>
+       </varlistentry>
+
+       <varlistentry>
+         <term><option>--keep-foreign-metadata</option>
+         </term>
+         <listitem>
+           <para>If encoding, save WAVE, RF64, or AIFF non-audio chunks in FLAC metadata.  If decoding, restore any saved non-audio chunks from FLAC metadata when writing the decoded file.  Foreign metadata cannot be transcoded, e.g. WAVE chunks saved in a FLAC file cannot be restored when decoding to AIFF.  Input and output must be regular files (not stdin or stdout).</para>
+         </listitem>
+       </varlistentry>
+
+       <varlistentry>
          <term><option>--skip</option>={<replaceable>#</replaceable>|<replaceable>mm:ss.ss</replaceable>}</term>
          <listitem>
            <para>Skip over the first number of samples of the input.  This works for both encoding and decoding, but not testing.  The alternative form mm:ss.ss can be used to specify minutes, seconds, and fractions of a second.</para>
          <term><option>--ogg</option></term>
 
          <listitem>
-           <para>When encoding, generate Ogg FLAC output instead of native FLAC.  Ogg FLAC streams are FLAC streams wrapped in an Ogg transport layer.  The resulting file should have an '.ogg' extension and will still be decodable by flac.</para>
-           <para>When decoding, force the input to be treated as Ogg FLAC.  This is useful when piping input from stdin or when the filename does not end in '.ogg'.</para>
+           <para>When encoding, generate Ogg FLAC output instead of native FLAC.  Ogg FLAC streams are FLAC streams wrapped in an Ogg transport layer.  The resulting file should have an '.oga' extension and will still be decodable by flac.</para>
+           <para>When decoding, force the input to be treated as Ogg FLAC.  This is useful when piping input from stdin or when the filename does not end in '.oga' or '.ogg'.</para>
          </listitem>
        </varlistentry>
 
          <term><option>--sector-align</option></term>
 
          <listitem>
-           <para>Align encoding of multiple CD format files on sector boundaries.  See the HTML documentation for more information.</para>
+           <para>Align encoding of multiple CD format files on sector boundaries.  See the HTML documentation for more information.  This option is DEPRECATED and may not exist in future versions of flac.</para>
          </listitem>
        </varlistentry>
 
                <term><option>-3</option>, <option>--compression-level-3</option></term>
 
                <listitem>
-                 <para>Synonymous with -l 6 -b 4608 -r 4</para>
+                 <para>Synonymous with -l 6 -b 4096 -r 4</para>
                </listitem>
              </varlistentry>
 
                <term><option>-4</option>, <option>--compression-level-4</option></term>
 
                <listitem>
-                 <para>Synonymous with -l 8 -b 4608 -M -r 4</para>
+                 <para>Synonymous with -l 8 -b 4096 -M -r 4</para>
                </listitem>
              </varlistentry>
 
                <term><option>-5</option>, <option>--compression-level-5</option></term>
 
                <listitem>
-                 <para>Synonymous with -l 8 -b 4608 -m -r 5</para>
+                 <para>Synonymous with -l 8 -b 4096 -m -r 5</para>
                </listitem>
              </varlistentry>
 
                <term><option>-6</option>, <option>--compression-level-6</option></term>
 
                <listitem>
-                 <para>Synonymous with -l 8 -b 4608 -m -r 6</para>
+                 <para>Synonymous with -l 8 -b 4096 -m -r 6</para>
                </listitem>
              </varlistentry>
 
                <term><option>-7</option>, <option>--compression-level-7</option></term>
 
                <listitem>
-                 <para>Synonymous with -l 8 -b 4608 -m -e -r 6</para>
+                 <para>Synonymous with -l 8 -b 4096 -m -e -r 6</para>
                </listitem>
              </varlistentry>
 
                <term><option>-8</option>, <option>--compression-level-8</option></term>
 
                <listitem>
-                 <para>Synonymous with -l 12 -b 4608 -m -e -r 6</para>
+                 <para>Synonymous with -l 12 -b 4096 -m -e -r 6</para>
                </listitem>
              </varlistentry>
            </variablelist>
          <term><option>--input-size</option>=<replaceable>#</replaceable></term>
 
          <listitem>
-           <para>Specify the size of the raw input in bytes.  If you are encoding raw samples from stdin, you must set this option in order to be able to use --skip, --until, --cue-sheet, or other options that need to know the size of the input beforehand.  If the size given is greater than what is found in the input stream, the encoder will complain about an unexpected end-of-file.  If the size given is less, samples will be truncated.</para>
+           <para>Specify the size of the raw input in bytes.  If you are encoding raw samples from stdin, you must set this option in order to be able to use --skip, --until, --cuesheet, or other options that need to know the size of the input beforehand.  If the size given is greater than what is found in the input stream, the encoder will complain about an unexpected end-of-file.  If the size given is less, samples will be truncated.</para>
+         </listitem>
+       </varlistentry>
+
+       <varlistentry>
+         <term><option>--force-raw-format</option></term>
+
+         <listitem>
+           <para>Force input (when encoding) or output (when decoding) to be treated as raw samples (even if filename ends in <filename>.wav</filename>).</para>
          </listitem>
        </varlistentry>
 
          <term><option>--force-aiff-format</option></term>
 
          <listitem>
-           <para>Force the decoder to output AIFF format.  This option is not needed if the output filename (as set by -o) ends with <filename>.aiff</filename>.  Also, this option has no effect when encoding since input AIFF is auto-detected.</para>
+           <para>Force the decoder to output AIFF format.  This option is not needed if the output filename (as set by -o) ends with <filename>.aif</filename> or <filename>.aiff</filename>.  Also, this option has no effect when encoding since input AIFF is auto-detected.</para>
          </listitem>
        </varlistentry>
 
        <varlistentry>
-         <term><option>--force-raw-format</option></term>
+         <term><option>--force-rf64-format</option></term>
 
          <listitem>
-           <para>Force input (when encoding) or output (when decoding) to be treated as raw samples (even if filename ends in <filename>.wav</filename>).</para>
+           <para>Force the decoder to output RF64 format.  This option is not needed if the output filename (as set by -o) ends with <filename>.rf64</filename>.  Also, this option has no effect when encoding since input RF64 is auto-detected.</para>
+         </listitem>
+       </varlistentry>
+
+       <varlistentry>
+         <term><option>--force-wave64-format</option></term>
+
+         <listitem>
+           <para>Force the decoder to output Wave64 format.  This option is not needed if the output filename (as set by -o) ends with <filename>.w64</filename>.  Also, this option has no effect when encoding since input Wave64 is auto-detected.</para>
          </listitem>
        </varlistentry>
 
       <variablelist>
        <varlistentry>
          <term><option>--no-adaptive-mid-side</option></term>
+         <term><option>--no-cued-seekpoints</option></term>
          <term><option>--no-decode-through-errors</option></term>
          <term><option>--no-delete-input-file</option></term>
+         <term><option>--no-preserve-modtime</option></term>
+         <term><option>--no-keep-foreign-metadata</option></term>
          <term><option>--no-exhaustive-model-search</option></term>
+         <term><option>--no-force</option></term>
          <term><option>--no-lax</option></term>
          <term><option>--no-mid-side</option></term>
          <term><option>--no-ogg</option></term>
          <term><option>--no-padding</option></term>
-         <term><option>--no-qlp-coeff-precision-search</option></term>
+         <term><option>--no-qlp-coeff-prec-search</option></term>
+         <term><option>--no-replay-gain</option></term>
          <term><option>--no-residual-gnuplot</option></term>
          <term><option>--no-residual-text</option></term>
          <term><option>--no-sector-align</option></term>