# HG changeset patch
# User Kim Alvefur <zash@zash.se>
# Date 1389916552 -3600
# Node ID b95d737dc0142ef64bb380570f8e004c4a184121
# Parent  720b8a84ecf9b1fc2ff5b2cbfac3d827b117a108
show and tell, example invocation and description of fields

diff -r 720b8a84ecf9 -r b95d737dc014 mod_telnet_tlsinfo.wiki
--- a/mod_telnet_tlsinfo.wiki	Fri Jan 17 00:52:58 2014 +0100
+++ b/mod_telnet_tlsinfo.wiki	Fri Jan 17 00:55:52 2014 +0100
@@ -17,6 +17,36 @@
 	}
 }}}
 
+= Usage =
+
+Simply type `c2s:showtls()` to show client connections or `s2s:showtls()`
+for server-to-server connections.  These commands can also take a JID for
+limiting output to matching users or servers.
+
+{{{
+s2s:showtls("prosody.im")
+| example.com	->	prosody.im
+|             protocol: TLSv1.1
+|               cipher: DHE-RSA-AES256-SHA
+|           encryption: AES(256)
+|              algbits: 256
+|                 bits: 256
+|       authentication: RSA
+|                  key: DH
+|                  mac: SHA1
+|               export: false
+}}}
+
+|| *Field*        || *Description*                    ||
+||       protocol || The protocol used. *Note*: With older LuaSec, this is the protocol that added the used cipher ||
+||         cipher || The OpenSSL cipher string for the currently used cipher ||
+||     encryption || Encryption algorithm used ||
+||  bits, algbits || Secret bits involved in the cipher ||
+|| authentication || The authentication algoritm used ||
+||            mac || Message authentication algorithm used ||
+||            key || Key exchange mechanism used. ||
+||         export || Whethere an export cipher is used ||
+
 = Compatibility =
 
 ||0.9 with LuaSec 0.5||Works||