path: root/doc/en/index.docbook

<?xml version="1.0" ?>
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.1.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
<!ENTITY kvpnc "<application>kvpnc</application>">
<!ENTITY kappname "&kvpnc;"><!-- Do *not* replace kappname-->
<!ENTITY package "kdenetwork"><!-- kdebase, kdeadmin, etc -->
<!ENTITY % addindex "IGNORE">
<!ENTITY % English "INCLUDE"><!-- change language only here -->


<!-- Do not define any other entities; instead, use the entities
 from kde-genent.entities and $LANG/user.entities. -->
]>
<!-- kdoctemplate v0.8 October 1 1999 
 Minor update to "Credits and Licenses" section on August 24, 2000
 Removed "Revision history" section on 22 January 2001
 Changed to Installation/Help menu entities 18 October 2001
 Other minor cleanup and changes 18 October 2001 -->


<!--
This template was designed by: David Rugge davidrugge@mindspring.com
with lots of help from: Eric Bischoff ebisch@cybercable.tm.fr
and Frederik Fouvry fouvry@sfs.nphil.uni-tuebingen.de
of the KDE DocBook team.

You may freely use this template for writing any sort of KDE documentation.
If you have any changes or improvements, please let us know.

Remember:
- in XML, the case of the <tags> and attributes is relevant ;
- also, quote all attributes.

Please don't forget to remove all these comments in your final documentation,
thanks ;-).
-->

<!-- ................................................................ -->

<!-- The language must NOT be changed here. -->

<book lang="&language;">

<!-- This header contains all of the meta-information for the document such
as Authors, publish date, the abstract, and Keywords -->

<bookinfo>
<title>The &kvpnc; Handbook</title>
<authorgroup>
<author>
<firstname>Christoph</firstname>
<othername></othername>
<surname>Thielecke</surname>
<affiliation>
<address><email>crissi99&#64;gmx&#46;de</email></address>
</affiliation>
</author>
<author>
<firstname>Florian</firstname>
<othername></othername>
<surname>Fainelli</surname>
<affiliation>
<address><email>florian&#64;alphacore&#46;net</email></address>
</affiliation>
</author>
</authorgroup>
<!-- TRANS:ROLES_OF_TRANSLATORS -->
<copyright>
<year>2004</year>
<year>2005</year>
<year>2006</year>
<year>2007</year>
<year>2008</year>
<holder>Christoph Thielecke</holder>
</copyright>
<!-- Translators: put here the copyright notice of the translation -->
<!-- Put here the FDL notice.Read the explanation in fdl-notice.docbook
 and in the FDL itself on how to use it. -->
<legalnotice>&FDLNotice;</legalnotice>

<!-- Date and version information of the documentation
Don't forget to include this last date and this last revision number, we
need them for translation coordination !
Please respect the format of the date (YYYY-MM-DD) and of the version
(V.MM.LL), it could be used by automation scripts.
Do NOT change these in the translation. -->

<date>2005-07-22</date>
<releaseinfo>0&#46;3</releaseinfo>

<!-- Abstract about this handbook -->

<abstract>
<para>
&kvpnc; is a KDE frontend for various vpn clients.
</para>
</abstract>

<!-- This is a set of Keywords for indexing by search engines.
Please at least include KDE, the KDE package it is in, the name
 of your application, and a few relevant keywords. -->

<keywordset>
<keyword>KDE</keyword>
<keyword>kvpnc</keyword>
<keyword>VPN</keyword>
<keyword>vpnc</keyword>
<keyword>freeswan</keyword>
<keyword>racoon</keyword>
<keyword>IPSec</keyword>
<keyword>IPsec</keyword>
<keyword>Cisco</keyword>
<keyword>OpenVPN</keyword>
<keyword>PPTP</keyword>
</keywordset>

</bookinfo>

<!-- The contents of the documentation begin here.Label
each chapter so with the id attribute. This is necessary for two reasons: it
allows you to easily reference the chapter from other chapters of your
document, and if there is no ID, the name of the generated HTML files will vary
from time to time making it hard to manage for maintainers and for the CVS
system. Any chapter labelled (OPTIONAL) may be left out at the author's
discretion. Other chapters should not be left out in order to maintain a
consistent documentation style across all KDE apps. -->

