Update android documentation to match source code

Acked-by: Gert Doering <gert@greenie.muc.de>
Message-Id: <1468248659-27123-1-git-send-email-arne@rfc2549.org>
URL: http://article.gmane.org/gmane.network.openvpn.devel/12074

Signed-off-by: Gert Doering <gert@greenie.muc.de>
This commit is contained in:
Arne Schwabe 2016-07-11 16:50:59 +02:00 committed by Gert Doering
parent 97894360fa
commit 49817bf0ad

View file

@ -2,7 +2,7 @@ This file documents the support in OpenVPN for Android 4.0 and up.
This support is primarily used in the "OpenVPN for Android" app
(http://code.google.com/p/ics-openvpn/). For building see the developer
README: http://code.google.com/p/ics-openvpn/source/browse/doc/README.txt.
README: https://github.com/schwabe/ics-openvpn/blob/master/doc/README.txt
Android provides the VPNService API
(http://developer.android.com/reference/android/net/VpnService.html)
@ -89,3 +89,12 @@ are not specific to Android but are rarely used on other platform.
For example using SIGUSR1 and management-hold to restart, pause,
continue the VPN on network changes or the external key management
--management-external-key option and inline files.
To better support handover between networks, a the management command
network-change [samenetwork]
is used on the Android platform. It tells OpenVPN to do the necessary
action when the network changes. Currently this is just calling
the protect callback when using peer-id regardless of the samenetwork.
Without peer-id OpenVPN will generate USR1 when samenetwork is not set.