3
0
mirror of https://git.kernel.org/pub/scm/network/wireless/iwd.git synced 2024-11-20 04:19:25 +01:00

doc: Update iwd.ap(5) man page

Try to document some of the settings moved from struct ap_config to the
settings object now passed to ap_start(), skip the strictly internal-use
ones.
This commit is contained in:
Andrew Zaborowski 2021-04-27 01:34:08 +02:00 committed by Denis Kenzior
parent 5cc0f68d51
commit ca9895692a

View File

@ -41,6 +41,23 @@ SETTINGS
The settings are split into several categories. Each category has a group
associated with it and is described in the corresponding table below.
General Settings
----------------
The group ``[General]`` contains general AP configuration.
.. list-table::
:header-rows: 0
:stub-columns: 0
:widths: 20 80
:align: left
* - Channel
- Channel number
Optional channel number for the access point to operate on. Only the
2.4GHz-band channels are currently allowed.
Network Authentication Settings
-------------------------------
@ -56,7 +73,14 @@ configuration.
* - Passphrase
- 8..63 character string
WPA-PSK Passphrase to be used with this access point.
WPA-PSK Passphrase to be used with this access point. At least one of
*Passphrase*, *PreSharedKey* must be present.
* - PreSharedKey
- 64-character hex-string
Processed passphrase for this network in the form of a hex-encoded
32-byte pre-shared key. Either this or *Passphrase* must be present.
IPv4 Network Configuration
--------------------------
@ -117,6 +141,40 @@ is desired, the group header line must still be present:
From and to addresses of the range assigned to clients through DHCP.
If not provided the range from local address + 1 to .254 will be used.
Wi-Fi Simple Configuration
--------------------------
The group ``[WSC]`` fine-tunes some Wi-Fi Simple Configuration local parameters
(formerly known as WPS, Wi-Fi Protected Setup.)
.. list-table::
:header-rows: 0
:stub-columns: 0
:widths: 20 80
:align: left
* - DeviceName
- 1..32-character string
Optional Device Name string for the AP to advertise as. Defaults to
the SSID.
* - PrimaryDeviceType
- Subcategory string or a 64-bit integer
Optional Primary Device Type for the AP to advertise as. Defaults to
PC computer. Can be specified as a lower-case WSC v2.0.5 subcategory
string or a 64-bit integer encoding, from MSB to LSB: the 16-bit
category ID, the 24-bit OUI, the 8-bit OUI type and the 16-bit
subcategory ID.
* - AuthorizedMACs
- Comma-separated MAC address list
Optional list of Authorized MAC addresses for the WSC registrar to
check on association. Each address is specified in the
colon-hexadecimal notation. Defaults to no MAC-based checks.
SEE ALSO
========