stoken: Update documentation, manpage with libstoken information
[platform/upstream/openconnect.git] / www / building.xml
index 0814f33..07f3689 100644 (file)
@@ -25,12 +25,14 @@ libraries and tools installed:</p>
 <ul>
   <li><b><tt>libxml2</tt></b></li>
   <li><b><tt>zlib</tt></b></li>
-  <li><b><tt>OpenSSL</tt></b></li>
+  <li>Either <b><tt>OpenSSL</tt></b> or <b><tt>GnuTLS</tt></b></li>
   <li><b><tt>pkg-config</tt></b></li>
 </ul>
 And <em>optionally</em> also:
 <ul>
-  <li><b><a href="http://code.google.com/p/libproxy/">libproxy</a></b></li>
+  <li><b><tt><a href="http://code.google.com/p/libproxy/">libproxy</a></tt></b></li>
+  <li><b><tt><a href="http://trousers.sourceforge.net/">trousers</a></tt></b> <i>(for TPM support if using GnuTLS)</i></li>
+  <li><b><tt><a href="http://stoken.sourceforge.net/">libstoken</a></tt></b> <i>(for SecurID software token support)</i></li>
 </ul>
 <p>OpenConnect supports the use of HTTP and SOCKS proxies to connect to the
 AnyConnect service, even without using libproxy. You may wish to use libproxy
@@ -38,6 +40,23 @@ if you want OpenConnect to automatically use the appropriate proxies for your
 environment, without having to manually give it the <tt>--proxy</tt> argument
 on the command line.</p>
 
+<h2>Install vpnc-script</h2>
+ <p>Since version 3.17, The <a href="vpnc-script.html">vpnc-script</a> that OpenConnect
+ uses to configure the network is no longer optional, so it needs to be told at compile
+ time where to find that script.</p>
+ <p>The <tt>configure</tt> script will check whether <tt>/etc/vpnc/vpnc-script</tt>
+ exists and can be executed, and will fail if not. If you don't already have
+ a copy then you should install one. It might be in a separate <tt>vpnc-script</tt>
+ package for your operating system, it might be part of their <tt>vpnc</tt> package,
+ and there's one linked from from the <a href="vpnc-script.html">vpnc-script page</a>,
+ if you need to download it manually. Install it as <tt>/etc/vpnc/vpnc-script</tt>.</p>
+
+<p>If you do not want to use the standard location, you can configure OpenConnect to
+ use a different location by default. When running the <tt>./configure</tt> script
+ in the instructions below, you can append an argument such as <tt>--with-vpnc-script=<i>/where/I/put/vpnc-script</i></tt> to its command line. Note that the path you give will not be checked; the script doesn't have to be present when you <b>build</b> OpenConnect. But of course OpenConnect won't work very
+well without it, so you'll still have to install it later.</p>
+
+
 <h2>Building OpenConnect</h2>
 
 <p>If you checked the source code out from git rather from a release tarball
@@ -52,6 +71,10 @@ on the command line.</p>
     <li><tt>make install</tt> <i>(If you want to install it)</i></li>
   </ul>
 
+<p>Note that OpenConnect will attempt to use the OpenSSL library by default.
+If you want it to use GnuTLS instead, then add <tt>--with-gnutls</tt> to the
+<tt>./configure</tt> command above.</p>
+
 <p>If compilation fails, please make sure you have a working compiler and the
 <b>development</b> packages for all the required libraries mentioned above. If
 it still doesn't build, please send the full output in a plain-text mail to the
@@ -60,7 +83,7 @@ it still doesn't build, please send the full output in a plain-text mail to the
 <h2>TUN/TAP driver</h2>
 
 <p>Mac OS X users will also need to install the
-<a href="http://tuntaposx.sourceforge.net/">Mac OS X tun/tap driver</a>, and Solaris users will need the <a href="http://www.whiteboard.ne.jp/~admin2/tuntap/">Solaris one</a>. Note that for IPv6 support, the Solaris tun/tap driver from 16th Nov 2009 or newer is required.</p>
+<a href="http://tuntaposx.sourceforge.net/">Mac OS X tun/tap driver</a>, and Solaris/OpenIndiana users will need the <a href="http://www.whiteboard.ne.jp/~admin2/tuntap/">Solaris one</a>. Note that for IPv6 support, the Solaris tun/tap driver from 16th Nov 2009 or newer is required.</p>
 
        <INCLUDE file="inc/footer.tmpl" />
 </PAGE>