MS VS : Add alloc.c to the grabbag static build.
[platform/upstream/flac.git] / man / flac.1
index 5dbe8ae..bd112af 100644 (file)
@@ -3,16 +3,16 @@
 .\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> 
 .\" Please send any bug reports, improvements, comments, patches, 
 .\" etc. to Steve Cheng <steve@ggi-project.org>.
-.TH "FLAC" "1" "12 February 2007" "" ""
+.TH "FLAC" "1" "Nov 4, 2006" "" ""
 
 .SH NAME
 flac \- Free Lossless Audio Codec
 .SH SYNOPSIS
 
-\fBflac\fR [ \fB\fIOPTIONS\fB\fR ] [ \fB\fIinfile.wav\fB\fR | \fB\fIinfile.aiff\fB\fR | \fB\fIinfile.raw\fB\fR | \fB\fIinfile.flac\fB\fR | \fB\fIinfile.ogg\fB\fR | \fB-\fR\fI ...\fR ]
+\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 ]
 
 
-\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.ogg\fB\fR | \fB-\fR\fI ...\fR ]
+\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 ]
 
 .SH "DESCRIPTION"
 .PP
@@ -50,6 +50,9 @@ Silent mode (do not write runtime encode/decode statistics to stderr)
 \fB--totally-silent \fR
 Do not print anything of any kind, including warnings or errors.  The exit code will be the only way to determine successful completion.
 .TP
+\fB--no-utf8-convert \fR
+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!
+.TP
 \fB-w, --warnings-as-errors \fR
 Treat all warnings as errors (which cause flac to terminate with a non-zero exit code).
 .TP
@@ -65,6 +68,12 @@ Prefix each output file name with the given string.  This can be useful for enco
 \fB--delete-input-file \fR
 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.
 .TP
+\fB--preserve-modtime \fR
+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.
+.TP
+\fB--keep-foreign-metadata \fR
+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).
+.TP
 \fB--skip={\fI#\fB|\fImm:ss.ss\fB}\fR
 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.
 .TP
@@ -72,9 +81,9 @@ Skip over the first number of samples of the input.  This works for both encodin
 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.
 .TP
 \fB--ogg\fR
-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 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.
 
-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'.
+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'.
 .TP
 \fB--serial-number=\fI#\fB\fR
 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.
@@ -170,7 +179,7 @@ For example, "|image/jpeg|||../cover.jpg" will embed the JPEG file at ../cover.j
 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.
 .TP
 \fB--sector-align\fR
-Align encoding of multiple CD format files on sector boundaries.  See the HTML documentation for more information.
+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.
 .TP
 \fB-S {\fI#\fB|\fIX\fB|\fI#x\fB|\fI#s\fB}, --seekpoint={\fI#\fB|\fIX\fB|\fI#x\fB|\fI#s\fB}\fR
 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).
@@ -276,11 +285,17 @@ Set the sign of samples (the default is signed).
 \fB--input-size=\fI#\fB\fR
 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, --cue-sheet, 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.
 .TP
-\fB--force-aiff-format\fR
-Force the decoder to output AIFF format.  This option is not needed if the output filename (as set by -o) ends with \fI\&.aiff\fR\&.  Also, this option has no effect when encoding since input AIFF is auto-detected.
-.TP
 \fB--force-raw-format\fR
 Force input (when encoding) or output (when decoding) to be treated as raw samples (even if filename ends in \fI\&.wav\fR).
+.TP
+\fB--force-aiff-format\fR
+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.
+.TP
+\fB--force-rf64-format\fR
+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.
+.TP
+\fB--force-wave64-format\fR
+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.
 .SS "NEGATIVE OPTIONS"
 .TP
 \fB--no-adaptive-mid-side\fR
@@ -289,8 +304,14 @@ Force input (when encoding) or output (when decoding) to be treated as raw sampl
 .TP
 \fB--no-delete-input-file\fR
 .TP
+\fB--no-preserve-modtime\fR
+.TP
+\fB--no-keep-foreign-metadata\fR
+.TP
 \fB--no-exhaustive-model-search\fR
 .TP
+\fB--no-force\fR
+.TP
 \fB--no-lax\fR
 .TP
 \fB--no-mid-side\fR
@@ -301,6 +322,8 @@ Force input (when encoding) or output (when decoding) to be treated as raw sampl
 .TP
 \fB--no-qlp-coeff-precision-search\fR
 .TP
+\fB--no-replay-gain\fR
+.TP
 \fB--no-residual-gnuplot\fR
 .TP
 \fB--no-residual-text\fR