[FFmpeg-cvslog] doc/ffmpeg: document more deeply -re option.

[burek]

ffmpeg | branch: master | burek <burek021 at gmail.com> | Wed Jul 11 21:22:43 2012 +0200| [cb59e62abbf0d7a04fecb04ff7dd3463fa73b8ce] | committer: Clément Bœsch

doc/ffmpeg: document more deeply -re option.

Signed-off-by: Clément Bœsch <ubitux at gmail.com>
Signed-off-by: Lou Logan <lou at lrcd.com>

> http://git.videolan.org/gitweb.cgi/ffmpeg.git/?a=commit;h=cb59e62abbf0d7a04fecb04ff7dd3463fa73b8ce
---

 doc/ffmpeg.texi |    7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/doc/ffmpeg.texi b/doc/ffmpeg.texi
index 3d3d78f..4d36327 100644
--- a/doc/ffmpeg.texi
+++ b/doc/ffmpeg.texi
@@ -820,6 +820,13 @@ Dump each input packet to stderr.
 When dumping packets, also dump the payload.
 @item -re (@emph{input})
 Read input at native frame rate. Mainly used to simulate a grab device.
+By default @command{ffmpeg} attempts to read the input(s) as fast as possible.
+This option will slow down the reading of the input(s) to the native frame rate
+of the input(s). It is useful for real-time output (e.g. live streaming). If
+your input(s) is coming from some other live streaming source (through HTTP or
+UDP for example) the server might already be in real-time, thus the option will
+likely not be required. On the other hand, this is meaningful if your input(s)
+is a file you are trying to push in real-time.
 @item -loop_input
 Loop over the input stream. Currently it works only for image
 streams. This option is used for automatic FFserver testing.