From d2e0e0e121bc75b5996102a0c8249d89cdeaa2cb Mon Sep 17 00:00:00 2001
From: Josh Coalson <jcoalson@users.sourceforce.net>
Date: Wed, 6 Jun 2001 19:27:48 +0000
Subject: [PATCH] document the new -o and --delete-input-file options

---
 doc/documentation.html | 40 ++++++++++++++++++++++++++++------------
 doc/news.html          |  2 ++
 man/flac.sgml          | 23 +++++++++++++++++++++--
 3 files changed, 51 insertions(+), 14 deletions(-)

diff --git a/doc/documentation.html b/doc/documentation.html
index 3f72a58..3177fd5 100644
--- a/doc/documentation.html
+++ b/doc/documentation.html
@@ -129,19 +129,19 @@
 		</UL>
 	</P>
 	<P>
-		In any case, if no <TT>inputfile</TT> is specified, stdin is assumed.  If only one inputfile is specified, it may be "-" for stdin.  When stdin is used as input, <B><TT>flac</TT></B> will write to stdout.  Otherwise <B><TT>flac</TT></B> will perform the desired operation on each input file to similarly named output files (meaning for encoding, the extension will be replaced with ".flac", or appended with ".flac" if the input file has no extension, and for decoding, the extension will be ".wav" for WAVE output and ".raw" for raw output).  The original file is not deleted.
+		In any case, if no <TT>inputfile</TT> is specified, stdin is assumed.  If only one inputfile is specified, it may be "-" for stdin.  When stdin is used as input, <B><TT>flac</TT></B> will write to stdout.  Otherwise <B><TT>flac</TT></B> will perform the desired operation on each input file to similarly named output files (meaning for encoding, the extension will be replaced with ".flac", or appended with ".flac" if the input file has no extension, and for decoding, the extension will be ".wav" for WAVE output and ".raw" for raw output).  The original file is not deleted unless --delete-input-file is specified.
 	</P>
 	<P>
-		There are special forms for encoding/decoding from stdin to a file:
+		If you are encoding/decoding from stdin to a file, you should use the -o option like so:
 		<UL>
 		<LI>
-			flac [options] - outputfile
+			flac [options] -o outputfile
 		</LI>
 		<LI>
-			flac -d [options] - outputfile
+			flac -d [options] -o outputfile
 		</LI>
 		</UL>
-		which are better than
+		which are better than:
 		<UL>
 		<LI>
 			flac [options] &gt; outputfile
@@ -170,7 +170,7 @@
 		</TR>
 		<TR>
 			<TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
