From 988a9f9e3a47e2b9b6459ad8d982e43bfeae52d1 Mon Sep 17 00:00:00 2001
From: Fabrice Bellard <fabrice@bellard.org>
Date: Tue, 16 Sep 2003 20:28:18 +0000
Subject: [PATCH] doc update

Originally committed as revision 2285 to svn://svn.ffmpeg.org/ffmpeg/trunk
---
 doc/TODO            |  1 -
 doc/faq.texi        |  9 +++++----
 doc/ffmpeg-doc.texi | 29 +++++++++++++++++++++++------
 doc/ffplay-doc.texi |  6 ++++++
 4 files changed, 34 insertions(+), 11 deletions(-)

diff --git a/doc/TODO b/doc/TODO
index 59928a7eea..2026d7f81c 100644
--- a/doc/TODO
+++ b/doc/TODO
@@ -14,7 +14,6 @@ Short term:
 - clean up (incompatible change, for 0.5.0): 
     * AVStream -> AVComponent
     * AVFormatContext -> AVInputStream/AVOutputStream
-    * CODEC_ID_MP3LAME and CODEC_ID_MP2 -> CODEC_ID_MPEGAUDIO
     * suppress rate_emu from AVCodecContext
 - add av_log() in libavcodec and suppress all printf
 - add new float/integer audio filterting and conversion : suppress
diff --git a/doc/faq.texi b/doc/faq.texi
index e85a29deb2..8e8198d851 100644
--- a/doc/faq.texi
+++ b/doc/faq.texi
@@ -69,11 +69,12 @@ No. Only GCC is supported. GCC is ported on most systems available and I
 don't see the need to pollute the source code with @code{#ifdef}s
 related to the compiler.
 
-@section I want to use ffmpeg or libavcodec under Windows. Can you support my proprietary C compiler XXX ?
+@section Can I use FFmpeg or libavcodec under Windows ?
 
-No. Use @code{mingw-gcc} available at @url{http://www.mingw.org/} to
-compile the code. It generates object files fully compatible with other
-windows compilers.
+Yes, but the MinGW tools @emph{must} be used to compile FFmpeg. You
+can link the resulting DLLs with any other Windows program. Read the
+@emph{Native Windows Compilation} section in the FFmpeg documentation
+to have more information.
 
 @section Can you add automake, libtool or autoconf support ?
 
diff --git a/doc/ffmpeg-doc.texi b/doc/ffmpeg-doc.texi
index 0011ca959b..795274f0df 100644
--- a/doc/ffmpeg-doc.texi
+++ b/doc/ffmpeg-doc.texi
@@ -754,7 +754,8 @@ the MinGW development library of SDL 1.2.x
 (@file{SDL-devel-1.2.x-mingw32.tar.gz}) from
 @url{http://www.libsdl.org}. Unpack it in a temporary place, and
 unpack the archive @file{i386-mingw32msvc.tar.gz} in the MinGW tool
-directory.
+directory. Edit the @file{sdl-config} script so that it gives the
+correct SDL directory when invoked.
 
 @item Extract the current version of FFmpeg (the latest release version or the current CVS snapshot whichever is recommended).
  
@@ -766,15 +767,31 @@ directory.
 suffices. If you have problems using SDL, verify that
 @file{sdl-config} can be launched from the MSYS command line.
 
-@item You can install FFmpeg in @file{Program Files/FFmpeg} by typing @file{make install}.
+@item You can install FFmpeg in @file{Program Files/FFmpeg} by typing @file{make install}. Don't forget to copy @file{SDL.dll} at the place you launch 
+@file{ffplay}.
 
 @end itemize
 
-Note: The target @file{make wininstaller} can be used to create a Nullsoft based Windows installer for FFmpeg and FFplay.
+Notes: 
+@itemize
 
-@subsection How to create a single Windows DLL from libavcodec and libavformat
- 
-Read @url{http://ffmpeg.org/win32.html}.
+@item The target @file{make wininstaller} can be used to create a
+Nullsoft based Windows installer for FFmpeg and FFplay. @file{SDL.dll}
+must be copied in the ffmpeg directory in order to build the
+installer.
+
+@item By using @code{./configure --enable-shared} when configuring ffmpeg, 
+you can build @file{avcodec.dll} and @file{avformat.dll}. With
+@code{make install} you install the FFmpeg DLLs and the associated
+headers in @file{Program Files/FFmpeg}. 
+
+@item Visual C++ compatibility: if you used @code{./configure --enable-shared} 
+when configuring FFmpeg, then FFmpeg tries to use the Microsoft Visual
+C++ @code{lib} tool to build @code{avcodec.lib} and
+@code{avformat.lib}. With these libraries, you can link your Visual C++
+code directly with the FFmpeg DLLs.
+
+@end itemize
 
 @subsection Cross compilation for Windows with Linux
 
diff --git a/doc/ffplay-doc.texi b/doc/ffplay-doc.texi
index a1eed74c77..d4cad5cab9 100644
--- a/doc/ffplay-doc.texi
+++ b/doc/ffplay-doc.texi
@@ -43,6 +43,12 @@ disable video
 disable graphical display
 @item -f fmt
 force format
+@item -img img_fmt
+this option is used to force a given image format
+when playing image sequences. Example:
+@example
+ffplay -img pgmyuv tests/vsynth1/%d.pgm
+@end example
 @end table
 
 @section Advanced options