[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
bug#26137: [PATCH 6/6] doc: Re-generate openvpn service documentation.
From: |
Mathieu Othacehe |
Subject: |
bug#26137: [PATCH 6/6] doc: Re-generate openvpn service documentation. |
Date: |
Fri, 17 Mar 2017 11:34:30 +0100 |
* doc/guix.texi (VPN Services): Generate documentation with
generate-openvpn-server-documentation and
generate-openvpn-client-documentation helpers and guile 2.1.7.
---
doc/guix.texi | 88 +++++++++++++++++++++++++++++------------------------------
1 file changed, 44 insertions(+), 44 deletions(-)
diff --git a/doc/guix.texi b/doc/guix.texi
index bed8a6ff4..fd6b9a15b 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -13027,19 +13027,19 @@ Both can be run simultaneously.
Available @code{openvpn-client-configuration} fields are:
address@hidden @code{openvpn-client-configuration} parameter package openvpn
address@hidden address@hidden parameter} package openvpn
The OpenVPN package.
@end deftypevr
address@hidden @code{openvpn-client-configuration} parameter string pid-file
address@hidden address@hidden parameter} string pid-file
The OpenVPN pid file.
Defaults to @samp{"/var/run/openvpn/openvpn.pid"}.
@end deftypevr
address@hidden @code{openvpn-client-configuration} parameter proto proto
address@hidden address@hidden parameter} proto proto
The protocol (UDP or TCP) used to open a channel between clients and
servers.
@@ -13047,21 +13047,21 @@ Defaults to @samp{udp}.
@end deftypevr
address@hidden @code{openvpn-client-configuration} parameter dev dev
address@hidden address@hidden parameter} dev dev
The device type used to represent the VPN connection.
Defaults to @samp{tun}.
@end deftypevr
address@hidden @code{openvpn-client-configuration} parameter string ca
address@hidden address@hidden parameter} string ca
The certificate authority to check connections against.
Defaults to @samp{"/etc/openvpn/ca.crt"}.
@end deftypevr
address@hidden @code{openvpn-client-configuration} parameter string cert
address@hidden address@hidden parameter} string cert
The certificate of the machine the daemon is running on. It should be
signed by the authority given in @code{ca}.
@@ -13069,7 +13069,7 @@ Defaults to @samp{"/etc/openvpn/client.crt"}.
@end deftypevr
address@hidden @code{openvpn-client-configuration} parameter string key
address@hidden address@hidden parameter} string key
The key of the machine the daemon is running on. It must be the key whose
certificate is @code{cert}.
@@ -13077,21 +13077,21 @@ Defaults to @samp{"/etc/openvpn/client.key"}.
@end deftypevr
address@hidden @code{openvpn-client-configuration} parameter boolean comp-lzo?
address@hidden address@hidden parameter} boolean comp-lzo?
Whether to use the lzo compression algorithm.
Defaults to @samp{#t}.
@end deftypevr
address@hidden @code{openvpn-client-configuration} parameter boolean
persist-key?
address@hidden address@hidden parameter} boolean persist-key?
Don't re-read key files across SIGUSR1 or --ping-restart.
Defaults to @samp{#t}.
@end deftypevr
address@hidden @code{openvpn-client-configuration} parameter boolean
persist-tun?
address@hidden address@hidden parameter} boolean persist-tun?
Don't close and reopen TUN/TAP device or run up/down scripts across
SIGUSR1 or --ping-restart restarts.
@@ -13099,14 +13099,14 @@ Defaults to @samp{#t}.
@end deftypevr
address@hidden @code{openvpn-client-configuration} parameter number verbosity
address@hidden address@hidden parameter} number verbosity
Verbosity level.
Defaults to @samp{3}.
@end deftypevr
address@hidden @code{openvpn-client-configuration} parameter tls-auth-client
tls-auth
address@hidden address@hidden parameter} tls-auth-client tls-auth
Add an additional layer of HMAC authentication on top of the TLS control
channel to protect against DoS attacks.
@@ -13114,42 +13114,42 @@ Defaults to @samp{#f}.
@end deftypevr
address@hidden @code{openvpn-client-configuration} parameter key-usage
verify-key-usage?
address@hidden address@hidden parameter} key-usage verify-key-usage?
Whether to check the server certificate has server usage extension.
Defaults to @samp{#t}.
@end deftypevr
address@hidden @code{openvpn-client-configuration} parameter bind bind?
address@hidden address@hidden parameter} bind bind?
Bind to a specific local port number.
Defaults to @samp{#f}.
@end deftypevr
address@hidden @code{openvpn-client-configuration} parameter resolv-retry
resolv-retry?
address@hidden address@hidden parameter} resolv-retry resolv-retry?
Retry resolving server address.
Defaults to @samp{#t}.
@end deftypevr
address@hidden @code{openvpn-client-configuration} parameter
openvpn-remote-list remote
address@hidden address@hidden parameter} openvpn-remote-list remote
A list of remote servers to connect to.
Defaults to @samp{()}.
Available @code{openvpn-remote-configuration} fields are:
address@hidden @code{openvpn-remote-configuration} parameter string name
address@hidden address@hidden parameter} string name
Server name.
Defaults to @samp{"my-server"}.
@end deftypevr
address@hidden @code{openvpn-remote-configuration} parameter number port
address@hidden address@hidden parameter} number port
Port number the server listens to.
Defaults to @samp{1194}.
@@ -13163,19 +13163,19 @@ Defaults to @samp{1194}.
Available @code{openvpn-server-configuration} fields are:
address@hidden @code{openvpn-server-configuration} parameter package openvpn
address@hidden address@hidden parameter} package openvpn
The OpenVPN package.
@end deftypevr
address@hidden @code{openvpn-server-configuration} parameter string pid-file
address@hidden address@hidden parameter} string pid-file
The OpenVPN pid file.
Defaults to @samp{"/var/run/openvpn/openvpn.pid"}.
@end deftypevr
address@hidden @code{openvpn-server-configuration} parameter proto proto
address@hidden address@hidden parameter} proto proto
The protocol (UDP or TCP) used to open a channel between clients and
servers.
@@ -13183,21 +13183,21 @@ Defaults to @samp{udp}.
@end deftypevr
address@hidden @code{openvpn-server-configuration} parameter dev dev
address@hidden address@hidden parameter} dev dev
The device type used to represent the VPN connection.
Defaults to @samp{tun}.
@end deftypevr
address@hidden @code{openvpn-server-configuration} parameter string ca
address@hidden address@hidden parameter} string ca
The certificate authority to check connections against.
Defaults to @samp{"/etc/openvpn/ca.crt"}.
@end deftypevr
address@hidden @code{openvpn-server-configuration} parameter string cert
address@hidden address@hidden parameter} string cert
The certificate of the machine the daemon is running on. It should be
signed by the authority given in @code{ca}.
@@ -13205,7 +13205,7 @@ Defaults to @samp{"/etc/openvpn/client.crt"}.
@end deftypevr
address@hidden @code{openvpn-server-configuration} parameter string key
address@hidden address@hidden parameter} string key
The key of the machine the daemon is running on. It must be the key whose
certificate is @code{cert}.
@@ -13213,21 +13213,21 @@ Defaults to @samp{"/etc/openvpn/client.key"}.
@end deftypevr
address@hidden @code{openvpn-server-configuration} parameter boolean comp-lzo?
address@hidden address@hidden parameter} boolean comp-lzo?
Whether to use the lzo compression algorithm.
Defaults to @samp{#t}.
@end deftypevr
address@hidden @code{openvpn-server-configuration} parameter boolean
persist-key?
address@hidden address@hidden parameter} boolean persist-key?
Don't re-read key files across SIGUSR1 or --ping-restart.
Defaults to @samp{#t}.
@end deftypevr
address@hidden @code{openvpn-server-configuration} parameter boolean
persist-tun?
address@hidden address@hidden parameter} boolean persist-tun?
Don't close and reopen TUN/TAP device or run up/down scripts across
SIGUSR1 or --ping-restart restarts.
@@ -13235,14 +13235,14 @@ Defaults to @samp{#t}.
@end deftypevr
address@hidden @code{openvpn-server-configuration} parameter number verbosity
address@hidden address@hidden parameter} number verbosity
Verbosity level.
Defaults to @samp{3}.
@end deftypevr
address@hidden @code{openvpn-server-configuration} parameter tls-auth-server
tls-auth
address@hidden address@hidden parameter} tls-auth-server tls-auth
Add an additional layer of HMAC authentication on top of the TLS control
channel to protect against DoS attacks.
@@ -13250,56 +13250,56 @@ Defaults to @samp{#f}.
@end deftypevr
address@hidden @code{openvpn-server-configuration} parameter number port
address@hidden address@hidden parameter} number port
Specifies the port number on which the server listens.
Defaults to @samp{1194}.
@end deftypevr
address@hidden @code{openvpn-server-configuration} parameter ip-mask server
address@hidden address@hidden parameter} ip-mask server
An ip and mask specifying the subnet inside the virtual network.
Defaults to @samp{"10.8.0.0 255.255.255.0"}.
@end deftypevr
address@hidden @code{openvpn-server-configuration} parameter cidr6 server-ipv6
address@hidden address@hidden parameter} cidr6 server-ipv6
A CIDR notation specifying the IPv6 subnet inside the virtual network.
Defaults to @samp{#f}.
@end deftypevr
address@hidden @code{openvpn-server-configuration} parameter string dh
address@hidden address@hidden parameter} string dh
The Diffie-Hellman parameters file.
Defaults to @samp{"/etc/openvpn/dh2048.pem"}.
@end deftypevr
address@hidden @code{openvpn-server-configuration} parameter string
ifconfig-pool-persist
address@hidden address@hidden parameter} string ifconfig-pool-persist
The file that records client IPs.
Defaults to @samp{"/etc/openvpn/ipp.txt"}.
@end deftypevr
address@hidden @code{openvpn-server-configuration} parameter gateway
redirect-gateway?
address@hidden address@hidden parameter} gateway redirect-gateway?
When true, the server will act as a gateway for its clients.
Defaults to @samp{#f}.
@end deftypevr
address@hidden @code{openvpn-server-configuration} parameter boolean
client-to-client?
address@hidden address@hidden parameter} boolean client-to-client?
When true, clients are alowed to talk to each other inside the VPN.
Defaults to @samp{#f}.
@end deftypevr
address@hidden @code{openvpn-server-configuration} parameter keepalive keepalive
address@hidden address@hidden parameter} keepalive keepalive
Causes ping-like messages to be sent back and forth over the link so
that each side knows when the other side has gone down. @code{keepalive}
requires a pair. The first element is the period of the ping sending,
@@ -13308,14 +13308,14 @@ down.
@end deftypevr
address@hidden @code{openvpn-server-configuration} parameter number max-clients
address@hidden address@hidden parameter} number max-clients
The maximum number of clients.
Defaults to @samp{100}.
@end deftypevr
address@hidden @code{openvpn-server-configuration} parameter string status
address@hidden address@hidden parameter} string status
The status file. This file shows a small report on current connection.
It is trunkated and rewritten every minute.
@@ -13323,28 +13323,28 @@ Defaults to @samp{"/var/run/openvpn/status"}.
@end deftypevr
address@hidden @code{openvpn-server-configuration} parameter openvpn-ccd-list
client-config-dir
address@hidden address@hidden parameter} openvpn-ccd-list client-config-dir
The list of configuration for some clients.
Defaults to @samp{()}.
Available @code{openvpn-ccd-configuration} fields are:
address@hidden @code{openvpn-ccd-configuration} parameter string name
address@hidden address@hidden parameter} string name
Client name.
Defaults to @samp{"client"}.
@end deftypevr
address@hidden @code{openvpn-ccd-configuration} parameter ip-mask iroute
address@hidden address@hidden parameter} ip-mask iroute
Client own network
Defaults to @samp{#f}.
@end deftypevr
address@hidden @code{openvpn-ccd-configuration} parameter ip-mask ifconfig-push
address@hidden address@hidden parameter} ip-mask ifconfig-push
Client VPN IP.
Defaults to @samp{#f}.
--
2.12.0
- bug#26137: [PATCH 0/6 v2] Add tlp service., Mathieu Othacehe, 2017/03/17
- bug#26137: [PATCH 1/6] gnu: tlp: Read configuration from /etc/tlp., Mathieu Othacehe, 2017/03/17
- bug#26137: [PATCH v3 0/6] Add TLP service., Mathieu Othacehe, 2017/03/24
- bug#26137: [PATCH v3 1/6] gnu: tlp: Read configuration from /etc/tlp., Mathieu Othacehe, 2017/03/24
- bug#26137: [PATCH v3 3/6] services: configuration: Rewrite id procedure., Mathieu Othacehe, 2017/03/24
- bug#26137: [PATCH v3 2/6] services: Factorize define-maybe macro., Mathieu Othacehe, 2017/03/24
- bug#26137: [PATCH v3 5/6] services: openvpn: Fix a typo which was corrected in generated doc., Mathieu Othacehe, 2017/03/24
- bug#26137: [PATCH v3 6/6] doc: Re-generate openvpn service documentation., Mathieu Othacehe, 2017/03/24
- bug#26137: [PATCH v3 4/6] gnu: Add tlp service., Mathieu Othacehe, 2017/03/24
- bug#26137: [PATCH v3 0/6] Add TLP service., Clément Lassieur, 2017/03/24