Sync the wlan*(4) manual pages with FreeBSD for the 802.11 update.
authorSascha Wildner <saw@online.de>
Sat, 24 Apr 2010 20:55:20 +0000 (22:55 +0200)
committerSascha Wildner <saw@online.de>
Sat, 24 Apr 2010 20:55:20 +0000 (22:55 +0200)
share/man/man4/Makefile
share/man/man4/wlan.4
share/man/man4/wlan_acl.4
share/man/man4/wlan_amrr.4 [copied from share/man/man4/wlan_acl.4 with 67% similarity]
share/man/man4/wlan_ccmp.4
share/man/man4/wlan_tkip.4
share/man/man4/wlan_wep.4
share/man/man4/wlan_xauth.4

index 4d6aa64..cc73e21 100644 (file)
@@ -334,6 +334,7 @@ MAN=        aac.4 \
        wi.4 \
        wlan.4 \
        wlan_acl.4 \
+       wlan_amrr.4 \
        wlan_ccmp.4 \
        wlan_tkip.4 \
        wlan_wep.4 \
index 9a9705e..ef76dd8 100644 (file)
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
-.\" $FreeBSD: src/share/man/man4/wlan.4,v 1.8.2.1 2005/12/02 16:45:03 brueffer Exp $
-.\" $DragonFly: src/share/man/man4/wlan.4,v 1.8 2008/07/26 16:25:41 swildner Exp $
+.\" $FreeBSD: src/share/man/man4/wlan.4,v 1.23 2010/01/14 09:38:23 roam Exp $
 .\"
-.Dd May 14, 2006
+.Dd April 14, 2010
 .Dt WLAN 4
 .Os
 .Sh NAME
@@ -42,116 +41,131 @@ Where a device does not directly support 802.11 functionality
 this layer fills in.
 The
 .Nm
-is required for the
-.Xr acx 4 ,
-.Xr ath 4 ,
-.Xr bwi 4 ,
-.Xr iwi 4 ,
-.Xr iwl 4 ,
-.Xr ndis 4 ,
-.Xr ral 4 ,
-.Xr rtw 4 ,
-.Xr rum 4 ,
-.Xr ural 4 ,
-and
-.Xr wi 4
-drivers, with other drivers to follow.
+module is required by all native 802.11 drivers.
+.\" as well as the
+.\".Xr ndis 4
+.\"support.
 .Pp
-The
 .Nm
-module supports multi-mode devices capable of
+supports multi-mode devices capable of
 operating in both 2.4GHz and 5GHz bands and supports numerous
-802.11 protocols: 802.11a, 802.11b, and 802.11g.
+802.11 standards: 802.11a, 802.11b, 802.11g, 802.11n, and 802.11s (Draft 3.0).
 The WPA, 802.11i, and 802.1x security protocols are supported
 through a combination of in-kernel code and user-mode applications.
-The WME and WMM multi-media protocols are supported entirely within
+The WME/WMM multi-media protocols are supported entirely within
 the
 .Nm
 module but require a suitably capable hardware device.
+Likewise the 802.11h specification is supported only by suitably
+capable devices.
 .Pp
-The
+Drivers provide 802.11 functionality through
 .Nm
-module defines several mechanisms by which plugin modules may
-be used to extend functionality.
-Cryptographic support such as WEP, TKIP, and AES-CCMP are implemented
-as modules that are loaded on demand (if not statically configured
-into a system).
-Similarly there is an authenticator framework for defining 802.11
-authentication services and a framework for integrating access
-control mechanisms specific to the 802.11 protocol.
-.Sh DEBUGGING
-If the associated interface is marked for debugging with, for example,
-.Pp
-.Dl "ifconfig wi0 debug"
-.Pp
-then messages describing the operation of the 802.11 protocol will
-be sent to the console.
-Complete debugging controls are available using:
-.Pp
-.Dl "sysctl net.wlan.X.debug=mask"
-.Pp
-where
-.Ar X
-is the number of the
+interfaces that are created at runtime using interface cloning.
+This is done with the
+.Xr ifconfig 8
+.Cm create
+command or using the
+.Va wlans_IFX
+variable in
+.Xr rc.conf 5 .
+Some drivers support the creation of multiple
 .Nm
-instance and mask is a bit-or of control bits that determine which
-debugging messages to enable.
-For example,
+interfaces that share the same underlying device;
+this is the way by which ``multi-bss support'' is provided but it
+can also be used to create WDS links and other interesting applications.
 .Pp
