[FFmpeg-cvslog] tls: user documentation

[Peter Ross]

ffmpeg | branch: master | Peter Ross <pross at xvid.org> | Sun Jul 22 14:25:42 2012 +1000| [a8fb7690d94075388306b80dc48a6ae7f5128ef7] | committer: Michael Niedermayer

tls: user documentation

Signed-off-by: Michael Niedermayer <michaelni at gmx.at>

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

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

diff --git a/doc/protocols.texi b/doc/protocols.texi
index 74c15f6..c68cd7e 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.