<chapter id="introduction">
<title>Introduction</title>
<!-- The introduction chapter contains a brief introduction for the
application that explains what it does and where to report
problems. Basically a long version of the abstract.Don't include a
revision history. (see installation appendix comment) -->
<para>
KVpnc is a <ulink url="http://www.kde.org/">KDE</ulink> frontend for various vpn clients. It supports Cisco VPN (<ulink url="http://www.unix-ag.uni-kl.de/~massar/vpnc/">vpnc</ulink>), IPSec (<ulink url="http://www.freeswan.org">FreeS/WAN</ulink> (OpenS/WAN), <ulink url="http://ipsec-tools.sourceforge.net/">racoon</ulink>), PPTP (<ulink url="http://sourceforge.net/projects/pptpclient/">pptpclient</ulink>), <ulink url="http://www.openvpn.net">OpenVPN</ulink>, L2TP (FreeS/WAN, <ulink url="http://www.openswan.org/">Openswan</ulink>, <ulink url="http://www.strongswan.org/" >strongSwan</ulink>, <ulink url="http://ipsec-tools.sourceforge.net/">ipsec-tools</ulink>), <ulink url="http://vtun.sourceforge.net/">Vtun</ulink> and <ulink url="http://www.openssh.net/">OpenSSH</ulink>.


</para>
</chapter>

<chapter id="getting-help">
<title>Getting help</title>
<itemizedlist>
<listitem>
<para>General</para>
<para>The project page can be found at: <ulink url="https://www.gna.org/projects/kvpnc/">https://www.gna.org/projects/kvpnc</ulink>.</para>
</listitem>
<listitem>
<para>Contact the kvpnc team:</para>
<itemizedlist>
<listitem>
<para>Bug report - To report bugs or wishes use the bugtracker page at: <ulink url="https://gna.org/bugs/?group=kvpnc">https://gna.org/bugs/?group=kvpnc</ulink></para>
</listitem>
<listitem>
<para>A list of planned features (TODO list) can be found here: <ulink url="http://cvs.gna.org/viewcvs/*checkout*/kvpnc/kvpnc/TODO?rev=HEAD&amp;content-type=text/plain">http://cvs.gna.org/viewcvs/*checkout*/kvpnc/kvpnc/TODO?rev=HEAD&amp;content-type=text/plain</ulink> (in English).
</para>
</listitem>
</itemizedlist>
<itemizedlist>
<listitem>
<para>Mailing list</para>
<itemizedlist>
<listitem>
<para>kvpnc-user - this list is for users of KVpnc who want to discuss about KVpnc.</para>
</listitem>
<listitem>
<para>kvpnc-devel - this list is related to development of KVpnc.</para>
</listitem>
<listitem>
<para>kvpnc-cvs - this list shows the commit to the CVS tree (readonly).</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</chapter>

<chapter id="using-kvpnc">
<title>Using &kvpnc;</title>

<!-- This chapter should tell the user how to use your app. You should use as
many sections (Chapter, Sect1, Sect3, etc...) as is necessary to fully document
your application. -->

<para>

<!-- Note that all graphics should be in .png format. Use no gifs because of
patent issues. 
<imageobject>
<imagedata fileref="screenshot.png" format="PNG"/>
</imageobject>
<imageobject>
<imagedata fileref="screenshot.eps" format="EPS"/>
</imageobject>
-->
The following picture shows the mainwindow of &kvpnc;.
<screenshot>
<screeninfo>Screenshot of the main window of &kvpnc;</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="mainwindow.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Screenshot of mainwindow</phrase>
</textobject>
</mediaobject>
</screenshot>
</para>
</chapter>

<chapter id="howto-kvpnc">
<title>How I create an connection</title>
 <sect1 id="Howto-cisco">
<title>Cisco Concentrator</title>
<para>A connection to a cisco concentrator will be often found at universities. The students can fetch the cisco client for use with it. Normally the administrator provides a configuration file (*.pcf), which also can be included in the client.</para>
<para>The original cisco client has some problems:
<itemizedlist>
<listitem><para>Needs a propriarity kernel module (can be build against own kernel)</para></listitem>
<listitem><para>console only</para></listitem>
</itemizedlist>
</para>
<note>
<para>
You need: Username, password, VPN ID, IP address or hostname of the VPN gateway and preshared secret (PSK) if you dont have a cisco profile file (*.pcf).
</para>
</note>
<para>To setup a connection to the Cisco concentrator you need to do the following steps:
<orderedlist>
<listitem><para>Import the pcf file given from administrator (if available go to step 4)</para></listitem>
<listitem><para>Create a new profile with type cisco</para></listitem>
<listitem><para>Set gateway (hostname or IP address of the cisco concentrator) at general profile settings</para></listitem>
<listitem><para>Set at PSK profile  settings (Pre shared key) the group password if you want to store it</para></listitem>
<listitem><para>Set at user settings the user name and password (if you want to store it)</para></listitem>
</orderedlist>
</para>
 </sect1>
