- <term><option>-v</option>, <option>--version</option>
- </term>
- <listitem>
- <para>Show the flac version number</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-h</option>, <option>--help</option>
- </term>
- <listitem>
- <para>Show basic usage and a list of all options</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-H</option>, <option>--explain</option>
- </term>
- <listitem>
- <para>Show detailed explanation of usage and all options</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-d</option>, <option>--decode</option>
- </term>
- <listitem>
- <para>Decode (the default behavior is to encode)</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-t</option>, <option>--test</option>
- </term>
- <listitem>
- <para>Test a flac encoded file (same as -d
- except no decoded file is written)</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-a</option>, <option>--analyze</option>
- </term>
- <listitem>
- <para>Analyze a FLAC encoded file (same as -d
- except an analysis file is written)</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-c</option>, <option>--stdout</option>
- </term>
- <listitem>
- <para>Write output to stdout</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-s</option>, <option>--silent</option>
- </term>
- <listitem>
- <para>Silent mode (do not write runtime
- encode/decode statistics to stderr)</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>--totally-silent</option>
- </term>
- <listitem>
- <para>Do not print anything of any kind,
- including warnings or errors. The exit
- code will be the only way to determine
- successful completion.</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-f</option>, <option>--force</option>
- </term>
- <listitem>
- <para>Force overwriting of output files. By default,
- flac warns that the output file already exists and
- continues to the next file.</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-o</option> <replaceable>filename</replaceable>, <option>--output-name</option>=<replaceable>filename</replaceable></term>
- <listitem>
- <para>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.</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>--output-prefix</option>=<replaceable>string</replaceable></term>
- <listitem>
- <para>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).</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>--delete-input-file</option>
- </term>
- <listitem>
- <para>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.</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>--skip</option>={<replaceable>#</replaceable>|<replaceable>mm:ss.ss</replaceable>}</term>
- <listitem>
- <para>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.</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>--until</option>={<replaceable>#</replaceable>|[<replaceable>+</replaceable>|<replaceable>-</replaceable>]<replaceable>mm:ss.ss</replaceable>}</term>
- <listitem>
- <para>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.</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>--ogg</option></term>
-
- <listitem>
- <para>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.</para>
- <para>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'.</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>--serial-number</option>=<replaceable>#</replaceable></term>
-
- <listitem>
- <para>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.</para>
- </listitem>
- </varlistentry>
-
- </variablelist>
- </refsect2>
-
- <refsect2>
- <title>Analysis Options</title>
-
- <variablelist>
- <varlistentry>
- <term><option>--residual-text</option>
- </term>
- <listitem>
- <para>Includes the residual signal in the analysis
- file. This will make the file very big, much
- larger than even the decoded file.</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>--residual-gnuplot</option>
- </term>
- <listitem>
- <para>Generates a gnuplot file for every subframe;
- each file will contain the residual distribution
- of the subframe. This will create a lot of
- files.</para>
- </listitem>
- </varlistentry>
-
- </variablelist>
- </refsect2>
-
- <refsect2>
- <title>Decoding Options</title>
-
- <variablelist>
- <varlistentry>
- <term><option>--cue=[<replaceable>#.#</replaceable>][-[<replaceable>#.#</replaceable>]]</option></term>
- <listitem>
- <para>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.</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-F</option>, <option>--decode-through-errors</option>
- </term>
- <listitem>
- <para>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.</para>
- </listitem>
- </varlistentry>
-
- </variablelist>
- </refsect2>
-
- <refsect2>
- <title>Encoding Options</title>
-
- <variablelist>
- <varlistentry>
- <term><option>-V</option>, <option>--verify</option></term>
-
- <listitem>
- <para>Verify a correct encoding by decoding the
- output in parallel and comparing to the
- original</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>--lax</option></term>
-
- <listitem>
- <para>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.</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>--replay-gain</option></term>
-
- <listitem>
- <para>Calculate ReplayGain values and store in
- Vorbis comments, 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).
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>--cuesheet</option>=<replaceable>filename</replaceable></term>
-
- <listitem>
- <para>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.</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>--sector-align</option></term>
-
- <listitem>
- <para>Align encoding of multiple CD format WAVE
- files on sector boundaries. See the HTML
- documentation for more information.</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-S</option> {<replaceable>#</replaceable>|<replaceable>X</replaceable>|<replaceable>#x</replaceable>|<replaceable>#s</replaceable>}, <option>--seekpoint</option>={<replaceable>#</replaceable>|<replaceable>X</replaceable>|<replaceable>#x</replaceable>|<replaceable>#s</replaceable>}</term>
-
- <listitem>
- <para>
- 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).</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-P</option> <replaceable>#</replaceable>, <option>--padding</option>=<replaceable>#</replaceable></term>
-
- <listitem>
- <para>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.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-T</option> <replaceable>FIELD=VALUE</replaceable>, <option>--tag</option>=<replaceable>FIELD=VALUE</replaceable></term>
-
- <listitem>
- <para>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.</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-b</option> <replaceable>#</replaceable>, <option>--blocksize</option>=<replaceable>#</replaceable></term>
-
- <listitem>
- <para>Specify the block size in samples. The
- default is 1152 for -l 0, else 4608; must be one of
- 192, 576, 1152, 2304, 4608, 256, 512, 1024, 2048,
- 4096, 8192, 16384, or 32768 (unless --lax is used)</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-m</option>, <option>--mid-side</option></term>