c7e73c6883dfdca905acac009b05f6d74dd7a2a2
[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>January 29, 2001</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>2000</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 Coder</refpurpose>
44       </refnamediv>
45         <refsynopsisdiv>
46           <cmdsynopsis>
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>outfile</replaceable></arg>
52           </cmdsynopsis>
53         </refsynopsisdiv>
54         <refsect1>
55           <title>DESCRIPTION</title>
56
57           <para>This manual page documents briefly the
58             <command>flac</command> command.</para>
59
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>
64
65         </refsect1>
66         <refsect1>
67           <title>OPTIONS</title>
68
69           <para>A summary of options is included below.  For a complete
70           description, see the HTML documentation.</para>
71
72           <refsect2>
73             <title>Generic Options</title>
74
75             <variablelist>
76               <varlistentry>
77                 <term><option>-d</option>
78                 </term>
79                 <listitem>
80                   <para>Decode (default behavior is encode)</para>
81                 </listitem>
82               </varlistentry>
83
84               <varlistentry>
85                 <term><option>-t</option>
86                 </term>
87                 <listitem>
88                   <para>Test a flac encoded file (same as -d
89                     except no decoded file is written)</para>
90                 </listitem>
91               </varlistentry>
92
93               <varlistentry>
94                 <term><option>-a</option>
95                 </term>
96                 <listitem>
97                   <para>Analyze a flac encoded file (same as -d
98                     except an analysis file is written)</para>
99                 </listitem>
100               </varlistentry>
101
102               <varlistentry>
103                 <term><option>-s</option>
104                 </term>
105                 <listitem>
106                   <para>Silent mode (do not write runtime
107                     encode/decode statistics to stdout)</para>
108                 </listitem>
109               </varlistentry>
110
111               <varlistentry>
112                 <term><option>--skip</option> <replaceable>samples</replaceable></term>
113                 <listitem>
114                   <para>Skip the specified number of samples at the
115                     beginning of the input file (can be used for both
116                     encoding and decoding)</para>
117                 </listitem>
118               </varlistentry>
119
120             </variablelist>
121           </refsect2>
122
123           <refsect2>
124             <title>Encoding Options</title>
125
126             <variablelist>
127               <varlistentry>
128                 <term><option>--lax</option></term>
129
130                 <listitem>
131                   <para>Allow encoder to generate non-Subset
132                     files</para>
133                 </listitem>
134               </varlistentry>
135
136               <varlistentry>
137                 <term><option>-b</option> <replaceable>blocksize</replaceable></term>
138
139                 <listitem>
140                   <para>Default is 1152 for -l 0, else 4608; should
141                     be 192/576/1152/2304/4608 (unless --lax is
142                     used)</para>
143                 </listitem>
144               </varlistentry>
145
146               <varlistentry>
147                 <term><option>-m</option></term>
148
149                 <listitem>
150                   <para>Try mid-side coding for each frame (stereo
151                     input only)</para>
152                 </listitem>
153               </varlistentry>
154
155               <varlistentry>
156                 <term><option>-m</option></term>
157
158                 <listitem>
159                   <para>Loose mid-side coding for all frames (stereo
160                     input only)</para>
161                 </listitem>
162               </varlistentry>
163
164               <varlistentry>
165                 <term><option>-0</option>..<option>-9</option></term>
166
167                 <listitem>
168                   <para>Fastest compression..highest compression
169                     (default is -6).  These are synonyms for other
170                     options:</para>
171
172                   <variablelist>
173                     <varlistentry>
174                       <term><option>-0</option></term>
175                       
176                       <listitem>
177                         <para>Synonymous with -l 0</para>
178                       </listitem>
179                     </varlistentry>
180                     
181                     <varlistentry>
182                       <term><option>-1</option></term>
183                       
184                       <listitem>
185                         <para>Synonymous with -l 0 -M</para>
186                       </listitem>
187                     </varlistentry>
188                     
189                     <varlistentry>
190                       <term><option>-2</option></term>
191                       
192                       <listitem>
193                         <para>Synonymous with -l 0 -m -r # (# is
194                           automatically determined by the block
195                           size)</para>
196                       </listitem>
197                     </varlistentry>
198
199                     <varlistentry>
200                       <term><option>-3</option></term>
201                       
202                       <listitem>
203                         <para>Reserved</para>
204                       </listitem>
205                     </varlistentry>
206
207                     <varlistentry>
208                       <term><option>-4</option></term>
209                       
210                       <listitem>
211                         <para>Synonymous with -l 8</para>
212                       </listitem>
213                     </varlistentry>
214                     
215                     <varlistentry>
216                       <term><option>-5</option></term>
217                       
218                       <listitem>
219                         <para>Synonymous with -l 8 -M</para>
220                       </listitem>
221                     </varlistentry>
222
223                     <varlistentry>
224                       <term><option>-6</option></term>
225                       
226                       <listitem>
227                         <para>Synonymous with -l 8 -m -r # (# is
228                           automatically determined by the block
229                           size)</para>
230                       </listitem>
231                     </varlistentry>
232                     
233                     <varlistentry>
234                       <term><option>-7</option></term>
235                       
236                       <listitem>
237                         <para>Reserved</para>
238                       </listitem>
239                     </varlistentry>
240                     
241                     <varlistentry>
242                       <term><option>-8</option></term>
243                       
244                       <listitem>
245                         <para>Synonymous with -l 32 -m -r # (# is
246                           automatically determined by the block
247                           size)</para>
248                       </listitem>
249                     </varlistentry>
250                     
251                     <varlistentry>
252                       <term><option>-9</option></term>
253                       
254                       <listitem>
255                         <para>Synonymous with -l 32 -m -e -r 99 -p
256                           (very slow!)</para>
257                       </listitem>
258                     </varlistentry>
259                   </variablelist>
260                   
261                 </listitem>
262
263
264               </varlistentry>
265
266               <varlistentry>
267                 <term><option>-e</option></term>
268
269                 <listitem>
270                   <para>Do exhaustive model search
271                     (expensive!)</para>
272                 </listitem>
273               </varlistentry>
274
275               <varlistentry>
276                 <term><option>-l</option> <replaceable>max_lpc_order</replaceable></term>
277
278                 <listitem>
279                   <para>0 => use only fixed predictors</para>
280                 </listitem>
281               </varlistentry>
282
283               <varlistentry>
284                 <term><option>-p</option></term>
285
286                 <listitem>
287                   <para>Do exhaustive search of LP coefficient
288                     quantization (expensive!).  Overrides -q,
289                     does nothing if using -l 0</para>
290                 </listitem>
291               </varlistentry>
292
293               <varlistentry>
294                 <term><option>-q</option> <replaceable>bits</replaceable></term>
295
296                 <listitem>
297                   <para>Precision of the quantized linear-predictor
298                     coefficients, 0 => let encoder decide (min is 5,
299                     default is 0)</para>
300                 </listitem>
301               </varlistentry>
302
303               <varlistentry>
304                 <term><option>-r</option> <replaceable>level</replaceable></term>
305
306                 <listitem>
307                   <para>Rice parameter optimization level (0..99). 0
308                     => none, default is 0, above 4 doesn't usually
309                     help much)</para>
310                 </listitem>
311               </varlistentry>
312
313               <varlistentry>
314                 <term><option>-V</option></term>
315
316                 <listitem>
317                   <para>Verify a correct encoding by decoding the
318                     output in parallel and comparing to the
319                     original</para>
320                 </listitem>
321               </varlistentry>
322
323               <varlistentry>
324                 <term><option>-m-</option> <option>-M-</option> <option>-e-</option> <option>-p-</option> <option>-V-</option> <option>--lax-</option>
325                 </term>
326
327                 <listitem>
328                   <para>These flags can be used to invert the sense
329                     of the corresponding normal option.</para>
330                 </listitem>
331               </varlistentry>
332             </variablelist>
333
334           </refsect2>
335           <refsect2>
336             <title>Format Options</title>
337
338             <variablelist>
339               <varlistentry>
340                 <term><option>-fb</option></term>
341
342                 <listitem>
343                   <para>Big-endian byte order</para>
344                 </listitem>
345               </varlistentry>
346
347               <varlistentry>
348                 <term><option>-fl</option></term>
349
350                 <listitem>
351                   <para>Little-endian byte order</para>
352                 </listitem>
353               </varlistentry>
354
355               <varlistentry>
356                 <term><option>-fc</option>
357                   <replaceable>channels</replaceable></term>
358
359                 <listitem>
360                   <para>Set number of channels.</para>
361                 </listitem>
362               </varlistentry>
363
364               <varlistentry>
365                 <term><option>-fp</option>
366                   <replaceable>bits_per_sample</replaceable></term>
367
368                 <listitem>
369                   <para>Set bits per sample.</para>
370                 </listitem>
371               </varlistentry>
372
373               <varlistentry>
374                 <term><option>-fs</option>
375                   <replaceable>sample_rate</replaceable></term>
376
377                 <listitem>
378                   <para>Set sample rate (in Hz).</para>
379                 </listitem>
380               </varlistentry>
381
382               <varlistentry>
383                 <term><option>-fu</option></term>
384
385                 <listitem>
386                   <para>Unsigned samples (default is signed)</para>
387                 </listitem>
388               </varlistentry>
389
390               <varlistentry>
391                 <term><option>-fr</option></term>
392
393                 <listitem>
394                   <para>Force to raw format (even if filename ends
395                     in <filename>.wav</filename>).</para>
396                 </listitem>
397               </varlistentry>
398
399               <varlistentry>
400                 <term><option>-fw</option></term>
401
402                 <listitem>
403                   <para>Force to RIFF WAVE.</para>
404                 </listitem>
405               </varlistentry>
406
407             </variablelist>
408           </refsect2>
409
410         </refsect1>
411           <refsect1>
412             <title>SEE ALSO</title>
413
414             <para>The programs are documented fully by HTML format
415               documentation, available in
416               <filename>/usr/share/doc/flac/html</filename> on
417                 &debian; systems.</para>
418           </refsect1>
419           <refsect1>
420             <title>AUTHOR</title>
421
422             <para>This manual page was written by &dhusername; &dhemail; for
423               the &debian; system (but may be used by others).</para>
424
425             <!-- <para>Permission is granted to copy, distribute and/or modify
426             this document under the terms of the <acronym>GNU</acronym> Free
427             Documentation License, Version 1.1 or any later version
428             published by the Free Software Foundation; with no Invariant
429             Sections, no Front-Cover Texts and no Back-Cover Texts.  A copy
430             of the license can be found under
431           <filename>/usr/share/common-licenses/FDL</filename>.</para> -->
432
433         </refsect1>
434       </refentry>
435
436         <!-- Keep this comment at the end of the file
437               Local variables:
438               mode: sgml
439               sgml-omittag:t
440               sgml-shorttag:t
441               sgml-minimize-attributes:nil
442               sgml-always-quote-attributes:t
443               sgml-indent-step:2
444               sgml-indent-data:t
445               sgml-parent-document:nil
446               sgml-default-dtd-file:nil
447               sgml-exposed-tags:nil
448               sgml-local-catalogs:nil
449               sgml-local-ecat-files:nil
450               End:
451               -->