<sect1 id="Howto-IPSec">
<title>IPSec</title>
<para>
...
</para>
</sect1>
<sect1 id="Howto-OpenVPN">
<title>OpenVPN</title>
<para>
...
</para>
</sect1>
<sect1 id="Howto-PPTP">
<title>PPTP</title>
<para>
PPTP is a old VPN protocol designed by Microsoft. Today its known to be insecure. Reasons are unencrypted control channel and design mistakes.
</para>
</sect1>
</chapter>

<chapter id="kvpnc-features">
<title>&kvpnc; features</title>
<!-- <para> -->
<!-- <sect1> -->
<para>KVpnc provides a lot of features:</para>
<itemizedlist>
<listitem><para>Easy to use KDE gui</para></listitem>
<listitem><para>Docking in kicker</para></listitem>
<listitem><para>Can be used to generate configuration files for the supported vpn clients</para></listitem>
<listitem>
<para>
Localized GUI
<itemizedlist>
<listitem><para>Bulgarian</para></listitem>
<listitem><para>Chinese</para></listitem>
<listitem><para>Dutch</para></listitem>
<listitem><para>French</para></listitem>
<listitem><para>German</para></listitem>
<listitem><para>Hungarian</para></listitem>
<listitem><para>Italian</para></listitem>
<listitem><para>Slovak</para></listitem>
<listitem><para>Polish</para></listitem>
<listitem><para>Portuguese Brazilian</para></listitem>
<listitem><para>Russian</para></listitem>
<listitem><para>Spanish</para></listitem>

</itemizedlist>
</para>
</listitem>
<listitem><para>VPN connection to Cisco concentrator</para></listitem>
<listitem><para>VPN connection to VPN servers by using IPsec</para></listitem>
<listitem><para>FreeS/WAN (Linux 2.4.x) or racoon (Linux 2.6.x/BSD) use</para></listitem>
<listitem><para>Multiple profiles</para></listitem>
<listitem><para>Preshared secret support </para></listitem>
<listitem><para>X509 certificate support</para></listitem>
<listitem><para>Cisco PCF file import</para></listitem>
<listitem><para>PKCS12 certificate import</para></listitem>
<listitem><para>Ping test</para></listitem>
<listitem><para>Automatically sets routes and firewall rules (iptables)</para></listitem>
<listitem><para>Automatically detects network device (can be overridden)</para></listitem>
<listitem><para>Log file writing</para></listitem>
<listitem><para>Supports different debug levels for kvpnc, racoon and vpnc</para></listitem>
<listitem><para>PPTP support (pptpclient)</para></listitem>
<listitem><para>OpenVPN support</para></listitem>
<listitem><para>DCOP interface</para></listitem>
<listitem><para>User notification on sucessful connection/disconnection</para></listitem>
<listitem><para>NAT-T support (racoon/FreeSWAN/OpenVPN/vpnc)</para></listitem>
<listitem><para>Log viewer</para></listitem>
<listitem><para>Tool checking</para></listitem>
<listitem><para>Retrieve dns servers from peer (PPTP)</para></listitem>
<listitem><para>Special user-defined server certificate option (FreeS/WAN)</para></listitem>
<listitem><para>Additional network routes support</para></listitem>
<listitem><para>Support for Debian resolv.conf (vpnc)</para></listitem>
<listitem><para>Colorized log output</para></listitem>
<listitem><para>User notifications</para></listitem>
<listitem><para>Deletes/keeps generated config files</para></listitem>
<listitem><para>Checking of /dev/net/tun and creating missing device entry</para></listitem>
<listitem><para>Stores size and position of the mainwindow</para></listitem>
</itemizedlist>
<!-- </sect1> -->
<!-- </para> -->
</chapter>

