xref: /freebsd/share/man/man4/ipheth.4 (revision bc96366c864c07ef352edb92017357917c75b36c)
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$
29.\"
30.Dd September 30, 2014
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 ipheth"
51.Ed
52.Sh DESCRIPTION
53The
54.Nm
55driver provides support for network access through Apple
56iPhone and iPad devices, often referred to as USB tethering.
57.Pp
58.Nm
59should work with any Apple iPhone or iPad device.
60In most cases this must be explicitly enabled on the device first.
61.Pp
62For more information on configuring this device, see
63.Xr ifconfig 8 .
64The device does not support different media types or options.
65.Sh HARDWARE
66The following devices are supported by the
67.Nm
68driver:
69.Pp
70.Bl -bullet -compact
71.It
72Apple iPhone tethering (all models)
73.It
74Apple iPad tethering (all models)
75.El
76.Sh SEE ALSO
77.Xr arp 4 ,
78.Xr cdce 4 ,
79.Xr intro 4 ,
80.Xr netintro 4 ,
81.Xr urndis 4 ,
82.Xr usb 4 ,
83.Xr ifconfig 8 ,
84.Xr usbconfig 8
85.Sh HISTORY
86The
87.Nm
88device driver first appeared in
89.Fx 8.2 .
90.Sh AUTHORS
91.An -nosplit
92The
93.Nm
94driver was written by
95.An Hans Petter Selasky Aq Mt hselasky@FreeBSD.org .
96.Sh BUGS
97Some devices may need to be manually configured to use an alternative
98configuration with the
99.Xr usbconfig 8
100utility.
101A command similar to
102.Dl usbconfig -u 1 -a 2 set_config 3
103may be required if the device is not recognised automatically by
104.Nm
105after it is connected.
106