Updated connman to version 1.35

[platform/upstream/connman.git] / doc / vpn-config-format.txt

diff --git a/doc/vpn-config-format.txt b/doc/vpn-config-format.txt
index b4898eb..cb0f16a 100644 (file)
--- a/doc/vpn-config-format.txt
+++ b/doc/vpn-config-format.txt
@@ -88,7 +88,8 @@ OpenVPN VPN supports following options (see openvpn(8) for details):
                                          --auth-user-pass value (O)
  OpenVPN.TLSRemote      --tls-remote     Accept connections only from a host
                                          with X509 name or common name equal
-                                         to name parameter (O)
+                                         to name parameter (O). Deprecated in
+                                         OpenVPN 2.3+.
  OpenVPN.TLSAuth        sub-option of --tls-remote (O)
  OpenVPN.TLSAuthDir     sub-option of --tls-remote (O)
  OpenVPN.Cipher         --cipher         Encrypt packets with cipher algorithm
@@ -104,6 +105,9 @@ OpenVPN VPN supports following options (see openvpn(8) for details):
  OpenVPN.ConfigFile     --config         OpenVPN config file that can contain
                                          extra options not supported by OpenVPN
                                          plugin (O)
+ OpenVPN.DeviceType     --dev-type       Whether the VPN should use a tun (OSI
+                                         layer 3) or tap (OSI layer 2) device.
+                                         Value is "tun" (default) or "tap" (O)
 
 VPNC VPN supports following options (see vpnc(8) for details):
  Option name         VPNC config value     Description
@@ -113,16 +117,23 @@ VPNC VPN supports following options (see vpnc(8) for details):
  VPNC.Xauth.Password Xauth password        your password (cleartext) (O)
  VPNC.IKE.Authmode   IKE Authmode          IKE Authentication mode (O)
  VPNC.IKE.DHGroup    IKE DH Group          name of the IKE DH Group (O)
- VPNC.PFS Perfect    Forward Secrecy       Diffie-Hellman group to use for PFS (O)
+ VPNC.PFS            Perfect Forward Secrecy    Diffie-Hellman group to use for
+                                               PFS (O)
  VPNC.Domain         Domain                Domain name for authentication (O)
  VPNC.Vendor         Vendor                vendor of your IPSec gateway (O)
  VPNC.LocalPort      Local Port            local ISAKMP port number to use
- VPNC.CiscoPort      Cisco UDP Encapsulation Port  Local UDP port number to use (O)
- VPNC.AppVersion     Application Version   Application Version to report (O)
+ VPNC.CiscoPort      Cisco UDP Encapsulation Port    Local UDP port number to
+                                                    use (O)
+ VPNC.AppVersion     Application version   Application Version to report (O)
  VPNC.NATTMode       NAT Traversal Mode    Which NAT-Traversal Method to use (O)
- VPNC.DPDTimeout     DPD idle timeout (our side)  Send DPD packet after timeout (O)
+ VPNC.DPDTimeout     DPD idle timeout (our side)    Send DPD packet after
+                                                   timeout (O)
  VPNC.SingleDES      Enable Single DES     enables single DES encryption (O)
- VPNC.NoEncryption   Enable no encryption  enables using no encryption for data traffic (O)
+ VPNC.NoEncryption   Enable no encryption  enables using no encryption for data
+                                          traffic (O)
+ VPNC.DeviceType     Interface mode        Whether the VPN should use a tun (OSI
+                                           layer 3) or tap (OSI layer 2) device.
+                                           Value is "tun" (default) or "tap" (O)
 
 L2TP VPN supports following options (see xl2tpd.conf(5) and pppd(8) for details)
  Option name         xl2tpd config value    Description
@@ -130,9 +141,9 @@ L2TP VPN supports following options (see xl2tpd.conf(5) and pppd(8) for details)
                                             if not set here (O)
  L2TP.Password       -                      L2TP password, asked from the user
                                             if not set here (O)
- L2TP.BPS            bps                    Max bandwith to use (O)
- L2TP.TXBPS          tx bps                 Max transmit bandwith to use (O)
- L2TP.RXBPS          rx bps                 Max receive bandwith to use (O)
+ L2TP.BPS            bps                    Max bandwidth to use (O)
+ L2TP.TXBPS          tx bps                 Max transmit bandwidth to use (O)
+ L2TP.RXBPS          rx bps                 Max receive bandwidth to use (O)
  L2TP.LengthBit      length bit             Use length bit (O)
  L2TP.Challenge      challenge              Use challenge authentication (O)
  L2TP.DefaultRoute   defaultroute           Default route (O)
@@ -162,13 +173,14 @@ L2TP VPN supports following options (see xl2tpd.conf(5) and pppd(8) for details)
  PPPD.RefuseMSCHAP2  refuse-mschapv2        Deny mschapv2 auth (O)
  PPPD.NoBSDComp      nobsdcomp              Disables BSD compression (O)
  PPPD.NoPcomp        nopcomp                Disable protocol compression (O)
- PPPD.UseAccomp      accomp                 Disable address/control compression (O)
+ PPPD.UseAccomp      noaccomp               Disable address/control
+                                           compression (O)
  PPPD.NoDeflate      nodeflate              Disable deflate compression (O)
  PPPD.ReqMPPE        require-mppe           Require the use of MPPE (O)
  PPPD.ReqMPPE40      require-mppe-40        Require the use of MPPE 40 bit (O)
  PPPD.ReqMPPE128     require-mppe-128       Require the use of MPPE 128 bit (O)
  PPPD.ReqMPPEStateful mppe-stateful         Allow MPPE to use stateful mode (O)
- PPPD.NoVJ           no-vj-comp             No Van Jacobson compression (O)
+ PPPD.NoVJ           novj                   No Van Jacobson compression (O)
 
 
 PPTP VPN supports following options (see pptp(8) and pppd(8) for details)
@@ -193,7 +205,7 @@ PPTP VPN supports following options (see pptp(8) and pppd(8) for details)
  PPPD.RequirMPPE40   require-mppe-40      Require the use of MPPE 40 bit (O)
  PPPD.RequirMPPE128  require-mppe-128     Require the use of MPPE 128 bit (O)
  PPPD.RequirMPPEStateful mppe-stateful    Allow MPPE to use stateful mode (O)
- PPPD.NoVJ           no-vj-comp           No Van Jacobson compression (O)
+ PPPD.NoVJ           novj                 No Van Jacobson compression (O)
 
 IPsec VPN supports following options (see swanctl.conf(5) for details):
  Option name                   IPSec config value    Description