vde/doc/vde_switch.1

   1 .\" Copyright (c) 2004 Renzo Davoli
   2 .\"
   3 .\" This is free documentation; you can redistribute it and/or
   4 .\" modify it under the terms of the GNU General Public License as
   5 .\" published by the Free Software Foundation; either version 2 of
   6 .\" the License, or (at your option) any later version.
   7 .\"
   8 .\" The GNU General Public License's references to "object code"
   9 .\" and "executables" are to be interpreted as the output of any
  10 .\" document formatting or typesetting system, including
  11 .\" intermediate and printed output.
  12 .\"
  13 .\" This manual is distributed in the hope that it will be useful,
  14 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 .\" GNU General Public License for more details.
  17 .\"
  18 .\" You should have received a copy of the GNU General Public
  19 .\" License along with this manual; if not, write to the Free
  20 .\" Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139,
  21 .\" USA.
  22
  23 .TH VDE_SWITCH 1 "February 23, 2004" "Virtual Distributed Ethernet"
  24 .SH NAME
  25 vde_switch \- Virtual Distributed Ethernet switch
  26 .SH SYNOPSIS
  27 .B vde_switch
  28 [
  29 .B \-hub
  30 ]
  31 [
  32 .BI \-unix
  33 .I socketpath
  34 ]
  35 [
  36 .BI \-tap
  37 .I interface
  38 ]
  39 [
  40 .BI \-daemon
  41 ]
  42 .br
  43 .SH DESCRIPTION
  44 A
  45 \fBvde_switch\fP
  46 is a virtual switch for the vde architecture.
  47 .br
  48 A vde network can include several vde_switches running on different
  49 (real) computers.
  50 vde_switches can be connected by vde cables (see
  51 \fBvde_plug (1)\fP
  52 ).
  53 .br
  54 Supported architecture for VDE end nodes include:
  55 real linux boxes (through the tuntap interface),
  56 bochs, qemu and MPS virtual machines.
  57 .br
  58 VDE is useful to create networks of heterogeneous virtual machines as
  59 well as as a general tunneling tool -- all the ethernet based protocols work
  60 by this kind of tunnel -- and also as a tool for mobility.
  61 In fact VDE creates an overlay network where users can keep their IP
  62 addresses despite of the change of IP addresses on the interfaces.
  63
  64 vde_switch needs root privileges to open a tap interface, can be run by
  65 users when no -tap option is specified.
  66
  67 .SH OPTIONS
  68 .TP
  69 .B \-hub,
  70 turn off the switch engine. It operates as a hub.
  71 .TP
  72 .B \-unix "\fIsocketpath\fP",
  73 specify the UNIX socket to be used by local programs for joining the VDE.
  74 The default value is "/tmp/vde.ctl"
  75 .TP
  76 .B \-tap "\fIinterface\fP",
  77 connect the specified tuntap interface to this vde_switch (needs root privileges)
  78 .TP
  79 .B \-daemon,
  80 Run as a daemon. Use syslog for logging.
  81 .SH SEE ALSO
  82 .BR vde_plug (1),
  83 .BR vdeq (1).
  84 .BR dpipe (1).
  85 .br
  86 .SH AUTHOR
  87 This code is based on uml_switch by Jeff Dike and others.
  88 .br
  89 VDE is a project by Renzo Davoli <renzo@cs.unibo.it>