[FFmpeg-cvslog] Document tcp proto 'timeout' parameter behavior

[Andrey Utkin]

ffmpeg | branch: master | Andrey Utkin <andrey.krieger.utkin at gmail.com> | Thu Sep 13 03:43:29 2012 +0300| [aa7c88df50eeec6829cd8fc2d397693a0b0be1b2] | committer: Michael Niedermayer

Document tcp proto 'timeout' parameter behavior

Signed-off-by: Michael Niedermayer <michaelni at gmx.at>

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

 doc/protocols.texi |    5 +++++
 1 file changed, 5 insertions(+)

diff --git a/doc/protocols.texi b/doc/protocols.texi
index 0ad985c..e790459 100644
--- a/doc/protocols.texi
+++ b/doc/protocols.texi
@@ -578,6 +578,11 @@ tcp://@var{hostname}:@var{port}[?@var{options}]
 @item listen
 Listen for an incoming connection
 
+ at item timeout=@var{microseconds}
+In read mode: if no data arrived in more than this time interval, raise error.
+In write mode: if socket cannot be written in more than this time interval, raise error.
+This also sets timeout on TCP connection establishing.
+
 @example
 ffmpeg -i @var{input} -f @var{format} tcp://@var{hostname}:@var{port}?listen
 ffplay tcp://@var{hostname}:@var{port}