diff options
Diffstat (limited to 'share/man')
| -rw-r--r-- | share/man/man4/Makefile | 8 | ||||
| -rw-r--r-- | share/man/man4/upgt.4 | 332 | ||||
| -rw-r--r-- | share/man/man4/usb.4 | 6 |
3 files changed, 340 insertions, 6 deletions
diff --git a/share/man/man4/Makefile b/share/man/man4/Makefile index 5bfeec38431..4b88c0203fb 100644 --- a/share/man/man4/Makefile +++ b/share/man/man4/Makefile @@ -1,4 +1,4 @@ -# $OpenBSD: Makefile,v 1.438 2007/11/25 17:11:11 oga Exp $ +# $OpenBSD: Makefile,v 1.439 2007/12/16 09:05:52 mglocker Exp $ MAN= aac.4 ac97.4 acphy.4 \ acpi.4 acpiac.4 acpibat.4 acpibtn.4 acpicpu.4 acpidock.4 \ @@ -51,9 +51,9 @@ MAN= aac.4 ac97.4 acphy.4 \ ucom.4 uchcom.4 ucycom.4 udav.4 udcf.4 udp.4 udsbr.4 \ ueagle.4 uftdi.4 ugen.4 uhci.4 uhid.4 uhidev.4 uipaq.4 uk.4 ukbd.4 \ ukphy.4 ulpt.4 umass.4 umbg.4 umct.4 umidi.4 umodem.4 ums.4 umsm.4 \ - unix.4 uow.4 upl.4 uplcom.4 ural.4 urio.4 url.4 urlphy.4 usb.4 usbf.4 \ - uscanner.4 uslcom.4 usscanner.4 uticom.4 uts.4 uvisor.4 uvscom.4 \ - uyap.4 vga.4 vgafb.4 vge.4 viaenv.4 viapm.4 viasio.4 vic.4 \ + unix.4 uow.4 upgt.4 upl.4 uplcom.4 ural.4 urio.4 url.4 urlphy.4 usb.4 \ + usbf.4 uscanner.4 uslcom.4 usscanner.4 uticom.4 uts.4 uvisor.4 \ + uvscom.4 uyap.4 vga.4 vgafb.4 vge.4 viaenv.4 viapm.4 viasio.4 vic.4 \ vlan.4 vnd.4 vr.4 watchdog.4 wb.4 wbenv.4 wbng.4 wd.4 wdc.4 \ we.4 wi.4tbl wpi.4 wscons.4 wsdisplay.4 wskbd.4 wsmouse.4 wsmux.4 \ xe.4 xf86.4 xge.4 xl.4 xmphy.4 yds.4 ym.4 zero.4 zyd.4 diff --git a/share/man/man4/upgt.4 b/share/man/man4/upgt.4 new file mode 100644 index 00000000000..25db370a161 --- /dev/null +++ b/share/man/man4/upgt.4 @@ -0,0 +1,332 @@ +.\" $OpenBSD: upgt.4,v 1.1 2007/12/16 09:05:52 mglocker Exp $ +.\" +.\" Copyright (c) 2007 Marcus Glocker <mglocker@openbsd.org> +.\" Copyright (c) 2005-2007 +.\" Damien Bergamini <damien.bergamini@free.fr> +.\" +.\" Permission to use, copy, modify, and distribute this software for any +.\" purpose with or without fee is hereby granted, provided that the above +.\" copyright notice and this permission notice appear in all copies. +.\" +.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES +.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF +.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR +.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN +.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF +.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. +.\" + +.\" +.\" Copyright (c) 2006 Theo de Raadt. +.\" Copyright (c) 2006 The DragonFly Project. All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in +.\" the documentation and/or other materials provided with the +.\" distribution. +.\" 3. Neither the name of The DragonFly Project nor the names of its +.\" contributors may be used to endorse or promote products derived +.\" from this software without specific, prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS +.\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE +.\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, +.\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING, +.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; +.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED +.\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, +.\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT +.\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.Dd $Mdocdate: December 16 2007 $ +.Os +.Dt UPGT 4 +.Sh NAME +.Nm upgt +.Nd Conexant/Intersil PrismGT SoftMAC USB IEEE 802.11b/g wireless network +device +.Sh SYNOPSIS +.Cd "upgt* at uhub? port ?" +.Sh DESCRIPTION +The +.Nm +driver supports the USB 2.0 Conexant/Intersil PrismGT series wireless +adapters based on the GW3887 chipset. +.Pp +These are the modes the +.Nm +driver can operate in: +.Bl -tag -width "IBSS-masterXX" +.It BSS mode +Also known as +.Em infrastructure +mode, this is used when associating with an access point, through +which all traffic passes. +This mode is the default. +.\" .It IBSS mode +.\" Also known as +.\" .Em IEEE ad-hoc +.\" mode or +.\" .Em peer-to-peer +.\" mode. +.\" This is the standardized method of operating without an access point. +.\" Stations associate with a service set. +.\" However, actual connections between stations are peer-to-peer. +.\" .It Host AP +.\" In this mode the driver acts as an access point (base station) +.\" for other cards. +.It monitor mode +In this mode the driver is able to receive packets without +associating with an access point. +This disables the internal receive filter and enables the card to +capture packets from networks which it wouldn't normally have access to, +or to scan for access points. +.El +.Pp +.Nm +supports software WEP. +Wired Equivalent Privacy (WEP) is the de facto encryption standard +for wireless networks. +It can be typically configured in one of three modes: +no encryption; 40-bit encryption; or 104-bit encryption. +Unfortunately, due to serious weaknesses in WEP protocol +it is strongly recommended that it not be used as the +sole mechanism to secure wireless communication. +WEP is not enabled by default. +.\".Pp +.\"The transmit speed is user-selectable or can be adapted automatically by the +.\"driver depending on the received signal strength and on the number of hardware +.\"transmission retries. +.Sh CONFIGURATION +The +.Nm +driver can be configured at runtime with +.Xr ifconfig 8 +or on boot with +.Xr hostname.if 5 +using the following parameters: +.Bl -tag -width Ds +.It Cm bssid Ar bssid +Set the desired BSSID. +.It Fl bssid +Unset the desired BSSID. +The interface will automatically select a BSSID in this mode, which is +the default. +.It Cm chan Ar n +Set the channel (radio frequency) to be used by the driver based on +the given channel ID +.Ar n . +.It Fl chan +Unset the desired channel to be used by the driver. +The driver will automatically select a channel in this mode, which is +the default. +.It Cm media Ar media +The +.Nm +driver supports the following +.Ar media +types: +.Pp +.Bl -tag -width autoselect -compact +.It Cm autoselect +Enable autoselection of the media type and options. +.It Cm DS1 +Set 802.11b DS 1Mbps operation. +.It Cm DS2 +Set 802.11b DS 2Mbps operation. +.It Cm DS5 +Set 802.11b DS 5.5Mbps operation. +.It Cm DS11 +Set 802.11b DS 11Mbps operation. +.It Cm OFDM6 +Set 802.11g OFDM 6Mbps operation. +.It Cm OFDM9 +Set 802.11g OFDM 9Mbps operation. +.It Cm OFDM12 +Set 802.11g OFDM 12Mbps operation. +.It Cm OFDM18 +Set 802.11g OFDM 18Mbps operation. +.It Cm OFDM24 +Set 802.11g OFDM 24Mbps operation. +.It Cm OFDM36 +Set 802.11g OFDM 36Mbps operation. +.It Cm OFDM48 +Set 802.11g OFDM 48Mbps operation. +.It Cm OFDM54 +Set 802.11g OFDM 54Mbps operation. +.El +.It Cm mediaopt Ar opts +The +.Nm +driver supports the following media options: +.Pp +.Bl -tag -width monitor -compact +.\".It Cm hostap +.\"Select Host AP operation. +.\".It Cm ibss +.\"Select IBSS operation. +.It Cm monitor +Select monitor mode. +.El +.It Fl mediaopt Ar opts +Disable the specified media options on the driver and return it to the +default mode of operation (BSS). +.It Cm mode Ar mode +The +.Nm +driver supports the following modes: +.Pp +.Bl -tag -width 11b -compact +.It Cm 11b +Force 802.11b operation. +.It Cm 11g +Force 802.11g operation. +.El +.It Cm nwid Ar id +Set the network ID. +The +.Ar id +can either be any text string up to 32 characters in length, +or a series of hexadecimal digits up to 64 digits. +An empty +.Ar id +string allows the interface to connect to any available access points. +By default the +.Nm +driver uses an empty string. +Note that network ID is synonymous with Extended Service Set ID (ESSID). +.It Fl nwid +Set the network ID to the empty string to allow the interface to connect +to any available access point. +.It Cm nwkey Ar key +Enable WEP encryption using the specified +.Ar key . +The +.Ar key +can either be a string, a series of hexadecimal digits (preceded by +.Sq 0x ) , +or a set of keys of the form +.Dq n:k1,k2,k3,k4 , +where +.Sq n +specifies which of the keys will be used for transmitted packets, +and the four keys, +.Dq k1 +through +.Dq k4 , +are configured as WEP keys. +If a set of keys is specified, a comma +.Pq Sq \&, +within the key must be escaped with a backslash. +Note that if multiple keys are used, their order must be the same within +the network. +.Nm +is capable of using both 40-bit (5 characters or 10 hexadecimal digits) +or 104-bit (13 characters or 26 hexadecimal digits) keys. +.It Fl nwkey +Disable WEP encryption. +This is the default mode of operation. +.El +.Sh FILES +The driver needs a firmware file which is loaded when an interface is +brought up: +.Pp +.Bl -tag -width Ds -offset indent -compact +.It Pa /etc/firmware/upgt-v2 +.El +.\".Pp +.\"These firmware files are not free because Conexant/Intersil refuses +.\"to grant distribution rights. +.\"As a result, even though +.\".Ox +.\"includes the driver, the firmware files cannot be included and +.\"users have to download these files on their own. +.Pp +A prepackaged version of the firmware, designed to be used with +.Xr pkg_add 1 , +can be found at: +.Bd -literal -offset indent +http://www.nazgul.ch/upgt/upgt-firmware-1.0.tgz +.Ed +.Sh HARDWARE +The following adapters should work: +.Pp +.Bl -tag -width Ds -offset indent -compact +.It SMC EZ ConnectG SMC2862W-G +.El +.Sh EXAMPLES +The following +.Xr hostname.if 5 +example configures upgt0 to join whatever network is available on boot, +using WEP key +.Dq 0x1deadbeef1 , +channel 11, obtaining an IP address using DHCP: +.Bd -literal -offset indent +dhcp NONE NONE NONE nwkey 0x1deadbeef1 chan 11 +.\".Ed +.\".Pp +.\"The following +.\".Xr hostname.if 5 +.\"example creates a host-based access point on boot: +.\".Bd -literal -offset indent +.\"inet 192.168.1.1 255.255.255.0 NONE media autoselect \e +.\" mediaopt hostap nwid my_net chan 11 +.Ed +.Pp +Configure upgt0 for WEP, using hex key +.Dq 0x1deadbeef1 : +.Bd -literal -offset indent +# ifconfig upgt0 nwkey 0x1deadbeef1 +.Ed +.Pp +Return upgt0 to its default settings: +.Bd -literal -offset indent +# ifconfig upgt0 -bssid -chan media autoselect \e + nwid "" -nwkey +.Ed +.Pp +Join an existing BSS network, +.Dq my_net : +.Bd -literal -offset indent +# ifconfig upgt0 192.168.1.1 netmask 0xffffff00 nwid my_net +.Ed +.Sh SEE ALSO +.Xr arp 4 , +.Xr ifmedia 4 , +.Xr intro 4 , +.Xr netintro 4 , +.Xr usb 4 , +.Xr hostname.if 5 , +.\".Xr hostapd 8 , +.Xr ifconfig 8 +.Sh HISTORY +The +.Nm +driver first appeared in +.Ox 4.3 . +.Sh AUTHORS +.An -nosplit +The +.Nm +driver was written by +.An Marcus Glocker Aq mglocker@openbsd.org . +.Pp +The hardware specification was reverse engineered by the people at +.Pa http://www.prism54.org . +.Sh CAVEATS +The +.Nm +driver just supports the USB 2.0 devices (GW3887 chipset) but not the +USB 1.0 devices containing the NET2280, ISL3880, and ISL3886 chipsets. +Some further efforts would be necessary to add USB 1.0 support to the +driver. diff --git a/share/man/man4/usb.4 b/share/man/man4/usb.4 index e6c18fef9c2..39dd070b541 100644 --- a/share/man/man4/usb.4 +++ b/share/man/man4/usb.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: usb.4,v 1.99 2007/11/27 22:11:05 jmc Exp $ +.\" $OpenBSD: usb.4,v 1.100 2007/12/16 09:05:52 mglocker Exp $ .\" $NetBSD: usb.4,v 1.15 1999/07/29 14:20:32 augustss Exp $ .\" .\" Copyright (c) 1999 The NetBSD Foundation, Inc. @@ -35,7 +35,7 @@ .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE .\" POSSIBILITY OF SUCH DAMAGE. .\" -.Dd $Mdocdate: November 27 2007 $ +.Dd $Mdocdate: December 16 2007 $ .Dt USB 4 .Os .Sh NAME @@ -151,6 +151,8 @@ Ralink Technology USB IEEE 802.11a/b/g wireless network device Atheros USB IEEE 802.11a/b/g wireless network device .It Xr ubt 4 Bluetooth adapters +.It Xr upgt 4 +Conexant/Intersil PrismGT SoftMAC USB IEEE 802.11b/g wireless network device .It Xr ural 4 Ralink Technology USB IEEE 802.11b/g wireless network device .It Xr wi 4 |