summaryrefslogtreecommitdiff
path: root/share
diff options
context:
space:
mode:
authorPierre-Yves Ritschard <pyr@cvs.openbsd.org>2008-05-07 02:43:46 +0000
committerPierre-Yves Ritschard <pyr@cvs.openbsd.org>2008-05-07 02:43:46 +0000
commit7bdcb7674e14048e5ca5afa66643a47c78e80e06 (patch)
treeede88840fc4b9763ca5b1b216a82b7f6ed3f8d43 /share
parenta85f69c61a76f9552e1ef6903a57fa34a93fb5a0 (diff)
Document the new mpe interface and explain the appropriate commands
in ifconfig(8). The man pages reference mpls(8) which doesn't exist, but claudio promises it will follow shortly. a thumb up and ok from claudio@
Diffstat (limited to 'share')
-rw-r--r--share/man/man4/mpe.471
1 files changed, 71 insertions, 0 deletions
diff --git a/share/man/man4/mpe.4 b/share/man/man4/mpe.4
new file mode 100644
index 00000000000..635b5191df7
--- /dev/null
+++ b/share/man/man4/mpe.4
@@ -0,0 +1,71 @@
+.\" $OpenBSD: mpe.4,v 1.1 2008/05/07 02:43:45 pyr Exp $
+.\"
+.\" Copyright (C) 2008 Pierre-Yves Ritschard <pyr@openbsd.org>
+.\"
+.\" Permission to use, copy, modify, and distribute this software for any
+.\" purpose with or without fee is hereby granted, provided that the above
+.\" copyright notice and this permission notice appear in all copies.
+.\"
+.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+.\"
+.Dd $Mdocdate: May 7 2008 $
+.Dt MPE 4
+.Os
+.Sh NAME
+.Nm mpe
+.Nd MPLS Provider Edge
+.Sh SYNOPSIS
+.Cd "pseudo-device mpe"
+.Sh DESCRIPTION
+The
+.Nm
+interface is an MPLS Provider Edge pseudo-device used to enter
+and leave an MPLS domain.
+.Pp
+A
+.Nm
+interface can be created at runtime using the
+.Ic ifconfig mpe Ns Ar N Ic create
+command or by setting up a
+.Xr hostname.if 5
+configuration file for
+.Xr netstart 8 .
+The interface itself can be configured with
+.Xr ifconfig 8 ;
+see its manual page for more information.
+.Pp
+.Nm
+interfaces support the following unique
+.Xr ioctl 2 s:
+.Bl -tag -width "SIOCSETLABEL" -offset 3n
+.It SIOCSETLABEL
+Encapsulate packets entering this interface in MPLS using
+the specified label.
+.It SIOCGETLABEL
+Report the label packets entering this interface will be
+tagged with.
+.El
+.\"
+.Sh SEE ALSO
+.Xr sysctl 3 ,
+.Xr mpls 8 ,
+.Xr hostname.if 5 ,
+.Xr ifconfig 8 ,
+.Xr netstart 8
+.Rs
+.\"
+.Sh HISTORY
+The
+.Nm
+device first appeared in OpenBSD 4.4
+.\"
+.Sh AUTHORS
+The
+.Nm
+driver was written by Pierre-Yves Ritschard <pyr@openbsd.org>.