added ffplay documentation - added automatic man page generation for ffmpeg, ffserver and ffplay

git-svn-id: file:///var/local/repositories/ffmpeg/trunk@2136 9553f0bf-9b14-0410-a0b8-cfaf0461ba5b

doc/Makefile

-all: ffmpeg-doc.html faq.html ffserver-doc.html hooks.html
+all: ffmpeg-doc.html faq.html ffserver-doc.html ffplay-doc.html hooks.html \
+     ffmpeg.1 ffserver.1 ffplay.1
 
 %.html: %.texi Makefile
 	texi2html -monolithic -number $<
 
+%.pod: %-doc.texi
+	./texi2pod.pl $< $@
+
+%.1: %.pod
+	pod2man --section=1 --center=" " --release=" " $< > $@
+
 clean:
-	rm -f *.html
+	rm -f *.html *.pod *.1

doc/ffplay-doc.texi

+\input texinfo @c -*- texinfo -*-
+
+@settitle FFplay Documentation
+@titlepage
+@sp 7
+@center @titlefont{FFplay Documentation}
+@sp 3
+@end titlepage
+
+
+@chapter Introduction
+
+@c man begin DESCRIPTION
+FFplay is a very simple and portable media player using the FFmpeg
+libraries and the SDL library. It is mostly used as a test bench for the
+various APIs of FFmpeg.
+@c man end
+
+@chapter Invocation
+
+@section Syntax
+@example 
+@c man begin SYNOPSIS
+ffplay [options] @file{input_file}
+@c man end
+@end example
+
+@c man begin OPTIONS
+@section Main options
+
+@table @option
+@item -h
+show help
+@item -x width
+force displayed width
+@item -y height
+force displayed height
+@item -an
+disable audio
+@item -vn
+disable video
+@item -nodisp
+disable graphical display
+@item -f fmt
+force format
+@end table
+
+@section Advanced options
+@table @option
+@item -stats
+show the stream duration, the codec parameters, the current position in
+the stream, and the audio/video synchronisation drift.
+@item -rtp_tcp
+force RTP/TCP protocol usage instead of RTP/UDP. It is only meaningful
+if you are doing stream with the RTSP protocol.
+@item -sync type
+set the master clock to audio (@code{type=audio}), video
+(@code{type=video}) or external (@code{type=ext}). Default is audio. The
+master clock is used to control audio-video synchronization. Most media
+players use audio as master clock, but in some cases (streaming or high
+quality broadcast) it is necessary to change that. This option is mainly
+used for debugging purposes.
+@end table
+
+@section While playing
+
+@table @key
+@item q, ESC
+quit
+
+@item f
+toggle full screen
+
+@item p, SPC
+pause
+
+@item a
+cycle audio channel
+
+@item v
+cycle video channel
+
+@item w
+show audio waves
+@end table
+
+@c man end
+
+@ignore
+
+@setfilename ffplay
+@settitle FFplay media player
+
+@c man begin SEEALSO
+ffmpeg(1), ffserver(1) and the html documentation of @file{ffmpeg}.
+@c man end
+
+@c man begin AUTHOR
+Fabrice Bellard
+@c man end
+
+@end ignore
+
+@bye

doc/ffserver-doc.texi

@@ -10,6 +10,7 @@
 
 @chapter Introduction
 
+@c man begin DESCRIPTION
 FFserver is a streaming server for both audio and video. It supports
 several live feeds, streaming from files and time shifting on live feeds
 (you can seek to positions in the past on each live feed, provided you
@@ -17,8 +18,9 @@ specify a big enough feed storage in ffserver.conf).
 
 This documentation covers only the streaming aspects of ffserver /
 ffmpeg. All questions about parameters for ffmpeg, codec questions,
-etc. are not covered here. Read @file{ffmpeg-doc.[texi|html]} for more
+etc. are not covered here. Read @file{ffmpeg-doc.html} for more
 information.
+@c man end
 
 @chapter QuickStart
 
@@ -182,4 +184,39 @@ in the future and so unlikely to useful.
 You use this by adding the ?date= to the end of the URL for the stream.
 For example:   @samp{http://localhost:8080/test.asf?date=2002-07-26T23:05:00}.
 
+@chapter Invocation
+@section Syntax
+@example 
+@c man begin SYNOPSIS
+ffserver [options]
+@c man end
+@end example
+
+@section Options
+@c man begin OPTIONS
+@table @option
+@item -L
+print the license
+@item -h
+print the help
+@item -f configfile
+use @file{configfile} instead of @file{/etc/ffserver.conf}
+@end table
+@c man end
+
+@ignore
+
+@setfilename ffsserver
+@settitle FFserver video server
+
+@c man begin SEEALSO
+ffmpeg(1), ffplay(1) and the html documentation of @file{ffmpeg}.
+@c man end
+
+@c man begin AUTHOR
+Fabrice Bellard
+@c man end
+
+@end ignore
+
 @bye