doc: document the wifi executor as interfaces-wifi(5).
This commit is contained in:
parent
b2f5a62c35
commit
eeb40937fb
3 changed files with 61 additions and 0 deletions
1
Makefile
1
Makefile
|
@ -164,6 +164,7 @@ MANPAGES_5 = \
|
||||||
doc/interfaces-ppp.5 \
|
doc/interfaces-ppp.5 \
|
||||||
doc/interfaces-vrf.5 \
|
doc/interfaces-vrf.5 \
|
||||||
doc/interfaces-vxlan.5 \
|
doc/interfaces-vxlan.5 \
|
||||||
|
doc/interfaces-wifi.5 \
|
||||||
doc/interfaces-wireguard.5
|
doc/interfaces-wireguard.5
|
||||||
|
|
||||||
MANPAGES_7 = \
|
MANPAGES_7 = \
|
||||||
|
|
55
doc/interfaces-wifi.scd
Normal file
55
doc/interfaces-wifi.scd
Normal file
|
@ -0,0 +1,55 @@
|
||||||
|
interfaces-wifi(5)
|
||||||
|
|
||||||
|
# NAME
|
||||||
|
|
||||||
|
*interfaces-wifi* - WiFi vocabulary for the interfaces(5) file format
|
||||||
|
|
||||||
|
# DESCRIPTION
|
||||||
|
|
||||||
|
Wi-Fi (the IEEE 802.11 family of protocols) is a commonly used wireless
|
||||||
|
networking standard. The following options allow for configuration of
|
||||||
|
Wi-Fi client interfaces.
|
||||||
|
|
||||||
|
# WIFI-RELATED OPTIONS
|
||||||
|
|
||||||
|
*wifi-config-path* _path_
|
||||||
|
Denotes the absolute _path_ to a *wpa_supplicant* configuration file.
|
||||||
|
If no path is given, _/run/wpa_supplicant.<interface>.conf_ will be
|
||||||
|
used for a temporary configuration file. This option may not be used
|
||||||
|
with other configuration options.
|
||||||
|
|
||||||
|
*wifi-ssid* _ssid_
|
||||||
|
The SSID the Wi-Fi client should connect to.
|
||||||
|
|
||||||
|
*wifi-psk* _psk_
|
||||||
|
The passphrase for connecting to the Wi-Fi network. If unset, the
|
||||||
|
client will connect without WPA2 encryption.
|
||||||
|
|
||||||
|
# EXAMPLES
|
||||||
|
|
||||||
|
A typical setup may involve connecting to a home and work network. To
|
||||||
|
achieve this, we can define a pair of virtual interfaces called *wifi-home*
|
||||||
|
and *wifi-work*, which connect to their respective wifi networks:
|
||||||
|
|
||||||
|
```
|
||||||
|
iface wifi-home
|
||||||
|
use dhcp
|
||||||
|
wifi-ssid HomeNetwork
|
||||||
|
wifi-psk ExamplePassphrase
|
||||||
|
|
||||||
|
iface wifi-work
|
||||||
|
use dhcp
|
||||||
|
wifi-config-path /etc/network/wpa-work.conf
|
||||||
|
```
|
||||||
|
|
||||||
|
The virtual interfaces can be used with *ifup* and *ifdown*:
|
||||||
|
|
||||||
|
```
|
||||||
|
# ifup wlan0=wifi-home
|
||||||
|
# ifdown wlan0
|
||||||
|
# ifup wlan0=wifi-work
|
||||||
|
```
|
||||||
|
|
||||||
|
# AUTHORS
|
||||||
|
|
||||||
|
Ariadne Conill <ariadne@dereferenced.org>
|
|
@ -178,6 +178,11 @@ most common executors are:
|
||||||
The interface is a Virtual Extensible LAN (VXLAN) tunnel
|
The interface is a Virtual Extensible LAN (VXLAN) tunnel
|
||||||
endpoint.
|
endpoint.
|
||||||
|
|
||||||
|
*wifi*
|
||||||
|
The interface is a Wi-Fi (IEEE 802.11) client interface.
|
||||||
|
Configuration of the WiFi client interface requires the
|
||||||
|
*wpa_supplicant* package to be installed.
|
||||||
|
|
||||||
*wireguard*
|
*wireguard*
|
||||||
The interface is a Wireguard VPN tunnel endpoint.
|
The interface is a Wireguard VPN tunnel endpoint.
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue