← Back to branch summary

~ubuntu-branches/ubuntu/hoary/flac/hoary

« back to all changes in this revision

Viewing changes to man/flac.sgml

  • Committer: Bazaar Package Importer
  • Author(s): Matt Zimmerman
  • Date: 2004-04-16 15:14:31 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20040416151431-eyloggqxpwbwpogz
Tags: 1.1.0-11
Ensure that libFLAC is linked with -lm on all architectures, and
regardless of whether nasm is present

Show diffs side-by-side

added added

removed removed

Lines of Context:
man/flac.sgml
4
4
  <!ENTITY dhfirstname "<firstname>Matt</firstname>">
5
5
  <!ENTITY dhsurname   "<surname>Zimmerman</surname>">
6
6
  <!-- Please adjust the date whenever revising the manpage. -->
7
 
  <!ENTITY dhdate      "<date>November 15, 2001</date>">
 
7
  <!ENTITY dhdate      "<date>July 26, 2003</date>">
8
8
  <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
9
9
       allowed: see man(7), man(1). -->
10
10
  <!ENTITY dhsection   "<manvolnum>1</manvolnum>">
27
27
        &dhsurname;
28
28
      </author>
29
29
        <copyright>
30
 
                    <year>2001</year>
 
30
                    <year>2002,2003</year>
31
31
                    <holder>&dhusername;</holder>
32
32
        </copyright>
33
33
            &dhdate;
45
45
        <refsynopsisdiv>
46
46
          <cmdsynopsis>
47
47
            <command>flac</command>
48
 
 
49
 
            <arg><option><replaceable>OPTION</replaceable></option></arg>
50
 
            <arg choice=plain><replaceable>infile</replaceable></arg>
51
 
            <arg choice=plain><replaceable>...</replaceable></arg>
 
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>
52
65
          </cmdsynopsis>
53
66
        </refsynopsisdiv>
54
67
        <refsect1>
55
68
          <title>DESCRIPTION</title>
56
69
 
57
 
          <para>This manual page documents briefly the
58
 
            <command>flac</command> command.</para>
 
70
          <para><command>flac</command> is a command-line tool for
 
71
             encoding, decoding, testing and analyzing FLAC streams.
 
72
          </para>
59
73
 
60
 
          <para>This manual page was written for the &debian;
61
 
            distribution because the original program does not have a
62
 
            manual page.  Instead, it has documentation in HTML
63
 
            format; see below.</para>
 
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>
64
77
 
65
78
        </refsect1>
66
79
        <refsect1>
70
83
          description, see the HTML documentation.</para>
71
84
 
72
85
          <refsect2>
73
 
            <title>Generic Options</title>
 
86
            <title>General Options</title>
74
87
 
75
88
            <variablelist>
76
89
              <varlistentry>
77
 
                <term><option>-H</option>
78
 
                </term>
79
 
                <listitem>
80
 
                  <para>Show detailed help screen</para>
81
 
                </listitem>
82
 
              </varlistentry>
83
 
 
84
 
              <varlistentry>
85
 
                <term><option>-d</option>
86
 
                </term>
87
 
                <listitem>
88
 
                  <para>Decode (default behavior is encode)</para>
 
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>
89
136
                </listitem>
90
137
              </varlistentry>
91
138
 
92
139
              <varlistentry>
93
 
                <term><option>-c</option>
 
140
                <term><option>-c</option>, <option>--stdout</option>
94
141
                </term>
95
142
                <listitem>
96
 
                  <para>Encode from standard input, or decode to
97
 
                  standard output</para>
 
143
                  <para>Write output to stdout</para>
98
144
                </listitem>
99
145
              </varlistentry>
100
146
 
101
147
              <varlistentry>
102
 
                <term><option>-t</option>
103
 
                </term>
104
 
                <listitem>
105
 
                  <para>Test a flac encoded file (same as -d
106
 
                    except no decoded file is written)</para>
107
 
                </listitem>
108
 
              </varlistentry>
109
 
 
110
 
              <varlistentry>
111
 
                <term><option>-a</option>
112
 
                </term>
113
 
                <listitem>