-.Dl "sysctl net.wlan.0.debug=0x00200000"
-.Pp
-enables debugging messages related to scanning for an access point,
-adhoc neighbor, or an unoccupied channel when operation as an access point.
-.\"The
-.\".Xr 80211debug
-.\"tool provides a more user-friendly mechanism for doing the same thing.
-.Pp
-Many drivers will also display the contents of each 802.11 frame
-sent and received when the interface is marked with
-both debugging and
-.Cm link2 ;
-e.g.,
-.Pp
-.Dl "ifconfig wi0 debug link2"
-.Pp
-Beware however that some management frames may be processed entirely within
-the device and not be received by the host.
-.Sh EXAMPLES
-Join an existing BSS network (i.e., connect to an access point):
-.Pp
-.Dl "ifconfig iface 192.168.0.20/24"
-.Pp
-Join a specific BSS network with network name
-.Dq Li my_net :
-.Pp
-.Dl "ifconfig iface 192.168.0.20/24 ssid my_net"
-.Pp
-Join a specific BSS network with 64 bit WEP encryption:
-.Bd -literal -offset indent
-ifconfig iface 192.168.0.20/24 ssid my_net wepmode on \e
-        wepkey 0x1234567890 weptxkey 1
-.Ed
-.Pp
-Join a specific BSS network with 128 bit WEP encryption:
-.Bd -literal -offset indent
-ifconfig iface 192.168.0.20/24 ssid my_net wepmode on \e
-        wepkey 0x01020304050607080910111213 weptxkey 1
-.Ed
-.Pp
-Join/create an 802.11b IBSS network:
-.Bd -literal -offset indent
-ifconfig iface 192.168.0.20/24 ssid my_net mediaopt adhoc
-.Ed
+There are several types of
+.Nm
+interfaces that may be created:
+.Bl -tag -width monitor
+.It Cm sta
+A client station in an infrastructure bss
+(i.e. one that associates to an access point).
+.It Cm hostap
+An access point in an infrastructure bss.
+.It Cm mesh
+A mesh station in an MBSS network.
+.It Cm adhoc
+A station in an IBSS network.
+.It Cm ahdemo
+A station operating in ``adhoc demo mode''.
+This is essentially an IBSS station that does not use management
+frames (e.g. no beacons are transmitted).
+An
+.Cm ahdemo
+interface is especially useful for applications that want to transmit
+and receive raw 802.11 packets.
+.It Cm monitor
+An interface used exclusively for capturing 802.11 frames.
+In particular this specified to have read-only properties
+which enables it to be operated on frequencies where one
+would otherwise not be allowed.
+.It Cm wds
+A station that passes 4-address 802.11 traffic for the purpose
+of tunneling traffic over a wireless link.
+Typically this station would share the same MAC address as a
+.Cm hostap
+interface.
+It may be possible to create
+.Cm wds
+interfaces without a companion
+.Cm hostap
+interface but that is not guaranteed; one may need to create a
+.Cm hostap
+interface that does not send beacon frames before
+.Cm wds
+interfaces may be created.
+.El
 .Pp
-To debug a network setup, you may wish to enable interface debugging:
-.Bd -literal -offset indent
-ifconfig iface down debug up
-.Ed
+Note that an interface's type cannot be changed once it is created.
 .Pp
