summaryrefslogtreecommitdiff
path: root/doc/protocols.texi
diff options
context:
space:
mode:
authorAndrey Utkin <andrey.krieger.utkin@gmail.com>2013-07-14 13:43:25 +0300
committerMichael Niedermayer <michaelni@gmx.at>2013-08-01 04:08:14 +0200
commit11ace706071f07a5c4ea28e11c2d4d19eef9317e (patch)
tree94dbe2572fe149eb89edb0062c377ee74188ffa7 /doc/protocols.texi
parent69fe25cdca7c68b037984fd5d9704c237055ea2a (diff)
doc/protocols: Document file protocol options
Reviewed-by: Stefano Sabatini <stefasab@gmail.com> Signed-off-by: Michael Niedermayer <michaelni@gmx.at>
Diffstat (limited to 'doc/protocols.texi')
-rw-r--r--doc/protocols.texi14
1 files changed, 14 insertions, 0 deletions
diff --git a/doc/protocols.texi b/doc/protocols.texi
index bae05d593f..c91a07ba1a 100644
--- a/doc/protocols.texi
+++ b/doc/protocols.texi
@@ -129,6 +129,20 @@ The ff* 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 truncate
+Truncate existing files on write, if set to 1. A value of 0 prevents
+truncating. Default value is 1.
+
+@item blocksize
+Set I/O operation maximum block size, in bytes. Default value is
+@code{INT_MAX}, which results in not limiting the requested block size.
+Setting this value reasonably low improves user termination request reaction
+time, which is valuable for files on slow medium.
+@end table
+
@section ftp
FTP (File Transfer Protocol).