44c587e6d5cc26cc22786cb08772391c01c61894
[platform/upstream/flac.git] / 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>--tag-from-file</option>=<replaceable>FIELD=FILENAME</replaceable></term>
470
471                 <listitem>
472                   <para>Like --tag, except FILENAME is a file whose
473                     contents will be read verbatim to set the tag
474                     value.  The contents will be converted to UTF-8
475                     from the local charset.  This can be used to
476                     store a cuesheet in a tag (e.g.
477                     --tag-from-file="CUESHEET=image.cue").  Do not
478                     try to store binary data in tag fields!  Use
479                     APPLICATION blocks for that.</para>
480                 </listitem>
481               </varlistentry>
482
483               <varlistentry>
484                 <term><option>-b</option> <replaceable>#</replaceable>, <option>--blocksize</option>=<replaceable>#</replaceable></term>
485
486                 <listitem>
487                   <para>Specify the block size in samples.  The
488                     default is 1152 for -l 0, else 4608; must be one of
489                     192, 576, 1152, 2304, 4608, 256, 512, 1024, 2048,
490                     4096, 8192, 16384, or 32768 (unless --lax is used)</para>
491                 </listitem>
492               </varlistentry>
493
494               <varlistentry>
495                 <term><option>-m</option>, <option>--mid-side</option></term>
496
497                 <listitem>
498                   <para>Try mid-side coding for each frame (stereo
499                     input only)</para>
500                 </listitem>
501               </varlistentry>
502
503               <varlistentry>
504                 <term><option>-M</option>, <option>--adaptive-mid-side</option></term>
505
506                 <listitem>
507                   <para>Adaptive mid-side coding for all frames (stereo
508                     input only)</para>
509                 </listitem>
510               </varlistentry>
511
512               <varlistentry>
513                 <term><option>-0</option>..<option>-8</option>, <option>--compression-level-0</option>..<option>--compression-level-8</option></term>
514
515                 <listitem>
516                   <para>Fastest compression..highest compression
517                     (default is -5).  These are synonyms for other
518                     options:</para>
519
520                   <variablelist>
521                     <varlistentry>
522                       <term><option>-0</option>, <option>--compression-level-0</option></term>
523
524                       <listitem>
525                         <para>Synonymous with -l 0 -b 1152 -r 2,2
526                           </para>
527                       </listitem>
528                     </varlistentry>
529
530                     <varlistentry>
531                       <term><option>-1</option>, <option>--compression-level-1</option></term>
532
533                       <listitem>
534                         <para>Synonymous with -l 0 -b 1152 -M -r 2,2
535                           </para>
536                       </listitem>
537                     </varlistentry>
538
539                     <varlistentry>
540                       <term><option>-2</option>, <option>--compression-level-2</option></term>
541
542                       <listitem>
543                         <para>Synonymous with -l 0 -b 1152 -m -r 3
544                           </para>
545                       </listitem>
546                     </varlistentry>
547
548                     <varlistentry>
549                       <term><option>-3</option>, <option>--compression-level-3</option></term>
550
551                       <listitem>
552                         <para>Synonymous with -l 6 -b 4608 -r 3,3
553                           </para>
554                       </listitem>
555                     </varlistentry>
556
557                     <varlistentry>
558                       <term><option>-4</option>, <option>--compression-level-4</option></term>
559
560                       <listitem>
561                         <para>Synonymous with -l 8 -b 4608 -M -r 3,3
562                           </para>
563                       </listitem>
564                     </varlistentry>
565
566                     <varlistentry>
567                       <term><option>-5</option>, <option>--compression-level-5</option></term>
568
569                       <listitem>
570                         <para>Synonymous with -l 8 -b 4608 -m -r 3,3
571                           </para>
572                       </listitem>
573                     </varlistentry>
574
575                     <varlistentry>
576                       <term><option>-6</option>, <option>--compression-level-6</option></term>
577
578                       <listitem>
579                         <para>Synonymous with -l 8 -b 4608 -m -r 4
580                           </para>
581                       </listitem>
582                     </varlistentry>
583
584                     <varlistentry>
585                       <term><option>-7</option>, <option>--compression-level-7</option></term>
586
587                       <listitem>
588                         <para>Synonymous with -l 8 -b 4608 -m -e -r 6
589                           </para>
590                       </listitem>
591                     </varlistentry>
592
593                     <varlistentry>
594                       <term><option>-8</option>, <option>--compression-level-8</option></term>
595
596                       <listitem>
597                         <para>Synonymous with -l 12 -b 4608 -m -e -r 6
598                           </para>
599                       </listitem>
600                     </varlistentry>
601                   </variablelist>
602
603                 </listitem>
604
605               </varlistentry>
606
607               <varlistentry>
608                 <term><option>--fast</option></term>
609
610                 <listitem>
611                   <para>Fastest compression.  Currently
612                     synonymous with -0.</para>
613                 </listitem>
614               </varlistentry>
615
616               <varlistentry>
617                 <term><option>--best</option></term>
618
619                 <listitem>
620                   <para>Highest compression.  Currently
621                     synonymous with -8.</para>
622                 </listitem>
623               </varlistentry>
624
625               <varlistentry>
626                 <term><option>-e</option>, <option>--exhaustive-model-search</option></term>
627
628                 <listitem>
629                   <para>Do exhaustive model search
630                     (expensive!)</para>
631                 </listitem>
632               </varlistentry>
633
634               <varlistentry>
635                 <term><option>-A</option> <replaceable>function</replaceable>, <option>--apodization</option>=<replaceable>function</replaceable></term>
636
637                 <listitem>
638                   <para>Window audio data with given the apodization function.
639                     The functions are: bartlett, bartlett_hann, blackman,
640                     blackman_harris_4term_92db, connes, flattop, gauss(STDDEV),
641                     hamming, hann, kaiser_bessel, nuttall, rectangle, triangle,
642                     tukey(P), welch.</para>
643                   <para>For gauss(STDDEV), STDDEV is the standard deviation
644                     (0&lt;STDDEV&lt;=0.5).</para>
645                   <para>For tukey(P), P specifies the fraction of the window that
646                     is tapered (0&lt;=P&lt;=1; P=0 corresponds to "rectangle" and
647                     P=1 corresponds to "hann").</para>
648                   <para>More than one -A option (up to 32) may be used.  Any
649                     function that is specified erroneously is silently dropped.
650                     The encoder chooses suitable defaults in the absence of any
651                     -A options; any -A option specified replaces the default(s).
652                     </para>
653                   <para>When more than one function is specified, then for every
654                     subframe the encoder will try each of them separately and
655                     choose the window that results in the smallest compressed
656                     subframe.  Multiple functions can greatly increase the
657                     encoding time.</para>
658                 </listitem>
659               </varlistentry>
660
661               <varlistentry>
662                 <term><option>-l</option> <replaceable>#</replaceable>, <option>--max-lpc-order</option>=<replaceable>#</replaceable></term>
663
664                 <listitem>
665                   <para>Set the maximum LPC order; 0 means use only the fixed predictors</para>
666                 </listitem>
667               </varlistentry>
668
669               <varlistentry>
670                 <term><option>-p</option>, <option>--qlp-coeff-precision-search</option></term>
671
672                 <listitem>
673                   <para>Do exhaustive search of LP coefficient
674                     quantization (expensive!).  Overrides -q;
675                     does nothing if using -l 0</para>
676                 </listitem>
677               </varlistentry>
678
679               <varlistentry>
680                 <term><option>-q</option> <replaceable>#</replaceable>, <option>--qlp-coeff-precision</option>=<replaceable>#</replaceable></term>
681
682                 <listitem>
683                   <para>Precision of the quantized linear-predictor
684                     coefficients, 0 => let encoder decide (min is 5,
685                     default is 0)</para>
686                 </listitem>
687               </varlistentry>
688
689               <varlistentry>
690                 <term><option>-r</option> [<replaceable>#</replaceable>,]<replaceable>#</replaceable>, <option>--rice-partition-order</option>=[<replaceable>#</replaceable>,]<replaceable>#</replaceable></term>
691
692                 <listitem>
693                   <para>Set the [min,]max residual partition order
694                     (0..16). min defaults to 0 if unspecified.  Default
695                     is -r 3,3.</para>
696                 </listitem>
697               </varlistentry>
698
699             </variablelist>
700
701           </refsect2>
702           <refsect2>
703             <title>Format Options</title>
704
705             <variablelist>
706               <varlistentry>
707                 <term><option>--endian</option>={<replaceable>big</replaceable>|<replaceable>little</replaceable>}</term>
708
709                 <listitem>
710                   <para>Set the byte order for samples</para>
711                 </listitem>
712               </varlistentry>
713
714               <varlistentry>
715                 <term><option>--channels</option>=<replaceable>#</replaceable></term>
716
717                 <listitem>
718                   <para>Set number of channels.</para>
719                 </listitem>
720               </varlistentry>
721
722               <varlistentry>
723                 <term><option>--bps</option>=<replaceable>#</replaceable></term>
724
725                 <listitem>
726                   <para>Set bits per sample.</para>
727                 </listitem>
728               </varlistentry>
729
730               <varlistentry>
731                 <term><option>--sample-rate</option>=<replaceable>#</replaceable></term>
732
733                 <listitem>
734                   <para>Set sample rate (in Hz).</para>
735                 </listitem>
736               </varlistentry>
737
738               <varlistentry>
739                 <term><option>--sign</option>={<replaceable>signed</replaceable>|<replaceable>unsigned</replaceable>}</term>
740
741                 <listitem>
742                   <para>Set the sign of samples (the default is signed).</para>
743                 </listitem>
744               </varlistentry>
745
746               <varlistentry>
747                 <term><option>--input-size</option>=<replaceable>#</replaceable></term>
748
749                 <listitem>
750                   <para>Specify the size of the raw input in bytes.  If you are
751                     encoding raw samples from stdin, you must set this option
752                     in order to be able to use --skip, --until, --cue-sheet, or
753                     other options that need to know the size of the input
754                     beforehand.  If the size given is greater than what is
755                     found in the input stream, the encoder will complain about
756                     an unexpected end-of-file.  If the size given is less,
757                     samples will be truncated.</para>
758                 </listitem>
759               </varlistentry>
760
761               <varlistentry>
762                 <term><option>--force-aiff-format</option></term>
763
764                 <listitem>
765                   <para>Force the decoder to output AIFF format.  This option
766                     is not needed if the output filename (as set by -o) ends
767                     with <filename>.aiff</filename>.  Also, this option has no
768                     effect when encoding since input AIFF is auto-detected.</para>
769                 </listitem>
770               </varlistentry>
771
772               <varlistentry>
773                 <term><option>--force-raw-format</option></term>
774
775                 <listitem>
776                   <para>Force input (when encoding) or output (when decoding)
777                     to be treated as raw samples (even if filename ends
778                     in <filename>.wav</filename>).</para>
779                 </listitem>
780               </varlistentry>
781
782             </variablelist>
783           </refsect2>
784
785           <refsect2>
786             <title>Negative Options</title>
787
788             <variablelist>
789               <varlistentry>
790                 <term><option>--no-adaptive-mid-side</option></term>
791                 <term><option>--no-decode-through-errors</option></term>
792                 <term><option>--no-delete-input-file</option></term>
793                 <term><option>--no-exhaustive-model-search</option></term>
794                 <term><option>--no-lax</option></term>
795                 <term><option>--no-mid-side</option></term>
796                 <term><option>--no-ogg</option></term>
797                 <term><option>--no-padding</option></term>
798                 <term><option>--no-qlp-coeff-precision-search</option></term>
799                 <term><option>--no-residual-gnuplot</option></term>
800                 <term><option>--no-residual-text</option></term>
801                 <term><option>--no-sector-align</option></term>
802                 <term><option>--no-seektable</option></term>
803                 <term><option>--no-silent</option></term>
804                 <term><option>--no-verify</option></term>
805                 <listitem>
806                   <para>These flags can be used to invert the sense
807                     of the corresponding normal option.</para>
808                 </listitem>
809               </varlistentry>
810             </variablelist>
811
812           </refsect2>
813
814         </refsect1>
815           <refsect1>
816             <title>SEE ALSO</title>
817
818             <para>metaflac(1).</para>
819
820             <para>The programs are documented fully by HTML format
821               documentation, available in
822               <filename>/usr/share/doc/flac/html</filename> on
823                 &debian; systems.</para>
824           </refsect1>
825           <refsect1>
826             <title>AUTHOR</title>
827
828             <para>This manual page was written by &dhusername; &dhemail; for
829               the &debian; system (but may be used by others).</para>
830
831             <!-- <para>Permission is granted to copy, distribute and/or modify
832             this document under the terms of the <acronym>GNU</acronym> Free
833             Documentation License, Version 1.1 or any later version
834             published by the Free Software Foundation; with no Invariant
835             Sections, no Front-Cover Texts and no Back-Cover Texts.  A copy
836             of the license can be found under
837           <filename>/usr/share/common-licenses/FDL</filename>.</para> -->
838
839         </refsect1>
840       </refentry>
841
842         <!-- Keep this comment at the end of the file
843               Local variables:
844               mode: sgml
845               sgml-omittag:t
846               sgml-shorttag:t
847               sgml-minimize-attributes:nil
848               sgml-always-quote-attributes:t
849               sgml-indent-step:2
850               sgml-indent-data:t
851               sgml-parent-document:nil
852               sgml-default-dtd-file:nil
853               sgml-exposed-tags:nil
854               sgml-local-catalogs:nil
855               sgml-local-ecat-files:nil
856               End:
857               -->