[DOC] Create glossary in user manual and move pages to it

Signed-off-by: Sergey Matveev <stargrave@stargrave.org>

diff --git a/doc/cpr.texi b/doc/cpr.texi
index 5256a81e7f0c565707ce33478b659ed641f40bbe..5ea57177df8520442865eadd9ce1eab07ac5cc67 100644 (file)
--- a/doc/cpr.texi
+++ b/doc/cpr.texi
@@ -1,5 +1,5 @@
 @node CPR
 @node CPR

-@section Constant Packet Rate
+@subsection Constant Packet Rate

 
 Constant Packet Rate is used to hide fact of underlying payload packets
 appearance. In this mode daemon inserts necessary dummy packets and
 
 Constant Packet Rate is used to hide fact of underlying payload packets
 appearance. In this mode daemon inserts necessary dummy packets and


@@ -7,4 +7,4 @@ delays other ones.
 
 This mode is turned by @code{-cpr} option, where you specify desired
 outgoing traffic rate in KiB/sec (kibibytes per second). This option also
 
 This mode is turned by @code{-cpr} option, where you specify desired
 outgoing traffic rate in KiB/sec (kibibytes per second). This option also

-@strong{forces} using of the @ref{Noise}! It is turned off by default.
+@strong{forces} using of the @ref{Noise, noise}! It is turned off by default.

diff --git a/doc/egd.texi b/doc/egd.texi
index 62d1d87a2e73c60d6e5085844e7156c07d3981b9..c0006db3ac601ae52bb3595339956d8409d75b20 100644 (file)
--- a/doc/egd.texi
+++ b/doc/egd.texi
@@ -1,5 +1,5 @@
 @node EGD
 @node EGD

-@section Entropy Gathering Daemon
+@subsection Entropy Gathering Daemon

 
 Overall security mainly depends on client side:
 @ref{PAKE, good passphrase} and cryprographically good pseudo random
 
 Overall security mainly depends on client side:
 @ref{PAKE, good passphrase} and cryprographically good pseudo random

diff --git a/doc/glossary.texi b/doc/glossary.texi
new file mode 100644 (file)
index 0000000..8d1158f
--- /dev/null
+++ b/doc/glossary.texi
@@ -0,0 +1,28 @@
+@node Glossary
+@section Glossary
+
+@menu
+* Entropy gathering daemon: EGD.
+* Identity::
+* Password Authenticated Key Agreement: PAKE.
+* Timeout::
+* Network transport: Network.
+* Proxy::
+* Maximum Transmission Unit: MTU.
+* Statistics: Stats.
+* Noise::
+* Constant Packet Rate: CPR.
+* Verifier::
+@end menu
+
+@include egd.texi
+@include identity.texi
+@include pake.texi
+@include timeout.texi
+@include netproto.texi
+@include proxy.texi
+@include mtu.texi
+@include stats.texi
+@include noise.texi
+@include cpr.texi
+@include verifier.texi

diff --git a/doc/identity.texi b/doc/identity.texi
index 3153abd9489ef509a4b8a63606b8b6b62b92e8d2..3a37790cab5f9b132a69ef345058089d60d322f3 100644 (file)
--- a/doc/identity.texi
+++ b/doc/identity.texi
@@ -1,5 +1,5 @@
 @node Identity
 @node Identity

-@section Identity
+@subsection Identity

 
 Client's identity is 128-bit string. It is not secret, so can be
 transmitted and stored in the clear. However handshake applies PRP on it
 
 Client's identity is 128-bit string. It is not secret, so can be
 transmitted and stored in the clear. However handshake applies PRP on it

diff --git a/doc/mtu.texi b/doc/mtu.texi
index 9c958cd383533381d4113a5fddab8eba8bb712dd..f847166cf6b7c5f18c9d041789065d4bd5a465e3 100644 (file)
--- a/doc/mtu.texi
+++ b/doc/mtu.texi
@@ -1,5 +1,5 @@
 @node MTU
 @node MTU

-@section Maximum Transmission Unit
+@subsection Maximum Transmission Unit

 
 MTU option tells what maximum transmission unit is expected to get from
 TAP interface. It is per-user configuration. If the program gets bigger
 
 MTU option tells what maximum transmission unit is expected to get from
 TAP interface. It is per-user configuration. If the program gets bigger

diff --git a/doc/netproto.texi b/doc/netproto.texi
index d033656901f090a735b39a268ad49b577969b867..d57edb35ab0dbdf5a95a85dd48ed9b7ce05856bc 100644 (file)
--- a/doc/netproto.texi
+++ b/doc/netproto.texi
@@ -1,5 +1,5 @@
 @node Network
 @node Network

-@section Network transport
+@subsection Network transport

 
 You can use either UDP or TCP underlying network transport protocols.
 
 
 You can use either UDP or TCP underlying network transport protocols.
 

diff --git a/doc/noise.texi b/doc/noise.texi
index 06ee1de2051a830a542505f4d8a54fb2c0b417eb..9cd03d2bffac012c24ba5fb4ed4e4bb1365c8118 100644 (file)
--- a/doc/noise.texi
+++ b/doc/noise.texi
@@ -1,5 +1,5 @@
 @node Noise
 @node Noise

