Kernel
/
iwd
mirror of https://git.kernel.org/pub/scm/network/wireless/iwd.git
3
0
Fork 0
Code Releases Activity

doc: clean up main.conf documentation 

All options should now have a description which describes the
default value for each option. The example use (commented or not)
now contains the default value as well.
This commit is contained in:
James Prestwood 2019-07-30 12:36:46 -07:00 committed by Denis Kenzior
parent d8dac9a330
commit 2f8e9b9c53
1 changed files with 16 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
doc/main.conf
View File

@ -21,7 +21,7 @@ max_4way_handshake_time=5
# should be set to False. # should be set to False.
ControlPortOverNL80211=True ControlPortOverNL80211=True
# #
# Set the threshold RSSI for roaming # Set the threshold RSSI for roaming (default -70)
roam_rssi_threshold=-70 roam_rssi_threshold=-70
# #
# Do not allow iwd to destroy / recreate wireless interfaces at startup, # Do not allow iwd to destroy / recreate wireless interfaces at startup,
@ -35,7 +35,7 @@ roam_rssi_threshold=-70
# Explicitly enforce/disable management frame protection # Explicitly enforce/disable management frame protection
# #
# 0 - Disable management frame protection # 0 - Disable management frame protection
# 1 - Set management frame protection capable # 1 - Set management frame protection capable (default)
# 2 - Management frame protection required # 2 - Management frame protection required
# #
# ManagementFrameProtection=1 # ManagementFrameProtection=1
@ -79,7 +79,8 @@ roam_rssi_threshold=-70
# issuing the periodic scans for the available networks while disconnected. # issuing the periodic scans for the available networks while disconnected.
# The behavior of the user-initiated scans isn't affected. # The behavior of the user-initiated scans isn't affected.
# The periodic scan is enabled by default. # The periodic scan is enabled by default.
#disable_periodic_scan=true #
# disable_periodic_scan=false
# #
# #
@ -87,7 +88,8 @@ roam_rssi_threshold=-70
# issuing the roaming scans for the available networks while connected. # issuing the roaming scans for the available networks while connected.
# The behavior of the user-initiated scans isn't affected. # The behavior of the user-initiated scans isn't affected.
# The roaming scan is enabled by default. # The roaming scan is enabled by default.
#disable_roaming_scan=true #
# disable_roaming_scan=false
# #
# #
@ -95,7 +97,8 @@ roam_rssi_threshold=-70
# the capable network adapters from randomizing MAC addresses during the active # the capable network adapters from randomizing MAC addresses during the active
# scans for networks, thus decreasing user privacy. # scans for networks, thus decreasing user privacy.
# The MAC address randomization is enabled by default. # The MAC address randomization is enabled by default.
#disable_mac_address_randomization=true #
# disable_mac_address_randomization=false
# #
[Blacklist] [Blacklist]
@ -106,16 +109,16 @@ roam_rssi_threshold=-70
# for. # for.
# #
# bss_blacklist_time - The initial timeout for a blacklisted BSS in # bss_blacklist_time - The initial timeout for a blacklisted BSS in
# seconds. # seconds (default 60)
# bss_blacklist_multiplier - What bss_blacklist_time is multiplied by after # bss_blacklist_multiplier - What bss_blacklist_time is multiplied by after
# future unsuccessful connection attempts in # future unsuccessful connection attempts in
# seconds. # seconds (default 30)
# bss_blacklist_max_time - The maximum time a BSS can be blacklisted for in # bss_blacklist_max_time - The maximum time a BSS can be blacklisted for in
# seconds. # seconds (default 86400)
# #
#bss_blacklist_time=60 # bss_blacklist_time=60
#bss_blacklist_multiplier=30 # bss_blacklist_multiplier=30
#bss_blacklist_max_time=86400 # bss_blacklist_max_time=86400
[Rank] [Rank]
# #
@ -124,6 +127,6 @@ roam_rssi_threshold=-70
# is still possible for IWD to prefer a 2.4GHz AP in the right conditions. # is still possible for IWD to prefer a 2.4GHz AP in the right conditions.
# This ranking provides a way to further weight the ranking towards 5G if # This ranking provides a way to further weight the ranking towards 5G if
# required. Also, a lower 5G factor could be used to weight 2.4GHz if that is # required. Also, a lower 5G factor could be used to weight 2.4GHz if that is
# desired. # desired. The default is 1.0, which does not affect the calculated ranking.
# #
#rank_5g_factor=1.0 # rank_5g_factor=1.0