flac.sgml 19.6 KB
Newer Older
Josh Coalson's avatar
Josh Coalson committed
1
2
3
4
5
6
<!doctype refentry PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [

  <!-- Fill in your name for FIRSTNAME and SURNAME. -->
  <!ENTITY dhfirstname "<firstname>Matt</firstname>">
  <!ENTITY dhsurname   "<surname>Zimmerman</surname>">
  <!-- Please adjust the date whenever revising the manpage. -->
Josh Coalson's avatar
Josh Coalson committed
7
  <!ENTITY dhdate      "<date>September 19, 2002</date>">
Josh Coalson's avatar
Josh Coalson committed
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
  <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
       allowed: see man(7), man(1). -->
  <!ENTITY dhsection   "<manvolnum>1</manvolnum>">
  <!ENTITY dhemail     "<email>mdz@debian.org</email>">
  <!ENTITY dhusername  "Matt Zimmerman">
  <!ENTITY dhucpackage "<refentrytitle>FLAC</refentrytitle>">
  <!ENTITY dhpackage   "flac">

  <!ENTITY debian      "<productname>Debian GNU/Linux</productname>">
  <!ENTITY gnu         "<acronym>GNU</acronym>">
]>

<refentry>
  <docinfo>
    <address>
	&dhemail;
    </address>
    <author>
	&dhfirstname;
	&dhsurname;
      </author>
	<copyright>
30
		    <year>2002</year>
Josh Coalson's avatar
Josh Coalson committed
31
32
33
34
35
36
37
38
39
40
41
42
		    <holder>&dhusername;</holder>
	</copyright>
	    &dhdate;
	</docinfo>
  <refmeta>
      &dhucpackage;

      &dhsection;
    </refmeta>
      <refnamediv>
		   <refname>&dhpackage;</refname>

43
	<refpurpose>Free Lossless Audio Codec</refpurpose>
Josh Coalson's avatar
Josh Coalson committed
44
45
46
47
48
49
50
      </refnamediv>
	<refsynopsisdiv>
	  <cmdsynopsis>
	    <command>flac</command>

	    <arg><option><replaceable>OPTION</replaceable></option></arg>
	    <arg choice=plain><replaceable>infile</replaceable></arg>
51
	    <arg choice=plain><replaceable>...</replaceable></arg>
Josh Coalson's avatar
Josh Coalson committed
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
	  </cmdsynopsis>
	</refsynopsisdiv>
	<refsect1>
	  <title>DESCRIPTION</title>

	  <para>This manual page documents briefly the
	    <command>flac</command> command.</para>

	  <para>This manual page was written for the &debian;
	    distribution because the original program does not have a
	    manual page.  Instead, it has documentation in HTML
	    format; see below.</para>

	</refsect1>
	<refsect1>
	  <title>OPTIONS</title>

	  <para>A summary of options is included below.  For a complete
	  description, see the HTML documentation.</para>

	  <refsect2>
	    <title>Generic Options</title>

	    <variablelist>
Josh Coalson's avatar
Josh Coalson committed
76
77
78
79
80
81
82
83
	      <varlistentry>
		<term><option>-v</option>, <option>--version</option>
		</term>
		<listitem>
		  <para>Show the flac version number</para>
		</listitem>
	      </varlistentry>

84
	      <varlistentry>
85
		<term><option>-h</option>, <option>--help</option>
86
87
		</term>
		<listitem>
88
		  <para>Show basic usage and a list of all options</para>
89
90
91
		</listitem>
	      </varlistentry>

Josh Coalson's avatar
Josh Coalson committed
92
	      <varlistentry>
93
		<term><option>-H</option>, <option>--explain</option>
Josh Coalson's avatar
Josh Coalson committed
94
95
		</term>
		<listitem>
96
		  <para>Show detailed explanation of usage and all options</para>
Josh Coalson's avatar
Josh Coalson committed
97
98
99
		</listitem>
	      </varlistentry>

