]> Cypherpunks.ru repositories - govpn.git/blobdiff - doc/user.texi
JSON configuration
[govpn.git] / doc / user.texi
index 075f2991bedea3905cdc0ed736645b0eac41cd2d..73214da36ef357ceae50702ad118233a694749af 100644 (file)
@@ -1,41 +1,46 @@
-@node User manual
+@node User
 @unnumbered User manual
 
-Announcements about updates and new releases can be found in
-@ref{Reporting bugs}.
+Announcements about updates and new releases can be found in @ref{Contacts}.
 
-GoVPN is split into two pieces: client and server. Each of them work on
-top of UDP and TAP virtual network interfaces. GoVPN is just a
-tunnelling of Ethernet frames, nothing less, nothing more. All you
-IP-level network management is not touched by VPN at all. You can
-automate it using up and down shell scripts.
+GoVPN is split into two pieces: @ref{Client} and @ref{Server}. Each of
+them work on top of @ref{Network, UDP/TCP} and TAP virtual network
+interfaces. GoVPN is just a tunnelling of Ethernet frames, nothing less,
+nothing more. All you IP-related network management is not touched by
+VPN at all. You can automate it using up and down shell scripts.
+
+What network performance can user expect? For example single
+@emph{Intel i5-2450M 2.5 GHz} core on @emph{FreeBSD 10.2 amd64}
+with @emph{Go 1.5.1} gives 786 Mbps (UDP transport) throughput.
 
 @menu
+* EGD:: Entropy gathering daemon
+* Identity::
+* PAKE:: Password Authenticated Key Agreement
 * Timeout::
-* Nonce difference::
-* MTU::
-* Client part::
-* Server part::
+* Network transport: Network.
+* Proxy::
+* MTU:: Maximum Transmission Unit
 * Stats::
 * Noise::
-* CPR::
-* Example usage::
+* CPR:: Constant Packet Rate
+* Verifier::
+* Client part: Client.
+* Server part: Server.
+* Example usage: Example.
 @end menu
 
+@include egd.texi
+@include identity.texi
+@include pake.texi
 @include timeout.texi
-
-@include noncediff.texi
-
+@include netproto.texi
+@include proxy.texi
 @include mtu.texi
-
-@include client.texi
-
-@include server.texi
-
 @include stats.texi
-
 @include noise.texi
-
 @include cpr.texi
-
+@include verifier.texi
+@include client.texi
+@include server.texi
 @include example.texi