3
0
mirror of https://git.kernel.org/pub/scm/network/wireless/iwd.git synced 2024-12-22 13:02:44 +01:00

doc: add man pages for AP provisioning files

This commit is contained in:
James Prestwood 2020-11-04 08:52:24 -08:00 committed by Denis Kenzior
parent da6b818a53
commit 39ca2c3e05
2 changed files with 66 additions and 2 deletions

View File

@ -171,7 +171,8 @@ man_MANS =
endif
manual_pages = src/iwd.8 src/iwd.debug.7 src/iwd.config.5 src/iwd.network.5 \
client/iwctl.1 monitor/iwmon.1 wired/ead.8 tools/hwsim.1
src/iwd.ap.5 client/iwctl.1 monitor/iwmon.1 wired/ead.8 \
tools/hwsim.1
eap_sources = src/eap.c src/eap.h src/eap-private.h \
src/eap-md5.c \
@ -263,7 +264,8 @@ systemd_network_DATA += src/80-iwd.link
endif
if MANUAL_PAGES
man_MANS += src/iwd.8 src/iwd.debug.7 src/iwd.config.5 src/iwd.network.5
man_MANS += src/iwd.8 src/iwd.debug.7 src/iwd.config.5 src/iwd.network.5 \
src/iwd.ap.5
endif
endif

62
src/iwd.ap.rst Normal file
View File

@ -0,0 +1,62 @@
============
iwd.ap
============
--------------------------------------
Configuration of IWD access point
--------------------------------------
:Author: James Prestwood <prestwoj@gmail.com>
:Copyright: 2020 Intel Corporation
:Version: iwd
:Date: 20 October 2020
:Manual section: 5
:Manual group: Linux Connectivity
NAME
====
iwd.ap - Access point provisioning files
SYNOPSIS
========
Description of access point provisioning files.
DESCRIPTION
===========
An access point provisioning files define the configuration of an IWD access
point. These files live in *$STATE_DIRECTORY*/ap (/var/lib/iwd/ap by default).
FILE FORMAT
===========
See *iwd.network* for details on the file format.
SETTINGS
========
The settings are split into several categories. Each category has a group
associated with it and described in separate tables below.
Network Authentication Settings
-------------------------------
The group ``[Security]`` contains settings for Wi-Fi security and authentication
configuration.
.. list-table::
:header-rows: 0
:stub-columns: 0
:widths: 20 80
:align: left
* - Passphrase
- 8..63 character string
Passphrase to be used with this access point.
SEE ALSO
========
iwd(8), iwd.network(5)