summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBrian P. Hinz <bphinz@users.sf.net>2014-11-14 00:25:12 -0500
committerBrian P. Hinz <bphinz@users.sf.net>2014-11-14 00:25:12 -0500
commit34d2b4de3a0b814ec22803ff09ef2f84fca1e1a5 (patch)
tree039286993c0da40a92b5eae9abd959fc9bc115db
parente328bd388ae665833dbcb430d0bb71a6f24d7f94 (diff)
downloadtigervnc-34d2b4de3a0b814ec22803ff09ef2f84fca1e1a5.tar.gz
tigervnc-34d2b4de3a0b814ec22803ff09ef2f84fca1e1a5.zip
Update BUILDING.txt to document GnuTLS requirements
See Issue #44 for further details.
-rw-r--r--BUILDING.txt23
1 files changed, 23 insertions, 0 deletions
diff --git a/BUILDING.txt b/BUILDING.txt
index 8f686cc3..e26073c8 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,28 @@ 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; \
+ /usr/local/lib/libgcrypt.a; \
+ /usr/local/lib/libgpg-error.a"
+
+to the CMake command line would link TigerVNC against a static version of
+libgnutls located under /usr/local.
+
+
+======================================
Building Native Language Support (NLS)
======================================