summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorMartin Storsjö <martin@martin.st>2015-02-05 15:06:42 +0200
committerMartin Storsjö <martin@martin.st>2016-03-24 10:33:59 +0200
commit933dec0e29ec4d2cb83474279a6c52d62fdb7310 (patch)
treea5dc9d46edec0e3dbed784f6c32c2457834bb67f /doc
parentccea588f831906084b8c8235222920e6984beb72 (diff)
file: Add an option for following a file that is being written
Using this requires setting the rw_timeout option to make it terminate, alternatively using the interrupt callback (if used via the API). Signed-off-by: Martin Storsjö <martin@martin.st>
Diffstat (limited to 'doc')
-rw-r--r--doc/protocols.texi11
1 files changed, 11 insertions, 0 deletions
diff --git a/doc/protocols.texi b/doc/protocols.texi
index c0663ac76a..c136c74e41 100644
--- a/doc/protocols.texi
+++ b/doc/protocols.texi
@@ -69,6 +69,17 @@ The av* tools default to the file protocol, that is a resource
specified with the name "FILE.mpeg" is interpreted as the URL
"file:FILE.mpeg".
+This protocol accepts the following options:
+
+@table @option
+@item follow
+If set to 1, the protocol will retry reading at the end of the file, allowing
+reading files that still are being written. In order for this to terminate,
+you either need to use the rw_timeout option, or use the interrupt callback
+(for API users).
+
+@end table
+
@section gopher
Gopher protocol.