xref: /dragonfly/share/man/man4/ipheth.4 (revision e5a92d33)
1.\" Copyright (c) 2014 Gavin Atkinson
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.\" $FreeBSD: head/share/man/man4/ipheth.4 272294 2014-09-30 05:36:16Z gavin $
29.\"
30.Dd November 16, 2018
31.Dt IPHETH 4
32.Os
33.Sh NAME
34.Nm ipheth
35.Nd "USB Apple iPhone/iPad tethered Ethernet driver"
36.Sh SYNOPSIS
37To load the driver as a module at boot time, place the
38following line in
39.Xr loader.conf 5 :
40.Bd -literal -offset indent
41if_ipheth_load="YES"
42.Ed
43.Pp
44Alternatively, to compile this driver into the kernel, place the
45following lines in your kernel configuration file:
46.Bd -ragged -offset indent
47.Cd "device uhci"
48.Cd "device ohci"
49.Cd "device usb"
50.Cd "device uether"
51.Cd "device ipheth"
52.Ed
53.Sh DESCRIPTION
54The
55.Nm
56driver provides support for network access through Apple
57iPhone and iPad devices, often referred to as USB tethering.
58.Pp
59.Nm
60should work with any Apple iPhone or iPad device.
61In most cases this must be explicitly enabled on the device first.
62.Pp
63For more information on configuring this device, see
64.Xr ifconfig 8 .
65The device does not support different media types or options.
66.Sh HARDWARE
67The following devices are supported by the
68.Nm
69driver:
70.Pp
71.Bl -bullet -compact
72.It
73Apple iPhone tethering (all models)
74.It
75Apple iPad tethering (all models)
76.El
77.Sh SEE ALSO
78.Xr arp 4 ,
79.Xr cdce 4 ,
80.Xr intro 4 ,
81.Xr netintro 4 ,
82.Xr urndis 4 ,
83.Xr usb 4 ,
84.Xr ifconfig 8 ,
85.Xr usbconfig 8
86.Sh HISTORY
87The
88.Nm
89device driver first appeared in
90.Fx 8.2 .
91.Sh AUTHORS
92.An -nosplit
93The
94.Nm
95driver was written by
96.An Hans Petter Selasky Aq Mt hselasky@FreeBSD.org .
97.Sh BUGS
98Some devices may need to be manually configured to use an alternative
99configuration with the
100.Xr usbconfig 8
101utility.
102A command similar to
103.Dl usbconfig -u 1 -a 2 set_config 3
104may be required if the device is not recognised automatically by
105.Nm
106after it is connected.
107