From 11ace706071f07a5c4ea28e11c2d4d19eef9317e Mon Sep 17 00:00:00 2001 From: Andrey Utkin Date: Sun, 14 Jul 2013 13:43:25 +0300 Subject: doc/protocols: Document file protocol options Reviewed-by: Stefano Sabatini Signed-off-by: Michael Niedermayer --- doc/protocols.texi | 14 ++++++++++++++ 1 file changed, 14 insertions(+) (limited to 'doc/protocols.texi') diff --git a/doc/protocols.texi b/doc/protocols.texi index bae05d5..c91a07b 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). -- cgit v1.1