Run documentation through ispell, plus some minor fixes.
authorDiego Biurrun <diego@biurrun.de>
Fri, 6 Jun 2008 07:51:36 +0000 (07:51 +0000)
committerDiego Biurrun <diego@biurrun.de>
Fri, 6 Jun 2008 07:51:36 +0000 (07:51 +0000)
Originally committed as revision 13670 to svn://svn.ffmpeg.org/ffmpeg/trunk

doc/faq.texi
doc/ffmpeg-doc.texi
doc/ffplay-doc.texi
doc/ffserver-doc.texi
doc/general.texi

index a7222b8..725cf34 100644 (file)
@@ -38,7 +38,7 @@ No. Windows DLLs are not portable, bloated and often slow.
 Moreover FFmpeg strives to support all codecs natively.
 A DLL loader is not conducive to that goal.
 
-@section My bugreport/mail to ffmpeg-devel/user has not received any replies.
+@section My bug report/mail to ffmpeg-devel/user has not received any replies.
 
 Likely reasons
 @itemize
@@ -69,7 +69,7 @@ documentation.
 @section Which codecs are supported by Windows?
 
 Windows does not support standard formats like MPEG very well, unless you
-install some additional codecs
+install some additional codecs.
 
 The following list of video codecs should work on most Windows systems:
 @table @option
@@ -82,7 +82,7 @@ The following list of video codecs should work on most Windows systems:
 @item wmv2
 .asf only
 @item mpeg4
-only if you have some MPEG-4 codec installed like ffdshow or Xvid
+Only if you have some MPEG-4 codec like ffdshow or Xvid installed.
 @item mpeg1
 .mpg only
 @end table
@@ -96,8 +96,9 @@ The following list of audio codecs should work on most Windows systems:
 @item adpcm_ima_wav
 @item adpcm_ms
 @item pcm
+always
 @item mp3
-if some MP3 codec like LAME is installed
+If some MP3 codec like LAME is installed.
 @end table
 
 
@@ -111,12 +112,12 @@ the gcc developers. Note that we will not add workarounds for gcc bugs.
 
 @chapter Usage
 