114
 
                  <para>Analyze a flac encoded file (same as -d
115
 
                    except an analysis file is written)</para>
116
 
                </listitem>
117
 
              </varlistentry>
118
 
 
119
 
              <varlistentry>
120
 
                <term><option>-s</option>
 
148
                <term><option>-s</option>, <option>--silent</option>
121
149
                </term>
122
150
                <listitem>
123
151
                  <para>Silent mode (do not write runtime
124
 
                    encode/decode statistics to stdout)</para>
 
152
                    encode/decode statistics to stderr)</para>
125
153
                </listitem>
126
154
              </varlistentry>
127
155
 
128
156
              <varlistentry>
129
 
                <term><option>-o</option> <replaceable>filename</replaceable></term>
 
157
                <term><option>-o</option> <replaceable>filename</replaceable>, <option>--output-name</option>=<replaceable>filename</replaceable></term>
130
158
                <listitem>
131
159
                  <para>Force the output file name (usually flac just
132
160
                    changes the extension).  May only be used when
136
164
              </varlistentry>
137
165
 
138
166
              <varlistentry>
139
 
                <term><option>--output-prefix</option> <replaceable>string</replaceable></term>
 
167
                <term><option>--output-prefix</option>=<replaceable>string</replaceable></term>
140
168
                <listitem>
141
169
                  <para>Prefix each output file name with the given
142
 
                    string.  This can be useful for encoding/decoding
 
170
                    string.  This can be useful for encoding or decoding
143
171
                    files to a different directory.  Make sure if your
144
172
                    string is a path name that it ends with a trailing
145
173
                    `/' (slash).</para>
158
186
              </varlistentry>
159
187
 
160
188
              <varlistentry>
161
 
                <term><option>--skip</option> <replaceable>samples</replaceable></term>
162
 
                <listitem>
163
 
                  <para>Skip the specified number of samples at the
164
 
                    beginning of the input file (can be used for both
165
 
                    encoding and decoding)</para>
166
 
                </listitem>
167
 
              </varlistentry>
168
 
 
169
 
            </variablelist>
170
 
          </refsect2>
171
 
 
172
 
          <refsect2>
173
 
            <title>Analysis Options</title>
174
 
 
175
 
            <variablelist>
176
 
              <varlistentry>
177
 
                <term><option>--a-rtext</option>
178
 
                </term>
179
 
                <listitem>
180
 
                  <para>Includes the residual signal in the analysis
181
 
                    file.  This will make the file very big, much
182
 
                    larger than even the decoded file.</para>
183
 
                </listitem>
184
 
              </varlistentry>
185
 
 
186
 
              <varlistentry>
187
 
                <term><option>--a-rgp</option>
188
 
                </term>
189
 
                <listitem>
190
 
                  <para>Generates a gnuplot file for every subframe;
191
 
                    each file will contain the residual distribution
192
 
                    of the subframe.  This will create a lot of
193
 
                    files.</para>
194
 
                </listitem>
195
 
              </varlistentry>
196
 
 
197
 
            </variablelist>
198
 
          </refsect2>
199
 
 
200
 
          <refsect2>
201
 
            <title>Encoding Options</title>
202
 
 
203
 
            <variablelist>
 
189
                <term><option>--skip</option>={<replaceable>#</replaceable>|<replaceable>mm:ss.ss</replaceable>}</term>
 
190
                <listitem>
 
191
                  <para>Skip over the first number of samples of the input.
 
192
                    This works for both encoding and decoding, but not
 
193
                    testing.  The alternative form mm:ss.ss can be used
 
194
                    to specify minutes, seconds, and fractions of a
 
195
                    second.</para>
 
196
                </listitem>
 
197
              </varlistentry>
 
198
 
 
199
              <varlistentry>
 
200
                <term><option>--until</option>={<replaceable>#</replaceable>|[<replaceable>+</replaceable>|<replaceable>-</replaceable>]<replaceable>mm:ss.ss</replaceable>}</term>
 
201
                <listitem>
 
202
                  <para>Stop at the given sample number for each input file.
 
203
                    This works for both encoding and decoding, but not testing.
 
204
                    The given sample number is not included in the decoded
 
205
                    output.  The alternative form mm:ss.ss can be used to
 
206
                    specify minutes, seconds, and fractions of a second.  If a
 
207
                    `+' (plus) sign is at the beginning, the --until point is
 