-To disable debugging, you may simply use:
-.Bd -literal -offset indent
-ifconfig iface down -debug up
-.Ed
+.Nm
+defines several mechanisms by which plugin modules may
+be used to extend its' functionality.
+Cryptographic support such as WEP, TKIP, and AES-CCMP are implemented
+as standalone modules (if not statically configured into a system)
+that register with
+.Nm .
+Similarly there is an authenticator framework for defining 802.11
+authentication services and a framework for integrating access
+control mechanisms specific to the 802.11 protocol.
+.\".Sh EXAMPLES
+.\"Join an existing BSS network (i.e., connect to an access point):
+.\".Pp
+.\".Dl "ifconfig iface 192.168.0.20/24"
+.\".Pp
+.\"Join a specific BSS network with network name
+.\".Dq Li my_net :
+.\".Pp
+.\".Dl "ifconfig iface 192.168.0.20/24 ssid my_net"
+.\".Pp
+.\"Join a specific BSS network with 64 bit WEP encryption:
+.\".Bd -literal -offset indent
+.\"ifconfig iface 192.168.0.20/24 ssid my_net wepmode on \e
+.\"        wepkey 0x1234567890 weptxkey 1
+.\".Ed
+.\".Pp
+.\"Join a specific BSS network with 128 bit WEP encryption:
+.\".Bd -literal -offset indent
+.\"ifconfig iface 192.168.0.20/24 ssid my_net wepmode on \e
+.\"        wepkey 0x01020304050607080910111213 weptxkey 1
+.\".Ed
+.\".Pp
+.\"Join/create an 802.11b IBSS network:
+.\".Bd -literal -offset indent
+.\"ifconfig iface 192.168.0.20/24 ssid my_net mediaopt adhoc
+.\".Ed
+.\".Pp
+.\"To debug a network setup, you may wish to enable interface debugging:
+.\".Bd -literal -offset indent
+.\"ifconfig iface down debug up
+.\".Ed
+.\".Pp
+.\"To disable debugging, you may simply use:
+.\".Bd -literal -offset indent
+.\"ifconfig iface down -debug up
+.\".Ed
 .\".Pp
 .\"Create an 802.11g host-based access point:
 .\".Bd -literal -offset indent
@@ -173,32 +187,76 @@ ifconfig iface down -debug up
 .\".Ed
 .\".Pp
 .\"This will give you the same functionality as an access point.
+.Sh DEBUGGING
+If the
+.Dv IEEE80211_DEBUG
+option is included in the kernel configuration,
+debugging controls are available using:
+.Pp
+.Dl "sysctl net.wlan.X.debug=mask"
+.Pp
+where
+.Ar X
+is the number of the
+.Nm
+instance and mask is a bit-or of control bits that determine which
+debugging messages to enable.
+For example,
+.Pp
+.Dl "sysctl net.wlan.0.debug=0x00200000"
+.Pp
+enables debugging messages related to scanning for an access point,
+adhoc neighbor, or an unoccupied channel when operation as an access point.
+The
+.Xr wlandebug 8
+tool provides a more user-friendly mechanism for doing the same thing.
+Note that
+.Pp
+.Dl "sysctl net.wlan.debug=mask"
+.Pp
+defines the initial value of the debugging flags for each cloned
+.Nm
+interface; this is useful to enable debug messages during interface creation.
 .Sh COMPATIBILITY
 The module name of
 .Nm
 was used to be compatible with
 .Nx .
+.Pp
+Mesh stations follow the 802.11s Draft 3.0 specification which is
+not ratified and subject to change.
+Beware that this specification is incompatible with earlier drafts;
+and stations implementing earlier drafts (e.g. Linux)
+may not interoperate.
 .Sh SEE ALSO
-.Xr acx 4 ,
+.\".Xr acx 4 ,
+.Xr an 4 ,
 .Xr ath 4 ,
-.Xr bwi 4 ,
-.Xr iwi 4 ,
-.Xr iwl 4 ,
-.Xr ndis 4 ,
+.\".Xr bwi 4 ,
+.\".Xr ipw 4 ,
+.\".Xr iwi 4 ,
+.\".Xr iwl 4 ,
+.\".Xr iwn 4 ,
+.\".Xr malo 4 ,
 .Xr netintro 4 ,
 .Xr ral 4 ,
-.Xr rtw 4 ,
-.Xr rum 4 ,
-.Xr ural 4 ,
+.\".Xr rtw 4 ,
+.\".Xr rum 4 ,
+.\".Xr uath 4 ,
+.\".Xr upgt 4 ,
+.\".Xr ural 4 ,
+.\".Xr urtw 4 ,
 .Xr wi 4 ,
 .Xr wlan_acl 4 ,
+.Xr wlan_amrr 4 ,
 .Xr wlan_ccmp 4 ,
-.Xr wlan_ratectl 4 ,
 .Xr wlan_tkip 4 ,
 .Xr wlan_wep 4 ,
 .Xr wlan_xauth 4
+.\".Xr wpi 4 ,
+.\".Xr zyd 4
 .Sh STANDARDS
-More information can be found in the IEEE 802.11 Standard.
+More information can be found in the IEEE 802.11 Standards.
 .Sh HISTORY
 The
 .Nm
