summaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorJosh Coalson <jcoalson@users.sourceforce.net>2002-12-21 03:28:06 +0000
committerJosh Coalson <jcoalson@users.sourceforce.net>2002-12-21 03:28:06 +0000
commit9906056ddb50a3b24295ba5e9e38e521b84c4d5c (patch)
treef2f7bf36b79765907d51f9bef8e8095eafb0f633 /man
parenteb7a8e4b53c6873aa88ed6ab0a48ab5c2bbc8dbf (diff)
downloadflac-9906056ddb50a3b24295ba5e9e38e521b84c4d5c.tar.gz
add --until, --cuesheet, --force-aiff-format
Diffstat (limited to 'man')
-rw-r--r--man/flac.140
-rw-r--r--man/flac.sgml54
2 files changed, 82 insertions, 12 deletions
diff --git a/man/flac.1 b/man/flac.1
index aa626085..7db83a7a 100644
--- a/man/flac.1
+++ b/man/flac.1
@@ -3,7 +3,7 @@
.\" <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" "02 December 2002" "" ""
+.TH "FLAC" "1" "20 December 2002" "" ""
.SH NAME
flac \- Free Lossless Audio Codec
.SH SYNOPSIS
@@ -23,7 +23,7 @@ format; see below.
.PP
A summary of options is included below. For a complete
description, see the HTML documentation.
-.SS "GENERIC OPTIONS"
+.SS "GENERAL OPTIONS"
.TP
\fB-v, --version \fR
Show the flac version number
@@ -71,10 +71,23 @@ successful encode or decode. If there was an
error (including a verify error) the input file
is left intact.
.TP
-\fB--skip=\fI#\fB\fR
-Skip the specified number of samples at the
-beginning of the input file (can be used for both
-encoding and decoding)
+\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
+\fB--until={\fI#\fB|[\fI+\fB|\fI-\fB]\fImm:ss.ss\fB}\fR
+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
@@ -142,6 +155,13 @@ 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).
.TP
+\fB--cuesheet=\fIfilename\fB\fR
+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.
+.TP
\fB--sector-align\fR
Align encoding of multiple CD format WAVE
files on sector boundaries. See the HTML
@@ -284,6 +304,12 @@ Set sample rate (in Hz).
\fB--sign={\fIsigned\fB|\fIunsigned\fB}\fR
Set the sign of samples (the default is signed).
.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
@@ -325,6 +351,8 @@ These flags can be used to invert the sense
of the corresponding normal option.
.SH "SEE ALSO"
.PP
+metaflac(1).
+.PP
The programs are documented fully by HTML format
documentation, available in
\fI/usr/share/doc/flac/html\fR on
diff --git a/man/flac.sgml b/man/flac.sgml
index 35013a8e..d3bdb327 100644
--- a/man/flac.sgml
+++ b/man/flac.sgml
@@ -4,7 +4,7 @@
<!ENTITY dhfirstname "<firstname>Matt</firstname>">
<!ENTITY dhsurname "<surname>Zimmerman</surname>">
<!-- Please adjust the date whenever revising the manpage. -->
- <!ENTITY dhdate "<date>November 6, 2002</date>">
+ <!ENTITY dhdate "<date>December 18, 2002</date>">
<!-- SECTION should be 1-8, maybe w/ subsection other parameters are
allowed: see man(7), man(1). -->
<!ENTITY dhsection "<manvolnum>1</manvolnum>">
@@ -70,7 +70,7 @@
description, see the HTML documentation.</para>
<refsect2>
- <title>Generic Options</title>
+ <title>General Options</title>
<variablelist>
<varlistentry>
@@ -173,11 +173,28 @@
</varlistentry>
<varlistentry>
- <term><option>--skip</option>=<replaceable>#</replaceable></term>
+ <term><option>--skip</option>={<replaceable>#</replaceable>|<replaceable>mm:ss.ss</replaceable>}</term>
<listitem>
- <para>Skip the specified number of samples at the
- beginning of the input file (can be used for both
- encoding and decoding)</para>
+ <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>
@@ -306,6 +323,18 @@
</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>
@@ -611,6 +640,17 @@
</varlistentry>
<varlistentry>
+ <term><option>--force-aiff-format</option></term>
+
+ <listitem>
+ <para>Force the decoder to output AIFF format. This option
+ is not needed if the output filename (as set by -o) ends
+ with <filename>.aiff</filename>. Also, this option has no
+ effect when encoding since input AIFF is auto-detected.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
<term><option>--force-raw-format</option></term>
<listitem>
@@ -657,6 +697,8 @@
<refsect1>
<title>SEE ALSO</title>
+ <para>metaflac(1).</para>
+
<para>The programs are documented fully by HTML format
documentation, available in
<filename>/usr/share/doc/flac/html</filename> on