diff mbox series

[FFmpeg-devel,10/10] doc: document fs: and file: changes.

Message ID 20210727144813.452917-11-george@nsup.org
State New
Headers show
Series [FFmpeg-devel,01/10] lavu/internal: add hex to int functions. | expand

Checks

Context Check Description
andriy/x86_make success Make finished
andriy/x86_make_fate success Make fate finished
andriy/PPC64_make success Make finished
andriy/PPC64_make_fate success Make fate finished

Commit Message

Nicolas George July 27, 2021, 2:48 p.m. UTC
Signed-off-by: Nicolas George <george@nsup.org>
---
 doc/protocols.texi | 40 +++++++++++++++++++++++++++++++---------
 1 file changed, 31 insertions(+), 9 deletions(-)
diff mbox series

Patch

diff --git a/doc/protocols.texi b/doc/protocols.texi
index 726e5f1c44..d341d93914 100644
--- a/doc/protocols.texi
+++ b/doc/protocols.texi
@@ -283,20 +283,16 @@  Read from or write to a file.
 
 A file URL can have the form:
 @example
-file:@var{filename}
+file://@var{encoded_absolute_path}
 @end example
 
-where @var{filename} is the path of the file to read.
+where @var{encoded_absolute_path} is the path of the file, with standard %
+URL encoding..
 
-An URL that does not have a protocol prefix will be assumed to be a
-file URL. Depending on the build, an URL that looks like a Windows
-path with the drive letter at the beginning will also be assumed to be
-a file URL (usually not the case in builds for unix-like systems).
-
-For example to read from a file @file{input.mpeg} with @command{ffmpeg}
+For example to read from a file @file{/tmp/test input.mpeg} with @command{ffmpeg}
 use the command:
 @example
-ffmpeg -i file:input.mpeg output.mpeg
+ffmpeg -i file:///tmp/test%20input.mpeg output.mpeg
 @end example
 
 This protocol accepts the following options:
@@ -327,6 +323,32 @@  overriding this might speed up opening certain files at the cost of losing some
 features (e.g. accurate seeking).
 @end table
 
+@section fs
+
+Direct file system access protocol.
+
+Read from or write to a file.
+
+A fs URL can have the form:
+@example
+fs:@var{filename}
+@end example
+
+where @var{filename} is the path of the file.
+
+An URL that does not have a protocol prefix will be assumed to be a
+fs URL. Depending on the build, an URL that looks like a Windows
+path with the drive letter at the beginning will also be assumed to be
+a fs URL (usually not the case in builds for unix-like systems).
+
+For example to read from a file @file{input.mpeg} with @command{ffmpeg}
+use the command:
+@example
+ffmpeg -i fs:input.mpeg output.mpeg
+@end example
+
+This protocol accepts the same options as the file protocol.
+
 @section ftp
 
 FTP (File Transfer Protocol).