From 5a473a755cd09d3eb38cbda414bcfadad7e04113 Mon Sep 17 00:00:00 2001 From: Marcel Holtmann Date: Sat, 26 Oct 2019 02:07:03 +0200 Subject: [PATCH] doc: Minor formatting changes for the configuration documentation --- src/iwd.config.rst | 24 ++++++++++++------------ src/iwd.network.rst | 10 +++------- 2 files changed, 15 insertions(+), 19 deletions(-) diff --git a/src/iwd.config.rst b/src/iwd.config.rst index f9fd29d8..c101d4de 100644 --- a/src/iwd.config.rst +++ b/src/iwd.config.rst @@ -54,7 +54,7 @@ The group ``[General]`` contains general settings. :align: left * - EnableNetworkConfiguration - - Values: true, false (default) + - Values: true, **false** Enable network configuration. @@ -62,7 +62,7 @@ The group ``[General]`` contains general settings. interfaces with the IP addresses. There are two types IP addressing supported by **iwd**: static and dynamic. The static IP addresses are configured through the network configuration files. If no static IP - configuration has been provided for a network, iwd will attempt to + configuration has been provided for a network, **iwd** will attempt to obtain the dynamic addresses from the network through the built-in DHCP client. @@ -173,11 +173,11 @@ Blacklist --------- The group ``[Blacklist]`` contains settings related to blacklisting of BSSes. -If iwd determines that a connection to a BSS fails for a reason that indicates -the BSS is currently misbehaving or misconfigured (e.g. timeouts, unexpected -status/reason codes, etc), then iwd will blacklist this BSS and avoid connecting -to it for a period of time. These options let the user control how long -a misbehaved BSS spends on the blacklist. +If **iwd** determines that a connection to a BSS fails for a reason that +indicates the BSS is currently misbehaving or misconfigured (e.g. timeouts, +unexpected status/reason codes, etc), then **iwd** will blacklist this BSS +and avoid connecting to it for a period of time. These options let the user +control how long a misbehaved BSS spends on the blacklist. .. list-table:: :header-rows: 0 @@ -237,16 +237,16 @@ No modification from defaults is normally required. * - DisablePeriodicScan - Values: true, **false** - Disable periodic scan. Setting this option to 'true' will prevent iwd - from issuing the periodic scans for the available networks while + Disable periodic scan. Setting this option to 'true' will prevent + **iwd** from issuing the periodic scans for the available networks while disconnected. The behavior of the user-initiated scans isn't affected. The periodic scan is enabled by default. * - DisableRoamingScan - - Values: trrue, **false** + - Values: true, **false** - Disable roaming scan. Setting this option to 'true' will prevent iwd + Disable roaming scan. Setting this option to 'true' will prevent **iwd** from trying to scan when roaming decisions are activated. This can - prevent iwd from roaming properly, but can be useful for networks + prevent **iwd** from roaming properly, but can be useful for networks operating under extremely low rssi levels where roaming isn't possible. SEE ALSO diff --git a/src/iwd.network.rst b/src/iwd.network.rst index 2410aa57..33efd3f4 100644 --- a/src/iwd.network.rst +++ b/src/iwd.network.rst @@ -94,13 +94,11 @@ General Settings The group ``[General]`` contains general settings. .. list-table:: - :header-rows: 1 + :header-rows: 0 :stub-columns: 0 :widths: 20 80 :align: left - * - Key - - Description * - AutoConnect - Values: **true**, false @@ -118,13 +116,11 @@ The group ``[Security]`` contains settings for Wi-Fi security and authentication configuration. .. list-table:: - :header-rows: 1 + :header-rows: 0 :stub-columns: 0 :widths: 20 80 :align: left - * - Key - - Description * - Passphrase - 8..63 character string @@ -217,7 +213,7 @@ authentication configuration. non-EAP methods is used. * - | EAP-TTLS-Phase2-Identity - The secure identity/username string for the TTLS non-EAP Phase 2 - methods. If not provided IWD will request a username at connection + methods. If not provided **iwd** will request a username at connection time. * - | EAP-TTLS-Phase2-Password - Password string for the TTLS non-EAP Phase 2 methods. If not provided