From df8fd27405c99dbb009244306f0446c84c315f91 Mon Sep 17 00:00:00 2001 From: Josh Coalson Date: Fri, 23 Jul 2004 05:07:36 +0000 Subject: [PATCH] add anchors for each option, add commented out docs for --apply-replaygain-which-is-not-lossless --- doc/html/documentation.html | 101 +++++++++++++++++++++++++++++++++++- 1 file changed, 100 insertions(+), 1 deletion(-) diff --git a/doc/html/documentation.html b/doc/html/documentation.html index db3e2512..f536d659 100644 --- a/doc/html/documentation.html +++ b/doc/html/documentation.html @@ -285,6 +285,7 @@ General Options + -v, --version @@ -293,6 +294,7 @@ Show the flac version number. + -h, --help @@ -301,6 +303,7 @@ Show basic usage and a list of all options. Running flac without arguments shows the short help screen by default. + -H, --explain @@ -309,6 +312,7 @@ Show detailed explanation of usage and all options. Running flac without arguments shows the short help screen by default. + -d, --decode @@ -317,6 +321,7 @@ Decode (flac encodes by default). flac will exit with an exit code of 1 (and print a message, even in silent mode) if there were any errors during decoding, including when the MD5 checksum does not match the decoded output. Otherwise the exit code will be 0. + -t, --test @@ -325,6 +330,7 @@ Test (same as -d except no decoded file is written). The exit codes are the same as in decode mode. + -a, --analyze @@ -333,6 +339,7 @@ Analyze (same as -d except an analysis file is written). The exit codes are the same as in decode mode. This option is mainly for developers; the output will be a text file that has data about each frame and subframe. + -c, --stdout @@ -341,6 +348,7 @@ Write output to stdout. + -s, --silent @@ -349,6 +357,7 @@ Silent: do not show encoding/decoding statistics. + --totally-silent @@ -357,6 +366,7 @@ Do not print anything of any kind, including warnings or errors. The exit code will be the only way to determine successful completion. + -f, --force @@ -365,6 +375,7 @@ Force overwriting of output files. By default, flac warns that the output file already exists and continues to the next file. + -o filename,
--output-name=filename @@ -373,6 +384,7 @@ 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. + --output-prefix=string @@ -381,6 +393,7 @@ Prefix each output file name with the given string. This can be useful for encoding/decoding files to a different directory. Make sure if your string is a path name that it ends with a trailing '/' slash. + --delete-input-file @@ -389,6 +402,7 @@ 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. + --skip={#|mm:ss.ss} @@ -400,6 +414,7 @@ --skip=1:23.45 : skip the first 1 minute and 23.45 seconds of the input + --until={#|[+|-]mm:ss.ss} @@ -414,6 +429,7 @@ --until=-0:00 : decode until the end of the input (the same as not specifying --until) + --ogg @@ -423,6 +439,7 @@ 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'. + --serial-number=# @@ -442,6 +459,7 @@ Analysis Options + --residual-text @@ -450,6 +468,7 @@ Includes the residual signal in the analysis file. This will make the file very big, much larger than even the decoded file. + --residual-gnuplot @@ -469,6 +488,7 @@ Decoding Options + --cue=[#.#][-[#.#]] @@ -483,6 +503,7 @@ --cue=2.1-2.4 : decode from track 2, index 1, up to, but not including, track 2, index 4

+ -F,
--decode-through-errors @@ -491,6 +512,49 @@ 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. +

@@ -502,6 +566,7 @@ Encoding Options + -V, --verify @@ -510,6 +575,7 @@ Verify the encoding process. With this option, flac will create a parallel decoder that decodes the output of the encoder and compares the result against the original. It will abort immediately with an error if a mismatch occurs. -V increases the total encoding time but is guaranteed to catch any unforseen bug in the encoding process. + --lax @@ -518,6 +584,7 @@ Allow encoder to generate non-Subset files. The resulting FLAC file may not be streamable, so you should only use this option in combination with custom encoding options meant for archival. File decoders will still be able play (and seek in) such files. + --replay-gain @@ -527,6 +594,7 @@ Note that this option cannot be used when encoding to standard output (stdout). + --cuesheet=FILENAME @@ -536,6 +604,7 @@ The cuesheet file must be of the sort written by CDRwin, CDRcue, EAC, et al. + --sector-align @@ -546,6 +615,7 @@ WARNING: The ordering of files is important! If you give a command like 'flac --sector-align *.wav' the shell may not expand the wildcard to the order you expect. To be safe you should 'echo *.wav' first to confirm the order, or be explicit like 'flac --sector-align 8.wav 9.wav 10.wav'. + -S {#|X|#x|#s},
--seekpoint={#|X|#x|#s} @@ -572,6 +642,7 @@ 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).
+ -P #, --padding=# @@ -580,6 +651,7 @@ 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 4096 bytes by default. + -T FIELD=VALUE, --tag=FIELD=VALUE @@ -588,6 +660,7 @@ Add a Vorbis comment. 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. + -b #, --blocksize=# @@ -596,6 +669,7 @@ Specify the block size in samples. The default is 1152 for -l 0, otherwise 4608. Subset streams must use one of 192/576/1152/2304/4608/256/512/1024/2048/4096/8192/16384/32768. The reference encoder uses the same block size for the entire stream. + -m, --mid-side @@ -604,6 +678,7 @@ Enable mid-side coding (only for stereo streams). Tends to increase compression by a few percent on average. For each block both the stereo pair and mid-side versions of the block will be encoded, and smallest resulting frame will be stored. Currently mid-side encoding is only available when bits-per-sample <= 16. + -M, --adaptive-mid-side @@ -612,6 +687,7 @@ Enable adaptive mid-side coding (only for stereo streams). Like -m but the encoder adaptively switches between independent and mid-side coding, which is faster but yields less compression than -m (which does an exhaustive search). + -0 .. -8 @@ -620,6 +696,7 @@ Fastest compression .. highest compression. The default is -5. + -0, --compression-level-0 @@ -628,6 +705,7 @@ Synonymous with -l 0 -b 1152 -r 2,2 + -1, --compression-level-1 @@ -636,6 +714,7 @@ Synonymous with -l 0 -b 1152 -M -r 2,2 + -2, --compression-level-2 @@ -644,6 +723,7 @@ Synonymous with -l 0 -b 1152 -m -r 3 + -3, --compression-level-3 @@ -652,6 +732,7 @@ Synonymous with -l 6 -b 4608 -r 3,3 + -4, --compression-level-4 @@ -660,6 +741,7 @@ Synonymous with -l 8 -b 4608 -M -r 3,3 + -5, --compression-level-5 @@ -668,6 +750,7 @@ Synonymous with -l 8 -b 4608 -m -r 3,3 + -6, --compression-level-6 @@ -676,6 +759,7 @@ Synonymous with -l 8 -b 4608 -m -r 4 + -7, --compression-level-7 @@ -684,6 +768,7 @@ Synonymous with -l 8 -b 4608 -m -e -r 6 + -8, --compression-level-8 @@ -692,6 +777,7 @@ Synonymous with -l 12 -b 4608 -m -e -r 6 + --fast @@ -700,6 +786,7 @@ Fastest compression. Currently synonymous with -0 + --best @@ -708,6 +795,7 @@ Highest compression. Currently synonymous with -8 + -e,
--exhaustive-model-search @@ -716,6 +804,7 @@ Exhaustive model search (expensive!). Normally the encoder estimates the best model to use and encodes once based on the estimate. With an exhaustive model search, the encoder will generate subframes for every order and use the smallest. If the max LPC order is high this can significantly increase the encode time but can shave off another 0.5%. + -l #, --max-lpc-order=# @@ -724,6 +813,7 @@ Specifies the maximum LPC order. This number must be <= 32. 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. + -q #,
--qlp-coeff-precision=# @@ -732,6 +822,7 @@ Specifies the precision of the quantized LP coefficients, in bits. The default is -q 0, which means let the encoder decide based on the signal. Unless you really know your input file it's best to leave this up to the encoder. + -p,
--qlp-coeff-precision-search @@ -740,6 +831,7 @@ Do exhaustive LP coefficient quantization optimization. This option overrides any -q option. It is expensive and typically will only improve the compression a tiny fraction of a percent. -q has no effect when -l 0 is used. + -r [#,]#,
--rice-partition-order=[#,]# @@ -760,6 +852,7 @@ Format Options + --endian={big|little} @@ -768,6 +861,7 @@ Specify big-endian or little-endian byte order in the raw file. + --channels=# @@ -776,6 +870,7 @@ Specify the number of channels in the raw file. + --bps=# @@ -784,6 +879,7 @@ Specify the number of bits per sample in the raw file. + --sample-rate=# @@ -792,6 +888,7 @@ Specify the sample rate of the raw file. + --sign={signed|unsigned} @@ -800,6 +897,7 @@ Specify that the samples in the raw file are signed or unsigned (the default is signed). + --force-aiff-format @@ -808,6 +906,7 @@ Force the decoder to output AIFF format. This option is not needed if the output filename (as set by -o) ends with .aiff. Also, this option has no effect when encoding since input AIFF is auto-detected. + --force-raw-format @@ -824,7 +923,7 @@
- Negative Options + Negative Options