svn commit: r257408 - head/share/man/man4

[Kevin Lo]

Author: kevlo
Date: Thu Oct 31 01:57:05 2013
New Revision: 257408
URL: http://svnweb.freebsd.org/changeset/base/257408

Log:
  Add manpage for urtwnfw, the Realtek RTL8188CU/RTL8192CU firmware
  module.  Also fix a few nits in urtwn.4.
  
  Reviewed by:	rpaulo

Added:
  head/share/man/man4/urtwnfw.4   (contents, props changed)
Modified:
  head/share/man/man4/Makefile
  head/share/man/man4/urtwn.4

Modified: head/share/man/man4/Makefile
==============================================================================
--- head/share/man/man4/Makefile	Thu Oct 31 01:45:55 2013	(r257407)
+++ head/share/man/man4/Makefile	Thu Oct 31 01:57:05 2013	(r257408)
@@ -523,6 +523,7 @@ MAN=	aac.4 \
 	urio.4 \
 	${_urtw.4} \
 	urtwn.4 \
+	urtwnfw.4 \
 	usb.4 \
 	usb_quirk.4 \
 	uslcom.4 \

Modified: head/share/man/man4/urtwn.4
==============================================================================
--- head/share/man/man4/urtwn.4	Thu Oct 31 01:45:55 2013	(r257407)
+++ head/share/man/man4/urtwn.4	Thu Oct 31 01:57:05 2013	(r257408)
@@ -1,6 +1,3 @@
-.\" $OpenBSD: urtwn.4,v 1.20 2013/05/16 10:02:59 sthen Exp $
-.\" $FreeBSD$
-.\"
 .\" Copyright (c) 2010 Damien Bergamini <damien.bergamini at free.fr>
 .\"
 .\" Permission to use, copy, modify, and distribute this software for any
@@ -15,7 +12,9 @@
 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 .\"
-.Dd October 6, 2013
+.\" $FreeBSD$
+.\"
+.Dd October 31, 2013
 .Dt URTWN 4
 .Os
 .Sh NAME
@@ -40,6 +39,13 @@ module at boot time, place the following
 .Bd -literal -offset indent
 if_urtwn_load="YES"
 .Ed
+.Pp
+In both cases, place the following line in
+.Xr loader.conf 5
+to acknowledge the firmware license (see below):
+.Bd -literal -offset indent
+legal.realtek.license_ack=1
+.Ed
 .Sh DESCRIPTION
 The
 .Nm
@@ -57,6 +63,22 @@ The RTL8192CU is a highly integrated mul
 802.11n adapter that combines a MAC, a 2T2R capable baseband and an
 RF in a single chip.
 It operates in the 2GHz spectrum only.
+.Pp
+This driver requires the firmware built with the
+.Nm urtwnfw
+module to work.
+For the loaded firmware to be enabled for use the license at
+.Pa /usr/share/doc/legal/realtek
+must be agreed by adding the following line to
+.Xr loader.conf 5 :
+.Pp
+.Dl "legal.realtek.license_ack=1"
+.Sh FILES
+.Bl -tag -width ".Pa /usr/share/doc/legal/realtek" -compact
+.It Pa /usr/share/doc/legal/realtek
+.Nm
+firmware license
+.El
 .Sh HARDWARE
 The following adapters should work:
 .Pp
@@ -97,6 +119,7 @@ The driver will reset the hardware.
 This should not happen.
 .El
 .Sh SEE ALSO
+.Xr urtwnfw 4 ,
 .Xr intro 4 ,
 .Xr netintro 4 ,
 .Xr usb 4 ,

Added: head/share/man/man4/urtwnfw.4
==============================================================================
--- /dev/null	00:00:00 1970	(empty, because file is newly added)
+++ head/share/man/man4/urtwnfw.4	Thu Oct 31 01:57:05 2013	(r257408)
@@ -0,0 +1,75 @@
+.\" Copyright (c) 2013 Kevin Lo
+.\" 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. The name of the author may not be used to endorse or promote products
+.\"    derived from this software without specific prior written permission.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 AUTHOR 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.
+.\"
+.\" $FreeBSD$
+.\"
+.Dd October 31, 2013
+.Dt URTWNFW 4
+.Os
+.Sh NAME
+.Nm urtwnfw
+.Nd "Firmware Module for Realtek Wireless driver"
+.Sh SYNOPSIS
+To compile this module into the kernel,
+place the following line in your
+kernel configuration file:
+.Bd -ragged -offset indent
+.Cd "device urtwnfw"
+.Ed
+.Pp
+This will include three firmware images inside the kernel.
+If you want to pick only the firmware image for your network adapter choose one
+of the following:
+.Bd -ragged -offset indent
+.Cd "device urtwn-rtl8192cfwT"
+.Cd "device urtwn-rtl8192cfwU"
+.Ed
+.Pp
+Alternatively, to load the driver as a
+module at boot time, place the following line in
+.Xr loader.conf 5 :
+.Bd -literal -offset indent
+urtwn-rtl8192cfwT_load="YES"
+urtwn-rtl8192cfwU_load="YES"
+.Ed
+.Sh DESCRIPTION
+This module provides access to firmware sets for the
+Realtek RTL8188CUS, RTL8188CE-VAU, RTL8188RU and RTL8192CU
+chip based USB WiFi adapters.
+It may be
+statically linked into the kernel, or loaded as a module.
+.Pp
+For the loaded firmware to be enabled for use the license at
+.Pa /usr/share/doc/legal/realtek
+must be agreed to by adding the following line to
+.Xr loader.conf 5 :
+.Pp
+.Dl "legal.realtek.license_ack=1"
+.Sh FILES
+.Bl -tag -width ".Pa /usr/share/doc/legal/realtek" -compact
+.It Pa /usr/share/doc/legal/realtek
+.Nm
+firmware license
+.El
+.Sh SEE ALSO
+.Xr urtwn 4 ,
+.Xr firmware 9