@@ -213,7 +271,8 @@ software from which this work began.
 brought the code into
 .Fx
 and then rewrote it to support multi-mode devices,
-802.11g, WPA/802.11i, WME, and add the extensible frameworks
+802.11g, 802.11n, WPA/802.11i, WME, multi-bss, and
+add the extensible frameworks
 for cryptographic, authentication, and access control plugins.
 This manual page was written by
 .An Tom Rhodes Aq trhodes@FreeBSD.org .
index 007ae40..f434e8a 100644 (file)
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
-.\" $FreeBSD: src/share/man/man4/wlan_acl.4,v 1.3 2005/01/13 11:09:58 ru Exp $
-.\" $DragonFly: src/share/man/man4/wlan_acl.4,v 1.1 2006/05/18 14:34:31 sephe Exp $
+.\" $FreeBSD: src/share/man/man4/wlan_acl.4,v 1.4 2008/04/20 20:35:45 sam Exp $
 .\"
-.Dd May 14, 2006
+.Dd April 14, 2010
 .Dt WLAN_ACL 4
 .Os
 .Sh NAME
@@ -41,12 +40,11 @@ module implements a MAC-based access control plugin for use
 with 802.11 devices operating as an access point.
 The
 .Nm
-module is an 802.11 access control plugin module for use with the
-.Xr wlan 4
-module.
-This module is automatically loaded if an application configures
-an access control policy for an 802.11 device operating as an access
-point.
+must be loaded for
+.Xr ifconfig 8
+to handle the
+.Cm mac:*
+requests.
 .Sh SEE ALSO
 .Xr wlan 4 ,
 .Xr ifconfig 8
similarity index 67%
copy from share/man/man4/wlan_acl.4
copy to share/man/man4/wlan_amrr.4
index 007ae40..0ce7402 100644 (file)
@@ -1,5 +1,5 @@
 .\"
-.\" Copyright (c) 2004 Sam Leffler
+.\" Copyright (c) 2007 Kevin Lo
 .\" All rights reserved.
 .\"
 .\" Redistribution and use in source and binary forms, with or without
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
-.\" $FreeBSD: src/share/man/man4/wlan_acl.4,v 1.3 2005/01/13 11:09:58 ru Exp $
-.\" $DragonFly: src/share/man/man4/wlan_acl.4,v 1.1 2006/05/18 14:34:31 sephe Exp $
+.\" $FreeBSD: src/share/man/man4/wlan_amrr.4,v 1.3 2008/04/20 20:35:45 sam Exp $
 .\"
-.Dd May 14, 2006
-.Dt WLAN_ACL 4
+.Dd April 14, 2010
+.Dt WLAN_AMRR 4
 .Os
 .Sh NAME
-.Nm wlan_acl
-.Nd MAC-based ACL support for 802.11 devices
+.Nm wlan_amrr
+.Nd AMRR rate adaptation algorithm support for 802.11 devices
 .Sh SYNOPSIS
-.Cd "device wlan_acl"
+.Cd "device wlan_amrr"
 .Sh DESCRIPTION
 The
 .Nm
-module implements a MAC-based access control plugin for use
-with 802.11 devices operating as an access point.
-The
-.Nm
-module is an 802.11 access control plugin module for use with the
-.Xr wlan 4
-module.
-This module is automatically loaded if an application configures
-an access control policy for an 802.11 device operating as an access
-point.
+module implements the Adaptive Multi-Rate Retry tx rate control
+algorithm for use by 802.11 device drivers.
 .Sh SEE ALSO
-.Xr wlan 4 ,
-.Xr ifconfig 8
+.\".Xr bwi 4 ,
+.\".Xr iwn 4 ,
+.Xr ral 4 ,
+.\".Xr rum 4 ,
+.\".Xr ural 4 ,
+.Xr wlan 4
+.\".Xr wpi 4 ,
+.\".Xr zyd 4
 .Sh STANDARDS
-More information can be found in the IEEE 802.11 Standard.
+More information can be found in the paper describing the
+.Em AMRR
+algorithm at
+.Pa http://hal.inria.fr/inria-00070784/en/ .
 .Sh HISTORY
 The
 .Nm
index 43ceec5..1b0bdcf 100644 (file)
@@ -24,9 +24,8 @@
 .\" SUCH DAMAGE.
 .\"
 .\" $FreeBSD: src/share/man/man4/wlan_ccmp.4,v 1.3 2005/01/13 11:09:58 ru Exp $
