Date: Thu, 02 May 2002 16:34:59 -0600 (MDT) From: "M. Warner Losh" <imp@village.org> To: doc@freebsd.org, ru@freebsd.org Subject: tbl support in man Message-ID: <20020502.163459.70459594.imp@village.org>
next in thread | raw e-mail | index | archive | help
----Next_Part(Thu_May__2_16:34:59_2002_503)--
Content-Type: Text/Plain; charset=us-ascii
Content-Transfer-Encoding: 7bit
[[ please CC me, since I don't subscribe to doc@ ]]
Here's a quick patch to the build system to help us use the tbl
functionality that is already present in man. If a man page ends in
tbl, then man will run it through tbl first.
I'm about to commit wi.4tbl which radically improves the wi man page.
I've also included the diff here. It is based heavily on the OpenBSD
man page, with the OpenBSDisms replaced by FreeBSDisms. I'd also like
to commit and then MFC this soon.
Comments?
Warner
----Next_Part(Thu_May__2_16:34:59_2002_503)--
Content-Type: Text/Plain; charset=us-ascii
Content-Transfer-Encoding: 7bit
Content-Disposition: inline; filename="tbl+wi.patch"
? share/man/man4/wi4tbl-o
Index: share/mk/bsd.man.mk
===================================================================
RCS file: /home/imp/FreeBSD/CVS/src/share/mk/bsd.man.mk,v
retrieving revision 1.46
diff -u -r1.46 bsd.man.mk
--- share/mk/bsd.man.mk 23 Apr 2002 09:03:56 -0000 1.46
+++ share/mk/bsd.man.mk 2 May 2002 22:34:10 -0000
@@ -162,10 +162,10 @@
.if defined(MANFILTER)
.for page in ${MAN}
${MINSTALL} ${page:T:S/$/${FILTEXTENSION}/g} \
- ${DESTDIR}${MANDIR}${page:E}${MANSUBDIR}/${page}
+ ${DESTDIR}${MANDIR}${page:E:S/tbl//}${MANSUBDIR}/${page}
.if defined(MANBUILDCAT) && !empty(MANBUILDCAT)
${MINSTALL} ${page:T:S/$/${CATEXT}${FILTEXTENSION}/g} \
- ${DESTDIR}${CATDIR}${page:E}${MANSUBDIR}/${page}
+ ${DESTDIR}${CATDIR}${page:E:S/tbl//}${MANSUBDIR}/${page}
.endif
.endfor
.else
@@ -183,17 +183,17 @@
.if defined(MANBUILDCAT) && !empty(MANBUILDCAT)
.for page in ${MAN}
${MINSTALL} ${page:T:S/$/${CATEXT}/} \
- ${DESTDIR}${CATDIR}${page:E}${MANSUBDIR}/${page:T}
+ ${DESTDIR}${CATDIR}${page:E:S/tbl//}${MANSUBDIR}/${page:T}
.endfor
.endif
.endif
.else
.for page in ${MAN}
${MINSTALL} ${page:T:S/$/${MCOMPRESS_EXT}/g} \
- ${DESTDIR}${MANDIR}${page:E}${MANSUBDIR}
+ ${DESTDIR}${MANDIR}${page:E:S/tbl//}${MANSUBDIR}
.if defined(MANBUILDCAT) && !empty(MANBUILDCAT)
${MINSTALL} ${page:T:S/$/${CATEXT}${MCOMPRESS_EXT}/g} \
- ${DESTDIR}${CATDIR}${page:E}${MANSUBDIR}/${page:T:S/$/${MCOMPRESS_EXT}/}
+ ${DESTDIR}${CATDIR}${page:E:S/tbl//}${MANSUBDIR}/${page:T:S/$/${MCOMPRESS_EXT}/}
.endif
.endfor
.endif
Index: share/man/man4/Makefile
===================================================================
RCS file: /home/imp/FreeBSD/CVS/src/share/man/man4/Makefile,v
retrieving revision 1.154
diff -u -r1.154 Makefile
--- share/man/man4/Makefile 23 Apr 2002 09:03:56 -0000 1.154
+++ share/man/man4/Makefile 2 May 2002 22:34:10 -0000
@@ -199,7 +199,7 @@
vpo.4 \
vr.4 \
wb.4 \
- wi.4 \
+ wi.4tbl \
witness.4 \
worm.4 \
xl.4 \
Index: share/man/man4/wi.4tbl
===================================================================
RCS file: /home/imp/FreeBSD/CVS/src/share/man/man4/wi.4tbl,v
retrieving revision 1.14
diff -u -r1.14 wi.4tbl
--- share/man/man4/wi.4tbl 14 Jul 2001 19:40:48 -0000 1.14
+++ share/man/man4/wi.4tbl 2 May 2002 22:34:11 -0000
@@ -29,54 +29,229 @@
.\" THE POSSIBILITY OF SUCH DAMAGE.
.\"
.\" $FreeBSD: src/share/man/man4/wi.4tbl,v 1.14 2001/07/14 19:40:48 schweikh Exp $
+.\" $OpenBSD: wi.4tbl,v 1.9 2002/04/11 20:34:06 millert Exp $
.\"
-.Dd April 21, 1999
+.Dd March 29, 2002
.Dt WI 4
.Os
.Sh NAME
.Nm wi
-.Nd Lucent Technologies WaveLAN/IEEE 802.11 PCMCIA driver
+.Nd WaveLAN/IEEE, PRISM-II and Spectrum24 802.11DS wireless network driver
.Sh SYNOPSIS
.Cd "device wi"
.Sh DESCRIPTION
The
.Nm
-driver provides support for WaveLAN/IEEE PCCARD adapters (also known
-as WaveLAN II cards). Note that while Lucent sells both ISA and PCMCIA
-WaveLAN/IEEE devices, the ISA product is actually a PCMCIA card in an
-ISA to PCMCIA bridge adapter.
-Consequently, the
-.Nm
-driver is required for both the ISA and PCMCIA NICs.
-Both the original
-2Mbps WaveLAN/IEEE cards and the newer 6Mbps WaveLAN/IEEE Turbo
-adapters are supported.
-.Pp
-The core of the WaveLAN/IEEE is the Lucent Hermes controller.
-All
-host/device interaction is via programmed I/O with the Hermes.
-The
-Hermes supports 802.11 and 802.3 frames, power management, BSS, WDS
-and ad-hoc operation modes.
+driver provides support for wireless network adapters based around
+the Lucent Hermes, Intersil PRISM-II, Intersil PRISM-2.5, and Symbol
+Spectrum24 chipsets.
+All four chipsets provide a similar interface to the driver.
+.Pp
+All host/device interaction is via programmed I/O.
+Supported features include 802.11 and 802.3 frames, power management, BSS,
+IBSS, WDS and ad-hoc operation modes.
+Cards based on the Intersil PRISM-II and PRISM-2.5 chips also support a
+host-based access point mode which allows a card to act as a normal access
+point (with some assistance from the
+.Nm
+driver).
+The Lucent Hermes and Symbol Spectrum24 chipsets do not contain this
+functionality.
+.Pp
The
.Nm
driver encapsulates all IP and ARP traffic as 802.11 frames, however
it can receive either 802.11 or 802.3 frames.
-Transmit speed is
-selectable between 1Mbps fixed, 2Mbps fixed or 2Mbps with auto fallback.
-For WaveLAN/IEEE Turbo adapters, speeds up to 6Mbps are available.
+Transmit speed is selectable between 1Mbps fixed, 2Mbps fixed, 2Mbps
+with auto fallback, 5.5Mbps, 8Mbps, or 11Mbps depending on your hardware.
+The Lucent WaveLAN/IEEE Silver and Gold cards as well as the Intersil
+and Symbol cards have support for WEP encryption.
+The WaveLAN Gold as well as newer Intersil and Symbol cards support
+104bit keys, the others only accept 40bit keys.
+The Lucent WaveLAN/IEEE Bronze cards do not support WEP at all.
+To enable encryption, use the
+.Xr wicontrol 8
+utility to set your keys.
.Pp
By default, the
.Nm
-driver configures the WaveLAN card for BSS operation.
+driver configures the card for BSS operation (aka infrastructure
+mode).
+This mode requires the use of an access point (base station).
+.Pp
+The
+.Nm
+driver also supports an ad-hoc (point-to-point) mode where
+the nwid is ignored and stations can communicate amongst
+themselves without the aid of an access point.
+Note that there are two possible ad-hoc modes.
+One mode, referred to as
+.Dq ad-hoc demo mode ,
+predates the IEEE 802.11 specification and so may not interoperate
+with cards from other vendors.
+The standardized ad-hoc mode, also know as IBSS mode, is not
+supported by cards with very old firmware revisions.
+.Pp
+Cards based on the Intersil PRISM-II and PRISM-2.5 chips also
+have a host-based access point mode which allows the card to
+act as an access point (base station).
.Pp
For more information on configuring this device, see
+.Xr ifconfig 8 .
+.Pp
+Cards supported by the
+.Nm
+driver come in a variety of packages, though the most common
+are of the PCMCIA type.
+In many cases, the PCI version of a wireless card is simply
+a PCMCIA card bundled with a PCI adapter.
+The PCI adapters come in two flavors: true PCMCIA bridges and
+dumb PCMCIA bridges.
+A true PCMCIA bridge (such as those sold by Lucent) will attach
+as a real PCMCIA controller.
+The wireless card will then attach to the PCMCIA bus.
+Wireless cards in PCMCIA slots may be inserted and ejected on the fly.
+.br
+A dumb bridge, on the other hand, does not show up as a true PCMCIA bus.
+The wireless card will simply appear to the host as a normal PCI
+device and will not require any PCMCIA support.
+Cards in this type of adapter should only be removed when the
+machine is powered down.
+.Pp
+The following cards are among those supported to by
+.Nm
+driver:
+.Pp
+.in +\n(dIu
+.TS
+tab (:) ;
+l l l
+_ _ _
+l l l .
+Card:Chip:Bus
+3Com AirConnect 3CRWE737A:Spectrum24:PCMCIA
+3Com AirConnect 3CRWE777A:Prism-II:PCI
+ACTIONTEC HWC01170:Prism-2.5:PCMCIA
+Addtron AWP-100:Prism-II:PCMCIA
+Agere Orinoco:Hermes:PCMCIA
+Apple Airport:Hermes:macobio
+Buffalo AirStation:Prism-II:PCMCIA
+Buffalo AirStation:Prism-II:CF
+Cabletron RoamAbout:Hermes:PCMCIA
+Compaq Agency NC5004:Prism-II:PCMCIA
+Contec FLEXLAN/FX-DS110-PCC:Prism-II:PCMCIA
+Corega PCC-11:Prism-II:PCMCIA
+Corega PCCA-11:Prism-II:PCMCIA
+Corega PCCB-11:Prism-II:PCMCIA
+Corega CGWLPCIA11:Prism-II:PCI
+ELSA XI300:Prism-II:PCMCIA
+ELSA XI800:Prism-II:CF
+EMTAC A2424i:Prism-II:PCMCIA
+Ericsson Wireless LAN CARD C11:Spectrum24:PCMCIA
+Gemtek WL-311:Prism-2.5:PCMCIA
+Hawking Technology WE110P:Prism-2.5:PCMCIA
+I-O DATA WN-B11/PCM:Prism-II:PCMCIA
+Intel PRO/Wireless 2011:Prism-II:PCMCIA
+Intersil Prism II:Prism-II:PCMCIA
+Intersil Mini-PCI:Prism-2.5:PCI
+Linksys Instant Wireless WPC11:Prism-II:PCMCIA
+Linksys Instant Wireless WPC11 2.5:Prism-2.5:PCMCIA
+Lucent WaveLAN:Hermes:PCMCIA
+NANOSPEED ROOT-RZ2000:Prism-II:PCMCIA
+NDC/Sohoware NCP130:Prism-II:PCI
+NEC CMZ-RT-WP:Prism-II:PCMCIA
+Netgear MA401:Prism-II:PCMCIA
+NTT-ME 11Mbps Wireless LAN:Prism-II:PCMCIA
+Proxim RangeLAN-DS:Prism-II:PCMCIA
+Samsung MagicLAN SWL-2000N:Prism-II:PCMCIA
+Symbol Spectrum24:Spectrum24:PCMCIA
+SMC 2632 EZ Connect:Prism-II:PCMCIA
+TDK LAK-CD011WL:Prism-II:PCMCIA
+.TE
+.in -\n(dIu
+.Pp
+Several vendors sell PCI adapters built around the PLX Technology 9050
+or 9052 chip.
+The following such adapters are supported or expected to work:
+.Pp
+.Bl -tag -width -compact
+.It 3Com AirConnect 3CRWE777A (3.3V)
+.It Belkin F5D6000 (a rebadged WL11000P)
+.It Eumitcom WL11000P
+.It Global Sun Technology GL24110P (untested)
+.It Global Sun Technology GL24110P02
+.It LinkSys WDT11 (a rebadged GL24110P02)
+.It Netgear MA301
+.It US Robotics 2415 (rebadged WL11000P)
+.El
+.Pp
+.Sh EXAMPLES
+The following examples utilize
.Xr ifconfig 8
+for simplicity, however,
+.Xr wicontrol 8
+can also be used to set wireless parameters.
+.Pp
+Join an existing BSS network (ie: connect to an access point):
+.Dl # ifconfig wi0 inet 192.168.0.20 netmask 0xffffff00
+.Pp
+Join a specific BSS network with network name
+.Dq my_net .
+.Dl # ifconfig wi0 inet 192.168.0.20 netmask 0xffffff00 ssid my_net
+.br
+.Pp
+Join a specific BSS network with WEP encryption:
+.Bd -literal -compact -offset indent
+# ifconfig wi0 inet 192.168.0.20 netmask 0xffffff00 ssid my_net \e
+ wepkey 0x8736639624
+.Ed
+.Pp
+Join an ad-hoc network with network name
+.Dq my_net .
+.Bd -literal -compact -offset indent
+# ifconfig wi0 inet 192.168.0.20 netmask 0xffffff00 ssid my_net \e
+ mediaopt adhoc
+.Ed
+.Pp
+Create an IBBS network with network name
+.Dq my_net .
+.Bd -literal -compact -offset indent
+# ifconfig wi0 inet 192.168.0.20 netmask 0xffffff00 ssid my_net \e
+ mediaopt create-ibss
+.Ed
+.Pp
+Join an IBBS network with network name
+.Dq my_net .
+.Bd -literal -compact -offset indent
+# ifconfig wi0 inet 192.168.0.22 netmask 0xffffff00 ssid my_net \e
+ mediaopt ibss
+.Ed
+.Pp
+Create a host-based access point (Prism only):
+.Bd -literal -compact -offset indent
+# ifconfig wi0 inet 192.168.0.10 netmask 0xffffff00 ssid my_ap \e
+ mediaopt hostap
+.Ed
+.Pp
+Create a host-based access point with WEP enabled (Prism only):
+.Bd -literal -compact -offset indent
+# ifconfig wi0 inet 192.168.0.10 netmask 0xffffff00 ssid my_ap \e
+ wepkey 0x1234567890 mediaopt hostap
+.Ed
+.Pp
+Create a host-based wireless bridge to fxp0 (Prism only):
+.Bd -literal -compact -offset indent
+Add BRIDGE to the kernel config.
+# ifconfig wi0 inet up ssid my_ap mediaopt hostap
+# sysctl net.link.ether.bridge=1
+# sysctl net.link.ether.bridge_cfg="wi0 fxp0"
+# sysctl net.inet.ip.forwarding=1
+.Ed
.Sh DIAGNOSTICS
.Bl -diag
.It "wi%d: init failed"
-The WaveLAN failed to come ready after an initialization command was
-issued.
+The WaveLAN card failed to come ready after an initialization command
+was issued.
.It "wi%d: failed to allocate %d bytes on NIC"
The driver was unable to allocate memory for transmit frames in the
NIC's on-board RAM.
@@ -85,8 +260,11 @@
command.
.El
.Sh SEE ALSO
+.Xr an 4 ,
.Xr arp 4 ,
.Xr netintro 4 ,
+.Xr ifmedia 4 ,
+.Xr hostname.if 5 ,
.Xr ifconfig 8 ,
.Xr wicontrol 8
.Rs
@@ -101,5 +279,19 @@
.Sh AUTHORS
The
.Nm
-driver was written by
-.An Bill Paul Aq wpaul@ctr.columbia.edu .
+driver was written by Bill Paul <wpaul@ctr.columbia.edu>.
+This man page comes from
+.Ox .
+.Sh CAVEATS
+The original Lucent WaveLAN cards usually default to channel 3;
+newer cards use channel 10 by default.
+Non-Lucent cards vary, for instance the Addtron cards use channel
+11 by default.
+See
+.Xr wicontrol 8
+for information on how to change the channel.
+.Pp
+IBSS creation does not currently work with Symbol cards.
+.Pp
+Prism2 host-based access point mode has bugs for firmware versions
+prior to 0.8.3.
----Next_Part(Thu_May__2_16:34:59_2002_503)----
To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe freebsd-doc" in the body of the message
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20020502.163459.70459594.imp>