Add some SSL documentation. From Tommi Komulainen.

diff --git a/INSTALL b/INSTALL
index c044e16a7dc1ba720f343ac6c72baf466a4c346c..7ad44fd8903248c164cdbcd9105062fd3195b3b5 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -82,6 +82,15 @@ to ``configure'' to help it out, or change the default behavior:
 --enable-imap
        enable IMAP support
 
+--with-ssl[=PFX]
+       enable SSL support with IMAP. SSL support requires you to have
+       OpenSSL headers and libraries properly installed before
+       compiling.  If the OpenSSL headers and libraries are not in the
+       default system pats you can use the optional PFX argument to
+       define the root directory of your installation.  The libraries
+       are then expected to be found in PFX/lib and headers in
+       PFX/include/openssl.
+
 --disable-nls
        This switch disables mutt's native language support.
 

diff --git a/README.SSL b/README.SSL
index 71b28c9909196a508d33df4bbc0bf82e97d58a43..38367d80dc1ed31df3c62957e1296e5e5410a757 100644 (file)
--- a/README.SSL
+++ b/README.SSL
@@ -1,11 +1,23 @@
 IMAP/SSL in mutt 
 ================
 
-To have SSL support in mutt, you need to install OpenSSL 
-(http://www.openssl.org) library before compiling. Versions 0.9.3
-and 0.9.4 have been tested.
+Compilation
+-----------
+If you want to have SSL support in mutt, you need to install OpenSSL
+(http://www.openssl.org) libraries and headers before compiling.
+OpenSSL versions 0.9.3 and 0.9.4 have been tested.
 
+For SSL support to be enabled, you need to run the ``configure''
+script with ``--enable-imap --with-ssl[=PFX]'' parameters.  If the
+OpenSSL headers and libraries are not in the default system search
+paths (usually /usr/include and /usr/lib) you can use the optional PFX
+argument to define the root directory of your installation.  The
+libraries are then expected to be found in PFX/lib and headers in
+PFX/include/openssl.
 
+
+Usage
+-----
 IMAP/SSL folders can be accessed just like normal IMAP folders, but you
 will also have to add '/ssl' before the closing curly brace. 
 
@@ -29,6 +41,8 @@ For example:
        set certificate_file=~/.mutt/certificates
 
 
+Troubleshooting
+---------------
 If after doing the above, you are unable to successfully connect, it
 is likely that your IMAP server does not support one of the SSL protocols.
 There exist three different protocols, TLSv1, SSLv2, and SSLv3.  To check