initial import
[flac.git] / man / flac.1
1 .\" This manpage has been automatically generated by docbook2man 
2 .\" from a DocBook document.  This tool can be found at:
3 .\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> 
4 .\" Please send any bug reports, improvements, comments, patches, 
5 .\" etc. to Steve Cheng <steve@ggi-project.org>.
6 .TH "FLAC" "1" "02 July 2002" "" ""
7 .SH NAME
8 flac \- Free Lossless Audio Codec
9 .SH SYNOPSIS
10
11 \fBflac\fR [ \fB\fIOPTION\fB\fR]  \fB\fIinfile\fB\fR \fB\fI...\fB\fR
12
13 .SH "DESCRIPTION"
14 .PP
15 This manual page documents briefly the
16 \fBflac\fR command.
17 .PP
18 This manual page was written for the Debian GNU/Linux
19 distribution because the original program does not have a
20 manual page.  Instead, it has documentation in HTML
21 format; see below.
22 .SH "OPTIONS"
23 .PP
24 A summary of options is included below.  For a complete
25 description, see the HTML documentation.
26 .SS "GENERIC OPTIONS"
27 .TP
28 \fB-H \fR
29 Show detailed help screen
30 .TP
31 \fB-d \fR
32 Decode (default behavior is encode)
33 .TP
34 \fB-c \fR
35 Encode from standard input, or decode to
36 standard output
37 .TP
38 \fB-t \fR
39 Test a flac encoded file (same as -d
40 except no decoded file is written)
41 .TP
42 \fB-a \fR
43 Analyze a flac encoded file (same as -d
44 except an analysis file is written)
45 .TP
46 \fB-s \fR
47 Silent mode (do not write runtime
48 encode/decode statistics to stdout)
49 .TP
50 \fB-o \fIfilename\fB\fR
51 Force the output file name (usually flac just
52 changes the extension).  May only be used when
53 encoding a single file.  May not be used in
54 conjunction with --output-prefix.
55 .TP
56 \fB--output-prefix \fIstring\fB\fR
57 Prefix each output file name with the given
58 string.  This can be useful for encoding/decoding
59 files to a different directory.  Make sure if your
60 string is a path name that it ends with a trailing
61 `/' (slash).
62 .TP
63 \fB--delete-input-file \fR
64 Automatically delete the input file after a
65 successful encode or decode.  If there was an
66 error (including a verify error) the input file
67 is left intact.
68 .TP
69 \fB--skip \fIsamples\fB\fR
70 Skip the specified number of samples at the
71 beginning of the input file (can be used for both
72 encoding and decoding)
73 .SS "ANALYSIS OPTIONS"
74 .TP
75 \fB--a-rtext \fR
76 Includes the residual signal in the analysis
77 file.  This will make the file very big, much
78 larger than even the decoded file.
79 .TP
80 \fB--a-rgp \fR
81 Generates a gnuplot file for every subframe;
82 each file will contain the residual distribution
83 of the subframe.  This will create a lot of
84 files.
85 .SS "DECODING OPTIONS"
86 .TP
87 \fB-F \fR
88 By default flac stops decoding with an error
89 and removes the partially decoded file if it
90 encounters a bitstream error.  With -F, errors are
91 still printed but flac will continue decoding to
92 completion.  Note that errors may cause the decoded
93 audio to be missing some samples or have silent
94 sections.
95 .SS "ENCODING OPTIONS"
96 .TP
97 \fB--ogg\fR
98 When encoding, generate Ogg-FLAC output instead
99 of native-FLAC.  Ogg-FLAC streams are FLAC streams
100 wrapped in an Ogg transport layer.  The resulting
101 file should have an '.ogg' extension and will still
102 be decodable by flac.
103
104 When decoding, force the input to be treated as
105 Ogg-FLAC.  This is useful when piping input from
106 stdin or when the filename does not end in '.ogg'.
107 .TP
108 \fB--lax\fR
109 Allow encoder to generate non-Subset
110 files.
111 .TP
112 \fB--sector-align\fR
113 Align encoding of multiple CD format WAVE
114 files on sector boundaries.  See the HTML
115 documentation for more information.
116 .TP
117 \fB-S \fI{ # | X | #x }\fB\fR
118 Include a point or points in a SEEKTABLE.  Using #,
119 a seek point at that sample number is added.  Using
120 X, a placeholder point is added at the end of a the
121 table.  Using #x, # evenly spaced seek points will
122 be added, the first being at sample 0.  You may use
123 many -S options; the resulting SEEKTABLE will be the
124 unique-ified union of all such values.  With no -S
125 options, flac defaults to '-S 100x'.  Use -S- for
126 no SEEKTABLE.  Note: '-S #x' will not work if the
127 encoder can't determine the input size before
128 starting.  Note: if you use '-S #' and # is >=
129 samples in the input, there will be either no seek
130 point entered (if the input size is determinable
131 before encoding starts) or a placeholder point (if
132 input size is not determinable).
133 .TP
134 \fB-P \fIbytes\fB\fR
135 Tell the encoder to write a PADDING metadata
136 block of the given length (in bytes) after the
137 STREAMINFO block.  This is useful if you plan to
138 tag the file later with an APPLICATION block;
139 instead of having to rewrite the entire file later
140 just to insert your block, you can write directly
141 over the PADDING block.  Note that the total length
142 of the PADDING block will be 4 bytes longer than
143 the length given because of the 4 metadata block
144 header bytes.  You can force no PADDING block at
145 all to be written with -P-, which is the default.
146 .TP
147 \fB-b \fIblocksize\fB\fR
148 Default is 1152 for -l 0, else 4608; must be
149 192/576/1152/2304/4608/256/512/1024/2048/4096/8192/16384/32768
150 (unless --lax is used)
151 .TP
152 \fB-m\fR
153 Try mid-side coding for each frame (stereo
154 input only)
155 .TP
156 \fB-M\fR
157 Loose mid-side coding for all frames (stereo
158 input only)
159 .TP
160 \fB-0..-8\fR
161 Fastest compression..highest compression
162 (default is -5).  These are synonyms for other
163 options:
164 .RS
165 .TP
166 \fB-0\fR
167 Synonymous with -l 0 -b 1152 -r 2,2
168 .TP
169 \fB-1\fR
170 Synonymous with -l 0 -b 1152 -M -r 2,2
171 .TP
172 \fB-2\fR
173 Synonymous with -l 0 -b 1152 -m -r 3
174 .TP
175 \fB-3\fR
176 Synonymous with -l 6 -b 4608 -r 3,3
177 .TP
178 \fB-4\fR
179 Synonymous with -l 8 -b 4608 -M -r 3,3
180 .TP
181 \fB-5\fR
182 Synonymous with -l 8 -b 4608 -m -r 3,3
183 .TP
184 \fB-6\fR
185 Synonymous with -l 8 -b 4608 -m -r 4
186 .TP
187 \fB-7\fR
188 Synonymous with -l 8 -b 4608 -m -e -r 6
189 .TP
190 \fB-8\fR
191 Synonymous with -l 12 -b 4608 -m -e -r 6
192 .RE
193 .TP
194 \fB--fast\fR
195 Fastest compression.  Currently
196 synonymous with -0.
197 .TP
198 \fB--best\fR
199 Highest compression.  Currently
200 synonymous with -8.
201 .TP
202 \fB-e\fR
203 Do exhaustive model search
204 (expensive!)
205 .TP
206 \fB-E\fR
207 Do escape coding in the entropy coder.  This
208 causes the encoder to use an unencoded representation
209 of the residual in a partition if it is smaller.  It
210 increases the runtime and usually results in an
211 improvement of less than 1%.
212 .TP
213 \fB-l \fImax_lpc_order\fB\fR
214 0 => use only fixed predictors
215 .TP
216 \fB-p\fR
217 Do exhaustive search of LP coefficient
218 quantization (expensive!).  Overrides -q,
219 does nothing if using -l 0
220 .TP
221 \fB-q \fIbits\fB\fR
222 Precision of the quantized linear-predictor
223 coefficients, 0 => let encoder decide (min is 5,
224 default is 0)
225 .TP
226 \fB-r \fI[level,]level\fB\fR
227 Set the [min,]max residual partition order
228 (0..16). min defaults to 0 if unspecified.  Default
229 is -r 3,3.
230 .TP
231 \fB-V\fR
232 Verify a correct encoding by decoding the
233 output in parallel and comparing to the
234 original
235 .TP
236 \fB-F- -S- -P- -m- -M- -e- -E- -p- -V- --delete-input-file- --lax- --ogg- \fR
237 These flags can be used to invert the sense
238 of the corresponding normal option.
239 .SS "FORMAT OPTIONS"
240 .TP
241 \fB-fb\fR
242 Big-endian byte order
243 .TP
244 \fB-fl\fR
245 Little-endian byte order
246 .TP
247 \fB-fc \fIchannels\fB\fR
248 Set number of channels.
249 .TP
250 \fB-fp \fIbits_per_sample\fB\fR
251 Set bits per sample.
252 .TP
253 \fB-fs \fIsample_rate\fB\fR
254 Set sample rate (in Hz).
255 .TP
256 \fB-fu\fR
257 Unsigned samples (default is signed)
258 .TP
259 \fB-fr\fR
260 Force to raw format (even if filename ends
261 in \fI.wav\fR).
262 .SH "SEE ALSO"
263 .PP
264 The programs are documented fully by HTML format
265 documentation, available in
266 \fI/usr/share/doc/flac/html\fR on
267 Debian GNU/Linux systems.
268 .SH "AUTHOR"
269 .PP
270 This manual page was written by Matt Zimmerman <mdz@debian.org> for
271 the Debian GNU/Linux system (but may be used by others).