diff options
author | Pierre-Yves Ritschard <pyr@cvs.openbsd.org> | 2008-05-07 02:43:46 +0000 |
---|---|---|
committer | Pierre-Yves Ritschard <pyr@cvs.openbsd.org> | 2008-05-07 02:43:46 +0000 |
commit | 7bdcb7674e14048e5ca5afa66643a47c78e80e06 (patch) | |
tree | ede88840fc4b9763ca5b1b216a82b7f6ed3f8d43 | |
parent | a85f69c61a76f9552e1ef6903a57fa34a93fb5a0 (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@
-rw-r--r-- | sbin/ifconfig/ifconfig.8 | 27 | ||||
-rw-r--r-- | share/man/man4/mpe.4 | 71 |
2 files changed, 95 insertions, 3 deletions
diff --git a/sbin/ifconfig/ifconfig.8 b/sbin/ifconfig/ifconfig.8 index 629774156a2..0ad7afdeb42 100644 --- a/sbin/ifconfig/ifconfig.8 +++ b/sbin/ifconfig/ifconfig.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: ifconfig.8,v 1.157 2008/04/18 17:01:50 damien Exp $ +.\" $OpenBSD: ifconfig.8,v 1.158 2008/05/07 02:43:45 pyr Exp $ .\" $NetBSD: ifconfig.8,v 1.11 1996/01/04 21:27:29 pk Exp $ .\" $FreeBSD: ifconfig.8,v 1.16 1998/02/01 07:03:29 steve Exp $ .\" @@ -31,7 +31,7 @@ .\" .\" @(#)ifconfig.8 8.4 (Berkeley) 6/1/94 .\" -.Dd $Mdocdate: April 18 2008 $ +.Dd $Mdocdate: May 7 2008 $ .Dt IFCONFIG 8 .Os .Sh NAME @@ -189,7 +189,8 @@ At least the following devices can be created on demand: .Xr sl 4 , .Xr trunk 4 , .Xr tun 4 , -.Xr vlan 4 +.Xr vlan 4, +.Xr mpe 4 .It Cm debug Enable driver-dependent debugging code; usually, this turns on extra console error logging. @@ -441,6 +442,8 @@ and .Xr gre 4 ) .It .Xr vlan 4 +.It +.Xr mpe 4 .El .\" CARP .Sh CARP @@ -1131,6 +1134,24 @@ to This value is a 3-bit number which is used to create an 802.1Q vlan header for packets sent from the vlan interface. .El +.\" MPE +.Sh MPE +.Nm ifconfig +.Bk -words +.Ar mpe-interface +.Op Cm mplslabel Ar mpls-label +.Ek +.Pp +The options are as follows: +.Bl -tag -width Ds +.It Cm mplslabel Ar mpls-label +If the interface is a +.Xr mpe 4 +pseudo-interface, set the mpls label to +.Ar mpls-label . +This value is a 20-bit number which will be used as the MPLS header for +packets entering the MPLS domain. +.El .Sh EXAMPLES Assign the address of 192.168.1.10 with a network mask of 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>. |