diff mbox

[FFmpeg-devel,2/2] doc: update cache protocol documentation

Message ID 8ed4df75-b715-5f30-d7bf-ba85e4c51705@gmail.com
State New
Headers show

Commit Message

Timothy Lee March 31, 2017, 2:28 a.m. UTC 
This patch updates the cache protocol documentation to describe the 
cache_file option added by the previous patch.
diff mbox

Patch

From 42e09bc8c6a27c760c1fba23ba9591a521768b36 Mon Sep 17 00:00:00 2001
From: Timothy Lee <timothy.ty.lee@gmail.com>
Date: Fri, 31 Mar 2017 12:54:57 +1100
Subject: [PATCH 2/2] doc: update cache protocol documentation

Describe cache_file option and give additional example
---
 doc/protocols.texi | 20 ++++++++++++++++++--
 1 file changed, 18 insertions(+), 2 deletions(-)

diff --git a/doc/protocols.texi b/doc/protocols.texi
index a7968ff56e..9e14e430cf 100644
--- a/doc/protocols.texi
+++ b/doc/protocols.texi
@@ -97,10 +97,26 @@  Read angle 2 of playlist 4 from BluRay mounted to /mnt/bluray, start from chapte
 
 Caching wrapper for input stream.
 
-Cache the input stream to temporary file. It brings seeking capability to live streams.
+Cache the input stream to a file. It brings seeking capability to live streams.
 
+This protocol accepts the following options:
+@table @option
+
+@item cache_file
+Name of the cache file.
+If not specified a temporary file will be used, and deleted after playback.
+
+@end table
+
+For example, to cache the input stream to a temporary file using
+@command{ffplay}:
+@example
+ffplay cache:@var{URL}
+@end example
+
+To cache the input stream to @file{stream.dat}:
 @example
-cache:@var{URL}
+ffplay -cache_file stream.dat cache:@var{URL}
 @end example
 
 @section concat
-- 
2.12.1