<chapter id="commands">
<title>Command Reference</title>

<!-- (OPTIONAL, BUT RECOMMENDED) This chapter should list all of the
application windows and their menubar and toolbar commands for easy reference.
Also include any keys that have a special function but have no equivalent in the
menus or toolbars. This may not be necessary for small apps or apps with no tool
or menu bars. -->

<sect1 id="kvpnc-mainwindow">
<title>The main &kvpnc; window</title>

<sect2>
<title>The File Menu</title>
<para>
<variablelist>
<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>Top</keycap></keycombo>
</shortcut>
<guimenu>File</guimenu>
<guimenuitem>Connect</guimenuitem>
</menuchoice></term>
<listitem><para><action>Establish connection using the currently chosen profile</action> &kvpnc;</para></listitem>
</varlistentry>
</variablelist>
<variablelist>
<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>Bottom</keycap></keycombo>
</shortcut>
<guimenu>File</guimenu>
<guimenuitem>Disconnect</guimenuitem>
</menuchoice></term>
<listitem><para><action>Disconnects from the currently used connection profile</action> &kvpnc;</para></listitem>
</varlistentry>
</variablelist>
<variablelist>
<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo>
</shortcut>
<guimenu>File</guimenu>
<guimenuitem>Quit</guimenuitem>
</menuchoice></term>
<listitem><para><action>Quits the application definitively and do not store into the kicker</action> &kvpnc;</para></listitem>
</varlistentry>
</variablelist>
</para>

</sect2>

<sect2>
<title>The Profile Menu</title>
<para>
<variablelist>
<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul"><keycap>N</keycap></keycombo>
</shortcut>
<guimenu>Profile</guimenu>
<guimenuitem>New profile</guimenuitem>
</menuchoice></term>
<listitem><para><action>Creates a new profile</action> &kvpnc;</para></listitem>
</varlistentry>
</variablelist>
<variablelist>
<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul"><keycap>S</keycap></keycombo>
</shortcut>
<guimenu>Profile</guimenu>
<guimenuitem>Save profile</guimenuitem>
</menuchoice></term>
<listitem><para><action>Saves the currently chosen profile</action> &kvpnc;</para></listitem>
</varlistentry>
</variablelist>
<variablelist>
<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul"><keycap>D</keycap></keycombo>
</shortcut>
<guimenu>Profile</guimenu>
<guimenuitem>Delete profile</guimenuitem>
</menuchoice></term>
<listitem><para><action>Deletes the currently chosen profile</action> &kvpnc;</para></listitem>
</varlistentry>
</variablelist>
<variablelist>
<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul"><keycap>I</keycap></keycombo>
</shortcut>
<guimenu>Profile</guimenu>
<guimenuitem>Import a Cisco PCF profile</guimenuitem>
</menuchoice></term>
<listitem><para><action>Imports a Cisco PCF profile</action> &kvpnc;</para></listitem>
</varlistentry>
</variablelist>
<variablelist>
<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul"><keycap>C</keycap></keycombo>
</shortcut>
<guimenu>Profile</guimenu>
<guimenuitem>Import a certificate file</guimenuitem>
</menuchoice></term>
<listitem><para><action>Imports a certificate file</action> &kvpnc;</para></listitem>
</varlistentry>
</variablelist>
<variablelist>
<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>C</keycap></keycombo>
</shortcut>
<guimenu>Profile</guimenu>
<guimenuitem>Show debugging console</guimenuitem>
</menuchoice></term>
<listitem><para><action>Shows the debugging console</action> &kvpnc;</para></listitem>
</varlistentry>
</variablelist>
<variablelist>
<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>T</keycap></keycombo>
</shortcut>
<guimenu>Profile</guimenu>
<guimenuitem>Show tools informations</guimenuitem>
</menuchoice></term>
<listitem><para><action>Shows the found tools, paths, and if working whether or not</action> &kvpnc;</para></listitem>
</varlistentry>
</variablelist>
<variablelist>
<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>L</keycap></keycombo>
</shortcut>
<guimenu>Profile</guimenu>
<guimenuitem>Show log</guimenuitem>
</menuchoice></term>
<listitem><para><action>Shows the logfile</action> &kvpnc;</para></listitem>
</varlistentry>
</variablelist>
</para>

</sect2>

<sect2>
<title>The <guimenu>Help</guimenu> Menu</title>

