[FFmpeg-devel] [PATCH 5/5] tls: user documentation

Peter Ross pross at xvid.org
Sun Jul 22 06:25:42 CEST 2012


---
 doc/protocols.texi |   42 ++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 42 insertions(+)

diff --git a/doc/protocols.texi b/doc/protocols.texi
index dc5d5eb..42f70fc 100644
--- a/doc/protocols.texi
+++ b/doc/protocols.texi
@@ -545,6 +545,48 @@ ffplay tcp://@var{hostname}:@var{port}
 
 @end table
 
+ at section tls
+
+Transport Layer Security/Secure Sockets Layer
+
+The required syntax for a TLS/SSL url is:
+ at example
+tls://@var{hostname}:@var{port}[?@var{options}]
+ at end example
+
+ at table @option
+
+ at item listen
+Act as a server, listening for an incoming connection.
+
+ at item cafile=@var{filename}
+Certificate authority file. The file must be in OpenSSL PEM format.
+
+ at item cert=@var{filename}
+Certificate file. The file must be in OpenSSL PEM format.
+
+ at item key=@var{filename}
+Private key file.
+
+ at item verify=@var{0|1}
+Verify the peer's certificate.
+
+ at end table
+
+Example command lines:
+
+To create a TLS/SSL server that serves an input stream.
+
+ at example
+ffmpeg -i @var{input} -f @var{format} tls://@var{hostname}:@var{port}?listen&cert=@var{server.crt}&key=@var{server.key}
+ at end example
+
+To play back a stream from the TLS/SSL server using @command{ffplay}:
+
+ at example
+ffplay tls://@var{hostname}:@var{port}
+ at end example
+
 @section udp
 
 User Datagram Protocol.
-- 
1.7.10.4

-- Peter
(A907 E02F A6E5 0CD2 34CD 20D2 6760 79C5 AC40 DD6B)
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 198 bytes
Desc: Digital signature
URL: <http://ffmpeg.org/pipermail/ffmpeg-devel/attachments/20120722/94cf4523/attachment.asc>


More information about the ffmpeg-devel mailing list