diff --git a/doc/documentation.html b/doc/documentation.html index ec8107af..6bca4a20 100644 --- a/doc/documentation.html +++ b/doc/documentation.html @@ -213,10 +213,10 @@ flac is the command-line file encoder/decoder. The input to the encoder and the output to the decoder must either be RIFF WAVE format, or raw interleaved sample data. flac only supports linear PCM samples (in other words, no A-LAW, uLAW, etc.). Another restriction (hopefully short-term) is that the input must be 8, 16, or 24 bits per sample. This is not a limitation of the FLAC format, just the reference encoder/decoder.

- flac assumes that RIFF WAVE files will have the extension ".wav"; this may be overridden with a command-line option. For piped-in data, flac tries to determine the type by looking at the beginning of the file. Other than this, flac makes no assumptions about file extensions, though the convention is that FLAC files have the extension ".flac" (or ".fla" on ancient file systems like FAT-16). + flac assumes that files ending in ".wav" or that have the RIFF WAVE header present are WAVE files; this may be overridden with a command-line option; it also assumes that files ending in ".ogg" are Ogg-FLAC files. Other than this, flac makes no assumptions about file extensions, though the convention is that FLAC files have the extension ".flac" (or ".fla" on ancient file systems like FAT-16).

- Before going into the full command-line description, a few other things help to sort it out: 1) flac encodes by default, so you must use -d to decode; 2) the options -0 .. -9 that control the compression level actually are just synonyms for different groups of specific encoding options (described later) and you can get the same effect by using the same options; 3) flac behaves similarly to gzip in the way it handles input and output files. + Before going into the full command-line description, a few other things help to sort it out: 1) flac encodes by default, so you must use -d to decode; 2) the options -0 .. -8 that control the compression level actually are just synonyms for different groups of specific encoding options (described later) and you can get the same effect by using the same options; 3) flac behaves similarly to gzip in the way it handles input and output files.

flac will be invoked one of four ways, depending on whether you are encoding, decoding, testing, or analyzing: @@ -275,6 +275,14 @@ General Options + + + -H + + + Show the long usage screen. Running flac without arguments shows the short help screen by default. + + -d @@ -385,6 +393,15 @@ Encoding Options + + + --ogg + + + 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.

+ 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'. + + --lax @@ -460,7 +477,7 @@ - -0 .. -9 + -0 .. -8 Fastest compression .. highest compression. The default is -5. @@ -538,14 +555,6 @@ Synonymous with -l 12 -b 4608 -m -e -r 6 - - - -9 - - - Synonymous with -l 32 -b 4608 -m -e -E -r 16 -p. This is painfully slow but gives you the maximum compression flac can do for the given block size. It is more of a theoretical option without much practical use, since -8 will get you within tiny fractions of a percent of -9 and much faster. - - -e @@ -600,7 +609,7 @@ -R # - Set the Rice parameter search distance. Defaults to 0. The residual coder will search for the best Rice parameter +/- this number for each residual partition. This option is expensive (run time for -R n will typically be (2n)*30% over that of -R 0) and doesn't give much of a gain. As a matter of fact, none of the -0..-9 options currently use it since -R > 1 is not consistently better like it should be. + Set the Rice parameter search distance. Defaults to 0. The residual coder will search for the best Rice parameter +/- this number for each residual partition. This option is expensive (run time for -R n will typically be (2n)*30% over that of -R 0) and doesn't give much of a gain. As a matter of fact, none of the -0..-8 options currently use it since -R > 1 is not consistently better like it should be. @@ -677,14 +686,6 @@ Treat the input file (or output file if decoding) as a raw file, regardless of the extension. - - - -fw - - - Treat the input file (or output file if decoding) as a RIFF WAVE file, regardless of the extension. - -

diff --git a/man/flac.sgml b/man/flac.sgml index 84b28697..98db4d03 100644 --- a/man/flac.sgml +++ b/man/flac.sgml @@ -73,6 +73,14 @@ Generic Options + + + + + Show detailed help screen + + + @@ -193,6 +201,21 @@ Encoding Options + + + + + 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.

+ 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'. + + + @@ -279,7 +302,7 @@ - .. + .. Fastest compression..highest compression @@ -367,15 +390,6 @@ - - - - - - Synonymous with -l 32 -b 4608 -m -e -E -r 16 -p - (very slow!) - - @@ -462,7 +476,7 @@ - + @@ -537,14 +551,6 @@ - - - - - Force to RIFF WAVE. - - -