--- doc/vpn-config-format.txt | 23 ++++++++++++----------- 1 file changed, 12 insertions(+), 11 deletions(-)
diff --git a/doc/vpn-config-format.txt b/doc/vpn-config-format.txt index daf8bf1..640eb2c 100644 --- a/doc/vpn-config-format.txt +++ b/doc/vpn-config-format.txt @@ -6,26 +6,27 @@ vpnd will be looking for its configuration files at VPN_STORAGEDIR which by default points to /var/lib/connman-vpn. Configuration file names must not include other characters than letters or numbers and must have a .config suffix. Those configuration files are text files with a simple -format and we typically have one file per provisioned network. +key-value pair format organized into sections. Values do not comprise leading +trailing whitespace. We typically have one file per provisioned network. If the config file is removed, then vpnd tries to remove the -provisioned service. If individual service entry inside config is removed, -then the corresponding provisioned service is removed. If service -entry is changed, then corresponding service is removed and then -immediately re-provisioned. +provisioned service. If an individual service entry inside a config is removed, +then the corresponding provisioned service is removed. If a service +section is changed, then the corresponding service is removed and immediately +re-provisioned. -Global entry [global] -===================== +Global section [global] +======================= -These files can have an optional global entry describing the actual file. -The 2 allowed fields for that entry are: +These files can have an optional global section describing the actual file. +The two allowed fields for this section are: - Name: Name of the network. - Description: Description of the network. -Provider entry [provider_*] -=========================== +Provider section [provider_*] +============================= Each provisioned provider must start with the [provider_*] tag. Replace * with an identifier unique to the config file. -- 1.7.9.5 _______________________________________________ connman mailing list [email protected] https://lists.connman.net/mailman/listinfo/connman