100
101
102
103
104
105
106
	      <varlistentry>
		<term><option>-d</option>, <option>--decode</option>
		</term>
		<listitem>
		  <para>Decode (the default behavior is to encode)</para>
		</listitem>
	      </varlistentry>
107

Josh Coalson's avatar
Josh Coalson committed
108
	      <varlistentry>
109
		<term><option>-t</option>, <option>--test</option>
Josh Coalson's avatar
Josh Coalson committed
110
111
112
113
114
115
116
117
		</term>
		<listitem>
		  <para>Test a flac encoded file (same as -d
		    except no decoded file is written)</para>
		</listitem>
	      </varlistentry>

	      <varlistentry>
118
		<term><option>-a</option>, <option>--analyze</option>
Josh Coalson's avatar
Josh Coalson committed
119
120
121
122
123
124
125
		</term>
		<listitem>
		  <para>Analyze a flac encoded file (same as -d
		    except an analysis file is written)</para>
		</listitem>
	      </varlistentry>

126
127
128
129
130
131
132
133
              <varlistentry>
	        <term><option>-c</option>, <option>--stdout</option>
                </term>
                <listitem>
                  <para>Write output to stdout</para>
                </listitem>
              </varlistentry>

Josh Coalson's avatar
Josh Coalson committed
134
	      <varlistentry>
135
		<term><option>-s</option>, <option>--silent</option>
Josh Coalson's avatar
Josh Coalson committed
136
137
138
		</term>
		<listitem>
		  <para>Silent mode (do not write runtime
139
		    encode/decode statistics to stderr)</para>
Josh Coalson's avatar
Josh Coalson committed
140
141
142
		</listitem>
	      </varlistentry>

143
	      <varlistentry>
144
		<term><option>-o</option> <replaceable>filename</replaceable>, <option>--output-name</option>=<replaceable>filename</replaceable></term>
145
146
		<listitem>
		  <para>Force the output file name (usually flac just
Josh Coalson's avatar
Josh Coalson committed
147
148
149
150
151
152
153
		    changes the extension).  May only be used when
		    encoding a single file.  May not be used in
		    conjunction with --output-prefix.</para>
		</listitem>
	      </varlistentry>

	      <varlistentry>
154
		<term><option>--output-prefix</option>=<replaceable>string</replaceable></term>
Josh Coalson's avatar
Josh Coalson committed
155
156
		<listitem>
		  <para>Prefix each output file name with the given
157
		    string.  This can be useful for encoding or decoding
