Mention SPAN and RSPAN in vswitchd.conf man page.

The terms SPAN and RSPAN are often used in what we call mirroring.  This
change points out how to achieve SPAN and RSPAN configurations using our
mirroring syntax.

diff --git a/vswitchd/vswitchd.conf.5.in b/vswitchd/vswitchd.conf.5.in
index b9127eb588da698c6a9aa02d90c76422a8ef2b81..1a00efe3839387e3c997dc0906329d85a73b195c 100644 (file)
--- a/vswitchd/vswitchd.conf.5.in
+++ b/vswitchd/vswitchd.conf.5.in
@@ -197,9 +197,11 @@ with physical network devices \fBeth2\fR and \fBeth3\fR:
         
 .fi
 .RE
-.SS "Port Mirroring"
+.SS "Port Mirroring (SPAN and RSPAN)"
 \fBvswitchd\fR may be configured to send selected frames to special
-``mirrored'' ports, in addition to their normal destinations.
+``mirrored'' ports, in addition to their normal destinations.  Mirroring
+traffic may also be referred to as SPAN or RSPAN, depending on the
+mechanism used for delivery.
 .PP
 Up to 32 instances of port mirroring may be configured on a given
 bridge.  Each must be given a name that is unique within the bridge.
@@ -250,7 +252,7 @@ part of \fIbridge\fR; that is, it must be listed on
 Specifying a \fIport\fR in this way reserves that port exclusively for
 mirroring.  No frames other than those selected for mirroring will be
 forwarded to \fIport\fR, and any frames received on \fIport\fR will be
-discarded.
+discarded.  This type of mirroring may also be referred to as SPAN.
 .TP
 \fBmirror.\fIbrname\fB.\fIpmname\fB.output.vlan = \fIvid\fR
 .
@@ -260,7 +262,8 @@ will be sent out all ports that trunk VLAN \fIvid\fR, as well as any
 ports with implicit VLAN \fIvid\fR.  When a mirrored frame is sent out
 a trunk port, the frame's VLAN tag will be set to \fIvid\fR, replacing
 any existing tag; when it is sent out an implicit VLAN port, the frame
-will not be tagged.
+will not be tagged.  This type of mirroring may also be referred to as
+RSPAN.
 .ST "Example"
 The following \fBvswitchd\fR configuration copies all frames received
 on \fBeth1\fR or \fBeth2\fR to \fBeth3\fR.