1.\" Copyright (c) 2005
2.\" Bill Paul <wpaul@windriver.com> All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\" notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\" notice, this list of conditions and the following disclaimer in the
11.\" documentation and/or other materials provided with the distribution.
12.\" 3. All advertising materials mentioning features or use of this software
13.\" must display the following acknowledgement:
14.\" This product includes software developed by Bill Paul.
15.\" 4. Neither the name of the author nor the names of any co-contributors
16.\" may be used to endorse or promote products derived from this software
17.\" without specific prior written permission.
18.\"
19.\" THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
20.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22.\" ARE DISCLAIMED. IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
23.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
29.\" THE POSSIBILITY OF SUCH DAMAGE.
30.\"
31.\" $FreeBSD: head/usr.sbin/wpa/ndis_events/ndis_events.8 151214 2005-10-10 17:51:12Z wpaul $
32.\"
33.Dd October 10, 2005
34.Dt NDIS_EVENTS 8
35.Os
36.Sh NAME
37.Nm ndis_events
38.Nd relay events from
39.Xr ndis 4
40drivers to
41.Xr wpa_supplicant 8
42.Sh SYNOPSIS
43.Nm
44.Op Fl d
45.Op Fl v
46.Sh DESCRIPTION
47The
48.Nm
49utility listens for events generated by an
50.Xr ndis 4
51wireless network driver and relays them to
52.Xr wpa_supplicant 8
53for possible processing. The three event types that can occur
54are media connect and disconnect events, such as when a wireless
55interface joins or leaves a network, and media-specific events.
56In particular,
57.Xr ndis 4
58drivers that support WPA2 will generate media-specific events
59containing PMKID candidate information which
60.Xr wpa_supplicant 8
61needs in order to properly associate with WPA2-capable access points.
62.Pp
63The
64.Nm
65daemon works by listening for interface information events via
66a routing socket. When it detects an event that was generated by an
67.Xr ndis 4
68interface, it transmits it via UDP packet on the loopback interface,
69where
70.Xr wpa_supplicant 8
71is presumeably listening. The standard
72.Xr wpa_supplicant 8
73distribution includes its own version of this utility for use with
74.Tn Windows\[rg] .
75The
76.Fx
77version performs the same functions as the
78.Tn Windows\[rg]
79except that it uses an
80.Xr ioctl 4
81and routing socket interface instead of WMI.
82.Pp
83Note that a single instance of
84.Nm
85is sufficient to scan for events for any number of
86.Xr ndis 4
87interfaces in a system.
88.Sh OPTIONS
89The
90.Nm
91daemon supports the following options:
92.Bl -tag -width indent
93.It Fl d
94Run in debug mode. This causes
95.Nm
96to run in the foreground and generate any output to the standard
97error instead of using the
98.Xr syslog 3
99facility.
100.It Fl v
101Run in verbose mode. This causes
102.Nm
103to emit notifications when it receives events.
104.El
105.Sh SEE ALSO
106.Xr ndis 4 ,
107.Xr ndisapi 9 ,
108.Xr wpa_supplicant 8
109.Sh HISTORY
110The
111.Nm
112utility first appeared in
113.Fx 7.0 .
114.Sh AUTHORS
115The
116.Nm
117utility was written by
118.An Bill Paul Aq wpaul@windriver.com .
2.\" Bill Paul <wpaul@windriver.com> All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\" notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\" notice, this list of conditions and the following disclaimer in the
11.\" documentation and/or other materials provided with the distribution.
12.\" 3. All advertising materials mentioning features or use of this software
13.\" must display the following acknowledgement:
14.\" This product includes software developed by Bill Paul.
15.\" 4. Neither the name of the author nor the names of any co-contributors
16.\" may be used to endorse or promote products derived from this software
17.\" without specific prior written permission.
18.\"
19.\" THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
20.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22.\" ARE DISCLAIMED. IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
23.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
29.\" THE POSSIBILITY OF SUCH DAMAGE.
30.\"
31.\" $FreeBSD: head/usr.sbin/wpa/ndis_events/ndis_events.8 151214 2005-10-10 17:51:12Z wpaul $
32.\"
33.Dd October 10, 2005
34.Dt NDIS_EVENTS 8
35.Os
36.Sh NAME
37.Nm ndis_events
38.Nd relay events from
39.Xr ndis 4
40drivers to
41.Xr wpa_supplicant 8
42.Sh SYNOPSIS
43.Nm
44.Op Fl d
45.Op Fl v
46.Sh DESCRIPTION
47The
48.Nm
49utility listens for events generated by an
50.Xr ndis 4
51wireless network driver and relays them to
52.Xr wpa_supplicant 8
53for possible processing. The three event types that can occur
54are media connect and disconnect events, such as when a wireless
55interface joins or leaves a network, and media-specific events.
56In particular,
57.Xr ndis 4
58drivers that support WPA2 will generate media-specific events
59containing PMKID candidate information which
60.Xr wpa_supplicant 8
61needs in order to properly associate with WPA2-capable access points.
62.Pp
63The
64.Nm
65daemon works by listening for interface information events via
66a routing socket. When it detects an event that was generated by an
67.Xr ndis 4
68interface, it transmits it via UDP packet on the loopback interface,
69where
70.Xr wpa_supplicant 8
71is presumeably listening. The standard
72.Xr wpa_supplicant 8
73distribution includes its own version of this utility for use with
74.Tn Windows\[rg] .
75The
76.Fx
77version performs the same functions as the
78.Tn Windows\[rg]
79except that it uses an
80.Xr ioctl 4
81and routing socket interface instead of WMI.
82.Pp
83Note that a single instance of
84.Nm
85is sufficient to scan for events for any number of
86.Xr ndis 4
87interfaces in a system.
88.Sh OPTIONS
89The
90.Nm
91daemon supports the following options:
92.Bl -tag -width indent
93.It Fl d
94Run in debug mode. This causes
95.Nm
96to run in the foreground and generate any output to the standard
97error instead of using the
98.Xr syslog 3
99facility.
100.It Fl v
101Run in verbose mode. This causes
102.Nm
103to emit notifications when it receives events.
104.El
105.Sh SEE ALSO
106.Xr ndis 4 ,
107.Xr ndisapi 9 ,
108.Xr wpa_supplicant 8
109.Sh HISTORY
110The
111.Nm
112utility first appeared in
113.Fx 7.0 .
114.Sh AUTHORS
115The
116.Nm
117utility was written by
118.An Bill Paul Aq wpaul@windriver.com .