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