diff options
author | gregory guy <gregory-tde@laposte.net> | 2020-02-22 12:31:47 +0100 |
---|---|---|
committer | gregory guy <gregory-tde@laposte.net> | 2020-02-22 12:44:01 +0100 |
commit | 9b99335373bb5e06cfb2cdbbff4f6d45b3d0edda (patch) | |
tree | 5414f4b1866fb6ac99d742f217b19f470e1ae477 /doc/en/index.docbook | |
parent | a79160540c050b5eaca4ecdcee65ec2e164eae6f (diff) | |
download | kvpnc-9b99335373bb5e06cfb2cdbbff4f6d45b3d0edda.tar.gz kvpnc-9b99335373bb5e06cfb2cdbbff4f6d45b3d0edda.zip |
Drop automake build support.
Add basic build instructions.
Rework of the README, INSTALL and help page.
Remove empty folder templates and the NEWS file.
Delete the INSTALL.debian and INSTALL.gentoo files.
Create the doc/misc folder to hold lot of config
and/or readme files.
Signed-off-by: gregory guy <gregory-tde@laposte.net>
Diffstat (limited to 'doc/en/index.docbook')
-rw-r--r-- | doc/en/index.docbook | 104 |
1 files changed, 29 insertions, 75 deletions
diff --git a/doc/en/index.docbook b/doc/en/index.docbook index 4ac4989..0f58ae6 100644 --- a/doc/en/index.docbook +++ b/doc/en/index.docbook @@ -91,7 +91,7 @@ Do NOT change these in the translation. --> <abstract> <para> -&kvpnc; is a KDE frontend for various vpn clients. +&kvpnc; is a TDE frontend for various vpn clients. </para> </abstract> @@ -131,7 +131,7 @@ 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>. +KVpnc is a <ulink url="http://www.trinitydesktop.org/">TDE</ulink> frontend for various vpn clients. It supports Cisco VPN (<ulink url="https://www.unix-ag.uni-kl.de/~massar/vpnc/">vpnc</ulink>), IPSec (<ulink url="https://www.freeswan.org">FreeS/WAN</ulink> (OpenS/WAN), <ulink url="http://ipsec-tools.sourceforge.net/">racoon</ulink>), PPTP (<ulink url="https://sourceforge.net/projects/pptpclient/">pptpclient</ulink>), <ulink url="https://www.openvpn.net">OpenVPN</ulink>, L2TP (FreeS/WAN, <ulink url="https://www.openswan.org/">Openswan</ulink>, <ulink url="https://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="https://www.openssh.net/">OpenSSH</ulink>. </para> @@ -142,17 +142,13 @@ KVpnc is a <ulink url="http://www.kde.org/">KDE</ulink> frontend for various vpn <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> +<para>The project page can be found at: <ulink url="https://mirror.git.trinitydesktop.org/gitea/TDE/kvpnc">https://mirror.git.trinitydesktop.org/gitea/TDE/kvpnc</ulink>.</para> </listitem> <listitem> -<para>Contact the kvpnc team:</para> +<para>Contact the kvpnc team (TDE):</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&content-type=text/plain">http://cvs.gna.org/viewcvs/*checkout*/kvpnc/kvpnc/TODO?rev=HEAD&content-type=text/plain</ulink> (in English). -</para> +<para>Bug reports as well as wishes for (new) features can be reported at the adress above.</para> </listitem> </itemizedlist> <itemizedlist> @@ -160,13 +156,13 @@ KVpnc is a <ulink url="http://www.kde.org/">KDE</ulink> frontend for various vpn <para>Mailing list</para> <itemizedlist> <listitem> -<para>kvpnc-user - this list is for users of KVpnc who want to discuss about KVpnc.</para> +<para>trinity-user - this list is for users of KVpnc who want to discuss about KVpnc: <ulink url="http://trinity-users.pearsoncomputing.net/">trinity-users@lists</ulink></para> </listitem> <listitem> -<para>kvpnc-devel - this list is related to development of KVpnc.</para> +<para>trinity-devel - this list is related to development of KVpnc: <ulink url="http://trinity-devel.pearsoncomputing.net/">trinity-devel@lists</ulink></para> </listitem> <listitem> -<para>kvpnc-cvs - this list shows the commit to the CVS tree (readonly).</para> +<para>trinity-commits - this list shows the commit to the git tree (readonly): <ulink url="http://trinity-commits.pearsoncomputing.net/">trinity-commits@lists</ulink></para> </listitem> </itemizedlist> </listitem> @@ -260,7 +256,7 @@ PPTP is a old VPN protocol designed by Microsoft. Today its known to be insecure <!-- <sect1> --> <para>KVpnc provides a lot of features:</para> <itemizedlist> -<listitem><para>Easy to use KDE gui</para></listitem> +<listitem><para>Easy to use TDE 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> @@ -503,15 +499,8 @@ 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> @@ -601,46 +590,13 @@ Packagers: <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> +<para>Get it from the release files section (<ulink url="https://mirror.git.trinitydesktop.org/gitea/TDE/kvpnc/releases">https://mirror.git.trinitydesktop.org/gitea/TDE/kvpnc/releases</ulink>).</para> +<para>Packages for various distributions are available there: <ulink url="http://www.trinitydesktop.org/releases.php">http://www.trinitydesktop.org/releases.php</ulink> 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> +<listitem><para>TDE</para> +<para>The latest development code can be obtain from the git respository. Simply do:</para> +<para><command>git clone https://mirror.git.trinitydesktop.org/gitea/TDE/kvpnc.git</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> @@ -656,31 +612,28 @@ capabilities, screen resolution, special expansion cards, etc. 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>In order to successfully build &kvpnc;, you will need the tdelibs and libgcrypt libraries.</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="https://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="https://www.freeswan.org">FreeS/WAN</ulink> (OpenS/WAN too) - IPSec VPN Linux 2.4/2.6</para></listitem> +<listitem><para><ulink url="https://www.strongswan.org/">strongSwan</ulink> - http://www.strongswan.org/</para></listitem> +<listitem><para><ulink url="https://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="https://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="https://www.xelerance.com/archives/155/">xl2tpd</ulink> - https://www.xelerance.com/software/xl2tpd/</para></listitem> +<listitem><para><ulink url="https://sourceforge.net/projects/openl2tp/">openl2tp</ulink> - https://sourceforge.net/projects/openl2tp/</para></listitem> +<listitem><para><ulink url="https://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> +<listitem><para><ulink url="https://openssh.net/">OpenSSH</ulink> - https://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>. +You can find a list of changes (not updated since 2010) at <ulink url="https://mirror.git.trinitydesktop.org/gitea/TDE/kvpnc/src/branch/master/ChangeLog">Changelog</ulink>. </para> </sect1> @@ -689,12 +642,13 @@ You can find a list of changes at <ulink url="http://home.gna.org/kvpnc/changelo <para>To compile kvpnc simply do:</para> <para>tar xvfj kvpnc-<version>.tar.bz2</para> <para>cd kvpnc-<version></para> -<para>make -f admin/Makefile.common (optional)</para> -<para>./configure [--prefix=...] (KDE3)</para> -<para>cmake . (KDE4)</para> +<para>mkdir -p build</para> +<para>cd build</para> +<para>cmake ..</para> <para>make</para> <para>su</para> <para>make install</para> +<para>For basic cmake options, please readme the INSTALL file.</para> </sect1> <sect1 id="configuration"> |