<!-- Assuming you have a standard help menu (help, what's this, about -->
<!-- &kvpnc;, about KDE) then the documentation is already written. -->
<!-- The following entity is valid anywhere that a variablelist is -->
<!-- valid.-->

&help.menu.documentation;

</sect2>

</sect1>
</chapter>

<chapter id="faq">
<title>Questions and Answers</title>

<!-- (OPTIONAL but recommended) This chapter should include all of the silly
(and not-so-silly) newbie questions that fill up your mailbox. This chapter
should be reserved for BRIEF questions and answers! If one question uses more
than a page or so then it should probably be part of the
"Using this Application" chapter instead. You should use links to
cross-reference questions to the parts of your documentation that answer them.
This is also a great place to provide pointers to other FAQ's if your users
must do some complicated configuration on other programs in order for your
application work. -->

&reporting.bugs;
&updating.documentation;

<qandaset id="faqlist">
<qandaentry>
<question><para>If compilation fails.</para></question>
<answer><para>There may be many reaons for the compilation to fail : lack of development tools and/or files, unstable code version ... Please try to search the web for your error and if you don't find an answer, then contact the team.</para></answer>
</qandaentry>
<qandaentry>
<question><para>What I have to do to get IPSec working?</para></question>
<answer>
<para>Please install and configure FreeS/WAN (Linux 2.4.x)/ipsec-tools (Linux 2.6.x) first.</para>
<para>Then do the following steps:</para>
<orderedlist>
<listitem><para>Import certificate (if X.509 is needed and it is PKCS12 which is ended with .p12).</para></listitem>
<listitem><para>Setup a new connection (gateway, ...)</para></listitem>
<listitem><para>Setup authentication (username,password/certificate/pre shared key) of the newly created connection.</para></listitem>
</orderedlist>
</answer>
</qandaentry>
<qandaentry>
<question><para>What I need for PPTP?</para></question>
<answer><para>You need a kernel with MPPE support and the <ulink url="http://sourceforge.net/projects/pptpclient/">pptpclient</ulink>.</para></answer>
</qandaentry>
</qandaset>
</chapter>

<chapter id="credits">

<!-- Include credits for the programmers, documentation writers, and
contributors here. The license for your software should then be included below
the credits with a reference to the appropriate license file included in the KDE
distribution. -->

<title>Credits and License</title>

<para>
&kvpnc;
</para>
<para>
Program copyright 2004-2005 Christoph Thielecke <email>crissi99&#64;gmx&#46;de</email>
</para>
<para>
Contributors:
<itemizedlist>
<listitem><para>KDE developers for great KDE.</para></listitem>
<listitem><para>KDevelop developers for great KDevelop.</para></listitem>
<listitem><para>Maurice Massar <email>vpnc@unix-ag.uni-kl.de</email> for his vpnc.</para></listitem>
<listitem><para>Laurent Montel <email>montel@kde.org</email> for patches.</para></listitem>
<listitem><para>Peter Kussmann <email>peter.kussmann@gmx.de</email> for various test environments and new ideas.</para></listitem>
<listitem><para>D. Klinkenberg <email>d.klinkenberg@gmx.net</email> for intensive testing PPTP functionality, usebility hints, tests and bug hunting.</para></listitem>
<listitem><para>All other people which report bugs.</para></listitem>
</itemizedlist>
</para>
<para>
Packagers:
<itemizedlist>
<listitem><para>Carsten Schöne <email>cs@linux-adminstrator.com</email> for building SuSE packages.</para></listitem>
</itemizedlist>
</para>
<!-- TRANS:CREDIT_FOR_TRANSLATORS -->
<para>
<itemizedlist>
<listitem><para>Christoph Thielecke <email>crissi99@gmx.de</email> - german  translation</para></listitem>
<listitem><para>Witek Strzelczyk <email>witek_strzelczyk@go2.pl</email> - polish translation</para></listitem>
<listitem><para>Tomas Olah <email>tomas.olah@alert.sk</email> - slovak translation</para></listitem>
<listitem><para>Lapo Luchini <email>lapo@lapo.it</email> - italian translation</para></listitem>
<listitem><para>Karoly Barcza <email>kbarcza@blackpanther.hu</email> - hungary translation</para></listitem>
<listitem><para>Luk De Ketelaere <email>balboy@kvirc.net</email> and Jorgen Kessler <email>jkesseler@home.nl</email> - dutch translation</para></listitem>
<listitem><para>Atanas M. <email>bugar@developer.bg</email> - bulgarian translation</para></listitem>
<listitem><para>Juanjo Avarez Martinez <email>juanjux@ yahoo.es</email> - Spanish translation</para></listitem>
<listitem><para>He Shi Jun <email>hax.sfo@gmail.com</email> and Marius Pacha <email>marius@matux.de</email> - Chinese translation</para></listitem>
<listitem><para>Ahinu <email>ahinu@wanadoo.fr</email> , Florian Fainelli<email>florian@alphacore.net</email> and Damien Raude-Morvan <email>drazzib@drazzib.com</email> - French translation</para></listitem>
<listitem><para>Valeriy Girchenko <email>valeragir@mail.ru</email> - Russian translation</para></listitem>
<listitem><para>Marc Serra Romero <email>mad93@majomo.com</email> - Catalan translation</para></listitem>
<listitem><para>Bülent SENER <email>bsener@inonu.edu.tr</email> - Turkish  translation</para></listitem>
</itemizedlist>
</para>
&underFDL; <!-- FDL: do not remove -->

