Fix option names in documentation and help messages.
[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" "Nov 4, 2006" "" ""
7
8 .SH NAME
9 flac \- Free Lossless Audio Codec
10 .SH SYNOPSIS
11
12 \fBflac\fR [ \fB\fIOPTIONS\fB\fR ] [ \fB\fIinfile.wav\fB\fR | \fB\fIinfile.rf64\fB\fR | \fB\fIinfile.aiff\fB\fR | \fB\fIinfile.raw\fB\fR | \fB\fIinfile.flac\fB\fR | \fB\fIinfile.oga\fB\fR | \fB\fIinfile.ogg\fB\fR | \fB-\fR\fI ...\fR ]
13
14
15 \fBflac\fR [ \fB-d\fR | \fB--decode\fR | \fB-t\fR | \fB--test\fR | \fB-a\fR | \fB--analyze\fR ] [ \fB\fIOPTIONS\fB\fR ] [ \fB\fIinfile.flac\fB\fR | \fB\fIinfile.oga\fB\fR | \fB\fIinfile.ogg\fB\fR | \fB-\fR\fI ...\fR ]
16
17 .SH "DESCRIPTION"
18 .PP
19 \fBflac\fR is a command-line tool for encoding, decoding, testing and analyzing FLAC streams.
20 .SH "OPTIONS"
21 .PP
22 A summary of options is included below.  For a complete
23 description, see the HTML documentation.
24 .SS "GENERAL OPTIONS"
25 .TP
26 \fB-v, --version\fR
27 Show the flac version number
28 .TP
29 \fB-h, --help \fR
30 Show basic usage and a list of all options
31 .TP
32 \fB-H, --explain \fR
33 Show detailed explanation of usage and all options
34 .TP
35 \fB-d, --decode \fR
36 Decode (the default behavior is to encode)
37 .TP
38 \fB-t, --test \fR
39 Test a flac encoded file (same as -d except no decoded file is written)
40 .TP
41 \fB-a, --analyze \fR
42 Analyze a FLAC encoded file (same as -d except an analysis file is written)
43 .TP
44 \fB-c, --stdout \fR
45 Write output to stdout
46 .TP
47 \fB-s, --silent \fR
48 Silent mode (do not write runtime encode/decode statistics to stderr)
49 .TP
50 \fB--totally-silent \fR
51 Do not print anything of any kind, including warnings or errors.  The exit code will be the only way to determine successful completion.
52 .TP
53 \fB--no-utf8-convert \fR
54 Do not convert tags from local charset to UTF-8.  This is useful for scripts, and setting tags in situations where the locale is wrong.  This option must appear before any tag options!
55 .TP
56 \fB-w, --warnings-as-errors \fR
57 Treat all warnings as errors (which cause flac to terminate with a non-zero exit code).
58 .TP
59 \fB-f, --force \fR
60 Force overwriting of output files.  By default, flac warns that the output file already exists and continues to the next file.
61 .TP
62 \fB-o \fIfilename\fB, --output-name=\fIfilename\fB\fR
63 Force the output file name (usually flac just changes the extension).  May only be used when encoding a single file.  May not be used in conjunction with --output-prefix.
64 .TP
65 \fB--output-prefix=\fIstring\fB\fR
66 Prefix each output file name with the given string.  This can be useful for encoding or decoding files to a different directory.  Make sure if your string is a path name that it ends with a trailing `/' (slash).
67 .TP
68 \fB--delete-input-file \fR
69 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.
70 .TP
71 \fB--preserve-modtime \fR
72 Output files have their timestamps/permissions set to match those of their inputs (this is default).  Use --no-preserve-modtime to make output files have the current time and default permissions.
73 .TP
74 \fB--keep-foreign-metadata \fR
75 If encoding, save WAVE, RF64, or AIFF non-audio chunks in FLAC metadata.  If decoding, restore any saved non-audio chunks from FLAC metadata when writing the decoded file.  Foreign metadata cannot be transcoded, e.g. WAVE chunks saved in a FLAC file cannot be restored when decoding to AIFF.  Input and output must be regular files (not stdin or stdout).
76 .TP
77 \fB--skip={\fI#\fB|\fImm:ss.ss\fB}\fR
78 Skip over the first number of samples of the input.  This works for both encoding and decoding, but not testing.  The alternative form mm:ss.ss can be used to specify minutes, seconds, and fractions of a second.
79 .TP
80 \fB--until={\fI#\fB|[\fI+\fB|\fI-\fB]\fImm:ss.ss\fB}\fR
81 Stop at the given sample number for each input file.  This works for both encoding and decoding, but not testing.  The given sample number is not included in the decoded output.  The alternative form mm:ss.ss can be used to specify minutes, seconds, and fractions of a second.  If a `+' (plus) sign is at the beginning, the --until point is relative to the --skip point.  If a `-' (minus) sign is at the beginning, the --until point is relative to end of the audio.
82 .TP
83 \fB--ogg\fR
84 When encoding, generate Ogg FLAC output instead of native FLAC.  Ogg FLAC streams are FLAC streams wrapped in an Ogg transport layer.  The resulting file should have an '.oga' extension and will still be decodable by flac.
85
86 When decoding, force the input to be treated as Ogg FLAC.  This is useful when piping input from stdin or when the filename does not end in '.oga' or '.ogg'.
87 .TP
88 \fB--serial-number=\fI#\fB\fR
89 When used with --ogg, specifies the serial number to use for the first Ogg FLAC stream, which is then incremented for each additional stream.  When encoding and no serial number is given, flac uses a random number for the first stream, then increments it for each additional stream.  When decoding and no number is given, flac uses the serial number of the first page.
90 .SS "ANALYSIS OPTIONS"
91 .TP
92 \fB--residual-text \fR
93 Includes the residual signal in the analysis file.  This will make the file very big, much larger than even the decoded file.
94 .TP
95 \fB--residual-gnuplot \fR
96 Generates a gnuplot file for every subframe; each file will contain the residual distribution of the subframe.  This will create a lot of files.
97 .SS "DECODING OPTIONS"
98 .TP
99 \fB--cue=[\fI#.#\fB][-[\fI#.#\fB]]\fR
100 Set the beginning and ending cuepoints to decode.  The optional first #.# is the track and index point at which decoding will start; the default is the beginning of the stream.  The optional second #.# is the track and index point at which decoding will end; the default is the end of the stream.  If the cuepoint does not exist, the closest one before it (for the start point) or after it (for the end point) will be used.  If those don't exist, the start of the stream (for the start point) or end of the stream (for the end point) will be used.  The cuepoints are merely translated into sample numbers then used as --skip and --until.  A CD track can always be cued by, for example, --cue=9.1-10.1 for track 9, even if the CD has no 10th track.
101 .TP
102 \fB-F, --decode-through-errors \fR
103 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.
104 .SS "ENCODING OPTIONS"
105 .TP
106 \fB-V, --verify\fR
107 Verify a correct encoding by decoding the output in parallel and comparing to the original
108 .TP
109 \fB--lax\fR
110 Allow encoder to generate non-Subset files.  The resulting FLAC file may not be streamable or might have trouble being played in all players (especially hardware devices), so you should only use this option in combination with custom encoding options meant for archival.
111 .TP
112 \fB--replay-gain\fR
113 Calculate ReplayGain values and store them as FLAC tags, similar to vorbisgain.  Title gains/peaks will be computed for each input file, and an album gain/peak will be computed for all files.  All input files must have the same resolution, sample rate, and number of channels.  Only mono and stereo files are allowed, and the sample rate must be one of 8, 11.025, 12, 16, 22.05, 24, 32, 44.1, or 48 kHz.  Also note that this option may leave a few extra bytes in a PADDING block as the exact size of the tags is not known until all files are processed.  Note that this option cannot be used when encoding to standard output (stdout).
114 .TP
115 \fB--cuesheet=\fIfilename\fB\fR
116 Import the given cuesheet file and store it in a CUESHEET metadata block.  This option may only be used when encoding a single file.  A seekpoint will be added for each index point in the cuesheet to the SEEKTABLE unless --no-cued-seekpoints is specified.
117 .TP
118 \fB--picture={\fIFILENAME\fB|\fISPECIFICATION\fB}\fR
119 Import a picture and store it in a PICTURE metadata block.  More than one --picture command can be specified.  Either a filename for the picture file or a more complete specification form can be used.  The SPECIFICATION is a string whose parts are separated by | (pipe) characters.  Some parts may be left empty to invoke default values.  FILENAME is just shorthand for "||||FILENAME".  The format of SPECIFICATION is
120
121 [TYPE]|[MIME-TYPE]|[DESCRIPTION]|[WIDTHxHEIGHTxDEPTH[/COLORS]]|FILE
122
123 TYPE is optional; it is a number from one of:
124
125 0: Other
126
127 1: 32x32 pixels 'file icon' (PNG only)
128
129 2: Other file icon
130
131 3: Cover (front)
132
133 4: Cover (back)
134
135 5: Leaflet page
136
137 6: Media (e.g. label side of CD)
138
139 7: Lead artist/lead performer/soloist
140
141 8: Artist/performer
142
143 9: Conductor
144
145 10: Band/Orchestra
146
147 11: Composer
148
149 12: Lyricist/text writer
150
151 13: Recording Location
152
153 14: During recording
154
155 15: During performance
156
157 16: Movie/video screen capture
158
159 17: A bright coloured fish
160
161 18: Illustration
162
163 19: Band/artist logotype
164
165 20: Publisher/Studio logotype
166
167 The default is 3 (front cover).  There may only be one picture each of type 1 and 2 in a file.
168
169 MIME-TYPE is optional; if left blank, it will be detected from the file.  For best compatibility with players, use pictures with MIME type image/jpeg or image/png.  The MIME type can also be --> to mean that FILE is actually a URL to an image, though this use is discouraged.
170
171 DESCRIPTION is optional; the default is an empty string.
172
173 The next part specfies the resolution and color information.  If the MIME-TYPE is image/jpeg, image/png, or image/gif, you can usually leave this empty and they can be detected from the file.  Otherwise, you must specify the width in pixels, height in pixels, and color depth in bits-per-pixel.  If the image has indexed colors you should also specify the number of colors used.  When manually specified, it is not checked against the file for accuracy.
174
175 FILE is the path to the picture file to be imported, or the URL if MIME type is -->
176
177 For example, "|image/jpeg|||../cover.jpg" will embed the JPEG file at ../cover.jpg, defaulting to type 3 (front cover) and an empty description.  The resolution and color info will be retrieved from the file itself.
178
179 The specification "4|-->|CD|320x300x24/173|http://blah.blah/backcover.tiff" will embed the given URL, with type 4 (back cover), description "CD", and a manually specified resolution of 320x300, 24 bits-per-pixel, and 173 colors.  The file at the URL will not be fetched; the URL itself is stored in the PICTURE metadata block.
180 .TP
181 \fB--sector-align\fR
182 Align encoding of multiple CD format files on sector boundaries.  See the HTML documentation for more information.  This option is DEPRECATED and may not exist in future versions of flac.
183 .TP
184 \fB-S {\fI#\fB|\fIX\fB|\fI#x\fB|\fI#s\fB}, --seekpoint={\fI#\fB|\fIX\fB|\fI#x\fB|\fI#s\fB}\fR
185 Include a point or points in a SEEKTABLE.  Using #, a seek point at that sample number is added.  Using X, a placeholder point is added at the end of a the table.  Using #x, # evenly spaced seek points will be added, the first being at sample 0.  Using #s, a seekpoint will be added every # seconds (# does not have to be a whole number; it can be, for example, 9.5, meaning a seekpoint every 9.5 seconds).  You may use many -S options; the resulting SEEKTABLE will be the unique-ified union of all such values.  With no -S options, flac defaults to '-S 10s'.  Use --no-seektable for no SEEKTABLE.  Note: '-S #x' and '-S #s' will not work if the encoder can't determine the input size before starting.  Note: if you use '-S #' and # is >= samples in the input, there will be either no seek point entered (if the input size is determinable before encoding starts) or a placeholder point (if input size is not determinable).
186 .TP
187 \fB-P \fI#\fB, --padding=\fI#\fB\fR
188 Tell the encoder to write a PADDING metadata block of the given length (in bytes) after the STREAMINFO block.  This is useful if you plan to tag the file later with an APPLICATION block; instead of having to rewrite the entire file later just to insert your block, you can write directly over the PADDING block.  Note that the total length of the PADDING block will be 4 bytes longer than the length given because of the 4 metadata block header bytes.  You can force no PADDING block at all to be written with --no-padding.  The encoder writes a PADDING block of 8192 bytes by default (or 65536 bytes if the input audio stream is more that 20 minutes long).
189 .TP
190 \fB-T \fIFIELD=VALUE\fB, --tag=\fIFIELD=VALUE\fB\fR
191 Add a FLAC tag.  The comment must adhere to the Vorbis comment spec; i.e. the FIELD must contain only legal characters, terminated by an 'equals' sign.  Make sure to quote the comment if necessary.  This option may appear more than once to add several comments.  NOTE: all tags will be added to all encoded files.
192 .TP
193 \fB--tag-from-file=\fIFIELD=FILENAME\fB\fR
194 Like --tag, except FILENAME is a file whose contents will be read verbatim to set the tag value.  The contents will be converted to UTF-8 from the local charset.  This can be used to store a cuesheet in a tag (e.g.  --tag-from-file="CUESHEET=image.cue").  Do not try to store binary data in tag fields!  Use APPLICATION blocks for that.
195 .TP
196 \fB-b \fI#\fB, --blocksize=\fI#\fB\fR
197 Specify the block size in samples.  Subset streams must use one of 192, 576, 1152, 2304, 4608, 256, 512, 1024, 2048, 4096 (and 8192 or 16384 if the sample rate is >48kHz).
198 .TP
199 \fB-m, --mid-side\fR
200 Try mid-side coding for each frame (stereo input only)
201 .TP
202 \fB-M, --adaptive-mid-side\fR
203 Adaptive mid-side coding for all frames (stereo input only)
204 .TP
205 \fB-0\&..-8, --compression-level-0\&..--compression-level-8\fR
206 Fastest compression..highest compression (default is -5).  These are synonyms for other options:
207 .RS
208 .TP
209 \fB-0, --compression-level-0\fR
210 Synonymous with -l 0 -b 1152 -r 3
211 .TP
212 \fB-1, --compression-level-1\fR
213 Synonymous with -l 0 -b 1152 -M -r 3
214 .TP
215 \fB-2, --compression-level-2\fR
216 Synonymous with -l 0 -b 1152 -m -r 3
217 .TP
218 \fB-3, --compression-level-3\fR
219 Synonymous with -l 6 -b 4096 -r 4
220 .TP
221 \fB-4, --compression-level-4\fR
222 Synonymous with -l 8 -b 4096 -M -r 4
223 .TP
224 \fB-5, --compression-level-5\fR
225 Synonymous with -l 8 -b 4096 -m -r 5
226 .TP
227 \fB-6, --compression-level-6\fR
228 Synonymous with -l 8 -b 4096 -m -r 6
229 .TP
230 \fB-7, --compression-level-7\fR
231 Synonymous with -l 8 -b 4096 -m -e -r 6
232 .TP
233 \fB-8, --compression-level-8\fR
234 Synonymous with -l 12 -b 4096 -m -e -r 6
235 .RE
236 .TP
237 \fB--fast\fR
238 Fastest compression.  Currently synonymous with -0.
239 .TP
240 \fB--best\fR
241 Highest compression.  Currently synonymous with -8.
242 .TP
243 \fB-e, --exhaustive-model-search\fR
244 Do exhaustive model search (expensive!)
245 .TP
246 \fB-A \fIfunction\fB, --apodization=\fIfunction\fB\fR
247 Window audio data with given the apodization function.  The functions are: bartlett, bartlett_hann, blackman, blackman_harris_4term_92db, connes, flattop, gauss(STDDEV), hamming, hann, kaiser_bessel, nuttall, rectangle, triangle, tukey(P), welch.
248
249 For gauss(STDDEV), STDDEV is the standard deviation (0<STDDEV<=0.5).
250
251 For tukey(P), P specifies the fraction of the window that is tapered (0<=P<=1; P=0 corresponds to "rectangle" and P=1 corresponds to "hann").
252
253 More than one -A option (up to 32) may be used.  Any function that is specified erroneously is silently dropped.  The encoder chooses suitable defaults in the absence of any -A options; any -A option specified replaces the default(s).
254
255 When more than one function is specified, then for every subframe the encoder will try each of them separately and choose the window that results in the smallest compressed subframe.  Multiple functions can greatly increase the encoding time.
256 .TP
257 \fB-l \fI#\fB, --max-lpc-order=\fI#\fB\fR
258 Specifies the maximum LPC order. This number must be <= 32. For Subset streams, it must be <=12 if the sample rate is <=48kHz. If 0, the encoder will not attempt generic linear prediction, and use only fixed predictors. Using fixed predictors is faster but usually results in files being 5-10% larger.
259 .TP
260 \fB-p, --qlp-coeff-precision-search\fR
261 Do exhaustive search of LP coefficient quantization (expensive!).  Overrides -q; does nothing if using -l 0
262 .TP
263 \fB-q \fI#\fB, --qlp-coeff-precision=\fI#\fB\fR
264 Precision of the quantized linear-predictor coefficients, 0 => let encoder decide (min is 5, default is 0)
265 .TP
266 \fB-r [\fI#\fB,]\fI#\fB, --rice-partition-order=[\fI#\fB,]\fI#\fB\fR
267 Set the [min,]max residual partition order (0..16). min defaults to 0 if unspecified.  Default is -r 5.
268 .SS "FORMAT OPTIONS"
269 .TP
270 \fB--endian={\fIbig\fB|\fIlittle\fB}\fR
271 Set the byte order for samples
272 .TP
273 \fB--channels=\fI#\fB\fR
274 Set number of channels.
275 .TP
276 \fB--bps=\fI#\fB\fR
277 Set bits per sample.
278 .TP
279 \fB--sample-rate=\fI#\fB\fR
280 Set sample rate (in Hz).
281 .TP
282 \fB--sign={\fIsigned\fB|\fIunsigned\fB}\fR
283 Set the sign of samples (the default is signed).
284 .TP
285 \fB--input-size=\fI#\fB\fR
286 Specify the size of the raw input in bytes.  If you are encoding raw samples from stdin, you must set this option in order to be able to use --skip, --until, --cuesheet, or other options that need to know the size of the input beforehand.  If the size given is greater than what is found in the input stream, the encoder will complain about an unexpected end-of-file.  If the size given is less, samples will be truncated.
287 .TP
288 \fB--force-raw-format\fR
289 Force input (when encoding) or output (when decoding) to be treated as raw samples (even if filename ends in \fI\&.wav\fR).
290 .TP
291 \fB--force-aiff-format\fR
292 Force the decoder to output AIFF format.  This option is not needed if the output filename (as set by -o) ends with \fI\&.aif\fR or \fI\&.aiff\fR\&.  Also, this option has no effect when encoding since input AIFF is auto-detected.
293 .TP
294 \fB--force-rf64-format\fR
295 Force the decoder to output RF64 format.  This option is not needed if the output filename (as set by -o) ends with \fI\&.rf64\fR\&.  Also, this option has no effect when encoding since input RF64 is auto-detected.
296 .TP
297 \fB--force-wave64-format\fR
298 Force the decoder to output Wave64 format.  This option is not needed if the output filename (as set by -o) ends with \fI\&.w64\fR\&.  Also, this option has no effect when encoding since input Wave64 is auto-detected.
299 .SS "NEGATIVE OPTIONS"
300 .TP
301 \fB--no-adaptive-mid-side\fR
302 .TP
303 \fB--no-cued-seekpoints\fR
304 .TP
305 \fB--no-decode-through-errors\fR
306 .TP
307 \fB--no-delete-input-file\fR
308 .TP
309 \fB--no-preserve-modtime\fR
310 .TP
311 \fB--no-keep-foreign-metadata\fR
312 .TP
313 \fB--no-exhaustive-model-search\fR
314 .TP
315 \fB--no-force\fR
316 .TP
317 \fB--no-lax\fR
318 .TP
319 \fB--no-mid-side\fR
320 .TP
321 \fB--no-ogg\fR
322 .TP
323 \fB--no-padding\fR
324 .TP
325 \fB--no-qlp-coeff-prec-search\fR
326 .TP
327 \fB--no-replay-gain\fR
328 .TP
329 \fB--no-residual-gnuplot\fR
330 .TP
331 \fB--no-residual-text\fR
332 .TP
333 \fB--no-sector-align\fR
334 .TP
335 \fB--no-seektable\fR
336 .TP
337 \fB--no-silent\fR
338 .TP
339 \fB--no-verify\fR
340 .TP
341 \fB--no-warnings-as-errors\fR
342 These flags can be used to invert the sense of the corresponding normal option.
343 .SH "SEE ALSO"
344 .PP
345 metaflac(1).
346 .PP
347 The programs are documented fully by HTML format documentation, available in \fI/usr/share/doc/flac/html\fR on Debian GNU/Linux systems.
348 .SH "AUTHOR"
349 .PP
350 This manual page was written by Matt Zimmerman <mdz@debian.org> for the Debian GNU/Linux system (but may be used by others).