From: Stefan Schantl Date: Thu, 16 May 2013 17:35:27 +0000 (+0200) Subject: pptp: Add documentation. X-Git-Tag: 007~136 X-Git-Url: http://git.ipfire.org/?p=network.git;a=commitdiff_plain;h=b5cacc073a7f2b3c8730d313d82d49f64d368fbc pptp: Add documentation. --- diff --git a/Makefile b/Makefile index a33c76d4..7c2addc0 100644 --- a/Makefile +++ b/Makefile @@ -59,7 +59,8 @@ MAN_PAGES = \ man/network-zone-aiccu.8 \ man/network-zone-bridge.8 \ man/network-zone-config-pppoe-server.8 \ - man/network-zone-pppoe.8 + man/network-zone-pppoe.8 \ + man/network-zone-pptp.8 MAN_PAGES_HTML = $(patsubst %.xml,%.html,$(MAN_PAGES_XML)) MAN_PAGES_XML = $(patsubst %.8,%.xml,$(MAN_PAGES)) diff --git a/man/network-zone-pptp.xml b/man/network-zone-pptp.xml new file mode 100644 index 00000000..278816e6 --- /dev/null +++ b/man/network-zone-pptp.xml @@ -0,0 +1,240 @@ + + + + + + network-zone-pptp + network + + + + Developer + Stefan + Schantl + stefan.schantl@ipfire.org + + + + + + network-zone-pptp + 8 + + + + network-zone-pptp + Network Configuration Control Program + + + + + network zone create ZONE pptp ... + + + + + Description + + + The pptp hook creates a Point-to-Point tunnel over IP and is used by some ISP for + internet dialin or other VPN services. + + + + + Options + + + The following options are understood: + + + + + + + + + + + The IPv4 address of the system to connect to. + + + For PPTP dialin connections this will be IP address of your modem. + If you are using PPTP for VPN services use the address of the remote server. + + + + + + + + + + + + Sets the username for authentication. + + + + + + + + + + + + Sets the password for authentication. + + + Use the option to transmit it + in a secure manner to the provider. + + + + + + + + + + + + This options sets the port, pppd is using to connect to + the modem. This may be a normal ethernet or vlan interface. + + + The port option is only required if you are using PPTP for + dialin connections. + + + + + + + + + + + + Add this IPV4 address to the configured port. + + + + Optionally a DHCP client can be used, istead of + configuring a static IPv4 address. Use the + to benefit from this feature. + + + + + + + + + + + + Sets the following network prefix to the configured port. + + + + + + + + + + + + Use a DHCP client to gather the interface address and prefix settings. + + + + + + + + + + + + By this option the support for IPv6 can be enabled or disabled. + + + + + + + + + + + + Sets the default MTU of the PPP connection. + The default value is 1492 which is a common MTU used + for DSL. + + + + + + + + + + + + Define the authentication method that is used to + authenticate against your provider. + The default is to use the provider's preference. + + + + + Challange-Handshake Authentication Protocol + (chap) is the preferred secure method. + + + + + Password Authentication Protocol + (pap) sends the plaintext password to the authentication + server which is the reason why it should be avoided to use PAP. + + + + + + + + + + + + + + By this option, you may define a list of auth methods which + are not supported by the service provider. + + + + + + + + See Also + + + + network + 8 + , + + network-zone + 8 + + + +