-				-d
+				<TT>-d</TT>
 			</TD>
 			<TD>
 				Decode (<B><TT>flac</TT></B> encodes by default).  <B><TT>flac</TT></B> will exit with an exit code of <TT>1</TT> (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 <TT>0</TT>.
@@ -178,7 +178,7 @@
 		</TR>
 		<TR>
 			<TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
-				-t
+				<TT>-t</TT>
 			</TD>
 			<TD>
 				Test (same as <B><TT>-d</TT></B> except no decoded file is written).  The exit codes are the same as in decode mode.
@@ -186,7 +186,7 @@
 		</TR>
 		<TR>
 			<TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
-				-a
+				<TT>-a</TT>
 			</TD>
 			<TD>
 				Analyze (same as <B><TT>-d</TT></B> 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.
@@ -194,7 +194,7 @@
 		</TR>
 		<TR>
 			<TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
-				-c
+				<TT>-c</TT>
 			</TD>
 			<TD>
 				Write output to stdout
@@ -202,7 +202,7 @@
 		</TR>
 		<TR>
 			<TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
-				-s
+				<TT>-s</TT>
 			</TD>
 			<TD>
 				Silent: do not show encoding/decoding statistics.
@@ -210,7 +210,23 @@
 		</TR>
 		<TR>
 			<TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
-				--skip #
+				<TT>-o filename</TT>
+			</TD>
+			<TD>
+				Force the output file name (usually <TT>flac</TT> just changes the extension).
+			</TD>
+		</TR>
+		<TR>
+			<TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
+				<TT>--delete-input-file</TT>
+			</TD>
+			<TD>
+				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.
+			</TD>
+		</TR>
+		<TR>
+			<TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
+				<TT>--skip #</TT>
 			</TD>
 			<TD>
 				Skip over the first # of samples of the input.  This works for both encoding and decoding, but not testing.
@@ -466,7 +482,7 @@
 			<TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
 			</TD>
 			<TD>
-				<TT>-S-</TT>, <TT>-m-</TT>, <TT>-e-</TT>, <TT>-p-</TT>, <TT>-V-</TT>, <TT>--lax-</TT> can all be used to turn off a particular option.
+				<TT>-S-</TT>, <TT>-m-</TT>, <TT>-e-</TT>, <TT>-p-</TT>, <TT>-V-</TT>, <TT>--delete-input-file-</TT>, <TT>--lax-</TT> can all be used to turn off a particular option.
 			</TD>
 		</TR>
 	</TABLE>
diff --git a/doc/news.html b/doc/news.html
index cdd5a5a..dd3a637 100644
--- a/doc/news.html
+++ b/doc/news.html
@@ -69,6 +69,8 @@
 				<LI><B><TT>flac</TT></B> now has a command-line usage similar to 'gzip'; make sure to see the latest <A HREF="documentation.html">documentation</A> for the new usage.  It also attempts to preserve the input file's timestamp and permissions.</LI>
 				<LI>The -# options in <B><TT>flac</TT></B> have been tweaked to yield the best compression-to-encode-time ratios.  The new default is -5.</LI>
 				<LI>The WAVE reader in <B><TT>flac</TT></B> now just ignores (with a warning) unsupported sub-chunks instead of aborting with an error.</LI>
+				<LI>Added an option '--delete-input-file' to <B><TT>flac</TT></B> which automatically deletes the input after a successful encode/decode.</LI>
+				<LI>Added an option '-o' to <B><TT>flac</TT></B> to force the output file name (the old usage of "flac - outputfilename" is no longer supported).</LI>
 				<LI>Changed the XMMS plugin to send smaller chunks of samples (now 512) so that visualization is not slow.</LI>
 				<LI>Fixed a bug in the stream decoder where the decoded samples counter got corrupted after a seek.</LI>
 			</UL>
diff --git a/man/flac.sgml b/man/flac.sgml
index 013de4b..8b19fe4 100644
--- a/man/flac.sgml
+++ b/man/flac.sgml
@@ -48,7 +48,7 @@
 
 	    <arg><option><replaceable>OPTION</replaceable></option></arg>
 	    <arg choice=plain><replaceable>infile</replaceable></arg>
-	    <arg choice=plain><replaceable>outfile</replaceable></arg>
+	    <arg choice=plain><replaceable>...</replaceable></arg>
 	  </cmdsynopsis>
 	</refsynopsisdiv>
 	<refsect1>
@@ -109,6 +109,25 @@
 	      </varlistentry>
 
 	      <varlistentry>
+		<term><option>-o</option> <replaceable>filename</replaceable></term>
+		<listitem>
+		  <para>Force the output file name (usually flac just
+		    changes the extension).</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>samples</replaceable></term>
 		<listitem>
 		  <para>Skip the specified number of samples at the
@@ -399,7 +418,7 @@
 	      </varlistentry>
 
 	      <varlistentry>
-		<term><option>-S-</option> <option>-m-</option> <option>-M-</option> <option>-e-</option> <option>-p-</option> <option>-V-</option> <option>--lax-</option>
+		<term><option>-S-</option> <option>-m-</option> <option>-M-</option> <option>-e-</option> <option>-p-</option> <option>-V-</option> <option>--delete-input-file-</option> <option>--lax-</option>
 		</term>
 
 		<listitem>
-- 
2.7.4