68696d9b3a65af375c658138dc4e397384f87be1
[dragonfly.git] / sbin / ifconfig / ifconfig.8
1 .\" Copyright (c) 1983, 1991, 1993
2 .\"     The Regents of the University of California.  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 .\" 4. Neither the name of the University nor the names of its contributors
13 .\"    may be used to endorse or promote products derived from this software
14 .\"    without specific prior written permission.
15 .\"
16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 .\" SUCH DAMAGE.
27 .\"
28 .\"     From: @(#)ifconfig.8    8.3 (Berkeley) 1/5/94
29 .\" $FreeBSD: src/sbin/ifconfig/ifconfig.8,v 1.124 2006/10/10 09:44:08 ru Exp $
30 .\" $DragonFly: src/sbin/ifconfig/ifconfig.8,v 1.24 2007/12/16 20:10:21 thomas Exp $
31
32 .\"
33 .Dd September 30, 2007
34 .Dt IFCONFIG 8
35 .Os
36 .Sh NAME
37 .Nm ifconfig
38 .Nd configure network interface parameters
39 .Sh SYNOPSIS
40 .Nm
41 .Op Fl L
42 .Op Fl k
43 .Op Fl m
44 .Ar interface
45 .Op Cm create
46 .Op Ar address_family
47 .Oo
48 .Ar address
49 .Op Ar dest_address
50 .Oc
51 .Op Ar parameters
52 .Nm
53 .Ar interface
54 .Cm destroy
55 .Nm
56 .Fl a
57 .Op Fl L
58 .Op Fl d
59 .Op Fl m
60 .Op Fl u
61 .Op Fl v
62 .Op Ar address_family
63 .Nm
64 .Fl l
65 .Op Fl d
66 .Op Fl u
67 .Op Ar address_family
68 .Nm
69 .Op Fl L
70 .Op Fl d
71 .Op Fl k
72 .Op Fl m
73 .Op Fl u
74 .Op Fl v
75 .Op Fl C
76 .Sh DESCRIPTION
77 The
78 .Nm
79 utility is used to assign an address
80 to a network interface and/or configure
81 network interface parameters.
82 The
83 .Nm
84 utility must be used at boot time to define the network address
85 of each interface present on a machine; it may also be used at
86 a later time to redefine an interface's address
87 or other operating parameters.
88 .Pp
89 The following options are available:
90 .Bl -tag -width indent
91 .It Ar address
92 For the
93 .Tn DARPA Ns -Internet
94 family,
95 the address is either a host name present in the host name data
96 base,
97 .Xr hosts 5 ,
98 or a
99 .Tn DARPA
100 Internet address expressed in the Internet standard
101 .Dq dot notation .
102 .Pp
103 It is also possible to use the CIDR notation (also known as the
104 slash notation) to include the netmask.
105 That is, one can specify an address like
106 .Li 192.168.0.1/16 .
107 .Pp
108 For
109 .Dq inet6
110 family, it is also possible to specify the prefix length using the slash
111 notation, like
112 .Li ::1/128 .
113 See the
114 .Cm prefixlen
115 parameter below for more information.
116 .\" For the Xerox Network Systems(tm) family,
117 .\" addresses are
118 .\" .Ar net:a.b.c.d.e.f ,
119 .\" where
120 .\" .Ar net
121 .\" is the assigned network number (in decimal),
122 .\" and each of the six bytes of the host number,
123 .\" .Ar a
124 .\" through
125 .\" .Ar f ,
126 .\" are specified in hexadecimal.
127 .\" The host number may be omitted on IEEE 802 protocol
128 .\" (Ethernet, FDDI, and Token Ring) interfaces,
129 .\" which use the hardware physical address,
130 .\" and on interfaces other than the first.
131 .\" For the
132 .\" .Tn ISO
133 .\" family, addresses are specified as a long hexadecimal string,
134 .\" as in the Xerox family.
135 .\" However, two consecutive dots imply a zero
136 .\" byte, and the dots are optional, if the user wishes to (carefully)
137 .\" count out long strings of digits in network byte order.
138 .Pp
139 The link-level
140 .Pq Dq link
141 address
142 is specified as a series of colon-separated hex digits.
143 This can be used to
144 e.g.\& set a new MAC address on an ethernet interface, though the
145 mechanism used is not ethernet-specific.
146 If the interface is already
147 up when this option is used, it will be briefly brought down and
148 then brought back up again in order to ensure that the receive
149 filter in the underlying ethernet hardware is properly reprogrammed.
150 .It Ar address_family
151 Specify the
152 address family
153 which affects interpretation of the remaining parameters.
154 Since an interface can receive transmissions in differing protocols
155 with different naming schemes, specifying the address family is recommended.
156 The address or protocol families currently
157 supported are
158 .Dq inet ,
159 .Dq inet6 ,
160 .Dq atalk ,
161 .Dq ipx ,
162 .\" .Dq iso ,
163 and
164 .Dq link .
165 .\" and
166 .\" .Dq ns .
167 The default is
168 .Dq inet .
169 .Dq ether
170 and
171 .Dq lladdr
172 are synonyms for
173 .Dq link .
174 .It Ar dest_address
175 Specify the address of the correspondent on the other end
176 of a point to point link.
177 .It Ar interface
178 This
179 parameter is a string of the form
180 .Dq name unit ,
181 for example,
182 .Dq Li ed0 .
183 .El
184 .Pp
185 The following parameters may be set with
186 .Nm :
187 .Bl -tag -width indent
188 .It Cm add
189 Another name for the
190 .Cm alias
191 parameter.
192 Introduced for compatibility
193 with
194 .Bsx .
195 .It Cm alias
196 Establish an additional network address for this interface.
197 This is sometimes useful when changing network numbers, and
198 one wishes to accept packets addressed to the old interface.
199 If the address is on the same subnet as the first network address
200 for this interface, a non-conflicting netmask must be given.
201 Usually
202 .Li 0xffffffff
203 is most appropriate.
204 .It Fl alias
205 Remove the network address specified.
206 This would be used if you incorrectly specified an alias, or it
207 was no longer needed.
208 If you have incorrectly set an NS address having the side effect
209 of specifying the host portion, removing all NS addresses will
210 allow you to respecify the host portion.
211 .It Cm anycast
212 (Inet6 only.)
213 Specify that the address configured is an anycast address.
214 Based on the current specification,
215 only routers may configure anycast addresses.
216 Anycast address will not be used as source address of any of outgoing
217 IPv6 packets.
218 .It Cm arp
219 Enable the use of the Address Resolution Protocol
220 .Pq Xr arp 4
221 in mapping
222 between network level addresses and link level addresses (default).
223 This is currently implemented for mapping between
224 .Tn DARPA
225 Internet
226 addresses and
227 .Tn IEEE
228 802 48-bit MAC addresses (Ethernet, FDDI, and Token Ring addresses).
229 .It Fl arp
230 Disable the use of the Address Resolution Protocol
231 .Pq Xr arp 4 .
232 .It Cm broadcast
233 (Inet only.)
234 Specify the address to use to represent broadcasts to the
235 network.
236 The default broadcast address is the address with a host part of all 1's.
237 .It Cm debug
238 Enable driver dependent debugging code; usually, this turns on
239 extra console error logging.
240 .It Fl debug
241 Disable driver dependent debugging code.
242 .It Cm promisc
243 Put interface into permanently promiscuous mode.
244 .It Fl promisc
245 Disable permanently promiscuous mode.
246 .It Cm delete
247 Another name for the
248 .Fl alias
249 parameter.
250 .It Cm down
251 Mark an interface
252 .Dq down .
253 When an interface is marked
254 .Dq down ,
255 the system will not attempt to
256 transmit messages through that interface.
257 If possible, the interface will be reset to disable reception as well.
258 This action does not automatically disable routes using the interface.
259 .It Cm eui64
260 (Inet6 only.)
261 Fill interface index
262 (lowermost 64bit of an IPv6 address)
263 automatically.
264 .It Cm ipdst
265 This is used to specify an Internet host who is willing to receive
266 IP packets encapsulating IPX packets bound for a remote network.
267 An apparent point to point link is constructed, and
268 the address specified will be taken as the IPX address and network
269 of the destination.
270 .It Cm media Ar type
271 If the driver supports the media selection system, set the media type
272 of the interface to
273 .Ar type .
274 Some interfaces support the mutually exclusive use of one of several
275 different physical media connectors.
276 For example, a 10Mbit/s Ethernet
277 interface might support the use of either
278 .Tn AUI
279 or twisted pair connectors.
280 Setting the media type to
281 .Cm 10base5/AUI
282 would change the currently active connector to the AUI port.
283 Setting it to
284 .Cm 10baseT/UTP
285 would activate twisted pair.
286 Refer to the interfaces' driver
287 specific documentation or man page for a complete list of the
288 available types.
289 .It Cm mediaopt Ar opts
290 If the driver supports the media selection system, set the specified
291 media options on the interface.
292 The
293 .Ar opts
294 argument
295 is a comma delimited list of options to apply to the interface.
296 Refer to the interfaces' driver specific man page for a complete
297 list of available options.
298 .It Fl mediaopt Ar opts
299 If the driver supports the media selection system, disable the
300 specified media options on the interface.
301 .It Cm mode Ar mode
302 If the driver supports the media selection system, set the specified
303 operating mode on the interface to
304 .Ar mode .
305 For IEEE 802.11 wireless interfaces that support multiple operating modes
306 this directive is used to select between 802.11a
307 .Pq Cm 11a ,
308 802.11b
309 .Pq Cm 11b ,
310 and 802.11g
311 .Pq Cm 11g
312 operating modes.
313 .It Cm name Ar name
314 Set the interface name to
315 .Ar name .
316 .It Cm rxcsum , txcsum
317 If the driver supports user-configurable checksum offloading,
318 enable receive (or transmit) checksum offloading on the interface.
319 Some drivers may not be able to enable these flags independently
320 of each other, so setting one may also set the other.
321 The driver will offload as much checksum work as it can reliably
322 support, the exact level of offloading varies between drivers.
323 .It Fl rxcsum , txcsum
324 If the driver supports user-configurable checksum offloading,
325 disable receive (or transmit) checksum offloading on the interface.
326 These settings may not always be independent of each other.
327 .It Cm vlanmtu , vlanhwtag
328 If the driver offers user-configurable VLAN support, enable
329 reception of extended frames or tag processing in hardware,
330 respectively.
331 Note that this must be issued on a physical interface associated with
332 .Xr vlan 4 ,
333 not on a
334 .Xr vlan 4
335 interface itself.
336 .It Fl vlanmtu , vlanhwtag
337 If the driver offers user-configurable VLAN support, disable
338 reception of extended frames or tag processing in hardware,
339 respectively.
340 .It Cm pollcpu Ar cpu
341 Turn on
342 .Xr polling 4
343 feature and disable interrupts on the interface,
344 if the driver supports this mode and
345 .Ar cpu
346 supports
347 .Xr polling 4 .
348 Driver will be polled by
349 .Ar cpu .
350 .It Cm polling
351 Turn on
352 .Xr polling 4
353 feature and disable interrupts on the interface, if the driver supports
354 this mode.
355 .It Fl polling
356 Turn off
357 .Xr polling 4
358 feature and enable interrupt mode on the interface.
359 .It Cm create
360 Create the specified network pseudo-device.
361 If the interface is given without a unit number, try to create a new
362 device with an arbitrary unit number.
363 If creation of an arbitrary device is successful, the new device name is
364 printed to standard output unless the interface is renamed or destroyed
365 in the same
366 .Nm
367 invocation.
368 .It Cm destroy
369 Destroy the specified network pseudo-device.
370 .It Cm plumb
371 Another name for the
372 .Cm create
373 parameter.
374 Included for
375 .Tn Solaris
376 compatibility.
377 .It Cm unplumb
378 Another name for the
379 .Cm destroy
380 parameter.
381 Included for
382 .Tn Solaris
383 compatibility.
384 .It Cm metric Ar n
385 Set the routing metric of the interface to
386 .Ar n ,
387 default 0.
388 The routing metric is used by the routing protocol
389 .Pq Xr routed 8 .
390 Higher metrics have the effect of making a route
391 less favorable; metrics are counted as additional hops
392 to the destination network or host.
393 .It Cm mtu Ar n
394 Set the maximum transmission unit of the interface to
395 .Ar n ,
396 default is interface specific.
397 The MTU is used to limit the size of packets that are transmitted on an
398 interface.
399 Not all interfaces support setting the MTU, and some interfaces have
400 range restrictions.
401 .It Cm netmask Ar mask
402 .\" (Inet and ISO.)
403 (Inet only.)
404 Specify how much of the address to reserve for subdividing
405 networks into sub-networks.
406 The mask includes the network part of the local address
407 and the subnet part, which is taken from the host field of the address.
408 The mask can be specified as a single hexadecimal number
409 with a leading
410 .Ql 0x ,
411 with a dot-notation Internet address,
412 or with a pseudo-network name listed in the network table
413 .Xr networks 5 .
414 The mask contains 1's for the bit positions in the 32-bit address
415 which are to be used for the network and subnet parts,
416 and 0's for the host part.
417 The mask should contain at least the standard network portion,
418 and the subnet field should be contiguous with the network
419 portion.
420 .Pp
421 The netmask can also be specified in CIDR notation after the address.
422 See the
423 .Ar address
424 option above for more information.
425 .It Cm autoconf
426 (Inet6 only.)
427 Enable autoconfiguration.
428 .It Fl autoconf
429 Disable autoconfiguration.
430 .It Cm pltime Ar n
431 (Inet6 only.)
432 Set preferred lifetime for the address.
433 .It Cm vltime Ar n
434 (Inet6 only.)
435 Set valid lifetime for the address.
436 .It Cm prefixlen Ar len
437 (Inet6 only.)
438 Specify that
439 .Ar len
440 bits are reserved for subdividing networks into sub-networks.
441 The
442 .Ar len
443 must be integer, and for syntactical reason it must be between 0 to 128.
444 It is almost always 64 under the current IPv6 assignment rule.
445 If the parameter is omitted, 64 is used.
446 .Pp
447 The prefix can also be specified using the slash notation after the address.
448 See the
449 .Ar address
450 option above for more information.
451 .It Cm deprecated
452 (Inet6 only.)
453 Set the IPv6 deprecated address bit.
454 .It Fl deprecated
455 (Inet6 only.)
456 Clear the IPv6 deprecated address bit.
457 .It Cm tentative
458 (Inet6 only.)
459 Set the IPv6 tentative address bit.
460 .It Fl tentative
461 (Inet6 only.)
462 Clear the IPv6 tentative address bit.
463 .\" see
464 .\" Xr eon 5 .
465 .\" .It Cm nsellength Ar n
466 .\" .Pf ( Tn ISO
467 .\" only)
468 .\" This specifies a trailing number of bytes for a received
469 .\" .Tn NSAP
470 .\" used for local identification, the remaining leading part of which is
471 .\" taken to be the
472 .\" .Tn NET
473 .\" (Network Entity Title).
474 .\" The default value is 1, which is conformant to US
475 .\" .Tn GOSIP .
476 .\" When an ISO address is set in an ifconfig command,
477 .\" it is really the
478 .\" .Tn NSAP
479 .\" which is being specified.
480 .\" For example, in
481 .\" .Tn US GOSIP ,
482 .\" 20 hex digits should be
483 .\" specified in the
484 .\" .Tn ISO NSAP
485 .\" to be assigned to the interface.
486 .\" There is some evidence that a number different from 1 may be useful
487 .\" for
488 .\" .Tn AFI
489 .\" 37 type addresses.
490 .It Cm range Ar netrange
491 Under appletalk, set the interface to respond to a
492 .Ar netrange
493 of the form
494 .Ar startnet Ns - Ns Ar endnet .
495 Appletalk uses this scheme instead of
496 netmasks though
497 .Dx
498 implements it internally as a set of netmasks.
499 .It Cm remove
500 Another name for the
501 .Fl alias
502 parameter.
503 Introduced for compatibility
504 with
505 .Bsx .
506 .It Cm phase
507 The argument following this specifies the version (phase) of the
508 Appletalk network attached to the interface.
509 Values of 1 or 2 are permitted.
510 .Sm off
511 .It Cm link Op Cm 0 No - Cm 2
512 .Sm on
513 Enable special processing of the link level of the interface.
514 These three options are interface specific in actual effect, however,
515 they are in general used to select special modes of operation.
516 An example
517 of this is to enable SLIP compression, or to select the connector type
518 for some Ethernet cards.
519 Refer to the man page for the specific driver
520 for more information.
521 .Sm off
522 .It Fl link Op Cm 0 No - Cm 2
523 .Sm on
524 Disable special processing at the link level with the specified interface.
525 .It Cm compress
526 Another name for the
527 .Cm link0
528 parameter.
529 .It Cm normal
530 Another name for the
531 .Fl link0
532 parameter.
533 .It Cm noicmp
534 Another name for the
535 .Cm link1
536 parameter.
537 .It Cm monitor
538 Put the interface in monitor mode.
539 No packets are transmitted, and received packets are discarded after
540 .Xr bpf 4
541 processing.
542 .It Fl monitor
543 Take the interface out of monitor mode.
544 .It Cm up
545 Mark an interface
546 .Dq up .
547 This may be used to enable an interface after an
548 .Dq Nm Cm down .
549 It happens automatically when setting the first address on an interface.
550 If the interface was reset when previously marked down,
551 the hardware will be re-initialized.
552 .El
553 .Pp
554 The following parameters are specific to IEEE 802.11 wireless interfaces:
555 .Bl -tag -width indent
556 .It Cm apbridge
557 When operating as an access point, pass packets between
558 wireless clients directly (default).
559 To instead let them pass up through the
560 system and be forwarded using some other mechanism, use
561 .Fl apbridge .
562 Disabling the internal bridging
563 is useful when traffic is to be processed with
564 packet filtering.
565 .It Cm authmode Ar mode
566 Set the desired authentication mode in infrastructure mode.
567 Not all adaptors support all modes.
568 The set of
569 valid modes is
570 .Cm none , open , shared
571 (shared key),
572 .Cm 8021x
573 (IEEE 802.1x),
574 and
575 .Cm wpa
576 (IEEE WPA/WPA2/802.11i).
577 The
578 .Cm 8021x
579 and
580 .Cm wpa
581 modes are only useful when using an authentication service
582 (a supplicant for client operation or an authenticator when
583 operating as an access point).
584 Modes are case insensitive.
585 .It Cm bintval Ar interval
586 Set the interval at which beacon frames are sent when operating in
587 ad-hoc or ap mode.
588 The
589 .Ar interval
590 parameter is specified in TU's (1024 usecs).
591 By default beacon frames are transmitted every 100 TU's.
592 .It Cm bmissthreshold Ar count
593 Set the number of consecutive missed beacons at which the station
594 will attempt to roam (i.e. search for a new access point).
595 The
596 .Ar count
597 parameter is must be in the range 1 to 255;
598 though the upper bound may be reduced according to device capabilities..
599 The default threshold is 7 consecutive missed beacons;
600 but this may be overridden by the device driver.
601 Another name for the
602 .Cm bmissthreshold
603 parameter is
604 .Cm bmiss .
605 .It Cm bssid Ar address
606 Specify the MAC address of the access point to use when operating
607 as a station in a BSS network.
608 This overrides any automatic selection done by the system.
609 To disable a previously selected access point, supply
610 .Cm any , none ,
611 or
612 .Cm -
613 for the address.
614 This option is useful when more than one access point uses the same SSID.
615 Another name for the
616 .Cm bssid
617 parameter is
618 .Cm ap .
619 .It Cm burst
620 Enable packet bursting.
621 Packet bursting is a transmission technique whereby the wireless
622 medium is acquired once to send multiple frames and the interframe
623 spacing is reduced.
624 This technique can significantly increase throughput by reducing
625 transmission overhead.
626 Packet bursting is supported by the 802.11e QoS specification
627 and some devices that do not support QoS may still be capable.
628 By default packet bursting is enabled if a device is capable
629 of doing it.
630 To disable packet bursting, use
631 .Fl burst .
632 .It Cm chanlist Ar channels
633 Set the desired channels to use when scanning for access
634 points, neighbors in an IBSS network, or looking for unoccupied
635 channels when operating as an access point.
636 The set of channels is specified as a comma-separated list with
637 each element in the list representing either a single channel number or a range
638 of the form
639 .Dq Li a-b .
640 Channel numbers must be in the range 1 to 255 and be permissible
641 according to the operating characteristics of the device.
642 .It Cm channel Ar number
643 Set a single desired channel.
644 Channels range from 1 to 255, but the exact selection available
645 depends on the region your adaptor was manufactured for.
646 Setting
647 the channel to
648 .Li 0 ,
649 .Cm any ,
650 or
651 .Cm -
652 will give you the default for your adaptor.
653 Some
654 adaptors ignore this setting unless you are in ad-hoc mode.
655 Alternatively the frequency, in megahertz, may be specified
656 instead of the channel number.
657 .It Cm deftxkey Ar index
658 Set the default key to use for transmission.
659 Typically this is only set when using WEP encryption.
660 The
661 .Cm weptxkey
662 is an alias for this request; it is provided for backwards compatibility.
663 .It Cm dtimperiod Ar period
664 Set the
665 DTIM
666 period for transmitting buffered multicast data frames when
667 operating in ap mode.
668 The
669 .Ar period
670 specifies the number of beacon intervals between DTIM
671 and must be in the range 1 to 15.
672 By default DTIM is 1 (i.e., DTIM occurs at each beacon).
673 .It Cm fragthreshold Ar length
674 Set the threshold for which transmitted frames are broken into fragments.
675 The
676 .Ar length
677 argument is the frame size in bytes and must be in the range 256 to 2346.
678 Setting
679 .Ar length
680 to
681 .Li 2346 ,
682 .Cm any ,
683 or
684 .Cm -
685 disables transmit fragmentation.
686 Not all adaptors honor the fragmentation threshold.
687 .It Cm hidessid
688 When operating as an access point, do not broadcast the SSID
689 in beacon frames or respond to probe request frames unless
690 they are directed to the ap (i.e., they include the ap's SSID).
691 By default, the SSID is included in beacon frames and
692 undirected probe request frames are answered.
693 To re-enable the broadcast of the SSID etc., use
694 .Fl hidessid .
695 .It Cm list active
696 Display the list of channels available for use taking into account
697 any restrictions set with the
698 .Cm chanlist
699 directive.
700 See the description of
701 .Cm list chan
702 for more information.
703 .It Cm list caps
704 Display the adaptor's capabilities, including the operating
705 modes supported.
706 .It Cm list chan
707 Display the list of channels available for use.
708 Channels are shown with their IEEE channel number, equivalent
709 frequency, and usage modes.
710 Channels identified as
711 .Ql 11g
712 are also usable in
713 .Ql 11b
714 mode.
715 Channels identified as
716 .Ql 11a Turbo
717 may be used only for Atheros' Static Turbo mode
718 specified with
719 .Cm mediaopt turbo ) .
720 Channels marked with a
721 .Ql *
722 have a regulatory constraint that they be passively scanned.
723 This means a station is not permitted to transmit on the channel until
724 it identifies the channel is being used for 802.11 communication;
725 typically by hearing a beacon frame from an access point operating
726 on the channel.
727 .Cm list freq
728 is another way of requesting this information.
729 .It Cm list mac
730 Display the current MAC Access Control List state.
731 Each address is prefixed with a character that indicates the
732 current policy applied to it:
733 .Ql +
734 indicates the address is allowed access,
735 .Ql -
736 indicates the address is denied access,
737 .Ql *
738 indicates the address is present but the current policy open
739 (so the ACL is not consulted).
740 .It Cm list scan
741 Display the access points and/or ad-hoc neighbors
742 located in the vicinity.
743 The
744 .Fl v
745 flag may be used to display long SSIDs.
746 This information may be updated automatically by the adaptor
747 and/or with a
748 .Cm scan
749 request.
750 .Cm list ap
751 is another way of requesting this information.
752 .It Cm list sta
753 When operating as an access point display the stations that are
754 currently associated.
755 When operating in ad-hoc mode display stations identified as
756 neighbors in the IBSS.
757 .It Cm list wme
758 Display the current parameters to use when operating in WME mode.
759 When WME mode is enabled for an adaptor this information will be
760 displayed with the regular status; this command is mostly useful
761 for examining parameters when WME mode is disabled.
762 See the description of the
763 .Cm wme
764 directive for information on the various parameters.
765 .It Cm mcastrate Ar rate
766 Set the rate for transmitting multicast/broadcast frames.
767 Rates are specified as megabits/second in decimal; e.g.\& 5.5 for 5.5 Mbit/s.
768 This rate should be valid for the current operating conditions;
769 if an invalid rate is specified drivers are free to chose an
770 appropriate rate.
771 .It Cm powersave
772 Enable powersave operation.
773 When operating as a client, the station will conserve power by
774 periodically turning off the radio and listening for
775 messages from the access point telling it there are packets waiting.
776 The station must then retrieve the packets.
777 When operating as an access point, the station must honor power
778 save operation of associated clients.
779 Not all devices support power save operation, either as a client
780 or as an access point.
781 Use
782 .Fl powersave
783 to disable powersave operation.
784 .It Cm powersavemode Ar mode
785 Set powersave mode.
786 The set of valid modes is
787 .Cm off
788 (same as
789 .Fl powersave ) ,
790 .Cm on
791 (same as
792 .Cm powersave ) ,
793 and
794 .Cm cam
795 (same as
796 .Cm powersave ) .
797 .It Cm powersavesleep Ar sleep
798 Set the desired max powersave sleep time in TU's (1024 usecs).
799 By default the max powersave sleep time is 100 TU's.
800 .It Cm protmode Ar technique
801 For interfaces operating in 802.11g, use the specified
802 .Ar technique
803 for protecting OFDM frames in a mixed 11b/11g network.
804 The set of valid techniques is
805 .Cm off , cts
806 (CTS to self),
807 and
808 .Cm rtscts
809 (RTS/CTS).
810 Technique names are case insensitive.
811 .It Cm pureg
812 When operating as an access point in 802.11g mode allow only
813 11g-capable stations to associate (11b-only stations are not
814 permitted to associate).
815 To allow both 11g and 11b-only stations to associate, use
816 .Fl pureg .
817 .It Cm roaming Ar mode
818 When operating as a station, control how the system will
819 behave when communication with the current access point
820 is broken.
821 The
822 .Ar mode
823 argument may be one of
824 .Cm device
825 (leave it to the hardware device to decide),
826 .Cm auto
827 (handle either in the device or the operating system\[em]as appropriate),
828 .Cm manual
829 (do nothing until explicitly instructed).
830 By default, the device is left to handle this if it is
831 capable; otherwise, the operating system will automatically
832 attempt to reestablish communication.
833 Manual mode is mostly useful when an application wants to
834 control the selection of an access point.
835 .It Cm ratectl Ar algorithm
836 Set the TX rate control algorithm.
837 The set of valid
838 .Ar algorithm
839 is
840 .Cm onoe
841 (Onoe TX rate control algorithm),
842 .Cm sample
843 (Sample TX rate control algorithm)
844 and
845 .Cm amrr
846 (AMRR TX rate control algorithm).
847 .Ar Algorithm
848 names are case sensitive.
849 .It Cm rtsthreshold Ar length
850 Set the threshold for which
851 transmitted frames are preceded by transmission of an
852 RTS
853 control frame.
854 The
855 .Ar length
856 argument
857 is the frame size in bytes and must be in the range 1 to 2346.
858 Setting
859 .Ar length
860 to
861 .Li 2346 ,
862 .Cm any ,
863 or
864 .Cm -
865 disables transmission of RTS frames.
866 Not all adaptors support setting the RTS threshold.
867 .It Cm ssid Ar ssid
868 Set the desired Service Set Identifier (aka network name).
869 The SSID is a string up to 32 characters
870 in length and may be specified as either a normal string or in
871 hexadecimal when preceded by
872 .Ql 0x .
873 Additionally, the SSID may be cleared by setting it to
874 .Ql - .
875 .It Cm scan
876 Initiate a scan of neighboring stations, wait for it to complete, and
877 display all stations found.
878 Only the super-user can initiate a scan.
879 Depending on the capabilities of the APs, the following
880 flags can be included in the output:
881 .Bl -tag -width 3n
882 .It Li A
883 Channel Agility.
884 Indicates that the station support channel hopping as described by the
885 IEEE 802.11b specification.
886 .It Li B
887 Packet Binary Convolution Code (PBCC).
888 A modulation alternative to the standard OFDM method.
889 .It Li C
890 Pollreq
891 .It Li c
892 Pollable
893 .It Li D
894 Direct Sequence Spread Spectrum - Orthogonal Frequency Division
895 Multiplexing (DSSS-OFDM).
896 Indicates the the station supports DSSS-OFDM modulation.
897 .It Li E
898 Extended Service Set (ESS).
899 Indicates that the station is part of an infrastructure network
900 (in contrast to an IBSS/ad-hoc network).
901 .It Li I
902 IBSS/ad-hoc network.
903 Indicates that the station is part of an ad-hoc network
904 (in contrast to an ESS network).
905 .It Li P
906 Privacy.
907 Data confidentiality is required for all data frames
908 exchanged within the BSS.
909 This means that this BSS requires the station to
910 use cryptographic means such as WEP, TKIP or AES-CCMP to
911 encrypt/decrypt data frames being exchanged with others.
912 .It Li R
913 Robust Security Network (RSN).
914 Indicates that the station supports the IEEE 802.11i authentication
915 and key management protocol.
916 .It Li S
917 Short Preamble.
918 Indicates that the network is using short preambles (defined
919 in 802.11b High Rate/DSSS PHY, short preamble utilizes a
920 56 bit sync field in contrast to a 128 bit field used in long
921 preamble mode).
922 .It Li s
923 Short slot time.
924 Indicates that the network is using a short slot time.
925 .El
926 .Pp
927 The
928 .Cm list scan
929 request can be used to show recent scan results without
930 initiating a new scan.
931 .Pp
932 The
933 .Fl v
934 flag may be used to prevent the shortening of long SSIDs.
935 .It Cm stationname Ar name
936 Set the name of this station.
937 It appears that the station name is not really part of the IEEE 802.11
938 protocol though all interfaces seem to support it.
939 As such it only
940 seems to be meaningful to identical or virtually identical equipment.
941 Setting the station name is identical in syntax to setting the SSID.
942 .It Cm txpower Ar power
943 Set the power used to transmit frames.
944 The
945 .Ar power
946 argument
947 is a unitless value in the range 0 to 100 that is interpreted
948 by drivers to derive a device-specific value.
949 Out of range values are truncated.
950 Typically only a few discreet power settings are available and
951 the driver will use the setting closest to the specified value.
952 Not all adaptors support changing the transmit power.
953 .It Cm wepmode Ar mode
954 Set the desired WEP mode.
955 Not all adaptors support all modes.
956 The set of valid modes is
957 .Cm off , on ,
958 and
959 .Cm mixed .
960 The
961 .Cm mixed
962 mode explicitly tells the adaptor to allow association with access
963 points which allow both encrypted and unencrypted traffic.
964 On these adaptors,
965 .Cm on
966 means that the access point must only allow encrypted connections.
967 On other adaptors,
968 .Cm on
969 is generally another name for
970 .Cm mixed .
971 Modes are case insensitive.
972 .It Cm weptxkey Ar index
973 Set the WEP key to be used for transmission.
974 This is the same as setting the default transmission key with
975 .Cm deftxkey .
976 .It Cm wepkey Ar key Ns | Ns Ar index : Ns Ar key
977 Set the selected WEP key.
978 If an
979 .Ar index
980 is not given, key 1 is set.
981 A WEP key will be either 5 or 13
982 characters (40 or 104 bits) depending of the local network and the
983 capabilities of the adaptor.
984 It may be specified either as a plain
985 string or as a string of hexadecimal digits preceded by
986 .Ql 0x .
987 For maximum portability, hex keys are recommended;
988 the mapping of text keys to WEP encryption is usually driver-specific.
989 In particular, the
990 .Tn Windows
991 drivers do this mapping differently to
992 .Dx .
993 A key may be cleared by setting it to
994 .Ql - .
995 If WEP is supported then there are at least four keys.
996 Some adaptors support more than four keys.
997 If that is the case, then the first four keys
998 (1-4) will be the standard temporary keys and any others will be adaptor
999 specific keys such as permanent keys stored in NVRAM.
1000 .It Cm wme
1001 Enable Wireless Multimedia Extensions (WME) support, if available,
1002 for the specified interface.
1003 WME is a subset of the IEEE 802.11e standard to support the
1004 efficient communication of realtime and multimedia data.
1005 To disable WME support, use
1006 .Fl wme .
1007 .Pp
1008 The following parameters are meaningful only when WME support is in use.
1009 Parameters are specified per-AC (Access Category) and
1010 split into those that are used by a station when acting
1011 as an access point and those for client stations in the BSS.
1012 The latter are received from the access point and may not be changed
1013 (at the station).
1014 The following Access Categories are recognized:
1015 .Pp
1016 .Bl -tag -width ".Cm AC_BK" -compact
1017 .It Cm AC_BE
1018 (or
1019 .Cm BE )
1020 best effort delivery,
1021 .It Cm AC_BK
1022 (or
1023 .Cm BK )
1024 background traffic,
1025 .It Cm AC_VI
1026 (or
1027 .Cm VI )
1028 video traffic,
1029 .It Cm AC_VO
1030 (or
1031 .Cm VO )
1032 voice traffic.
1033 .El
1034 .Pp
1035 AC parameters are case-insensitive.
1036 Traffic classification is done in the operating system using the
1037 vlan priority associated with data frames or the
1038 ToS (Type of Service) indication in IP-encapsulated frames.
1039 If neither information is present, traffic is assigned to the
1040 Best Effort (BE) category.
1041 .Bl -tag -width indent
1042 .It Cm ack Ar ac
1043 Set the ACK policy for QoS transmissions by the local station;
1044 this controls whether or not data frames transmitted by a station
1045 require an ACK response from the receiving station.
1046 To disable waiting for an ACK use
1047 .Fl ack .
1048 This parameter is applied only to the local station.
1049 .It Cm acm Ar ac
1050 Enable the Admission Control Mandatory (ACM) mechanism
1051 for transmissions by the local station.
1052 To disable the ACM use
1053 .Fl acm .
1054 On stations in a BSS this parameter is read-only and indicates
1055 the setting received from the access point.
1056 NB: ACM is not supported right now.
1057 .It Cm aifs Ar ac Ar count
1058 Set the Arbitration Inter Frame Spacing (AIFS)
1059 channel access parameter to use for transmissions
1060 by the local station.
1061 On stations in a BSS this parameter is read-only and indicates
1062 the setting received from the access point.
1063 .It Cm cwmin Ar ac Ar count
1064 Set the CWmin channel access parameter to use for transmissions
1065 by the local station.
1066 On stations in a BSS this parameter is read-only and indicates
1067 the setting received from the access point.
1068 .It Cm cwmax Ar ac Ar count
1069 Set the CWmax channel access parameter to use for transmissions
1070 by the local station.
1071 On stations in a BSS this parameter is read-only and indicates
1072 the setting received from the access point.
1073 .It Cm txoplimit Ar ac Ar limit
1074 Set the Transmission Opportunity Limit channel access parameter
1075 to use for transmissions by the local station.
1076 This parameter defines an interval of time when a WME station
1077 has the right to initiate transmissions onto the wireless medium.
1078 On stations in a BSS this parameter is read-only and indicates
1079 the setting received from the access point.
1080 .It Cm bss:aifs Ar ac Ar count
1081 Set the AIFS channel access parameter to send to stations in a BSS.
1082 This parameter is meaningful only when operating in ap mode.
1083 .It Cm bss:cwmin Ar ac Ar count
1084 Set the CWmin channel access parameter to send to stations in a BSS.
1085 This parameter is meaningful only when operating in ap mode.
1086 .It Cm bss:cwmax Ar ac Ar count
1087 Set the CWmax channel access parameter to send to stations in a BSS.
1088 This parameter is meaningful only when operating in ap mode.
1089 .It Cm bss:txoplimit Ar ac Ar limit
1090 Set the TxOpLimit channel access parameter to send to stations in a BSS.
1091 This parameter is meaningful only when operating in ap mode.
1092 .El
1093 .El
1094 .Pp
1095 The following parameters support an optional access control list
1096 feature available with some adaptors when operating in ap mode; see
1097 .Xr wlan_acl 4 .
1098 This facility allows an access point to accept/deny association
1099 requests based on the MAC address of the station.
1100 Note that this feature does not significantly enhance security
1101 as MAC address spoofing is easy to do.
1102 .Bl -tag -width indent
1103 .It Cm mac:add Ar address
1104 Add the specified MAC address to the database.
1105 Depending on the policy setting association requests from the
1106 specified station will be allowed or denied.
1107 .It Cm mac:allow
1108 Set the ACL policy to permit association only by
1109 stations registered in the database.
1110 .It Cm mac:del Ar address
1111 Delete the specified MAC address from the database.
1112 .It Cm mac:deny
1113 Set the ACL policy to deny association only by
1114 stations registered in the database.
1115 .It Cm mac:kick Ar address
1116 Force the specified station to be deauthenticated.
1117 This typically is done to block a station after updating the
1118 address database.
1119 .It Cm mac:open
1120 Set the ACL policy to allow all stations to associate.
1121 .It Cm mac:flush
1122 Delete all entries in the database.
1123 .El
1124 .Pp
1125 The following parameters are for compatibility with other systems:
1126 .Bl -tag -width indent
1127 .It Cm nwid Ar ssid
1128 Another name for the
1129 .Cm ssid
1130 parameter.
1131 Included for
1132 .Nx
1133 compatibility.
1134 .It Cm station Ar name
1135 Another name for the
1136 .Cm stationname
1137 parameter.
1138 Included for
1139 .Bsx
1140 compatibility.
1141 .It Cm wep
1142 Another way of saying
1143 .Cm wepmode on .
1144 Included for
1145 .Bsx
1146 compatibility.
1147 .It Fl wep
1148 Another way of saying
1149 .Cm wepmode off .
1150 Included for
1151 .Bsx
1152 compatibility.
1153 .It Cm nwkey key
1154 Another way of saying:
1155 .Dq Li "wepmode on weptxkey 1 wepkey 1:key wepkey 2:- wepkey 3:- wepkey 4:-" .
1156 Included for
1157 .Nx
1158 compatibility.
1159 .It Cm nwkey Xo
1160 .Sm off
1161 .Ar n : k1 , k2 , k3 , k4
1162 .Sm on
1163 .Xc
1164 Another way of saying
1165 .Dq Li "wepmode on weptxkey n wepkey 1:k1 wepkey 2:k2 wepkey 3:k3 wepkey 4:k4" .
1166 Included for
1167 .Nx
1168 compatibility.
1169 .It Fl nwkey
1170 Another way of saying
1171 .Cm wepmode off .
1172 Included for
1173 .Nx
1174 compatibility.
1175 .El
1176 .Pp
1177 The following parameters are specific to bridge interfaces:
1178 .Bl -tag -width indent
1179 .It Cm addm Ar interface
1180 Add the interface named by
1181 .Ar interface
1182 as a member of the bridge.
1183 The interface is put into promiscuous mode
1184 so that it can receive every packet sent on the network.
1185 .It Cm deletem Ar interface
1186 Remove the interface named by
1187 .Ar interface
1188 from the bridge.
1189 Promiscuous mode is disabled on the interface when
1190 it is removed from the bridge.
1191 .It Cm maxaddr Ar size
1192 Set the size of the bridge address cache to
1193 .Ar size .
1194 The default is 100 entries.
1195 .It Cm timeout Ar seconds
1196 Set the timeout of address cache entries to
1197 .Ar seconds
1198 seconds.
1199 If
1200 .Ar seconds
1201 is zero, then address cache entries will not be expired.
1202 The default is 240 seconds.
1203 .It Cm addr
1204 Display the addresses that have been learned by the bridge.
1205 .It Cm static Ar interface-name Ar address
1206 Add a static entry into the address cache pointing to
1207 .Ar interface-name .
1208 Static entries are never aged out of the cache or re-placed, even if the
1209 address is seen on a different interface.
1210 .It Cm deladdr Ar address
1211 Delete
1212 .Ar address
1213 from the address cache.
1214 .It Cm flush
1215 Delete all dynamically-learned addresses from the address cache.
1216 .It Cm flushall
1217 Delete all addresses, including static addresses, from the address cache.
1218 .It Cm discover Ar interface
1219 Mark an interface as a
1220 .Dq discovering
1221 interface.
1222 When the bridge has no address cache entry
1223 (either dynamic or static)
1224 for the destination address of a packet,
1225 the bridge will forward the packet to all
1226 member interfaces marked as
1227 .Dq discovering .
1228 This is the default for all interfaces added to a bridge.
1229 .It Fl discover Ar interface
1230 Clear the
1231 .Dq discovering
1232 attribute on a member interface.
1233 For packets without the
1234 .Dq discovering
1235 attribute, the only packets forwarded on the interface are broadcast
1236 or multicast packets and packets for which the destination address
1237 is known to be on the interface's segment.
1238 .It Cm learn Ar interface
1239 Mark an interface as a
1240 .Dq learning
1241 interface.
1242 When a packet arrives on such an interface, the source
1243 address of the packet is entered into the address cache as being a
1244 destination address on the interface's segment.
1245 This is the default for all interfaces added to a bridge.
1246 .It Fl learn Ar interface
1247 Clear the
1248 .Dq learning
1249 attribute on a member interface.
1250 .It Cm span Ar interface
1251 Add the interface named by
1252 .Ar interface
1253 as a span port on the bridge.
1254 Span ports transmit a copy of every frame received by the bridge.
1255 This is most useful for snooping a bridged network passively on
1256 another host connected to one of the span ports of the bridge.
1257 .It Fl span Ar interface
1258 Delete the interface named by
1259 .Ar interface
1260 from the list of span ports of the bridge.
1261 .It Cm stp Ar interface
1262 Enable Spanning Tree protocol on
1263 .Ar interface .
1264 The
1265 .Xr bridge 4
1266 driver has support for the IEEE 802.1D Spanning Tree protocol (STP).
1267 Spanning Tree is used to detect and remove loops in a network topology.
1268 .It Fl stp Ar interface
1269 Disable Spanning Tree protocol on
1270 .Ar interface .
1271 This is the default for all interfaces added to a bridge.
1272 .It Cm maxage Ar seconds
1273 Set the time that a Spanning Tree protocol configuration is valid.
1274 The default is 20 seconds.
1275 The minimum is 1 second and the maximum is 255 seconds.
1276 .It Cm fwddelay Ar seconds
1277 Set the time that must pass before an interface begins forwarding
1278 packets when Spanning Tree is enabled.
1279 The default is 15 seconds.
1280 The minimum is 1 second and the maximum is 255 seconds.
1281 .It Cm hellotime Ar seconds
1282 Set the time between broadcasting of Spanning Tree protocol
1283 configuration messages.
1284 The default is 2 seconds.
1285 The minimum is 1 second and the maximum is 255 seconds.
1286 .It Cm priority Ar value
1287 Set the bridge priority for Spanning Tree.
1288 The default is 32768.
1289 The minimum is 0 and the maximum is 65536.
1290 .It Cm ifpriority Ar interface Ar value
1291 Set the Spanning Tree priority of
1292 .Ar interface
1293 to
1294 .Ar value .
1295 The default is 128.
1296 The minimum is 0 and the maximum is 255.
1297 .It Cm ifpathcost Ar interface Ar value
1298 Set the Spanning Tree path cost of
1299 .Ar interface
1300 to
1301 .Ar value .
1302 The default is 55.
1303 The minimum is 0 and the maximum is 65535.
1304 .El
1305 .Pp
1306 The following parameters are specific to IP tunnel interfaces,
1307 .Xr gif 4 :
1308 .Bl -tag -width indent
1309 .It Cm tunnel Ar src_addr dest_addr
1310 Configure the physical source and destination address for IP tunnel
1311 interfaces.
1312 The arguments
1313 .Ar src_addr
1314 and
1315 .Ar dest_addr
1316 are interpreted as the outer source/destination for the encapsulating
1317 IPv4/IPv6 header.
1318 .It Fl tunnel
1319 Unconfigure the physical source and destination address for IP tunnel
1320 interfaces previously configured with
1321 .Cm tunnel .
1322 .It Cm deletetunnel
1323 Another name for the
1324 .Fl tunnel
1325 parameter.
1326 .El
1327 .Pp
1328 The following parameters are specific to
1329 .Xr vlan 4
1330 interfaces:
1331 .Bl -tag -width indent
1332 .It Cm vlan Ar vlan_tag
1333 Set the VLAN tag value to
1334 .Ar vlan_tag .
1335 This value is a 16-bit number which is used to create an 802.1Q
1336 VLAN header for packets sent from the
1337 .Xr vlan 4
1338 interface.
1339 Note that
1340 .Cm vlan
1341 and
1342 .Cm vlandev
1343 must both be set at the same time.
1344 .It Cm vlandev Ar iface
1345 Associate the physical interface
1346 .Ar iface
1347 with a
1348 .Xr vlan 4
1349 interface.
1350 Packets transmitted through the
1351 .Xr vlan 4
1352 interface will be
1353 diverted to the specified physical interface
1354 .Ar iface
1355 with 802.1Q VLAN encapsulation.
1356 Packets with 802.1Q encapsulation received
1357 by the parent interface with the correct VLAN tag will be diverted to
1358 the associated
1359 .Xr vlan 4
1360 pseudo-interface.
1361 The
1362 .Xr vlan 4
1363 interface is assigned a
1364 copy of the parent interface's flags and the parent's ethernet address.
1365 The
1366 .Cm vlandev
1367 and
1368 .Cm vlan
1369 must both be set at the same time.
1370 If the
1371 .Xr vlan 4
1372 interface already has
1373 a physical interface associated with it, this command will fail.
1374 To
1375 change the association to another physical interface, the existing
1376 association must be cleared first.
1377 .Pp
1378 Note: if the hardware tagging capability
1379 is set on the parent interface, the
1380 .Xr vlan 4
1381 pseudo
1382 interface's behavior changes:
1383 the
1384 .Xr vlan 4
1385 interface recognizes that the
1386 parent interface supports insertion and extraction of VLAN tags on its
1387 own (usually in firmware) and that it should pass packets to and from
1388 the parent unaltered.
1389 .It Fl vlandev Op Ar iface
1390 If the driver is a
1391 .Xr vlan 4
1392 pseudo device, disassociate the parent interface from it.
1393 This breaks the link between the
1394 .Xr vlan 4
1395 interface and its parent,
1396 clears its VLAN tag, flags and its link address and shuts the interface down.
1397 The
1398 .Ar iface
1399 argument is useless and hence deprecated.
1400 .El
1401 .Pp
1402 The following parameters are specific to
1403 .Xr carp 4
1404 interfaces:
1405 .Bl -tag -width indent
1406 .It Cm advbase Ar seconds
1407 Specifies the base of the advertisement interval in seconds.
1408 The acceptable values are 1 to 255.
1409 The default value is 1.
1410 .\" The default value is
1411 .\" .Dv CARP_DFLTINTV .
1412 .It Cm advskew Ar interval
1413 Specifies the skew to add to the base advertisement interval to
1414 make one host advertise slower than another host.
1415 It is specified in 1/256 of seconds.
1416 The acceptable values are 1 to 254.
1417 The default value is 0.
1418 .It Cm pass Ar phrase
1419 Set the authentication key to
1420 .Ar phrase .
1421 .It Cm vhid Ar n
1422 Set the virtual host ID.
1423 This is a required setting.
1424 Acceptable values are 1 to 255.
1425 .El
1426 .Pp
1427 The
1428 .Nm
1429 utility displays the current configuration for a network interface
1430 when no optional parameters are supplied.
1431 If a protocol family is specified,
1432 .Nm
1433 will report only the details specific to that protocol family.
1434 .Pp
1435 If the
1436 .Fl m
1437 flag is passed before an interface name,
1438 .Nm
1439 will display the capability list and all
1440 of the supported media for the specified interface.
1441 If
1442 .Fl L
1443 flag is supplied, address lifetime is displayed for IPv6 addresses,
1444 as time offset string.
1445 .Pp
1446 Optionally, the
1447 .Fl a
1448 flag may be used instead of an interface name.
1449 This flag instructs
1450 .Nm
1451 to display information about all interfaces in the system.
1452 The
1453 .Fl d
1454 flag limits this to interfaces that are down, and
1455 .Fl u
1456 limits this to interfaces that are up.
1457 When no arguments are given,
1458 .Fl a
1459 is implied.
1460 .Pp
1461 The
1462 .Fl l
1463 flag may be used to list all available interfaces on the system, with
1464 no other additional information.
1465 Use of this flag is mutually exclusive
1466 with all other flags and commands, except for
1467 .Fl d
1468 (only list interfaces that are down)
1469 and
1470 .Fl u
1471 (only list interfaces that are up).
1472 .Pp
1473 The
1474 .Fl v
1475 flag may be used to get more verbose status for an interface.
1476 .Pp
1477 The
1478 .Fl C
1479 flag may be used to list all of the interface cloners available on
1480 the system, with no additional information.
1481 Use of this flag is mutually exclusive with all other flags and commands.
1482 .Pp
1483 The
1484 .Fl k
1485 flag causes keying information for the interface, if available, to be
1486 printed.
1487 For example, the values of 802.11 WEP keys will be printed, if accessible to
1488 the current user.
1489 This information is not printed by default, as it may be considered
1490 sensitive.
1491 .Pp
1492 Only the super-user may modify the configuration of a network interface.
1493 .Sh DIAGNOSTICS
1494 Messages indicating the specified interface does not exist, the
1495 requested address is unknown, or the user is not privileged and
1496 tried to alter an interface's configuration.
1497 .Sh SEE ALSO
1498 .Xr netstat 1 ,
1499 .Xr carp 4 ,
1500 .Xr ifmedia 4 ,
1501 .Xr netintro 4 ,
1502 .Xr polling 4 ,
1503 .Xr vlan 4 ,
1504 .\" .Xr eon 5 ,
1505 .Xr rc 8 ,
1506 .Xr routed 8 ,
1507 .Xr sysctl 8
1508 .Sh HISTORY
1509 The
1510 .Nm
1511 utility appeared in
1512 .Bx 4.2 .
1513 .Sh BUGS
1514 Basic IPv6 node operation requires a link-local address on each
1515 interface configured for IPv6.
1516 Normally, such an address is automatically configured by the
1517 kernel on each interface added to the system; this behaviour may
1518 be disabled by setting the sysctl MIB variable
1519 .Va net.inet6.ip6.auto_linklocal
1520 to 0.
1521 .Pp
1522 If you delete such an address using
1523 .Nm ,
1524 the kernel may act very odd.
1525 Do this at your own risk.