-.\" $DragonFly: src/share/man/man4/wlan_ccmp.4,v 1.1 2006/05/18 14:34:31 sephe Exp $
 .\"
-.Dd May 14, 2006
+.Dd April 14, 2010
 .Dt WLAN_CCMP 4
 .Os
 .Sh NAME
@@ -47,10 +46,9 @@ module is an 802.11 cryptographic plugin module for use by the
 .Xr wlan 4
 module.
 This module is automatically loaded if an AES-CCMP key is configured;
-typically by a WPA supplicant program such as wpa_supplicant.
-.\"typically by a WPA supplicant program such as wpa_supplicant,
-.\"or a WPA authenticator program such as
-.\".Nm hostapd .
+typically by a WPA supplicant program such as wpa_supplicant,
+or a WPA authenticator program such as
+.Nm hostapd .
 Should the underlying network device not be capable of doing the AES-CCMP
 calculations in hardware, the
 .Nm
index 7471004..2a1db1f 100644 (file)
@@ -24,9 +24,8 @@
 .\" SUCH DAMAGE.
 .\"
 .\" $FreeBSD: src/share/man/man4/wlan_tkip.4,v 1.4 2005/06/15 19:29:03 wilko Exp $
-.\" $DragonFly: src/share/man/man4/wlan_tkip.4,v 1.1 2006/05/18 14:34:31 sephe Exp $
 .\"
-.Dd May 14, 2006
+.Dd April 14, 2010
 .Dt WLAN_TKIP 4
 .Os
 .Sh NAME
@@ -47,10 +46,9 @@ module is an 802.11 cryptographic plugin module for use by the
 .Xr wlan 4
 module.
 This module is automatically loaded if a TKIP key is configured;
-typically by a WPA supplicant program such as wpa_supplicant.
-.\"typically by a WPA supplicant program such as wpa_supplicant,
-.\"or a WPA authenticator program such as
-.\".Nm hostapd .
+typically by a WPA supplicant program such as wpa_supplicant,
+or a WPA authenticator program such as
+.Nm hostapd .
 Should the underlying network device not be capable of doing the TKIP
 and/or Michael calculations in hardware, the
 .Nm
index 447c116..bf35db1 100644 (file)
@@ -24,7 +24,6 @@
 .\" SUCH DAMAGE.
 .\"
 .\" $FreeBSD: src/share/man/man4/wlan_wep.4,v 1.2 2005/01/13 11:09:58 ru Exp $
-.\" $DragonFly: src/share/man/man4/wlan_wep.4,v 1.1 2006/05/18 14:34:31 sephe Exp $
 .\"
 .Dd May 14, 2006
 .Dt WLAN_WEP 4
index 1fc841e..da3c8bd 100644 (file)
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
-.\" $FreeBSD: src/share/man/man4/wlan_xauth.4,v 1.3 2005/01/13 11:09:58 ru Exp $
-.\" $DragonFly: src/share/man/man4/wlan_xauth.4,v 1.1 2006/05/18 14:34:31 sephe Exp $
+.\" $FreeBSD: src/share/man/man4/wlan_xauth.4,v 1.4 2008/04/20 20:35:45 sam Exp $
 .\"
-.Dd May 14, 2006
+.Dd April 14, 2010
 .Dt WLAN_XAUTH 4
 .Os
 .Sh NAME
@@ -37,7 +36,9 @@
 .Sh DESCRIPTION
 The
 .Nm
-module implements an authenticator plugin that is intended
+module is a
+.Xr wlan 4
+authenticator plugin
 for use with user-mode authentication implementations such
 as
 .Nm hostapd .
@@ -45,13 +46,10 @@ It hooks into the 802.11 layer and does nothing.
 As a result, 802.11 stations that associate are not authorized to
 send or receive frames until they are authorized by an external agent;
 typically using a protocol such as WPA, 802.1x, or 802.11i.
-The
-.Nm
-module is an 802.11 authenticator plugin module for use by the
-.Xr wlan 4
-module.
-This module is automatically loaded if an application configures
-an 802.11 device for operation as an AP with WPA or 802.1x authentication.
+.\".Pp
+.\"This module is automatically loaded by the rc script that normally
+.\"starts
+.\".Xr hostapd 8 .
 .Sh SEE ALSO
 .Xr wlan 4
 .Sh STANDARDS