Josh Coalson's avatar
Josh Coalson committed
158
159
160
		    files to a different directory.  Make sure if your
		    string is a path name that it ends with a trailing
		    `/' (slash).</para>
161
162
163
164
165
166
167
168
169
170
171
172
173
174
		</listitem>
	      </varlistentry>

	      <varlistentry>
		<term><option>--delete-input-file</option>
		</term>
		<listitem>
		  <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>
		</listitem>
	      </varlistentry>

Josh Coalson's avatar
Josh Coalson committed
175
	      <varlistentry>
176
		<term><option>--skip</option>=<replaceable>#</replaceable></term>
Josh Coalson's avatar
Josh Coalson committed
177
178
179
180
181
182
183
		<listitem>
		  <para>Skip the specified number of samples at the
		    beginning of the input file (can be used for both
		    encoding and decoding)</para>
		</listitem>
	      </varlistentry>

Josh Coalson's avatar
Josh Coalson committed
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
	      <varlistentry>
		<term><option>--ogg</option></term>

		<listitem>
		  <para>When encoding, generate Ogg-FLAC output instead
		    of native-FLAC.  Ogg-FLAC streams are FLAC streams
		    wrapped in an Ogg transport layer.  The resulting
		    file should have an '.ogg' extension and will still
		    be decodable by flac.</para>
		  <para>When decoding, force the input to be treated as
		    Ogg-FLAC.  This is useful when piping input from
		    stdin or when the filename does not end in '.ogg'.</para>
		</listitem>
	      </varlistentry>

	      <varlistentry>
		<term><option>--serial-number</option>=<replaceable>#</replaceable></term>

		<listitem>
		  <para>When used with --ogg, specifies the serial
		    number to use for the FLAC stream.  When encoding and
		    no serial number is given, flac uses '0'.  When
		    decoding and no number is given, flac uses the serial
		    number of the first page.</para>
		</listitem>
	      </varlistentry>

Josh Coalson's avatar
Josh Coalson committed
211
212
213
	    </variablelist>
	  </refsect2>

Josh Coalson's avatar
Josh Coalson committed
214
215
216
217
218
	  <refsect2>
	    <title>Analysis Options</title>

	    <variablelist>
	      <varlistentry>
219
		<term><option>--residual-text</option>
Josh Coalson's avatar
Josh Coalson committed
220
221
		</term>
		<listitem>
Josh Coalson's avatar
Josh Coalson committed
222
223
224
225
226
227
228
		  <para>Includes the residual signal in the analysis
		    file.  This will make the file very big, much
		    larger than even the decoded file.</para>
		</listitem>
	      </varlistentry>

	      <varlistentry>
229
		<term><option>--residual-gnuplot</option>
Josh Coalson's avatar
Josh Coalson committed
230
231
232
233
234
235
		</term>
		<listitem>
		  <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>
Josh Coalson's avatar
Josh Coalson committed
236
237
238
239
240
241
		</listitem>
	      </varlistentry>

	    </variablelist>
	  </refsect2>

Josh Coalson's avatar
Josh Coalson committed
242
243
244
245
246
	  <refsect2>
	    <title>Decoding Options</title>

	    <variablelist>
	      <varlistentry>
247
		<term><option>-F</option>, <option>--decode-through-errors</option>
Josh Coalson's avatar
Josh Coalson committed
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
		</term>
		<listitem>
		  <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>
		</listitem>
	      </varlistentry>

	    </variablelist>
	  </refsect2>

Josh Coalson's avatar
Josh Coalson committed
263
264
265
266
	  <refsect2>
	    <title>Encoding Options</title>

	    <variablelist>
267
268
269
270
271
272
273
274
275
276
	      <varlistentry>
		<term><option>-V</option>, <option>--verify</option></term>

		<listitem>
		  <para>Verify a correct encoding by decoding the
		    output in parallel and comparing to the
		    original</para>
		</listitem>
	      </varlistentry>

Josh Coalson's avatar
Josh Coalson committed
277
278
279
280
281
	      <varlistentry>
		<term><option>--lax</option></term>

		<listitem>
		  <para>Allow encoder to generate non-Subset
Josh Coalson's avatar
Josh Coalson committed
282
283
284
285
286
287
288
289
290
291
292
		    files.</para>
		</listitem>
	      </varlistentry>

	      <varlistentry>
		<term><option>--sector-align</option></term>

		<listitem>
		  <para>Align encoding of multiple CD format WAVE
		    files on sector boundaries.  See the HTML
		    documentation for more information.</para>
Josh Coalson's avatar
Josh Coalson committed
293
294
295
		</listitem>
	      </varlistentry>

Josh Coalson's avatar
Josh Coalson committed
296
	      <varlistentry>
297
		<term><option>-S</option> {<replaceable>#</replaceable>|<replaceable>X</replaceable>|<replaceable>#x</replaceable>}, <option>--seekpoint</option>={<replaceable>#</replaceable>|<replaceable>X</replaceable>|<replaceable>#x</replaceable>}</term>
Josh Coalson's avatar
Josh Coalson committed
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314

		<listitem>
		  <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.  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 100x'.  Use -S- for
		    no SEEKTABLE.  Note: '-S #x' 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
Josh Coalson's avatar
Josh Coalson committed
315
		    input size is not determinable).</para>
Josh Coalson's avatar
Josh Coalson committed
316
317
318
		</listitem>
	      </varlistentry>

Josh Coalson's avatar
Josh Coalson committed
319
	      <varlistentry>
320
		<term><option>-P</option> <replaceable>#</replaceable>, <option>--padding</option>=<replaceable>#</replaceable></term>
Josh Coalson's avatar
Josh Coalson committed
321
322
323
324

		<listitem>
		  <para>Tell the encoder to write a PADDING metadata
		    block of the given length (in bytes) after the
325
326
		    STREAMINFO block.  This is useful if you plan to
		    tag the file later with an APPLICATION block;
Josh Coalson's avatar
Josh Coalson committed
327
328
		    instead of having to rewrite the entire file later
		    just to insert your block, you can write directly
329
330
331
332
333
334
		    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 -P-, which is the default.
		    </para>
Josh Coalson's avatar
Josh Coalson committed
335
336
337
		</listitem>
	      </varlistentry>

Josh Coalson's avatar
Josh Coalson committed
338
339
340
341
342
343
344
345
346
347
348
349
350
351
	      <varlistentry>
		<term><option>-T</option> <replaceable>FIELD=VALUE</replaceable>, <option>--tag</option>=<replaceable>FIELD=VALUE</replaceable></term>

		<listitem>
		  <para>Add a Vorbis comment.  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>
		</listitem>
	      </varlistentry>

Josh Coalson's avatar
Josh Coalson committed
352
	      <varlistentry>
353
		<term><option>-b</option> <replaceable>#</replaceable>, <option>--blocksize</option>=<replaceable>#</replaceable></term>
Josh Coalson's avatar
Josh Coalson committed
354
355

		<listitem>
356
357
358
359
		  <para>Specify the block size in samples.  The
		    default is 1152 for -l 0, else 4608; must be one of
		    192, 576, 1152, 2304, 4608, 256, 512, 1024, 2048,
		    4096, 8192, 16384, or 32768 (unless --lax is used)</para>
Josh Coalson's avatar
Josh Coalson committed
360
361
362
363
		</listitem>
	      </varlistentry>

	      <varlistentry>
364
		<term><option>-m</option>, <option>--mid-side</option></term>
Josh Coalson's avatar
Josh Coalson committed
365
366
367
368
369
370
371
372

		<listitem>
		  <para>Try mid-side coding for each frame (stereo
		    input only)</para>
		</listitem>
	      </varlistentry>

	      <varlistentry>
373
		<term><option>-M</option>, <option>--adaptive-mid-side</option></term>
Josh Coalson's avatar
Josh Coalson committed
374
375

		<listitem>
376
		  <para>Adaptive mid-side coding for all frames (stereo
Josh Coalson's avatar
Josh Coalson committed
377
378
379
380
381
		    input only)</para>
		</listitem>
	      </varlistentry>

	      <varlistentry>
382
		<term><option>-0</option>..<option>-8</option>, <option>--compression-level-0</option>..<option>--compression-level-8</option></term>
Josh Coalson's avatar
Josh Coalson committed
383
384
385

		<listitem>
		  <para>Fastest compression..highest compression
Josh Coalson's avatar
Josh Coalson committed
386
		    (default is -5).  These are synonyms for other
Josh Coalson's avatar
Josh Coalson committed
387
388
389
390
		    options:</para>

		  <variablelist>
		    <varlistentry>
391
		      <term><option>-0</option>, <option>--compression-level-0</option></term>
Josh Coalson's avatar
Josh Coalson committed
392

Josh Coalson's avatar
Josh Coalson committed
393
		      <listitem>
Josh Coalson's avatar
Josh Coalson committed
394
395
			<para>Synonymous with -l 0 -b 1152 -r 2,2
			  </para>
Josh Coalson's avatar
Josh Coalson committed
396
397
		      </listitem>
		    </varlistentry>
Josh Coalson's avatar
Josh Coalson committed
398

Josh Coalson's avatar
Josh Coalson committed
399
		    <varlistentry>
400
		      <term><option>-1</option>, <option>--compression-level-1</option></term>
Josh Coalson's avatar
Josh Coalson committed
401

Josh Coalson's avatar
Josh Coalson committed
402
		      <listitem>
Josh Coalson's avatar
Josh Coalson committed
403
404
			<para>Synonymous with -l 0 -b 1152 -M -r 2,2
			  </para>
Josh Coalson's avatar
Josh Coalson committed
405
406
		      </listitem>
		    </varlistentry>
Josh Coalson's avatar
Josh Coalson committed
407

Josh Coalson's avatar
Josh Coalson committed
408
		    <varlistentry>
409
		      <term><option>-2</option>, <option>--compression-level-2</option></term>
Josh Coalson's avatar
Josh Coalson committed
410

Josh Coalson's avatar
Josh Coalson committed
411
		      <listitem>
Josh Coalson's avatar
Josh Coalson committed
412
413
			<para>Synonymous with -l 0 -b 1152 -m -r 3
			  </para>
Josh Coalson's avatar
Josh Coalson committed
414
415
416
417
		      </listitem>
		    </varlistentry>

		    <varlistentry>
418
		      <term><option>-3</option>, <option>--compression-level-3</option></term>
Josh Coalson's avatar
Josh Coalson committed
419

Josh Coalson's avatar
Josh Coalson committed
420
		      <listitem>
Josh Coalson's avatar
Josh Coalson committed
421
422
			<para>Synonymous with -l 6 -b 4608 -r 3,3
			  </para>
Josh Coalson's avatar
Josh Coalson committed
423
424
		      </listitem>
		    </varlistentry>
Josh Coalson's avatar
Josh Coalson committed
425

Josh Coalson's avatar
Josh Coalson committed
426
		    <varlistentry>
427
		      <term><option>-4</option>, <option>--compression-level-4</option></term>
Josh Coalson's avatar
Josh Coalson committed
428

Josh Coalson's avatar
Josh Coalson committed
429
		      <listitem>
Josh Coalson's avatar
Josh Coalson committed
430
431
			<para>Synonymous with -l 8 -b 4608 -M -r 3,3
			  </para>
Josh Coalson's avatar
Josh Coalson committed
432
433
		      </listitem>
		    </varlistentry>
Josh Coalson's avatar
Josh Coalson committed
434

Josh Coalson's avatar
Josh Coalson committed
435
		    <varlistentry>
436
		      <term><option>-5</option>, <option>--compression-level-5</option></term>
Josh Coalson's avatar
Josh Coalson committed
437

Josh Coalson's avatar
Josh Coalson committed
438
		      <listitem>
Josh Coalson's avatar
Josh Coalson committed
439
440
			<para>Synonymous with -l 8 -b 4608 -m -r 3,3
			  </para>
Josh Coalson's avatar
Josh Coalson committed
441
442
443
444
		      </listitem>
		    </varlistentry>

		    <varlistentry>
445
		      <term><option>-6</option>, <option>--compression-level-6</option></term>
Josh Coalson's avatar
Josh Coalson committed
446

Josh Coalson's avatar
Josh Coalson committed
447
		      <listitem>
Josh Coalson's avatar
Josh Coalson committed
448
449
			<para>Synonymous with -l 8 -b 4608 -m -r 4
			  </para>
Josh Coalson's avatar
Josh Coalson committed
450
451
		      </listitem>
		    </varlistentry>
Josh Coalson's avatar
Josh Coalson committed
452

Josh Coalson's avatar
Josh Coalson committed
453
		    <varlistentry>
454
		      <term><option>-7</option>, <option>--compression-level-7</option></term>
Josh Coalson's avatar
Josh Coalson committed
455

Josh Coalson's avatar
Josh Coalson committed
456
		      <listitem>
Josh Coalson's avatar
Josh Coalson committed
457
458
			<para>Synonymous with -l 8 -b 4608 -m -e -r 6
			  </para>
Josh Coalson's avatar
Josh Coalson committed
459
460
		      </listitem>
		    </varlistentry>
Josh Coalson's avatar
Josh Coalson committed
461

Josh Coalson's avatar
Josh Coalson committed
462
		    <varlistentry>
463
		      <term><option>-8</option>, <option>--compression-level-8</option></term>
Josh Coalson's avatar
Josh Coalson committed
464

Josh Coalson's avatar
Josh Coalson committed
465
		      <listitem>
Josh Coalson's avatar
Josh Coalson committed
466
467
			<para>Synonymous with -l 12 -b 4608 -m -e -r 6
			  </para>
Josh Coalson's avatar
Josh Coalson committed
468
469
470
		      </listitem>
		    </varlistentry>
		  </variablelist>
Josh Coalson's avatar
Josh Coalson committed
471

Josh Coalson's avatar
Josh Coalson committed
472
473
474
475
		</listitem>

	      </varlistentry>

Josh Coalson's avatar
Josh Coalson committed
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
	      <varlistentry>
		<term><option>--fast</option></term>

		<listitem>
		  <para>Fastest compression.  Currently
		    synonymous with -0.</para>
		</listitem>
	      </varlistentry>

	      <varlistentry>
		<term><option>--best</option></term>

		<listitem>
		  <para>Highest compression.  Currently
		    synonymous with -8.</para>
		</listitem>
	      </varlistentry>

Josh Coalson's avatar
Josh Coalson committed
494
	      <varlistentry>
495
		<term><option>-e</option>, <option>--exhaustive-model-search</option></term>
Josh Coalson's avatar
Josh Coalson committed
496
497
498
499
500
501
502
503

		<listitem>
		  <para>Do exhaustive model search
		    (expensive!)</para>
		</listitem>
	      </varlistentry>

	      <varlistentry>
504
		<term><option>-l</option> <replaceable>#</replaceable>, <option>--max-lpc-order</option>=<replaceable>#</replaceable></term>
Josh Coalson's avatar
Josh Coalson committed
505
506

		<listitem>
507
		  <para>Set the maximum LPC order; 0 means use only the fixed predictors</para>
Josh Coalson's avatar
Josh Coalson committed
508
509
510
511
		</listitem>
	      </varlistentry>

	      <varlistentry>
512
		<term><option>-p</option>, <option>--qlp-coeff-precision-search</option></term>
Josh Coalson's avatar
Josh Coalson committed
513
514
515

		<listitem>
		  <para>Do exhaustive search of LP coefficient
516
		    quantization (expensive!).  Overrides -q;
Josh Coalson's avatar
Josh Coalson committed
517
		    does nothing if using -l 0</para>
Josh Coalson's avatar
Josh Coalson committed
518
519
520
521
		</listitem>
	      </varlistentry>

	      <varlistentry>
522
		<term><option>-q</option> <replaceable>#</replaceable>, <option>--qlp-coeff-precision</option>=<replaceable>#</replaceable></term>
Josh Coalson's avatar
Josh Coalson committed
523
524
525
526
527
528
529
530
531

		<listitem>
		  <para>Precision of the quantized linear-predictor
		    coefficients, 0 => let encoder decide (min is 5,
		    default is 0)</para>
		</listitem>
	      </varlistentry>

	      <varlistentry>
532
		<term><option>-r</option> [<replaceable>#</replaceable>,]<replaceable>#</replaceable>, <option>--rice-partition-order</option>=[<replaceable>#</replaceable>,]<replaceable>#</replaceable></term>
Josh Coalson's avatar
Josh Coalson committed
533
534
535
536
537
538
539
540

		<listitem>
		  <para>Set the [min,]max residual partition order
		    (0..16). min defaults to 0 if unspecified.  Default
		    is -r 3,3.</para>
		</listitem>
	      </varlistentry>

Josh Coalson's avatar
Josh Coalson committed
541
542
543
544
545
546
547
548
	    </variablelist>

	  </refsect2>
	  <refsect2>
	    <title>Format Options</title>

	    <variablelist>
	      <varlistentry>
549
		<term><option>--endian</option>={<replaceable>big</replaceable>|<replaceable>little</replaceable>}</term>
Josh Coalson's avatar
Josh Coalson committed
550
551

		<listitem>
552
		  <para>Set the byte order for samples</para>
Josh Coalson's avatar
Josh Coalson committed
553
554
555
556
		</listitem>
	      </varlistentry>

	      <varlistentry>
557
		<term><option>--channels</option>=<replaceable>#</replaceable></term>
Josh Coalson's avatar
Josh Coalson committed
558
559
560
561
562
563
564

		<listitem>
		  <para>Set number of channels.</para>
		</listitem>
	      </varlistentry>

	      <varlistentry>
565
		<term><option>--bps</option>=<replaceable>#</replaceable></term>
Josh Coalson's avatar
Josh Coalson committed
566
567
568
569
570
571
572

		<listitem>
		  <para>Set bits per sample.</para>
		</listitem>
	      </varlistentry>

	      <varlistentry>
573
		<term><option>--sample-rate</option>=<replaceable>#</replaceable></term>
Josh Coalson's avatar
Josh Coalson committed
574
575
576
577
578
579
580

		<listitem>
		  <para>Set sample rate (in Hz).</para>
		</listitem>
	      </varlistentry>

	      <varlistentry>
581
		<term><option>--sign</option>={<replaceable>signed</replaceable>|<replaceable>unsigned</replaceable>}</term>
Josh Coalson's avatar
Josh Coalson committed
582
583

		<listitem>
584
		  <para>Set the sign of samples (the default is signed).</para>
Josh Coalson's avatar
Josh Coalson committed
585
586
587
588
		</listitem>
	      </varlistentry>

	      <varlistentry>
589
		<term><option>--force-raw-format</option></term>
Josh Coalson's avatar
Josh Coalson committed
590
591

		<listitem>
592
593
		  <para>Force input (when encoding) or output (when decoding)
		    to be treated as raw samples (even if filename ends
Josh Coalson's avatar
Josh Coalson committed
594
595
596
597
598
599
600
		    in <filename>.wav</filename>).</para>
		</listitem>
	      </varlistentry>

	    </variablelist>
	  </refsect2>

601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
	  <refsect2>
	    <title>Negative Options</title>

	    <variablelist>
	      <varlistentry>
		<term><option>--no-adaptive-mid-side</option></term>
		<term><option>--no-decode-through-errors</option></term>
		<term><option>--no-delete-input-file</option></term>
		<term><option>--no-escape-coding</option></term>
		<term><option>--no-exhaustive-model-search</option></term>
		<term><option>--no-lax</option></term>
		<term><option>--no-mid-side</option></term>
		<term><option>--no-ogg</option></term>
		<term><option>--no-padding</option></term>
		<term><option>--no-qlp-coeff-precision-search</option></term>
		<term><option>--no-residual-gnuplot</option></term>
		<term><option>--no-residual-text</option></term>
		<term><option>--no-sector-align</option></term>
		<term><option>--no-seektable</option></term>
		<term><option>--no-silent</option></term>
		<term><option>--no-verify</option></term>
		<listitem>
		  <para>These flags can be used to invert the sense
		    of the corresponding normal option.</para>
		</listitem>
	      </varlistentry>
	    </variablelist>

	  </refsect2>

Josh Coalson's avatar
Josh Coalson committed
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
	</refsect1>
	  <refsect1>
	    <title>SEE ALSO</title>

	    <para>The programs are documented fully by HTML format
	      documentation, available in
	      <filename>/usr/share/doc/flac/html</filename> on
		&debian; systems.</para>
	  </refsect1>
	  <refsect1>
	    <title>AUTHOR</title>

	    <para>This manual page was written by &dhusername; &dhemail; for
	      the &debian; system (but may be used by others).</para>

	    <!-- <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> -->

	</refsect1>
      </refentry>

	<!-- Keep this comment at the end of the file
	      Local variables:
	      mode: sgml
	      sgml-omittag:t
	      sgml-shorttag:t
	      sgml-minimize-attributes:nil
	      sgml-always-quote-attributes:t
	      sgml-indent-step:2
	      sgml-indent-data:t
	      sgml-parent-document:nil
	      sgml-default-dtd-file:nil
	      sgml-exposed-tags:nil
	      sgml-local-catalogs:nil
	      sgml-local-ecat-files:nil
	      End:
	      -->