Revert adding controversial 'make checkheaders' item to the development policy.
[ffmpeg.git] / doc / ffplay-doc.texi
index d4cad5c..0809d43 100644 (file)
 
 @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.
+libraries and the SDL library. It is mostly used as a testbed for the
+various FFmpeg APIs.
 @c man end
 
 @chapter Invocation
 
 @section Syntax
-@example 
+@example
 @c man begin SYNOPSIS
 ffplay [options] @file{input_file}
 @c man end
@@ -30,64 +30,95 @@ ffplay [options] @file{input_file}
 
 @table @option
 @item -h
-show help
-@item -x width
-force displayed width
-@item -y height
-force displayed height
+Show help.
+@item -version
+Show version.
+@item -L
+Show license.
+@item -formats
+Show available formats, codecs, protocols, ...
+@item -x @var{width}
+Force displayed width.
+@item -y @var{height}
+Force displayed height.
+@item -s @var{size}
+Set frame size (WxH or abbreviation), needed for videos which don't
+contain a header with the frame size like raw YUV.
 @item -an
-disable audio
+Disable audio.
 @item -vn
-disable video
+Disable video.
+@item -ss @var{pos}
+Seek to a given position in seconds.
+@item -bytes
+Seek by bytes.
 @item -nodisp
-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
+Disable graphical display.
+@item -f @var{fmt}
+Force format.
 @end table
 
 @section Advanced options
 @table @option
+@item -pix_fmt @var{format}
+Set pixel format.
 @item -stats
-show the stream duration, the codec parameters, the current position in
-the stream, and the audio/video synchronisation drift.
+Show the stream duration, the codec parameters, the current position in
+the stream and the audio/video synchronisation drift.
+@item -debug
+Print specific debug info.
+@item -bug
+Work around bugs.
+@item -vismv
+Visualize motion vectors.
+@item -fast
+Non-spec-compliant optimizations.
+@item -genpts
+Generate pts.
 @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
+Force RTP/TCP protocol usage instead of RTP/UDP. It is only meaningful
+if you are streaming with the RTSP protocol.
+@item -sync @var{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.
+@item -threads @var{count}
+Set the thread count.
 @end table
 
 @section While playing
 
 @table @key
 @item q, ESC
-quit
+Quit.
 
 @item f
-toggle full screen
+Toggle full screen.
 
 @item p, SPC
-pause
+Pause.
 
 @item a
-cycle audio channel
+Cycle audio channel.
 
 @item v
-cycle video channel
+Cycle video channel.
 
 @item w
-show audio waves
+Show audio waves.
+
+@item left/right
+Seek backward/forward 10 seconds.
+
+@item down/up
+Seek backward/forward 1 minute.
+
+@item mouse click
+Seek to percentage in file corresponding to fraction of width.
+
 @end table
 
 @c man end
@@ -98,7 +129,7 @@ show audio waves
 @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