diff options
| author | Patrik Flykt <patrik.flykt@linux.intel.com> | 2012-05-14 15:20:45 +0300 |
|---|---|---|
| committer | Patrik Flykt <patrik.flykt@linux.intel.com> | 2012-05-15 15:52:18 +0300 |
| commit | 7bf3a73557517338bb0f4c1bb26f85695d7f75e6 (patch) | |
| tree | 5d5acebcbeb7056a89c7cd03b149bcccc022b48e /doc | |
| parent | 9d4a0b844ae47893e2b928556901c22756f1d47c (diff) | |
| download | connman-7bf3a73557517338bb0f4c1bb26f85695d7f75e6.tar.gz connman-7bf3a73557517338bb0f4c1bb26f85695d7f75e6.tar.bz2 connman-7bf3a73557517338bb0f4c1bb26f85695d7f75e6.zip | |
doc: Update configuration format documentation
Clarify that 'Name' is used only as a string representation of an
SSID and ignored if the entry contains an 'SSID' entry. Also clarify
that the identifier part is unique only within the .config file.
Add indentation.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/config-format.txt | 19 |
1 files changed, 9 insertions, 10 deletions
diff --git a/doc/config-format.txt b/doc/config-format.txt index a9c560fc..1e03f787 100644 --- a/doc/config-format.txt +++ b/doc/config-format.txt @@ -25,14 +25,13 @@ Service entry [service_*] ========================= Each provisioned service must start with the [service_*] tag. Replace * with -your service identifier. -The service identifier can be anything and will be used internally by connman -to store the different services into an hash table. +an identifier unique to the config file. Allowed fields: - Type: Service type. We currently only support wifi. -- Name: Service name -- SSID: An hexadecimal representation of a 802.11 SSID. If the SSID field is +- Name: A string representation of an 802.11 SSID. If the SSID field is + present, the Name field is ignored. +- SSID: A hexadecimal representation of an 802.11 SSID. If the SSID field is omitted, the Name field is used instead. - EAP: EAP type. We currently only support tls, ttls or peap. - CACertFile: File path to CA certificate file (PEM/DER). @@ -40,13 +39,13 @@ Allowed fields: - PrivateKeyFile: File path to client private key file (PEM/DER/PFX). - PrivateKeyPassphrase: Password/passphrase for private key file. - PrivateKeyPassphraseType: We only support the fsid passphrase type for now. -This is for private keys generated by using their own filesystem UUID as the -passphrase. The PrivateKeyPassphrase field is ignored when this field is set -to fsid. + This is for private keys generated by using their own filesystem UUID as the + passphrase. The PrivateKeyPassphrase field is ignored when this field is set + to fsid. - Identity: Identity string for EAP. - Phase2: Phase2 (inner authentication with TLS tunnel) authentication method. -Prefix the value with "EAP-" to indicate the usage of an EAP-based inner -authentication method (should only be used with EAP = TTLS). + Prefix the value with "EAP-" to indicate the usage of an EAP-based inner + authentication method (should only be used with EAP = TTLS). - Passphrase: RSN/WPA/WPA2 Passphrase |