diff options
author | 2017-10-30 14:14:18 +0000 | |
---|---|---|
committer | 2017-10-30 14:14:18 +0000 | |
commit | 132c39fcc4b86474607672daca93703e38f5a193 (patch) | |
tree | 2465b3221878bd6b03290c166c69d1b617c2bf0b | |
parent | Let witness(4) differentiate between taskq mutexes to avoid (diff) | |
download | wireguard-openbsd-132c39fcc4b86474607672daca93703e38f5a193.tar.xz wireguard-openbsd-132c39fcc4b86474607672daca93703e38f5a193.zip |
Add bwfm(4) manpage.
ok stsp@
-rw-r--r-- | share/man/man4/Makefile | 4 | ||||
-rw-r--r-- | share/man/man4/bwfm.4 | 111 |
2 files changed, 113 insertions, 2 deletions
diff --git a/share/man/man4/Makefile b/share/man/man4/Makefile index b4c575cc34e..c41e2112b73 100644 --- a/share/man/man4/Makefile +++ b/share/man/man4/Makefile @@ -1,4 +1,4 @@ -# $OpenBSD: Makefile,v 1.657 2017/08/28 19:31:57 jasper Exp $ +# $OpenBSD: Makefile,v 1.658 2017/10/30 14:14:18 patrick Exp $ MAN= aac.4 ac97.4 acphy.4 \ acpi.4 acpiac.4 acpials.4 acpiasus.4 acpibat.4 \ @@ -15,7 +15,7 @@ MAN= aac.4 ac97.4 acphy.4 \ auacer.4 audio.4 \ aue.4 auglx.4 auich.4 auixp.4 autri.4 auvia.4 axe.4 axen.4 azalia.4 \ bce.4 berkwdt.4 bge.4 bio.4 bktr.4 bmtphy.4 bnx.4 \ - boca.4 bpf.4 brgphy.4 bridge.4 brswphy.4 bwi.4 bytgpio.4 \ + boca.4 bpf.4 brgphy.4 bridge.4 brswphy.4 bwfm.4 bwi.4 bytgpio.4 \ cac.4 cas.4 cardbus.4 carp.4 cd.4 cdce.4 cfxga.4 \ ch.4 chvgpio.4 ciphy.4 ciss.4 clcs.4 clct.4 cmpci.4 \ com.4 cue.4 cy.4 cz.4 dc.4 dcphy.4 ddb.4 de.4 \ diff --git a/share/man/man4/bwfm.4 b/share/man/man4/bwfm.4 new file mode 100644 index 00000000000..23670af5017 --- /dev/null +++ b/share/man/man4/bwfm.4 @@ -0,0 +1,111 @@ +.\" $OpenBSD: bwfm.4,v 1.1 2017/10/30 14:14:18 patrick Exp $ +.\" +.\" Copyright (c) 2017 Patrick Wildt <patrick@blueri.se> +.\" +.\" 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. +.\" +.Dd $Mdocdate: October 30 2017 $ +.Dt BWFM 4 +.Os +.Sh NAME +.Nm bwfm +.Nd Broadcom and Cypress wireless network driver +.Sh SYNOPSIS +.Cd "bwfm* at usb?" +.Sh DESCRIPTION +The +.Nm +driver provides support for Broadcom and Cypress FullMAC network +adapters. +.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. +.El +.Pp +The +.Nm +driver can be configured to use +Wired Equivalent Privacy (WEP) or +Wi-Fi Protected Access (WPA-PSK and WPA2-PSK). +WPA is the current encryption standard for wireless networks. +It is strongly recommended that WEP +not be used as the sole mechanism +to secure wireless communication, +due to serious weaknesses in it. +The +.Nm +driver relies on the software 802.11 stack for the WPA handshake. +Both encryption and decryption of data frames are handled by the +firmware. +.Pp +The firmware automatically select the transmit speed and the channel +depending on the received signal strength. +.Pp +The +.Nm +driver can be configured at runtime with +.Xr ifconfig 8 +or on boot with +.Xr hostname.if 5 . +.Sh FILES +The driver needs a firmware file which is loaded when the driver +attaches. +A prepackaged version of the firmware can be installed using +.Xr fw_update 1 . +.Sh EXAMPLES +The following example scans for available networks: +.Pp +.Dl # ifconfig bwfm0 scan +.Pp +The following +.Xr hostname.if 5 +example configures bwfm0 to join network +.Dq mynwid , +using WPA key +.Dq mywpakey , +obtaining an IP address using DHCP: +.Bd -literal -offset indent +nwid mynwid +wpakey mywpakey +dhcp +.Ed +.Sh SEE ALSO +.Xr arp 4 , +.Xr ifmedia 4 , +.Xr intro 4 , +.Xr netintro 4 , +.Xr usb 4 , +.Xr hostname.if 5 , +.Xr ifconfig 8 +.Sh HISTORY +The +.Nm +driver first appeared in +.Ox 6.3 . +.Sh AUTHORS +.An -nosplit +The +.Nm +driver was written by +.An Patrick Wildt Aq Mt patrick@blueri.se . +.Sh CAVEATS +The firmware is outdated and contains known vulnerabilities. +SDIO and PCI attachments are not yet supported. |