summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorbphinz <bphinz@users.sf.net>2014-11-18 07:41:48 -0500
committerbphinz <bphinz@users.sf.net>2014-11-18 07:41:48 -0500
commit7156e44a53da991b93274ddeee97c325eb4d86ad (patch)
treeab1879f235f6578341bb8093511cffff7289c31b
parent1e994be78a39fdb6abd47c902556a4062ef057d1 (diff)
parent94433e8a201d46401be10e5d1a5d2113911e1b53 (diff)
downloadtigervnc-7156e44a53da991b93274ddeee97c325eb4d86ad.tar.gz
tigervnc-7156e44a53da991b93274ddeee97c325eb4d86ad.zip
Merge pull request #71 from bphinz/buildfixes
Update BUILDING.txt to document GnuTLS requirements
-rw-r--r--BUILDING.txt21
1 files changed, 21 insertions, 0 deletions
diff --git a/BUILDING.txt b/BUILDING.txt
index 8f686cc3..41f493e9 100644
--- a/BUILDING.txt
+++ b/BUILDING.txt
@@ -15,6 +15,7 @@ Build Requirements (All Systems)
-- If building TLS support:
* GnuTLS
+ * See "Building TLS Support" below.
-- If building native language support (NLS):
* Gnu gettext 0.14.4 or later
@@ -322,6 +323,26 @@ or ":file " (see the jarsigner documentation for more info):
======================================
+Building TLS Support
+======================================
+
+TLS requires GnuTLS, which is supplied with most Linux distributions and
+with MinGW for Windows and can be built from source on OS X and other
+Unix variants. However, GnuTLS versions > 2.12.x && < 3.3.x should be
+avoided because of potential incompatibilities during initial handshaking.
+
+You can override the GNUTLS_LIBRARY and GNUTLS_INCLUDE_DIR CMake variables
+to specify the locations of libgnutls and any dependencies. For instance,
+adding
+
+ -DGNUTLS_INCLUDE_DIR=/usr/local/include \
+ -DGNUTLS_LIBRARY=/usr/local/lib/libgnutls.a
+
+to the CMake command line would link TigerVNC against a static version of
+libgnutls located under /usr/local.
+
+
+======================================
Building Native Language Support (NLS)
======================================