xref: /openbsd/share/man/man4/urndis.4 (revision 91f110e0)
1.\" Copyright (c) 2010 Michael Knudsen <mk@openbsd.org>
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.\"
8.\"    - Redistributions of source code must retain the above copyright
9.\"      notice, this list of conditions and the following disclaimer.
10.\"    - Redistributions in binary form must reproduce the above
11.\"      copyright notice, this list of conditions and the following
12.\"      disclaimer in the documentation and/or other materials provided
13.\"      with the distribution.
14.\"
15.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
16.\" "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
17.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
18.\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
19.\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
20.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
21.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
23.\" CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
25.\" ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26.\" POSSIBILITY OF SUCH DAMAGE.
27.\"
28.\" $OpenBSD: urndis.4,v 1.15 2013/07/16 16:05:49 schwarze Exp $
29.\"
30.Dd $Mdocdate: July 16 2013 $
31.Dt URNDIS 4
32.Os
33.Sh NAME
34.Nm urndis
35.Nd USB Remote NDIS Ethernet device
36.Sh SYNOPSIS
37.Cd "urndis*  at uhub?"
38.Sh DESCRIPTION
39The
40.Nm
41driver provides Ethernet access over Remote NDIS (RNDIS),
42allowing mobile devices such as phones and tablets to provide network access.
43It is often referred to as USB tethering,
44and in most cases must be explicitly enabled on the device.
45.Pp
46.Nm
47should work with any USB RNDIS devices,
48such as those commonly found on Android devices.
49It does not support different media types or options.
50For more information on configuring this device, see
51.Xr ifconfig 8 .
52.Sh SEE ALSO
53.Xr arp 4 ,
54.Xr intro 4 ,
55.Xr netintro 4 ,
56.Xr usb 4 ,
57.Xr hostname.if 5 ,
58.Xr ifconfig 8
59.Sh HISTORY
60The
61.Nm
62device driver first appeared in
63.Ox 4.7 .
64.Sh AUTHORS
65.An -nosplit
66The
67.Nm
68driver was written by
69.An Jonathan Armani Aq Mt armani@openbsd.org ,
70.An Michael Knudsen Aq Mt mk@openbsd.org ,
71and
72.An Fabien Romano Aq Mt fabien@openbsd.org .
73