f9c07938c3c3b4050ee9e3dd36380751873599db
[dragonfly.git] / share / man / man4 / urtwnfw.4
1 .\" Copyright (c) 2013 Kevin Lo
2 .\" 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. The name of the author may not be used to endorse or promote products
10 .\"    derived from this software without specific prior written permission.
11 .\"
12 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
13 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
14 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
15 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
16 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
17 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
18 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
19 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
20 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
21 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
22 .\"
23 .\" $FreeBSD: head/share/man/man4/urtwnfw.4 257408 2013-10-31 01:57:05Z kevlo $
24 .\"
25 .Dd March 6, 2014
26 .Dt URTWNFW 4
27 .Os
28 .Sh NAME
29 .Nm urtwnfw
30 .Nd "Firmware Module for Realtek Wireless driver"
31 .Sh SYNOPSIS
32 To compile this module into the kernel,
33 place the following line in your
34 kernel configuration file:
35 .Bd -ragged -offset indent
36 .Cd "device urtwnfw"
37 .Ed
38 .\".Pp
39 .\"This will include three firmware images inside the kernel.
40 .\"If you want to pick only the firmware image for your network adapter choose one
41 .\"of the following:
42 .\".Bd -ragged -offset indent
43 .\".Cd "device urtwn-rtl8192cfwT"
44 .\".Cd "device urtwn-rtl8192cfwU"
45 .\".Ed
46 .Pp
47 Alternatively, to load the driver as a
48 module at boot time, place the following line in
49 .Xr loader.conf 5 :
50 .Bd -literal -offset indent
51 urtwn-rtl8192cfwT_load="YES"
52 urtwn-rtl8192cfwU_load="YES"
53 .Ed
54 .Sh DESCRIPTION
55 This module provides access to firmware sets for the
56 Realtek RTL8188CUS, RTL8188CE-VAU, RTL8188RU and RTL8192CU
57 chip based USB WiFi adapters.
58 It may be
59 statically linked into the kernel, or loaded as a module.
60 .Pp
61 For the loaded firmware to be enabled for use the license at
62 .Pa /usr/share/doc/legal/realtek/LICENSE
63 must be agreed to by adding the following line to
64 .Xr loader.conf 5 :
65 .Pp
66 .Dl "legal.realtek.license_ack=1"
67 .Sh FILES
68 .Bl -tag -width ".Pa /usr/share/doc/legal/realtek/LICENSE" -compact
69 .It Pa /usr/share/doc/legal/realtek/LICENSE
70 .Nm
71 firmware license
72 .El
73 .Sh SEE ALSO
74 .Xr urtwn 4 ,
75 .Xr firmware 9