-@section ffmpeg does not work; What is wrong?
+@section ffmpeg does not work; what is wrong?
 
 Try a @code{make distclean} in the ffmpeg source directory before the build. If this does not help see
 (@url{http://ffmpeg.org/bugreports.html}).
 
-@section How do I encode single pictures to movies?
+@section How do I encode single pictures into movies?
 
 First, rename your pictures to follow a numerical sequence.
 For example, img1.jpg, img2.jpg, img3.jpg,...
@@ -160,7 +161,8 @@ Beware that there is no "jpeg" codec. Use "mjpeg" instead.
 
 @section I get "Unsupported codec (id=86043) for input stream #0.1". What is the problem?
 
-This is the Qcelp codec, FFmpeg has no support for that codec currently. Try mencoder/mplayer it might work.
+This is the Qcelp codec, FFmpeg has no support for that codec currently.
+Try MEncoder/MPlayer, it might work.
 
 @section Why do I see a slight quality degradation with multithreaded MPEG* encoding?
 
@@ -170,7 +172,7 @@ quite logical that there is a small reduction of quality. This is not a bug.
 
 @section How can I read from the standard input or write to the standard output?
 
-Use @file{-} as filename.
+Use @file{-} as file name.
 
 @section Why does FFmpeg not decode audio in VOB files?
 
@@ -206,7 +208,7 @@ Choose a different codec with the -vcodec command line option.
 
 Both Xvid and DivX (version 4+) are implementations of the ISO MPEG-4
 standard (note that there are many other coding formats that use this
-same standard). Thus, use '-vcodec mpeg4' to encode these formats. The
+same standard). Thus, use '-vcodec mpeg4' to encode in these formats. The
 default fourcc stored in an MPEG-4-coded file will be 'FMP4'. If you want
 a different fourcc, use the '-vtag' option. E.g., '-vtag xvid' will
 force the fourcc 'xvid' to be stored as the video fourcc rather than the
@@ -362,7 +364,7 @@ examining all of the vbv_delay values and making complicated computations."
 
 Yes. Read the Developers Guide of the FFmpeg documentation. Alternatively,
 examine the source code for one of the many open source projects that
-already incorporate ffmpeg at (@url{projects.html}).
+already incorporate FFmpeg at (@url{projects.html}).
 
 @section Can you support my C compiler XXX?
 
@@ -404,7 +406,7 @@ No. These tools are too bloated and they complicate the build.
 
 @section Why not rewrite ffmpeg in object-oriented C++?
 
-ffmpeg is already organized in a highly modular manner and does not need to
+FFmpeg is already organized in a highly modular manner and does not need to
 be rewritten in a formal object language. Further, many of the developers
 favor straight C; it works for them. For more arguments on this matter,
 read "Programming Religion" at (@url{http://www.tux.org/lkml/#s15}).
@@ -412,14 +414,14 @@ read "Programming Religion" at (@url{http://www.tux.org/lkml/#s15}).
 @section Why are the ffmpeg programs devoid of debugging symbols?
 
 The build process creates ffmpeg_g, ffplay_g, etc. which contain full debug
-information. Those binaries are strip'd to create ffmpeg, ffplay, etc. If
+information. Those binaries are stripped to create ffmpeg, ffplay, etc. If
 you need the debug information, used the *_g versions.
 
 @section I do not like the LGPL, can I contribute code under the GPL instead?
 
 Yes, as long as the code is optional and can easily and cleanly be placed
 under #ifdef CONFIG_GPL without breaking anything. So for example a new codec
-or filter would be OK under GPL while a bugfix to LGPL code would not.
+or filter would be OK under GPL while a bug fix to LGPL code would not.
 
 @section I want to compile xyz.c alone but my compiler produced many errors.
 
index 3988017..bc7e53d 100644 (file)
@@ -124,7 +124,7 @@ Converts a.wav to a.mp2 at 64 kbits and to b.mp2 at 128 kbits. '-map
 file:index' specifies which input stream is used for each output
 stream, in the order of the definition of output streams.
 
-* You can transcode decrypted VOBs
+* You can transcode decrypted VOBs:
 
 @example
 ffmpeg -i snatch_1.vob -f avi -vcodec mpeg4 -b 800k -g 300 -bf 2 -acodec libmp3lame -ab 128k snatch.avi
@@ -206,7 +206,7 @@ Show available formats, codecs, protocols, ...
 Force format.
 
 @item -i @var{filename}
-input filename
+input file name
 
 @item -y
 Overwrite output files.
@@ -419,7 +419,7 @@ Add a new video stream to the current output stream.
 Set pixel format. Use 'list' as parameter to show all the supported
 pixel formats.
 @item -sws_flags @var{flags}
-Set SwScaler flags (only available when compiled with SwScaler support).
+Set SwScaler flags (only available when compiled with swscale support).
 @item -g @var{gop_size}
 Set the group of pictures size.
 @item -intra
@@ -801,7 +801,7 @@ Fabrice Bellard
 
 @section Protocols
 
-The filename can be @file{-} to read from standard input or to write
+The file name can be @file{-} to read from standard input or to write
 to standard output.
 
 FFmpeg also handles many protocols specified with an URL syntax.
index b88f951..0809d43 100644 (file)
@@ -43,7 +43,7 @@ Force displayed width.
 Force displayed height.
 @item -s @var{size}
 Set frame size (WxH or abbreviation), needed for videos which don't
-contain a header with the framesize like raw YUV.
+contain a header with the frame size like raw YUV.
 @item -an
 Disable audio.
 @item -vn
@@ -129,7 +129,7 @@ Seek to percentage in file corresponding to fraction of width.
 @settitle FFplay media player
 
 @c man begin SEEALSO
-ffmpeg(1), ffserver(1) and the html documentation of @file{ffmpeg}.
+ffmpeg(1), ffserver(1) and the HTML documentation of @file{ffmpeg}.
 @c man end
 
 @c man begin AUTHOR
index bc55445..ec885a0 100644 (file)
@@ -22,7 +22,7 @@ etc. are not covered here. Read @file{ffmpeg-doc.html} for more
 information.
 @c man end
 
-@chapter QuickStart
+@chapter Quick Start
 
 [Contributed by Philip Gladstone, philip-ffserver at gladstonefamily dot net]
 
@@ -211,7 +211,7 @@ Use @file{configfile} instead of @file{/etc/ffserver.conf}.
 
 @ignore
 
-@setfilename ffsserver
+@setfilename ffserver
 @settitle FFserver video server
 
 @c man begin SEEALSO
index aa7ea8f..b7e6799 100644 (file)
@@ -72,8 +72,8 @@ library:
 @item DV               @tab  X @tab  X
 @item 4xm              @tab    @tab X
 @tab 4X Technologies format, used in some games.
-@item Playstation STR  @tab    @tab X
-@item Id RoQ           @tab X  @tab X
+@item PlayStation STR  @tab    @tab X
+@item id RoQ           @tab X  @tab X
 @tab Used in Quake III, Jedi Knight 2, other computer games.
 @item Interplay MVE    @tab    @tab X
 @tab Format used in various Interplay computer games.
@@ -83,7 +83,7 @@ library:
 @tab Used in many Sega Saturn console games.
 @item Westwood Studios VQA/AUD  @tab    @tab X
 @tab Multimedia formats used in Westwood Studios games.
-@item Id Cinematic (.cin) @tab    @tab X
+@item id Cinematic (.cin) @tab    @tab X
 @tab Used in Quake II.
 @item FLIC format      @tab    @tab X
 @tab .fli/.flc files
@@ -112,7 +112,7 @@ library:
 @item MXF @tab    @tab X
 @tab Material eXchange Format SMPTE 377M, used by D-Cinema, broadcast industry.
 @item SEQ @tab    @tab X
-@tab Tiertex .seq files used in the DOS CDROM version of the game Flashback.
+@tab Tiertex .seq files used in the DOS CD-ROM version of the game Flashback.
 @item DXA @tab    @tab X
 @tab This format is used in non-Windows version of Feeble Files game and
 different game cutscenes repacked for use with ScummVM.
@@ -211,8 +211,8 @@ following image formats are supported:
 @item ATI VCR2               @tab     @tab  X @tab fourcc: VCR2
 @item Cirrus Logic AccuPak   @tab     @tab  X @tab fourcc: CLJR
 @item 4X Video               @tab     @tab  X @tab Used in certain computer games.
-@item Sony Playstation MDEC  @tab     @tab  X
-@item Id RoQ                 @tab  X  @tab  X @tab Used in Quake III, Jedi Knight 2, other computer games.
+@item Sony PlayStation MDEC  @tab     @tab  X
+@item id RoQ                 @tab  X  @tab  X @tab Used in Quake III, Jedi Knight 2, other computer games.
 @item Xan/WC3                @tab     @tab  X @tab Used in Wing Commander III .MVE files.
 @item Interplay Video        @tab     @tab  X @tab Used in Interplay .MVE files.
 @item Apple Animation        @tab  X  @tab  X @tab fourcc: 'rle '
@@ -223,7 +223,7 @@ following image formats are supported:
 @item Microsoft RLE          @tab     @tab  X
 @item Microsoft Video-1      @tab     @tab  X
 @item Westwood VQA           @tab     @tab  X
-@item Id Cinematic Video     @tab     @tab  X @tab Used in Quake II.
+@item id Cinematic Video     @tab     @tab  X @tab Used in Quake II.
 @item Planar RGB             @tab     @tab  X @tab fourcc: 8BPS
 @item FLIC video             @tab     @tab  X
 @item Duck TrueMotion v1     @tab     @tab  X @tab fourcc: DUCK
@@ -248,7 +248,7 @@ following image formats are supported:
 @item KMVC                   @tab     @tab  X @tab Codec used in Worms games.
 @item VMware Video           @tab     @tab  X @tab Codec used in videos captured by VMware.
 @item Cin Video              @tab     @tab  X @tab Codec used in Delphine Software games.
-@item Tiertex Seq Video      @tab     @tab  X @tab Codec used in DOS CDROM FlashBack game.
+@item Tiertex Seq Video      @tab     @tab  X @tab Codec used in DOS CD-ROM FlashBack game.
 @item DXA Video              @tab     @tab  X @tab Codec originally used in Feeble Files game.
 @item AVID DNxHD             @tab   X @tab  X @tab aka SMPTE VC3
 @item C93 Video              @tab     @tab  X @tab Codec used in Cyberia game.
@@ -311,7 +311,7 @@ following image formats are supported:
 @item AMR-WB                 @tab X    @tab X
 @tab Supported through an external library.
 @item DV audio               @tab      @tab X
-@item Id RoQ DPCM            @tab X    @tab X
+@item id RoQ DPCM            @tab X    @tab X
 @tab Used in Quake III, Jedi Knight 2, other computer games.
 @item Interplay MVE DPCM     @tab      @tab X
 @tab Used in various Interplay computer games.
@@ -340,7 +340,7 @@ following image formats are supported:
 @item Intel Music Coder      @tab      @tab X
 @item Musepack               @tab      @tab X
 @tab SV7 and SV8 are supported
-@item DT$ Coherent Audio     @tab      @tab X
+@item DTS Coherent Audio     @tab      @tab X
 @item ATRAC 3                @tab      @tab X
 @item Monkey's Audio         @tab      @tab X @tab Only versions 3.97-3.99 are supported
 @item Nellymoser ASAO        @tab      @tab X