[FFmpeg-cvslog] doc/protocols: add details and reformat IPFS section

Gyan Doshi git at videolan.org
Thu May 26 13:52:24 EEST 2022


ffmpeg | branch: master | Gyan Doshi <ffmpeg at gyani.pro> | Thu May 26 16:36:57 2022 +0530| [0dcbe1c1aa8ace2a84a4a7963acd755c4bbd96fb] | committer: Gyan Doshi

doc/protocols: add details and reformat IPFS section

> http://git.videolan.org/gitweb.cgi/ffmpeg.git/?a=commit;h=0dcbe1c1aa8ace2a84a4a7963acd755c4bbd96fb
---

 doc/protocols.texi | 33 +++++++++++++++++----------------
 1 file changed, 17 insertions(+), 16 deletions(-)

diff --git a/doc/protocols.texi b/doc/protocols.texi
index 399e998068..39b719dc50 100644
--- a/doc/protocols.texi
+++ b/doc/protocols.texi
@@ -617,15 +617,26 @@ icecast://[@var{username}[:@var{password}]@@]@var{server}:@var{port}/@var{mountp
 @section ipfs
 
 InterPlanetary File System (IPFS) protocol support. One can access files stored
-on the IPFS network through so called gateways. Those are http(s) endpoints.
-This protocol wraps the IPFS native protocols (ipfs:// and ipns://) to be send
+on the IPFS network through so-called gateways. These are http(s) endpoints.
+This protocol wraps the IPFS native protocols (ipfs:// and ipns://) to be sent
 to such a gateway. Users can (and should) host their own node which means this
-protocol will use your local gateway to access files on the IPFS network.
+protocol will use one's local gateway to access files on the IPFS network.
 
-If a user doesn't have a node of their own then the public gateway dweb.link is
-used by default.
+If a user doesn't have a node of their own then the public gateway @code{https://dweb.link}
+is used by default.
 
-You can use this protocol in 2 ways. Using IPFS:
+This protocol accepts the following options:
+
+ at table @option
+
+ at item gateway
+Defines the gateway to use. When not set, the protocol will first try
+locating the local gateway by looking at @code{$IPFS_GATEWAY}, @code{$IPFS_PATH}
+and @code{$HOME/.ipfs/}, in that order. If that fails @code{https://dweb.link} will be used.
+
+ at end table
+
+One can use this protocol in 2 ways. Using IPFS:
 @example
 ffplay ipfs://QmbGtJg23skhvFmu9mJiePVByhfzu5rwo74MEkVDYAmF5T
 @end example
@@ -635,16 +646,6 @@ Or the IPNS protocol (IPNS is mutable IPFS):
 ffplay ipns://QmbGtJg23skhvFmu9mJiePVByhfzu5rwo74MEkVDYAmF5T
 @end example
 
-You can also change the gateway to be used:
-
- at table @option
-
- at item gateway
-Defines the gateway to use. When nothing is provided the protocol will first try
-your local gateway. If that fails dweb.link will be used.
-
- at end table
-
 @section mmst
 
 MMS (Microsoft Media Server) protocol over TCP.



More information about the ffmpeg-cvslog mailing list