208
                    relative to the --skip point.  If a `-' (minus) sign is at
 
209
                    the beginning, the --until point is relative to end of the
 
210
                    audio.</para>
 
211
                </listitem>
 
212
              </varlistentry>
 
213
 
204
214
              <varlistentry>
205
215
                <term><option>--ogg</option></term>
206
216
 
217
227
              </varlistentry>
218
228
 
219
229
              <varlistentry>
 
230
                <term><option>--serial-number</option>=<replaceable>#</replaceable></term>
 
231
 
 
232
                <listitem>
 
233
                  <para>When used with --ogg, specifies the serial
 
234
                    number to use for the FLAC stream.  When encoding and
 
235
                    no serial number is given, flac uses '0'.  When
 
236
                    decoding and no number is given, flac uses the serial
 
237
                    number of the first page.</para>
 
238
                </listitem>
 
239
              </varlistentry>
 
240
 
 
241
            </variablelist>
 
242
          </refsect2>
 
243
 
 
244
          <refsect2>
 
245
            <title>Analysis Options</title>
 
246
 
 
247
            <variablelist>
 
248
              <varlistentry>
 
249
                <term><option>--residual-text</option>
 
250
                </term>
 
251
                <listitem>
 
252
                  <para>Includes the residual signal in the analysis
 
253
                    file.  This will make the file very big, much
 
254
                    larger than even the decoded file.</para>
 
255
                </listitem>
 
256
              </varlistentry>
 
257
 
 
258
              <varlistentry>
 
259
                <term><option>--residual-gnuplot</option>
 
260
                </term>
 
261
                <listitem>
 
262
                  <para>Generates a gnuplot file for every subframe;
 
263
                    each file will contain the residual distribution
 
264
                    of the subframe.  This will create a lot of
 
265
                    files.</para>
 
266
                </listitem>
 
267
              </varlistentry>
 
268
 
 
269
            </variablelist>
 
270
          </refsect2>
 
271
 
 
272
          <refsect2>
 
273
            <title>Decoding Options</title>
 
274
 
 
275
            <variablelist>
 
276
              <varlistentry>
 
277
                <term><option>-F</option>, <option>--decode-through-errors</option>
 
278
                </term>
 
279
                <listitem>
 
280
                  <para>By default flac stops decoding with an error
 
281
                    and removes the partially decoded file if it
 
282
                    encounters a bitstream error.  With -F, errors are
 
283
                    still printed but flac will continue decoding to
 
284
                    completion.  Note that errors may cause the decoded
 
285
                    audio to be missing some samples or have silent
 
286
                    sections.</para>
 
287
                </listitem>
 
288
              </varlistentry>
 
289
 
 
290
            </variablelist>
 
291
          </refsect2>
 
292
 
 
293
          <refsect2>
 
294
            <title>Encoding Options</title>
 
295
 
 
296
            <variablelist>
 
297
              <varlistentry>
 
298
                <term><option>-V</option>, <option>--verify</option></term>
 
299
 
 
300
                <listitem>
 
301
                  <para>Verify a correct encoding by decoding the
 
302
                    output in parallel and comparing to the
 
303
                    original</para>
 
304
                </listitem>
 
305
              </varlistentry>
 
306
 
 
307
              <varlistentry>
220
308
                <term><option>--lax</option></term>
221
309
 
222
310
                <listitem>
226
314
              </varlistentry>
227
315
 
228
316
              <varlistentry>
 
317
                <term><option>--replay-gain</option></term>
 
318
 
 
319
                <listitem>
 
320
                  <para>Calculate ReplayGain values and store in
 
321
                    Vorbis comments, similar to vorbisgain.  Title
 
322
                    gains/peaks will be computed for each input
 
323
                    file, and an album gain/peak will be computed
 
324
                    for all files.  All input files must have the
 
325
                    same resolution, sample rate, and number of
 
326
                    channels.  Only mono and stereo files are
 
327
                    allowed, and the sample rate must be one of
 
328
                    8, 11.025, 12, 16, 22.05, 24, 32, 44.1, or 48
 
329
                    kHz.  Also note that this option may leave a
 
330
                    few extra bytes in a PADDING block as the exact
 
331
                    size of the tags is not known until all files
 
332
                    are processed.  Note that this option cannot be
 
333
                    used when encoding to standard output (stdout).
 
334
                    </para>
 
335
                </listitem>
 
336
              </varlistentry>
 
337
 
 
338
              <varlistentry>
 
339
                <term><option>--cuesheet</option>=<replaceable>filename</replaceable></term>
 
340
 
 
341
                <listitem>
 
342
                  <para>Import the given cuesheet file and store it in a
 
343
                    CUESHEET metadata block.  This option may only be used
 
344
                    when encoding a single file.  A seekpoint will be added
 
345
                    for each index point in the cuesheet to the SEEKTABLE
 
346
                    unless --no-cued-seekpoints is specified.</para>
 
347
                </listitem>
 
348
              </varlistentry>
 
349
 
 
350
              <varlistentry>
229
351
                <term><option>--sector-align</option></term>
230
352
 
231
353
                <listitem>
236
358
              </varlistentry>
237
359
 
238
360
              <varlistentry>
239
 
                <term><option>-S</option> <replaceable>{ # | X | #x }</replaceable></term>
 
361
                <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>
240
362
 
241
363
                <listitem>
242
364
                  <para>
244
366
                    a seek point at that sample number is added.  Using
245
367
                    X, a placeholder point is added at the end of a the
246
368
                    table.  Using #x, # evenly spaced seek points will
247
 
                    be added, the first being at sample 0.  You may use
 
369
                    be added, the first being at sample 0.  Using #s, a
 
370
                    seekpoint will be added every # seconds (# does not
 
371
                    have to be a whole number; it can be, for example, 9.5,
 
372
                    meaning a seekpoint every 9.5 seconds).  You may use
248
373
                    many -S options; the resulting SEEKTABLE will be the
249
374
                    unique-ified union of all such values.  With no -S
250
 
                    options, flac defaults to '-S 100x'.  Use -S- for
251
 
                    no SEEKTABLE.  Note: '-S #x' will not work if the
252
 
                    encoder can't determine the input size before
 
375
                    options, flac defaults to '-S 10s'.  Use --no-seektable
 
376
                    for no SEEKTABLE.  Note: '-S #x' and '-S #s' will not
 
377
                    work if the encoder can't determine the input size before
253
378
                    starting.  Note: if you use '-S #' and # is >=
254
379
                    samples in the input, there will be either no seek
255
380
                    point entered (if the input size is determinable
259
384
              </varlistentry>
260
385
 
261
386
              <varlistentry>
262
 
                <term><option>-P</option> <replaceable>bytes</replaceable></term>
 
387
                <term><option>-P</option> <replaceable>#</replaceable>, <option>--padding</option>=<replaceable>#</replaceable></term>
263
388
 
264
389
                <listitem>
265
390
                  <para>Tell the encoder to write a PADDING metadata
266
391
                    block of the given length (in bytes) after the
267
 
                    STREAMINFO block.  -P 0 implies no PADDING block,
268
 
                    which is the default.  This is useful if you plan
269
 
                    to tag the file later with an APPLICATION block;
 
392
                    STREAMINFO block.  This is useful if you plan to
 
393
                    tag the file later with an APPLICATION block;
270
394
                    instead of having to rewrite the entire file later
271
395
                    just to insert your block, you can write directly
272
 
                    over the PADDING block.</para>
273
 
                </listitem>
274
 
              </varlistentry>
275
 
 
276
 
              <varlistentry>
277
 
                <term><option>-b</option> <replaceable>blocksize</replaceable></term>
278
 
 
279
 
                <listitem>
280
 
                  <para>Default is 1152 for -l 0, else 4608; must be
281
 
                    192/576/1152/2304/4608/256/512/1024/2048/4096/8192/16384/32768
282
 
                    (unless --lax is used)</para>
283
 
                </listitem>
284
 
              </varlistentry>
285
 
 
286
 
              <varlistentry>
287
 
                <term><option>-m</option></term>
 
396
                    over the PADDING block.  Note that the total length
 
397
                    of the PADDING block will be 4 bytes longer than
 
398
                    the length given because of the 4 metadata block
 
399
                    header bytes.  You can force no PADDING block at
 
400
                    all to be written with --no-padding.  The encoder
 
401
                    writes a PADDING block of 4096 bytes by default.
 
402
                    </para>
 
403
                </listitem>
 
404
              </varlistentry>
 
405
 
 
406
              <varlistentry>
 
407
                <term><option>-T</option> <replaceable>FIELD=VALUE</replaceable>, <option>--tag</option>=<replaceable>FIELD=VALUE</replaceable></term>
 
408
 
 
409
                <listitem>
 
410
                  <para>Add a Vorbis comment.  The comment must adhere
 
411
                    to the Vorbis comment spec; i.e. the FIELD must
 
412
                    contain only legal characters, terminated by an
 
413
                    'equals' sign.  Make sure to quote the comment if
 
414
                    necessary.  This option may appear more than once
 
415
                    to add several comments.  NOTE: all tags will be
 
416
                    added to all encoded files.</para>
 
417
                </listitem>
 
418
              </varlistentry>
 
419
 
 
420
              <varlistentry>
 
421
                <term><option>-b</option> <replaceable>#</replaceable>, <option>--blocksize</option>=<replaceable>#</replaceable></term>
 
422
 
 
423
                <listitem>
 
424
                  <para>Specify the block size in samples.  The
 
425
                    default is 1152 for -l 0, else 4608; must be one of
 
426
                    192, 576, 1152, 2304, 4608, 256, 512, 1024, 2048,
 
427
                    4096, 8192, 16384, or 32768 (unless --lax is used)</para>
 
428
                </listitem>
 
429
              </varlistentry>
 
430
 
 
431
              <varlistentry>
 
432
                <term><option>-m</option>, <option>--mid-side</option></term>
288
433
 
289
434
                <listitem>
290
435
                  <para>Try mid-side coding for each frame (stereo
293
438
              </varlistentry>
294
439
 
295
440
              <varlistentry>
296
 
                <term><option>-M</option></term>
 
441
                <term><option>-M</option>, <option>--adaptive-mid-side</option></term>
297
442
 
298
443
                <listitem>
299
 
                  <para>Loose mid-side coding for all frames (stereo
 
444
                  <para>Adaptive mid-side coding for all frames (stereo
300
445
                    input only)</para>
301
446
                </listitem>
302
447
              </varlistentry>
303
448
 
304
449
              <varlistentry>
305
 
                <term><option>-0</option>..<option>-8</option></term>
 
450
                <term><option>-0</option>..<option>-8</option>, <option>--compression-level-0</option>..<option>--compression-level-8</option></term>
306
451
 
307
452
                <listitem>
308
453
                  <para>Fastest compression..highest compression
311
456
 
312
457
                  <variablelist>
313
458
                    <varlistentry>
314
 
                      <term><option>-0</option></term>
 
459
                      <term><option>-0</option>, <option>--compression-level-0</option></term>
315
460
 
316
461
                      <listitem>
317
462
                        <para>Synonymous with -l 0 -b 1152 -r 2,2
320
465
                    </varlistentry>
321
466
 
322
467
                    <varlistentry>
323
 
                      <term><option>-1</option></term>
 
468
                      <term><option>-1</option>, <option>--compression-level-1</option></term>
324
469
 
325
470
                      <listitem>
326
471
                        <para>Synonymous with -l 0 -b 1152 -M -r 2,2
329
474
                    </varlistentry>
330
475
 
331
476
                    <varlistentry>
332
 
                      <term><option>-2</option></term>
 
477
                      <term><option>-2</option>, <option>--compression-level-2</option></term>
333
478
 
334
479
                      <listitem>
335
480
                        <para>Synonymous with -l 0 -b 1152 -m -r 3
338
483
                    </varlistentry>
339
484
 
340
485
                    <varlistentry>
341
 
                      <term><option>-3</option></term>
 
486
                      <term><option>-3</option>, <option>--compression-level-3</option></term>
342
487
 
343
488
                      <listitem>
344
489
                        <para>Synonymous with -l 6 -b 4608 -r 3,3
347
492
                    </varlistentry>
348
493
 
349
494
                    <varlistentry>
350
 
                      <term><option>-4</option></term>
 
495
                      <term><option>-4</option>, <option>--compression-level-4</option></term>
351
496
 
352
497
                      <listitem>
353
498
                        <para>Synonymous with -l 8 -b 4608 -M -r 3,3
356
501
                    </varlistentry>
357
502
 
358
503
                    <varlistentry>
359
 
                      <term><option>-5</option></term>
 
504
                      <term><option>-5</option>, <option>--compression-level-5</option></term>
360
505
 
361
506
                      <listitem>
362
507
                        <para>Synonymous with -l 8 -b 4608 -m -r 3,3
365
510
                    </varlistentry>
366
511
 
367
512
                    <varlistentry>
368
 
                      <term><option>-6</option></term>
 
513
                      <term><option>-6</option>, <option>--compression-level-6</option></term>
369
514
 
370
515
                      <listitem>
371
516
                        <para>Synonymous with -l 8 -b 4608 -m -r 4
374
519
                    </varlistentry>
375
520
 
376
521
                    <varlistentry>
377
 
                      <term><option>-7</option></term>
 
522
                      <term><option>-7</option>, <option>--compression-level-7</option></term>
378
523
 
379
524
                      <listitem>
380
525
                        <para>Synonymous with -l 8 -b 4608 -m -e -r 6
383
528
                    </varlistentry>
384
529
 
385
530
                    <varlistentry>
386
 
                      <term><option>-8</option></term>
 
531
                      <term><option>-8</option>, <option>--compression-level-8</option></term>
387
532
 
388
533
                      <listitem>
389
534
                        <para>Synonymous with -l 12 -b 4608 -m -e -r 6
394
539
 
395
540
                </listitem>
396
541
 
397
 
 
398
 
              </varlistentry>
399
 
 
400
 
              <varlistentry>
401
 
                <term><option>-e</option></term>
 
542
              </varlistentry>
 
543
 
 
544
              <varlistentry>
 
545
                <term><option>--fast</option></term>
 
546
 
 
547
                <listitem>
 
548
                  <para>Fastest compression.  Currently
 
549
                    synonymous with -0.</para>
 
550
                </listitem>
 
551
              </varlistentry>
 
552
 
 
553
              <varlistentry>
 
554
                <term><option>--best</option></term>
 
555
 
 
556
                <listitem>
 
557
                  <para>Highest compression.  Currently
 
558
                    synonymous with -8.</para>
 
559
                </listitem>
 
560
              </varlistentry>
 
561
 
 
562
              <varlistentry>
 
563
                <term><option>-e</option>, <option>--exhaustive-model-search</option></term>
402
564
 
403
565
                <listitem>
404
566
                  <para>Do exhaustive model search
407
569
              </varlistentry>
408
570
 
409
571
              <varlistentry>
410
 
                <term><option>-E</option></term>
411
 
 
412
 
                <listitem>
413
 
                  <para>Do escape coding in the entropy coder.  This
414
 
                    causes the encoder to use an unencoded representation
415
 
                    of the residual in a partition if it is smaller.  It
416
 
                    increases the runtime and usually results in an
417
 
                    improvement of less than 1%.</para>
418
 
                </listitem>
419
 
              </varlistentry>
420
 
 
421
 
              <varlistentry>
422
 
                <term><option>-l</option> <replaceable>max_lpc_order</replaceable></term>
423
 
 
424
 
                <listitem>
425
 
                  <para>0 => use only fixed predictors</para>
426
 
                </listitem>
427
 
              </varlistentry>
428
 
 
429
 
              <varlistentry>
430
 
                <term><option>-p</option></term>
 
572
                <term><option>-l</option> <replaceable>#</replaceable>, <option>--max-lpc-order</option>=<replaceable>#</replaceable></term>
 
573
 
 
574
                <listitem>
 
575
                  <para>Set the maximum LPC order; 0 means use only the fixed predictors</para>
 
576
                </listitem>
 
577
              </varlistentry>
 
578
 
 
579
              <varlistentry>
 
580
                <term><option>-p</option>, <option>--qlp-coeff-precision-search</option></term>
431
581
 
432
582
                <listitem>
433
583
                  <para>Do exhaustive search of LP coefficient
434
 
                    quantization (expensive!).  Overrides -q,
 
584
                    quantization (expensive!).  Overrides -q;
435
585
                    does nothing if using -l 0</para>
436
586
                </listitem>
437
587
              </varlistentry>
438
588
 
439
589
              <varlistentry>
440
 
                <term><option>-q</option> <replaceable>bits</replaceable></term>
 
590
                <term><option>-q</option> <replaceable>#</replaceable>, <option>--qlp-coeff-precision</option>=<replaceable>#</replaceable></term>
441
591
 
442
592
                <listitem>
443
593
                  <para>Precision of the quantized linear-predictor
447
597
              </varlistentry>
448
598
 
449
599
              <varlistentry>
450
 
                <term><option>-r</option> <replaceable>[level,]level</replaceable></term>
 
600
                <term><option>-r</option> [<replaceable>#</replaceable>,]<replaceable>#</replaceable>, <option>--rice-partition-order</option>=[<replaceable>#</replaceable>,]<replaceable>#</replaceable></term>
451
601
 
452
602
                <listitem>
453
603
                  <para>Set the [min,]max residual partition order
456
606
                </listitem>
457
607
              </varlistentry>
458
608
 
459
 
              <varlistentry>
460
 
                <term><option>-R</option> <replaceable>#</replaceable></term>
461
 
 
462
 
                <listitem>
463
 
                  <para>Set the Rice parameter search distance.
464
 
                    Default is 0.</para>
465
 
                </listitem>
466
 
              </varlistentry>
467
 
 
468
 
              <varlistentry>
469
 
                <term><option>-V</option></term>
470
 
 
471
 
                <listitem>
472
 
                  <para>Verify a correct encoding by decoding the
473
 
                    output in parallel and comparing to the
474
 
                    original</para>
475
 
                </listitem>
476
 
              </varlistentry>
477
 
 
478
 
              <varlistentry>
479
 
                <term><option>-S-</option> <option>-m-</option> <option>-M-</option> <option>-e-</option> <option>-E-</option> <option>-p-</option> <option>-V-</option> <option>--delete-input-file-</option> <option>--lax-</option> <option>--ogg-</option>
480
 
                </term>
481
 
 
482
 
                <listitem>
483
 
                  <para>These flags can be used to invert the sense
484
 
                    of the corresponding normal option.</para>
485
 
                </listitem>
486
 
              </varlistentry>
487
609
            </variablelist>
488
610
 
489
611
          </refsect2>
492
614
 
493
615
            <variablelist>
494
616
              <varlistentry>
495
 
                <term><option>-fb</option></term>
496
 
 
497
 
                <listitem>
498
 
                  <para>Big-endian byte order</para>
499
 
                </listitem>
500
 
              </varlistentry>
501
 
 
502
 
              <varlistentry>
503
 
                <term><option>-fl</option></term>
504
 
 
505
 
                <listitem>
506
 
                  <para>Little-endian byte order</para>
507
 
                </listitem>
508
 
              </varlistentry>
509
 
 
510
 
              <varlistentry>
511
 
                <term><option>-fc</option>
512
 
                  <replaceable>channels</replaceable></term>
 
617
                <term><option>--endian</option>={<replaceable>big</replaceable>|<replaceable>little</replaceable>}</term>
 
618
 
 
619
                <listitem>
 
620
                  <para>Set the byte order for samples</para>
 
621
                </listitem>
 
622
              </varlistentry>
 
623
 
 
624
              <varlistentry>
 
625
                <term><option>--channels</option>=<replaceable>#</replaceable></term>
513
626
 
514
627
                <listitem>
515
628
                  <para>Set number of channels.</para>
517
630
              </varlistentry>
518
631
 
519
632
              <varlistentry>
520
 
                <term><option>-fp</option>
521
 
                  <replaceable>bits_per_sample</replaceable></term>
 
633
                <term><option>--bps</option>=<replaceable>#</replaceable></term>
522
634
 
523
635
                <listitem>
524
636
                  <para>Set bits per sample.</para>
526
638
              </varlistentry>
527
639
 
528
640
              <varlistentry>
529
 
                <term><option>-fs</option>
530
 
                  <replaceable>sample_rate</replaceable></term>
 
641
                <term><option>--sample-rate</option>=<replaceable>#</replaceable></term>
531
642
 
532
643
                <listitem>
533
644
                  <para>Set sample rate (in Hz).</para>
535
646
              </varlistentry>
536
647
 
537
648
              <varlistentry>
538
 
                <term><option>-fu</option></term>
539
 
 
540
 
                <listitem>
541
 
                  <para>Unsigned samples (default is signed)</para>
542
 
                </listitem>
543
 
              </varlistentry>
544
 
 
545
 
              <varlistentry>
546
 
                <term><option>-fr</option></term>
547
 
 
548
 
                <listitem>
549
 
                  <para>Force to raw format (even if filename ends
 
649
                <term><option>--sign</option>={<replaceable>signed</replaceable>|<replaceable>unsigned</replaceable>}</term>
 
650
 
 
651
                <listitem>
 
652
                  <para>Set the sign of samples (the default is signed).</para>
 
653
                </listitem>
 
654
              </varlistentry>
 
655
 
 
656
              <varlistentry>
 
657
                <term><option>--force-aiff-format</option></term>
 
658
 
 
659
                <listitem>
 
660
                  <para>Force the decoder to output AIFF format.  This option
 
661
                    is not needed if the output filename (as set by -o) ends
 
662
                    with <filename>.aiff</filename>.  Also, this option has no
 
663
                    effect when encoding since input AIFF is auto-detected.</para>
 
664
                </listitem>
 
665
              </varlistentry>
 
666
 
 
667
              <varlistentry>
 
668
                <term><option>--force-raw-format</option></term>
 
669
 
 
670
                <listitem>
 
671
                  <para>Force input (when encoding) or output (when decoding)
 
672
                    to be treated as raw samples (even if filename ends
550
673
                    in <filename>.wav</filename>).</para>
551
674
                </listitem>
552
675
              </varlistentry>
554
677
            </variablelist>
555
678
          </refsect2>
556
679
 
 
680
          <refsect2>
 
681
            <title>Negative Options</title>
 
682
 
 
683
            <variablelist>
 
684
              <varlistentry>
 
685
                <term><option>--no-adaptive-mid-side</option></term>
 
686
                <term><option>--no-decode-through-errors</option></term>
 
687
                <term><option>--no-delete-input-file</option></term>
 
688
                <term><option>--no-exhaustive-model-search</option></term>
 
689
                <term><option>--no-lax</option></term>
 
690
                <term><option>--no-mid-side</option></term>
 
691
                <term><option>--no-ogg</option></term>
 
692
                <term><option>--no-padding</option></term>
 
693
                <term><option>--no-qlp-coeff-precision-search</option></term>
 
694
                <term><option>--no-residual-gnuplot</option></term>
 
695
                <term><option>--no-residual-text</option></term>
 
696
                <term><option>--no-sector-align</option></term>
 
697
                <term><option>--no-seektable</option></term>
 
698
                <term><option>--no-silent</option></term>
 
699
                <term><option>--no-verify</option></term>
 
700
                <listitem>
 
701
                  <para>These flags can be used to invert the sense
 
702
                    of the corresponding normal option.</para>
 
703
                </listitem>
 
704
              </varlistentry>
 
705
            </variablelist>
 
706
 
 
707
          </refsect2>
 
708
 
557
709
        </refsect1>
558
710
          <refsect1>
559
711
            <title>SEE ALSO</title>
560
712
 
 
713
            <para>metaflac(1).</para>
 
714
 
561
715
            <para>The programs are documented fully by HTML format
562
716
              documentation, available in
563
717
              <filename>/usr/share/doc/flac/html</filename> on