summaryrefslogtreecommitdiff
path: root/static/freebsd/man4/me.4 4.html
blob: 85d40ef7b9a042b401ade5caf793e03e2bd7c13d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
<table class="head">
  <tr>
    <td class="head-ltitle">ME(4)</td>
    <td class="head-vol">Device Drivers Manual</td>
    <td class="head-rtitle">ME(4)</td>
  </tr>
</table>
<div class="manual-text">
<section class="Sh">
<h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1>
<p class="Pp"><code class="Nm">me</code> &#x2014; <span class="Nd">encapsulating
    network device</span></p>
</section>
<section class="Sh">
<h1 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1>
<p class="Pp">To compile the driver into the kernel, place the following line in
    the kernel configuration file:</p>
<div class="Bd Pp Bd-indent"><code class="Cd">device me</code></div>
<p class="Pp">Alternatively, to load the driver as a module at boot time, place
    the following line in <a class="Xr">loader.conf(5)</a>:</p>
<div class="Bd Pp Bd-indent Li">
<pre>if_me_load=&quot;YES&quot;</pre>
</div>
</section>
<section class="Sh">
<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1>
<p class="Pp">The <code class="Nm">me</code> network interface is a
    point-to-point pseudo device encapsulating datagrams into IP. These
    encapsulated datagrams are routed to a destination host, where they are
    decapsulated and further routed to their final destination.</p>
<p class="Pp"><code class="Nm">me</code> interfaces are dynamically created and
    destroyed with the <a class="Xr">ifconfig(8)</a>
    <code class="Cm">create</code> and <code class="Cm">destroy</code>
    subcommands.</p>
<p class="Pp">This driver corresponds to RFC 2004. Datagrams are encapsulated
    into IP with a shorter encapsulation. The original IP header is modified and
    the modifications are inserted between the so modified header and the
    original payload. The protocol number 55 is used for outer header.</p>
</section>
<section class="Sh">
<h1 class="Sh" id="NOTES"><a class="permalink" href="#NOTES">NOTES</a></h1>
<p class="Pp">For correct operation, the <code class="Nm">me</code> device needs
    a route to the decapsulating host that does not run over the tunnel, as this
    would be a loop.</p>
</section>
<section class="Sh">
<h1 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE
  ALSO</a></h1>
<p class="Pp"><a class="Xr">gif(4)</a>, <a class="Xr">gre(4)</a>,
    <a class="Xr">inet(4)</a>, <a class="Xr">ip(4)</a>,
    <a class="Xr">netintro(4)</a>, <a class="Xr">protocols(5)</a>,
    <a class="Xr">ifconfig(8)</a>, <a class="Xr">sysctl(8)</a></p>
</section>
<section class="Sh">
<h1 class="Sh" id="AUTHORS"><a class="permalink" href="#AUTHORS">AUTHORS</a></h1>
<p class="Pp"><span class="An">Andrey V. Elsukov</span>
    &lt;<a class="Mt" href="mailto:ae@FreeBSD.org">ae@FreeBSD.org</a>&gt;</p>
</section>
</div>
<table class="foot">
  <tr>
    <td class="foot-date">March 4, 2026</td>
    <td class="foot-os">FreeBSD 15.0</td>
  </tr>
</table>