man/flac.sgml

   1 <!doctype refentry PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
   2
   3   <!-- Fill in your name for FIRSTNAME and SURNAME. -->
   4   <!ENTITY dhfirstname "<firstname>Matt</firstname>">
   5   <!ENTITY dhsurname   "<surname>Zimmerman</surname>">
   6   <!-- Please adjust the date whenever revising the manpage. -->
   7   <!ENTITY dhdate      "<date>Feb 2, 2005</date>">
   8   <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
   9        allowed: see man(7), man(1). -->
  10   <!ENTITY dhsection   "<manvolnum>1</manvolnum>">
  11   <!ENTITY dhemail     "<email>mdz@debian.org</email>">
  12   <!ENTITY dhusername  "Matt Zimmerman">
  13   <!ENTITY dhucpackage "<refentrytitle>FLAC</refentrytitle>">
  14   <!ENTITY dhpackage   "flac">
  15
  16   <!ENTITY debian      "<productname>Debian GNU/Linux</productname>">
  17   <!ENTITY gnu         "<acronym>GNU</acronym>">
  18 ]>
  19
  20 <refentry>
  21   <docinfo>
  22     <address>
  23         &dhemail;
  24     </address>
  25     <author>
  26         &dhfirstname;
  27         &dhsurname;
  28       </author>
  29         <copyright>
  30             <year>2002,2003,2004,2005</year>
  31             <holder>&dhusername;</holder>
  32         </copyright>
  33             &dhdate;
  34         </docinfo>
  35   <refmeta>
  36       &dhucpackage;
  37
  38       &dhsection;
  39     </refmeta>
  40       <refnamediv>
  41                    <refname>&dhpackage;</refname>
  42
  43         <refpurpose>Free Lossless Audio Codec</refpurpose>
  44       </refnamediv>
  45         <refsynopsisdiv>
  46           <cmdsynopsis>
  47             <command>flac</command>
  48             <arg choice=opt><replaceable>options</replaceable></arg>
  49             <group rep=repeat>
  50                <arg><replaceable>infile.wav</replaceable></arg>
  51                <arg><replaceable>infile.aiff</replaceable></arg>
  52                <arg><replaceable>infile.raw</replaceable></arg>
  53                <arg><replaceable>infile.flac</replaceable></arg>
  54                <arg>-</arg>
  55             </group>
  56           </cmdsynopsis>
  57           <cmdsynopsis>
  58             <command>flac</command>
  59             <group>
  60                <arg>-d</arg> <arg>--decode</arg>
  61                <arg>-t</arg> <arg>--test</arg>
  62                <arg>-a</arg> <arg>--analyze</arg>
  63             </group>
  64             <arg choice=opt><replaceable>OPTIONS</replaceable></arg>
  65             <arg choice=opt rep=repeat><replaceable>infile.flac</replaceable></arg>
  66           </cmdsynopsis>
  67         </refsynopsisdiv>
  68         <refsect1>
  69           <title>DESCRIPTION</title>
  70
  71           <para><command>flac</command> is a command-line tool for
  72              encoding, decoding, testing and analyzing FLAC streams.
  73           </para>
  74
  75         </refsect1>
  76         <refsect1>
  77           <title>OPTIONS</title>
  78
  79           <para>A summary of options is included below.  For a complete
  80           description, see the HTML documentation.</para>
  81
  82           <refsect2>
  83             <title>General Options</title>
  84
  85             <variablelist>
  86               <varlistentry>
  87                 <term><option>-v</option>, <option>--version</option>
  88                 </term>
  89                 <listitem>
  90                   <para>Show the flac version number</para>
  91                 </listitem>
  92               </varlistentry>
  93
  94               <varlistentry>
  95                 <term><option>-h</option>, <option>--help</option>
  96                 </term>
  97                 <listitem>
  98                   <para>Show basic usage and a list of all options</para>
  99                 </listitem>
 100               </varlistentry>
 101
 102               <varlistentry>
 103                 <term><option>-H</option>, <option>--explain</option>
 104                 </term>
 105                 <listitem>
 106                   <para>Show detailed explanation of usage and all options</para>
 107                 </listitem>
 108               </varlistentry>
 109
 110               <varlistentry>
 111                 <term><option>-d</option>, <option>--decode</option>
 112                 </term>
 113                 <listitem>
 114                   <para>Decode (the default behavior is to encode)</para>
 115                 </listitem>
 116               </varlistentry>
 117
 118               <varlistentry>
 119                 <term><option>-t</option>, <option>--test</option>
 120                 </term>
 121                 <listitem>
 122                   <para>Test a flac encoded file (same as -d
 123                     except no decoded file is written)</para>
 124                 </listitem>
 125               </varlistentry>
 126
 127               <varlistentry>
 128                 <term><option>-a</option>, <option>--analyze</option>
 129                 </term>
 130                 <listitem>
 131                   <para>Analyze a FLAC encoded file (same as -d
 132                     except an analysis file is written)</para>
 133                 </listitem>
 134               </varlistentry>
 135
 136               <varlistentry>
 137                 <term><option>-c</option>, <option>--stdout</option>
 138                 </term>
 139                 <listitem>
 140                   <para>Write output to stdout</para>
 141                 </listitem>
 142               </varlistentry>
 143
 144               <varlistentry>
 145                 <term><option>-s</option>, <option>--silent</option>
 146                 </term>
 147                 <listitem>
 148                   <para>Silent mode (do not write runtime
 149                     encode/decode statistics to stderr)</para>
 150                 </listitem>
 151               </varlistentry>
 152
 153               <varlistentry>
 154                 <term><option>--totally-silent</option>
 155                 </term>
 156                 <listitem>
 157                   <para>Do not print anything of any kind,
 158                     including warnings or errors.  The exit
 159                     code will be the only way to determine
 160                     successful completion.</para>
 161                 </listitem>
 162               </varlistentry>
 163
 164               <varlistentry>
 165                 <term><option>-f</option>, <option>--force</option>
 166                 </term>
 167                 <listitem>
 168                   <para>Force overwriting of output files.  By default,
 169                     flac warns that the output file already exists and
 170                     continues to the next file.</para>
 171                 </listitem>
 172               </varlistentry>
 173
 174               <varlistentry>
 175                 <term><option>-o</option> <replaceable>filename</replaceable>, <option>--output-name</option>=<replaceable>filename</replaceable></term>
 176                 <listitem>
 177                   <para>Force the output file name (usually flac just
 178                     changes the extension).  May only be used when
 179                     encoding a single file.  May not be used in
 180                     conjunction with --output-prefix.</para>
 181                 </listitem>
 182               </varlistentry>
 183
 184               <varlistentry>
 185                 <term><option>--output-prefix</option>=<replaceable>string</replaceable></term>
 186                 <listitem>
 187                   <para>Prefix each output file name with the given
 188                     string.  This can be useful for encoding or decoding
 189                     files to a different directory.  Make sure if your
 190                     string is a path name that it ends with a trailing
 191                     `/' (slash).</para>
 192                 </listitem>
 193               </varlistentry>
 194
 195               <varlistentry>
 196                 <term><option>--delete-input-file</option>
 197                 </term>
 198                 <listitem>
 199                   <para>Automatically delete the input file after a
 200                     successful encode or decode.  If there was an
 201                     error (including a verify error) the input file
 202                     is left intact.</para>
 203                 </listitem>
 204               </varlistentry>
 205
 206               <varlistentry>
 207                 <term><option>--skip</option>={<replaceable>#</replaceable>|<replaceable>mm:ss.ss</replaceable>}</term>
 208                 <listitem>
 209                   <para>Skip over the first number of samples of the input.
 210                     This works for both encoding and decoding, but not
 211                     testing.  The alternative form mm:ss.ss can be used
 212                     to specify minutes, seconds, and fractions of a
 213                     second.</para>
 214                 </listitem>
 215               </varlistentry>
 216
 217               <varlistentry>
 218                 <term><option>--until</option>={<replaceable>#</replaceable>|[<replaceable>+</replaceable>|<replaceable>-</replaceable>]<replaceable>mm:ss.ss</replaceable>}</term>
 219                 <listitem>
 220                   <para>Stop at the given sample number for each input file.
 221                     This works for both encoding and decoding, but not testing.
 222                     The given sample number is not included in the decoded
 223                     output.  The alternative form mm:ss.ss can be used to
 224                     specify minutes, seconds, and fractions of a second.  If a
 225                     `+' (plus) sign is at the beginning, the --until point is
 226                     relative to the --skip point.  If a `-' (minus) sign is at
 227                     the beginning, the --until point is relative to end of the
 228                     audio.</para>
 229                 </listitem>
 230               </varlistentry>
 231
 232               <varlistentry>
 233                 <term><option>--ogg</option></term>
 234
 235                 <listitem>
 236                   <para>When encoding, generate Ogg FLAC output instead
 237                     of native FLAC.  Ogg FLAC streams are FLAC streams
 238                     wrapped in an Ogg transport layer.  The resulting
 239                     file should have an '.ogg' extension and will still
 240                     be decodable by flac.</para>
 241                   <para>When decoding, force the input to be treated as
 242                     Ogg FLAC.  This is useful when piping input from
 243                     stdin or when the filename does not end in '.ogg'.</para>
 244                 </listitem>
 245               </varlistentry>
 246
 247               <varlistentry>
 248                 <term><option>--serial-number</option>=<replaceable>#</replaceable></term>
 249
 250                 <listitem>
 251                   <para>When used with --ogg, specifies the serial number to
 252                     use for the first Ogg FLAC stream, which is then
 253                     incremented for each additional stream.  When encoding and
 254                     no serial number is given, flac uses a random number for
 255                     the first stream, then increments it for each additional
 256                     stream.  When decoding and no number is given, flac uses
 257                     the serial number of the first page.</para>
 258                 </listitem>
 259               </varlistentry>
 260
 261             </variablelist>
 262           </refsect2>
 263
 264           <refsect2>
 265             <title>Analysis Options</title>
 266
 267             <variablelist>
 268               <varlistentry>
 269                 <term><option>--residual-text</option>
 270                 </term>
 271                 <listitem>
 272                   <para>Includes the residual signal in the analysis
 273                     file.  This will make the file very big, much
 274                     larger than even the decoded file.</para>
 275                 </listitem>
 276               </varlistentry>
 277
 278               <varlistentry>
 279                 <term><option>--residual-gnuplot</option>
 280                 </term>
 281                 <listitem>
 282                   <para>Generates a gnuplot file for every subframe;
 283                     each file will contain the residual distribution
 284                     of the subframe.  This will create a lot of
 285                     files.</para>
 286                 </listitem>
 287               </varlistentry>
 288
 289             </variablelist>
 290           </refsect2>
 291
 292           <refsect2>
 293             <title>Decoding Options</title>
 294
 295             <variablelist>
 296               <varlistentry>
 297                 <term><option>--cue=[<replaceable>#.#</replaceable>][-[<replaceable>#.#</replaceable>]]</option></term>
 298                 <listitem>
 299                   <para>Set the beginning and ending cuepoints to decode.
 300                     The optional first #.# is the track and index point at
 301                     which decoding will start; the default is the beginning
 302                     of the stream.  The optional second #.# is the track
 303                     and index point at which decoding will end; the default
 304                     is the end of the stream.  If the cuepoint does not
 305                     exist, the closest one before it (for the start point)
 306                     or after it (for the end point) will be used.  If those
 307                     don't exist, the start of the stream (for the start
 308                     point) or end of the stream (for the end point) will be
 309                     used.  The cuepoints are merely translated into sample
 310                     numbers then used as --skip and --until.  A CD track can
 311                     always be cued by, for example, --cue=9.1-10.1 for track
 312                     9, even if the CD has no 10th track.</para>
 313                 </listitem>
 314               </varlistentry>
 315
 316               <varlistentry>
 317                 <term><option>-F</option>, <option>--decode-through-errors</option>
 318                 </term>
 319                 <listitem>
 320                   <para>By default flac stops decoding with an error
 321                     and removes the partially decoded file if it
 322                     encounters a bitstream error.  With -F, errors are
 323                     still printed but flac will continue decoding to
 324                     completion.  Note that errors may cause the decoded
 325                     audio to be missing some samples or have silent
 326                     sections.</para>
 327                 </listitem>
 328               </varlistentry>
 329
 330             </variablelist>
 331           </refsect2>
 332
 333           <refsect2>
 334             <title>Encoding Options</title>
 335
 336             <variablelist>
 337               <varlistentry>
 338                 <term><option>-V</option>, <option>--verify</option></term>
 339
 340                 <listitem>
 341                   <para>Verify a correct encoding by decoding the
 342                     output in parallel and comparing to the
 343                     original</para>
 344                 </listitem>
 345               </varlistentry>
 346
 347               <varlistentry>
 348                 <term><option>--lax</option></term>
 349
 350                 <listitem>
 351                   <para>Allow encoder to generate non-Subset
 352                     files.  The resulting FLAC file may not be
 353                     streamable or might have trouble being played
 354                     in all players (especially hardware devices),
 355                     so you should only use this option in
 356                     combination with custom encoding options meant
 357                     for archival.</para>
 358                 </listitem>
 359               </varlistentry>
 360
 361               <varlistentry>
 362                 <term><option>--replay-gain</option></term>
 363
 364                 <listitem>
 365                   <para>Calculate ReplayGain values and store them
 366                     as FLAC tags, similar to vorbisgain.  Title
 367                     gains/peaks will be computed for each input
 368                     file, and an album gain/peak will be computed
 369                     for all files.  All input files must have the
 370                     same resolution, sample rate, and number of
 371                     channels.  Only mono and stereo files are
 372                     allowed, and the sample rate must be one of
 373                     8, 11.025, 12, 16, 22.05, 24, 32, 44.1, or 48
 374                     kHz.  Also note that this option may leave a
 375                     few extra bytes in a PADDING block as the exact
 376                     size of the tags is not known until all files
 377                     are processed.  Note that this option cannot be
 378                     used when encoding to standard output (stdout).
 379                     </para>
 380                 </listitem>
 381               </varlistentry>
 382
 383               <varlistentry>
 384                 <term><option>--cuesheet</option>=<replaceable>filename</replaceable></term>
 385
 386                 <listitem>
 387                   <para>Import the given cuesheet file and store it in a
 388                     CUESHEET metadata block.  This option may only be used
 389                     when encoding a single file.  A seekpoint will be added
 390                     for each index point in the cuesheet to the SEEKTABLE
 391                     unless --no-cued-seekpoints is specified.</para>
 392                 </listitem>
 393               </varlistentry>
 394
 395               <varlistentry>
 396                 <term><option>--sector-align</option></term>
 397
 398                 <listitem>
 399                   <para>Align encoding of multiple CD format
 400                     files on sector boundaries.  See the HTML
 401                     documentation for more information.</para>
 402                 </listitem>
 403               </varlistentry>
 404
 405               <varlistentry>
 406                 <term><option>-S</option> {<replaceable>#</replaceable>|<replaceable>X</replaceable>|<replaceable>#x</replaceable>|<replaceable>#s</replaceable>}, <option>--seekpoint</option>={<replaceable>#</replaceable>|<replaceable>X</replaceable>|<replaceable>#x</replaceable>|<replaceable>#s</replaceable>}</term>
 407
 408                 <listitem>
 409                   <para>
 410                     Include a point or points in a SEEKTABLE.  Using #,
 411                     a seek point at that sample number is added.  Using
 412                     X, a placeholder point is added at the end of a the
 413                     table.  Using #x, # evenly spaced seek points will
 414                     be added, the first being at sample 0.  Using #s, a
 415                     seekpoint will be added every # seconds (# does not
 416                     have to be a whole number; it can be, for example, 9.5,
 417                     meaning a seekpoint every 9.5 seconds).  You may use
 418                     many -S options; the resulting SEEKTABLE will be the
 419                     unique-ified union of all such values.  With no -S
 420                     options, flac defaults to '-S 10s'.  Use --no-seektable
 421                     for no SEEKTABLE.  Note: '-S #x' and '-S #s' will not
 422                     work if the encoder can't determine the input size before
 423                     starting.  Note: if you use '-S #' and # is >=
 424                     samples in the input, there will be either no seek
 425                     point entered (if the input size is determinable
 426                     before encoding starts) or a placeholder point (if
 427                     input size is not determinable).</para>
 428                 </listitem>
 429               </varlistentry>
 430
 431               <varlistentry>
 432                 <term><option>-P</option> <replaceable>#</replaceable>, <option>--padding</option>=<replaceable>#</replaceable></term>
 433
 434                 <listitem>
 435                   <para>Tell the encoder to write a PADDING metadata
 436                     block of the given length (in bytes) after the
 437                     STREAMINFO block.  This is useful if you plan to
 438                     tag the file later with an APPLICATION block;
 439                     instead of having to rewrite the entire file later
 440                     just to insert your block, you can write directly
 441                     over the PADDING block.  Note that the total length
 442                     of the PADDING block will be 4 bytes longer than
 443                     the length given because of the 4 metadata block
 444                     header bytes.  You can force no PADDING block at
 445                     all to be written with --no-padding.  The encoder
 446                     writes a PADDING block of 4096 bytes by default.
 447                     </para>
 448                 </listitem>
 449               </varlistentry>
 450
 451               <varlistentry>
 452                 <term><option>-T</option> <replaceable>FIELD=VALUE</replaceable>, <option>--tag</option>=<replaceable>FIELD=VALUE</replaceable></term>
 453
 454                 <listitem>
 455                   <para>Add a FLAC tag.  The comment must adhere to
 456                     the Vorbis comment spec; i.e. the FIELD must
 457                     contain only legal characters, terminated by an
 458                     'equals' sign.  Make sure to quote the comment if
 459                     necessary.  This option may appear more than once
 460                     to add several comments.  NOTE: all tags will be
 461                     added to all encoded files.</para>
 462                 </listitem>
 463               </varlistentry>
 464
 465               <varlistentry>
 466                 <term><option>--tag-from-file</option>=<replaceable>FIELD=FILENAME</replaceable></term>
 467
 468                 <listitem>
 469                   <para>Like --tag, except FILENAME is a file whose
 470                     contents will be read verbatim to set the tag
 471                     value.  The contents will be converted to UTF-8
 472                     from the local charset.  This can be used to
 473                     store a cuesheet in a tag (e.g.
 474                     --tag-from-file="CUESHEET=image.cue").  Do not
 475                     try to store binary data in tag fields!  Use
 476                     APPLICATION blocks for that.</para>
 477                 </listitem>
 478               </varlistentry>
 479
 480               <varlistentry>
 481                 <term><option>-b</option> <replaceable>#</replaceable>, <option>--blocksize</option>=<replaceable>#</replaceable></term>
 482
 483                 <listitem>
 484                   <para>Specify the block size in samples.  The
 485                     default is 1152 for -l 0, else 4608; must be one of
 486                     192, 576, 1152, 2304, 4608, 256, 512, 1024, 2048,
 487                     4096, 8192, 16384, or 32768 (unless --lax is used)</para>
 488                 </listitem>
 489               </varlistentry>
 490
 491               <varlistentry>
 492                 <term><option>-m</option>, <option>--mid-side</option></term>
 493
 494                 <listitem>
 495                   <para>Try mid-side coding for each frame (stereo
 496                     input only)</para>
 497                 </listitem>
 498               </varlistentry>
 499
 500               <varlistentry>
 501                 <term><option>-M</option>, <option>--adaptive-mid-side</option></term>
 502
 503                 <listitem>
 504                   <para>Adaptive mid-side coding for all frames (stereo
 505                     input only)</para>
 506                 </listitem>
 507               </varlistentry>
 508
 509               <varlistentry>
 510                 <term><option>-0</option>..<option>-8</option>, <option>--compression-level-0</option>..<option>--compression-level-8</option></term>
 511
 512                 <listitem>
 513                   <para>Fastest compression..highest compression
 514                     (default is -5).  These are synonyms for other
 515                     options:</para>
 516
 517                   <variablelist>
 518                     <varlistentry>
 519                       <term><option>-0</option>, <option>--compression-level-0</option></term>
 520
 521                       <listitem>
 522                         <para>Synonymous with -l 0 -b 1152 -r 2,2
 523                           </para>
 524                       </listitem>
 525                     </varlistentry>
 526
 527                     <varlistentry>
 528                       <term><option>-1</option>, <option>--compression-level-1</option></term>
 529
 530                       <listitem>
 531                         <para>Synonymous with -l 0 -b 1152 -M -r 2,2
 532                           </para>
 533                       </listitem>
 534                     </varlistentry>
 535
 536                     <varlistentry>
 537                       <term><option>-2</option>, <option>--compression-level-2</option></term>
 538
 539                       <listitem>
 540                         <para>Synonymous with -l 0 -b 1152 -m -r 3
 541                           </para>
 542                       </listitem>
 543                     </varlistentry>
 544
 545                     <varlistentry>
 546                       <term><option>-3</option>, <option>--compression-level-3</option></term>
 547
 548                       <listitem>
 549                         <para>Synonymous with -l 6 -b 4608 -r 3,3
 550                           </para>
 551                       </listitem>
 552                     </varlistentry>
 553
 554                     <varlistentry>
 555                       <term><option>-4</option>, <option>--compression-level-4</option></term>
 556
 557                       <listitem>
 558                         <para>Synonymous with -l 8 -b 4608 -M -r 3,3
 559                           </para>
 560                       </listitem>
 561                     </varlistentry>
 562
 563                     <varlistentry>
 564                       <term><option>-5</option>, <option>--compression-level-5</option></term>
 565
 566                       <listitem>
 567                         <para>Synonymous with -l 8 -b 4608 -m -r 3,3
 568                           </para>
 569                       </listitem>
 570                     </varlistentry>
 571
 572                     <varlistentry>
 573                       <term><option>-6</option>, <option>--compression-level-6</option></term>
 574
 575                       <listitem>
 576                         <para>Synonymous with -l 8 -b 4608 -m -r 4
 577                           </para>
 578                       </listitem>
 579                     </varlistentry>
 580
 581                     <varlistentry>
 582                       <term><option>-7</option>, <option>--compression-level-7</option></term>
 583
 584                       <listitem>
 585                         <para>Synonymous with -l 8 -b 4608 -m -e -r 6
 586                           </para>
 587                       </listitem>
 588                     </varlistentry>
 589
 590                     <varlistentry>
 591                       <term><option>-8</option>, <option>--compression-level-8</option></term>
 592
 593                       <listitem>
 594                         <para>Synonymous with -l 12 -b 4608 -m -e -r 6
 595                           </para>
 596                       </listitem>
 597                     </varlistentry>
 598                   </variablelist>
 599
 600                 </listitem>
 601
 602               </varlistentry>
 603
 604               <varlistentry>
 605                 <term><option>--fast</option></term>
 606
 607                 <listitem>
 608                   <para>Fastest compression.  Currently
 609                     synonymous with -0.</para>
 610                 </listitem>
 611               </varlistentry>
 612
 613               <varlistentry>
 614                 <term><option>--best</option></term>
 615
 616                 <listitem>
 617                   <para>Highest compression.  Currently
 618                     synonymous with -8.</para>
 619                 </listitem>
 620               </varlistentry>
 621
 622               <varlistentry>
 623                 <term><option>-e</option>, <option>--exhaustive-model-search</option></term>
 624
 625                 <listitem>
 626                   <para>Do exhaustive model search
 627                     (expensive!)</para>
 628                 </listitem>
 629               </varlistentry>
 630
 631               <varlistentry>
 632                 <term><option>-A</option> <replaceable>function</replaceable>, <option>--apodization</option>=<replaceable>function</replaceable></term>
 633
 634                 <listitem>
 635                   <para>Window audio data with given the apodization function.
 636                     The functions are: bartlett, bartlett_hann, blackman,
 637                     blackman_harris_4term_92db, connes, flattop, gauss(STDDEV),
 638                     hamming, hann, kaiser_bessel, nuttall, rectangle, triangle,
 639                     tukey(P), welch.</para>
 640                   <para>For gauss(STDDEV), STDDEV is the standard deviation
 641                     (0&lt;STDDEV&lt;=0.5).</para>
 642                   <para>For tukey(P), P specifies the fraction of the window that
 643                     is tapered (0&lt;=P&lt;=1; P=0 corresponds to "rectangle" and
 644                     P=1 corresponds to "hann").</para>
 645                   <para>More than one -A option (up to 32) may be used.  Any
 646                     function that is specified erroneously is silently dropped.
 647                     The encoder chooses suitable defaults in the absence of any
 648                     -A options; any -A option specified replaces the default(s).
 649                     </para>
 650                   <para>When more than one function is specified, then for every
 651                     subframe the encoder will try each of them separately and
 652                     choose the window that results in the smallest compressed
 653                     subframe.  Multiple functions can greatly increase the
 654                     encoding time.</para>
 655                 </listitem>
 656               </varlistentry>
 657
 658               <varlistentry>
 659                 <term><option>-l</option> <replaceable>#</replaceable>, <option>--max-lpc-order</option>=<replaceable>#</replaceable></term>
 660
 661                 <listitem>
 662                   <para>Set the maximum LPC order; 0 means use only the fixed predictors</para>
 663                 </listitem>
 664               </varlistentry>
 665
 666               <varlistentry>
 667                 <term><option>-p</option>, <option>--qlp-coeff-precision-search</option></term>
 668
 669                 <listitem>
 670                   <para>Do exhaustive search of LP coefficient
 671                     quantization (expensive!).  Overrides -q;
 672                     does nothing if using -l 0</para>
 673                 </listitem>
 674               </varlistentry>
 675
 676               <varlistentry>
 677                 <term><option>-q</option> <replaceable>#</replaceable>, <option>--qlp-coeff-precision</option>=<replaceable>#</replaceable></term>
 678
 679                 <listitem>
 680                   <para>Precision of the quantized linear-predictor
 681                     coefficients, 0 => let encoder decide (min is 5,
 682                     default is 0)</para>
 683                 </listitem>
 684               </varlistentry>
 685
 686               <varlistentry>
 687                 <term><option>-r</option> [<replaceable>#</replaceable>,]<replaceable>#</replaceable>, <option>--rice-partition-order</option>=[<replaceable>#</replaceable>,]<replaceable>#</replaceable></term>
 688
 689                 <listitem>
 690                   <para>Set the [min,]max residual partition order
 691                     (0..16). min defaults to 0 if unspecified.  Default
 692                     is -r 3,3.</para>
 693                 </listitem>
 694               </varlistentry>
 695
 696             </variablelist>
 697
 698           </refsect2>
 699           <refsect2>
 700             <title>Format Options</title>
 701
 702             <variablelist>
 703               <varlistentry>
 704                 <term><option>--endian</option>={<replaceable>big</replaceable>|<replaceable>little</replaceable>}</term>
 705
 706                 <listitem>
 707                   <para>Set the byte order for samples</para>
 708                 </listitem>
 709               </varlistentry>
 710
 711               <varlistentry>
 712                 <term><option>--channels</option>=<replaceable>#</replaceable></term>
 713
 714                 <listitem>
 715                   <para>Set number of channels.</para>
 716                 </listitem>
 717               </varlistentry>
 718
 719               <varlistentry>
 720                 <term><option>--bps</option>=<replaceable>#</replaceable></term>
 721
 722                 <listitem>
 723                   <para>Set bits per sample.</para>
 724                 </listitem>
 725               </varlistentry>
 726
 727               <varlistentry>
 728                 <term><option>--sample-rate</option>=<replaceable>#</replaceable></term>
 729
 730                 <listitem>
 731                   <para>Set sample rate (in Hz).</para>
 732                 </listitem>
 733               </varlistentry>
 734
 735               <varlistentry>
 736                 <term><option>--sign</option>={<replaceable>signed</replaceable>|<replaceable>unsigned</replaceable>}</term>
 737
 738                 <listitem>
 739                   <para>Set the sign of samples (the default is signed).</para>
 740                 </listitem>
 741               </varlistentry>
 742
 743               <varlistentry>
 744                 <term><option>--input-size</option>=<replaceable>#</replaceable></term>
 745
 746                 <listitem>
 747                   <para>Specify the size of the raw input in bytes.  If you are
 748                     encoding raw samples from stdin, you must set this option
 749                     in order to be able to use --skip, --until, --cue-sheet, or
 750                     other options that need to know the size of the input
 751                     beforehand.  If the size given is greater than what is
 752                     found in the input stream, the encoder will complain about
 753                     an unexpected end-of-file.  If the size given is less,
 754                     samples will be truncated.</para>
 755                 </listitem>
 756               </varlistentry>
 757
 758               <varlistentry>
 759                 <term><option>--force-aiff-format</option></term>
 760
 761                 <listitem>
 762                   <para>Force the decoder to output AIFF format.  This option
 763                     is not needed if the output filename (as set by -o) ends
 764                     with <filename>.aiff</filename>.  Also, this option has no
 765                     effect when encoding since input AIFF is auto-detected.</para>
 766                 </listitem>
 767               </varlistentry>
 768
 769               <varlistentry>
 770                 <term><option>--force-raw-format</option></term>
 771
 772                 <listitem>
 773                   <para>Force input (when encoding) or output (when decoding)
 774                     to be treated as raw samples (even if filename ends
 775                     in <filename>.wav</filename>).</para>
 776                 </listitem>
 777               </varlistentry>
 778
 779             </variablelist>
 780           </refsect2>
 781
 782           <refsect2>
 783             <title>Negative Options</title>
 784
 785             <variablelist>
 786               <varlistentry>
 787                 <term><option>--no-adaptive-mid-side</option></term>
 788                 <term><option>--no-decode-through-errors</option></term>
 789                 <term><option>--no-delete-input-file</option></term>
 790                 <term><option>--no-exhaustive-model-search</option></term>
 791                 <term><option>--no-lax</option></term>
 792                 <term><option>--no-mid-side</option></term>
 793                 <term><option>--no-ogg</option></term>
 794                 <term><option>--no-padding</option></term>
 795                 <term><option>--no-qlp-coeff-precision-search</option></term>
 796                 <term><option>--no-residual-gnuplot</option></term>
 797                 <term><option>--no-residual-text</option></term>
 798                 <term><option>--no-sector-align</option></term>
 799                 <term><option>--no-seektable</option></term>
 800                 <term><option>--no-silent</option></term>
 801                 <term><option>--no-verify</option></term>
 802                 <listitem>
 803                   <para>These flags can be used to invert the sense
 804                     of the corresponding normal option.</para>
 805                 </listitem>
 806               </varlistentry>
 807             </variablelist>
 808
 809           </refsect2>
 810
 811         </refsect1>
 812           <refsect1>
 813             <title>SEE ALSO</title>
 814
 815             <para>metaflac(1).</para>
 816
 817             <para>The programs are documented fully by HTML format
 818               documentation, available in
 819               <filename>/usr/share/doc/flac/html</filename> on
 820                 &debian; systems.</para>
 821           </refsect1>
 822           <refsect1>
 823             <title>AUTHOR</title>
 824
 825             <para>This manual page was written by &dhusername; &dhemail; for
 826               the &debian; system (but may be used by others).</para>
 827
 828             <!-- <para>Permission is granted to copy, distribute and/or modify
 829             this document under the terms of the <acronym>GNU</acronym> Free
 830             Documentation License, Version 1.1 or any later version
 831             published by the Free Software Foundation; with no Invariant
 832             Sections, no Front-Cover Texts and no Back-Cover Texts.  A copy
 833             of the license can be found under
 834           <filename>/usr/share/common-licenses/FDL</filename>.</para> -->
 835
 836         </refsect1>
 837       </refentry>
 838
 839         <!-- Keep this comment at the end of the file
 840               Local variables:
 841               mode: sgml
 842               sgml-omittag:t
 843               sgml-shorttag:t
 844               sgml-minimize-attributes:nil
 845               sgml-always-quote-attributes:t
 846               sgml-indent-step:2
 847               sgml-indent-data:t
 848               sgml-parent-document:nil
 849               sgml-default-dtd-file:nil
 850               sgml-exposed-tags:nil
 851               sgml-local-catalogs:nil
 852               sgml-local-ecat-files:nil
 853               End:
 854               -->