add checks for docbook2man
[platform/upstream/flac.git] / man / flac.1
index 7db83a7..01bd6ff 100644 (file)
@@ -3,22 +3,24 @@
 .\" <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" "20 December 2002" "" ""
+.TH "FLAC" "1" "29 July 2004" "" ""
 .SH NAME
 flac \- Free Lossless Audio Codec
 .SH SYNOPSIS
 
-\fBflac\fR [ \fB\fIOPTION\fB\fR ] \fB\fIinfile\fB\fR \fB\fI...\fB\fR
+\fBflac\fR [ \fB\fIoptions\fB\fR ] [ \fB\fIinfile.wav\fB\fR | \fB\fIinfile.aiff\fB\fR | \fB\fIinfile.raw\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\fI ...\fR ]
 
 .SH "DESCRIPTION"
 .PP
-This manual page documents briefly the
-\fBflac\fR command.
+\fBflac\fR is a command-line tool for
+encoding, decoding, testing and analyzing FLAC streams.
 .PP
-This manual page was written for the Debian GNU/Linux
-distribution because the original program does not have a
-manual page.  Instead, it has documentation in HTML
-format; see below.
+This manual page was originally written for the Debian GNU/Linux
+distribution because the original program did not have a
+manual page.
 .SH "OPTIONS"
 .PP
 A summary of options is included below.  For a complete
@@ -42,7 +44,7 @@ Test a flac encoded file (same as -d
 except no decoded file is written)
 .TP
 \fB-a, --analyze \fR
-Analyze a flac encoded file (same as -d
+Analyze a FLAC encoded file (same as -d
 except an analysis file is written)
 .TP
 \fB-c, --stdout \fR
@@ -52,6 +54,17 @@ Write output to stdout
 Silent mode (do not write runtime
 encode/decode statistics to stderr)
 .TP
+\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-f, --force \fR
+Force overwriting of output files.  By default,
+flac warns that the output file already exists and
+continues to the next file.
+.TP
 \fB-o \fIfilename\fB, --output-name=\fIfilename\fB\fR
 Force the output file name (usually flac just
 changes the extension).  May only be used when
@@ -101,11 +114,13 @@ Ogg-FLAC.  This is useful when piping input from
 stdin or when the filename does not end in '.ogg'.
 .TP
 \fB--serial-number=\fI#\fB\fR
-When used with --ogg, specifies the serial
-number to use for the FLAC stream.  When encoding and
-no serial number is given, flac uses '0'.  When
-decoding and no number is given, flac uses the serial
-number of the first page.
+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.
 .SS "ANALYSIS OPTIONS"
 .TP
 \fB--residual-text \fR
@@ -120,6 +135,20 @@ of the subframe.  This will create a lot of
 files.
 .SS "DECODING OPTIONS"
 .TP
+\fB--cue=[\fI#.#\fB][-[\fI#.#\fB]]\fR
+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 seekpoint 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.
+.TP
 \fB-F, --decode-through-errors \fR
 By default flac stops decoding with an error
 and removes the partially decoded file if it
@@ -178,7 +207,7 @@ 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 100x'.  Use --no-seektable
+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 >=
@@ -198,8 +227,8 @@ 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, which is the
-default.
+all to be written with --no-padding.  The encoder
+writes a PADDING block of 4096 bytes by default.
 .TP
 \fB-T \fIFIELD=VALUE\fB, --tag=\fIFIELD=VALUE\fB\fR
 Add a Vorbis comment.  The comment must adhere
@@ -322,8 +351,6 @@ in \fI.wav\fR).
 .TP
 \fB--no-delete-input-file\fR
 .TP
-\fB--no-escape-coding\fR
-.TP
 \fB--no-exhaustive-model-search\fR
 .TP
 \fB--no-lax\fR