<!-- Determine which license your application is licensed under, 
 and delete all the remaining licenses below:

 (NOTE:All documentation are licensed under the FDL,
 regardless of what license the application uses) -->

&underGPL; <!-- GPL License -->
<para>Documentation copyright 2004 Christoph Thielecke <email>crissi99&#64;gmx&#46;de</email></para>

</chapter>

<appendix id="installation">
<title>Installation</title>

<sect1 id="getting-kvpnc">
<title>How to obtain &kvpnc;</title>
<itemizedlist>
<listitem><para>Download</para>
<para>Get it from the filesection (<ulink url="http://download.gna.org/kvpnc/">http://download.gna.org/kvpnc/</ulink>).</para>
<para>Packages for various distributions are available there. You dont need to compile it, if there is a package for your distribution.</para>
</listitem>
<listitem><para>KDE3</para>
<para>The latest development code can be obtain from subversion respository. Simply do:</para>
<para><command>svn co svn://svn.gna.org/svn/kvpnc/trunk kvpnc</command></para>
<para><command>cd kvpnc</command></para>
<para><command>make -f admin/Makefile.common</command></para>
<para><command>./configure</command></para>
<para><command>make</command></para>
<para><command>su</command></para>
<para><command>make install</command></para>
<para><command>exit</command></para>
<para></para>
<para>Note to Gentoo and non usual KDE prefix users :</para>
<para>You have to export the TDEDIR variable in order to compile and install kvpnc properly, usually it is done by :</para>
<para><command>TDEDIR=/usr/kde/3.x/</command></para>
<para><command>./configure</command></para>


<para>Then continue as previously explained</para>
</listitem>
<listitem><para>KDE4</para>
<para>The latest development code can be obtain from KDE subversion respository. Simply do:</para>
<para><command>svn co svn://anonsvn.kde.org/home/kde/trunk/playground/network/kvpnc kvpnc-kde4</command></para>
<para><command>cd kvpnc-kde4</command></para>
<para><command>cmake .</command></para>
<para><command>make</command></para>
<para><command>su</command></para>
<para><command>make install</command></para>
<para><command>exit</command></para>
<para></para>
<para>Note to Gentoo and non usual KDE prefix users :</para>
<para>You have to export the TDEDIR variable in order to compile and install kvpnc properly, usually it is done by :</para>
<para><command>TDEDIR=/usr/kde/3.x/</command></para>
<para><command>./configure</command></para>



<para>Then continue as previously explained</para>
</listitem>
</itemizedlist>
</sect1>
<sect1 id="requirements">
<title>Requirements</title>
<!--
List any special requirements for your application here. This should include:
.Libraries or other software that is not included in kdesupport,
kdelibs, or kdebase.
.Hardware requirements like amount of RAM, disk space, graphics card
capabilities, screen resolution, special expansion cards, etc.
.Operating systems the app will run on. If your app is designed only for a
specific OS, (you wrote a graphical LILO configurator for example) put this
information here.
-->
<para>In order to successfully use &kvpnc;, you need &kde; >= 3.1.</para>
<para>The following tools are optional but minimal one of them is required for normal use.</para>
<itemizedlist>
<listitem><para><ulink url="http://www.unix-ag.uni-kl.de/~massar/vpnc/">vpnc</ulink> >= 0.2-rm+zomb-pre9 (0.3.x strongly recommended) - Cisco VPN</para></listitem>
<listitem><para><ulink url="http://www.freeswan.org">FreeS/WAN</ulink> (OpenS/WAN too) - IPSec VPN Linux 2.4/2.6</para></listitem>
<listitem><para><ulink url="http://www.strongswan.org/">strongSwan</ulink> - http://www.strongswan.org/</para></listitem>
<listitem><para><ulink url="http://www.openswan.org/">Openswan</ulink> - http://www.openswan.org/</para></listitem>
<listitem><para><ulink url="http://ipsec-tools.sourceforge.net/">racoon</ulink> - (ipsec-tools) > = 1.xIPSec VPN Linux 2.6</para></listitem>
<listitem><para><ulink url="http://sourceforge.net/projects/pptpclient/">pptpclient</ulink> - PPTP VPN</para></listitem>
<listitem><para><ulink url="http://l2tpd.sourceforge.net/">l2tpd</ulink> - http://l2tpd.sourceforge.net</para></listitem>
<listitem><para><ulink url="http://www.xelerance.com/software/xl2tpd/">xl2tpd</ulink> - http://www.xelerance.com/software/xl2tpd/</para></listitem>
<listitem><para><ulink url="http://www.openl2tp.org/">openl2tp</ulink> - http://www.openl2tp.org/</para></listitem>
<listitem><para><ulink url="http://www.openvpn.org/">OpenVPN</ulink>.- VPN based on SSL</para></listitem>
<listitem><para><ulink url="http://vtun.sourceforge.net/">Vtun</ulink> - http://vtun.sourceforge.net/</para></listitem>
<listitem><para><ulink url="http://openssh.net/">OpenSSH</ulink> - http://openssh.net/</para></listitem>


</itemizedlist>
<para>
&kvpnc; can be found at <ulink url="http://home.gna.org/kvpnc/">&kvpnc; home page</ulink>.
</para>
<!-- For a list of updates, you may refer to the application web site
or the ChangeLog file, or ... -->
<para>
You can find a list of changes at <ulink url="http://home.gna.org/kvpnc/changelog.html">Changelog</ulink>.
</para>
</sect1>

<sect1 id="compilation">
<title>Compilation and Installation</title>
<para>To compile kvpnc simply do:</para>
<para>tar xvfj kvpnc-&lt;version&gt;.tar.bz2</para>
<para>cd kvpnc-&lt;version&gt;</para>
<para>make -f admin/Makefile.common (optional)</para>
<para>./configure [--prefix=...] (KDE3)</para>
<para>cmake . (KDE4)</para>
<para>make</para>
<para>su</para>
<para>make install</para>
</sect1>

<sect1 id="configuration">
<!-- FIXME this is quite old!!! -->
<title>Configuration</title>
<para>
<itemizedlist>
<!-- <listitem> -->
<title>Creating a new profile</title>
<listitem>
<!--<para>aa</para>-->
<orderedlist>
<listitem>
<para>Click on "New profile..." from Profile menu.</para>
</listitem>
<listitem>
<para>Select the type of connection, hostname of the vpn server. Also fill in remote network, username, password, pres shared key (PSK) or certificate if nessary.</para>
</listitem>
<listitem>
<para>Click "Ok" for creating the new profile.</para>
</listitem>
</orderedlist>
<!-- </para> -->
<!-- </listitem> -->
<!--Start kvpnc from KDE - Internet - kvpnc. Change in preferences dialog the global settings. Click on "New profile..." to add a new profile. Enter the new Name in the upcoming dialog, fill in the empty fields and save profile by clicking on "Save profile...". After enter your VPN data, click on "connect" to connect to your VPN server. By default, kvpnc minimizes into kicker dock after sucessfull connect.-->
</listitem>
</itemizedlist>
</para>
</sect1>

</appendix>
&documentation.index;
</book>

<!--
Local Variables:
mode: sgml
sgml-minimize-attributes:nil
sgml-general-insert-case:lower
sgml-indent-step:0
sgml-indent-data:nil
End:

vim:tabstop=2:shiftwidth=2:expandtab 
-->