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