-@section Noise
+@subsection Noise

 
 So-called noise is used to hide underlying payload packets lengths.
 Without it GoVPN provides confidentiality and authenticity of messages,
 
 So-called noise is used to hide underlying payload packets lengths.
 Without it GoVPN provides confidentiality and authenticity of messages,

diff --git a/doc/pake.texi b/doc/pake.texi
index fa8a322c6666a9f132cfacd4564399dad3a4b2fc..b80f5697f51fc964eb0be98a4d6c173b2b0310fb 100644 (file)
--- a/doc/pake.texi
+++ b/doc/pake.texi
@@ -1,5 +1,5 @@
 @node PAKE
 @node PAKE

-@section Password Authenticated Key Agreement
+@subsection Password Authenticated Key Agreement

 
 Previously we used pre-shared high-entropy long-term static key for
 client-server authentication. Is is secure, but not convenient for some
 
 Previously we used pre-shared high-entropy long-term static key for
 client-server authentication. Is is secure, but not convenient for some

diff --git a/doc/proxy.texi b/doc/proxy.texi
index 0e990350df2aa5c45a8ce9d20dba500e72c30369..b0f08fc97644a51300683ec5641fc02e632350ad 100644 (file)
--- a/doc/proxy.texi
+++ b/doc/proxy.texi
@@ -1,5 +1,5 @@
 @node Proxy
 @node Proxy

-@section Proxy
+@subsection Proxy

 
 You can proxy your requests through HTTP using CONNECT method. This can
 help if you are only allowed to access outside world through HTTP proxy
 
 You can proxy your requests through HTTP using CONNECT method. This can
 help if you are only allowed to access outside world through HTTP proxy

diff --git a/doc/stats.texi b/doc/stats.texi
index f6284e0cad03b52d0ebe1b6eb3ebeedb3a5eff85..c543137a808a08dfe755e3083d755805aab50d23 100644 (file)
--- a/doc/stats.texi
+++ b/doc/stats.texi
@@ -1,5 +1,5 @@
 @node Stats
 @node Stats

-@section Stats
+@subsection Statistics

 
 Both client and server has ability to show statistics about known
 connected peers. You retrieve them by downloading JSON from built-in
 
 Both client and server has ability to show statistics about known
 connected peers. You retrieve them by downloading JSON from built-in

diff --git a/doc/timeout.texi b/doc/timeout.texi
index 0f2e2dbf43257272a35fe387068aca35d38e345d..89dd5b011579ae16c80dc05bf8d1f28eea33bcab 100644 (file)
--- a/doc/timeout.texi
+++ b/doc/timeout.texi
@@ -1,5 +1,5 @@
 @node Timeout
 @node Timeout

-@section Timeout
+@subsection Timeout

 
 Because of stateless UDP nature there is no way to reliably know if
 remote peer is alive. That is why timeouts are necessary. If no packets
 
 Because of stateless UDP nature there is no way to reliably know if
 remote peer is alive. That is why timeouts are necessary. If no packets

diff --git a/doc/user.texi b/doc/user.texi
index 73214da36ef357ceae50702ad118233a694749af..d2118b30be55b78f09fb8ce38a3a4fe01723dcdb 100644 (file)
--- a/doc/user.texi
+++ b/doc/user.texi
@@ -14,33 +14,13 @@ What network performance can user expect? For example single
 with @emph{Go 1.5.1} gives 786 Mbps (UDP transport) throughput.
 
 @menu
 with @emph{Go 1.5.1} gives 786 Mbps (UDP transport) throughput.
 
 @menu

-* EGD:: Entropy gathering daemon
-* Identity::
-* PAKE:: Password Authenticated Key Agreement
-* Timeout::
-* Network transport: Network.
-* Proxy::
-* MTU:: Maximum Transmission Unit
-* Stats::
-* Noise::
-* CPR:: Constant Packet Rate
-* Verifier::
+* Glossary::

 * Client part: Client.
 * Server part: Server.
 * Example usage: Example.
 @end menu
 
 * Client part: Client.
 * Server part: Server.
 * Example usage: Example.
 @end menu
 

-@include egd.texi
-@include identity.texi
-@include pake.texi
-@include timeout.texi
-@include netproto.texi
-@include proxy.texi
-@include mtu.texi
-@include stats.texi
-@include noise.texi
-@include cpr.texi
-@include verifier.texi
+@include glossary.texi

 @include client.texi
 @include server.texi
 @include example.texi
 @include client.texi
 @include server.texi
 @include example.texi

diff --git a/doc/verifier.texi b/doc/verifier.texi
index 74c61496e1d133f6334b02d58152c4a089769d52..bb364d747f6568f5b52e24fe3321571e82c08043 100644 (file)
--- a/doc/verifier.texi
+++ b/doc/verifier.texi
@@ -1,5 +1,5 @@
 @node Verifier
 @node Verifier

-@section Verifier
+@subsection Verifier

 
 Verifier is created using @code{govpn-verifier} utility. But currently
 Go does not provide native instruments to read passwords without echoing
 
 Verifier is created using @code{govpn-verifier} utility. But currently
 Go does not provide native instruments to read passwords without echoing