vde/doc/vdetaplib.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 VDETAPLIB 1 "February 23, 2004" "Virtual Distributed Ethernet"
  24 .SH NAME
  25 vdetaplib \- Virtual Distributed Ethernet tap emulation library
  26 .SH SYNOPSIS
  27 No synopsis
  28
  29 .br
  30 .SH DESCRIPTION
  31 \fBvdetaplib\fP
  32 is a library that emulates tap (tuntap level2 interface, see
  33 in kernel sources ./Documentation/networking/tun.c) and connects
  34 tap virtual interfaces to vde networks.
  35
  36 To use it, the libvdetab.so library must be preloaded (sh,ksh or bash syntax):
  37 .RS
  38 .br
  39 .B
  40 export LD_PRELOAD=/usr/local/lib/libvdetap.so
  41 .RE
  42 (csh, tchs syntax):
  43 .RS
  44 .br
  45 .B
  46 setenv LD_PRELOAD /usr/local/lib/libvdetap.so
  47 .RE
  48
  49 If you want to divert all tap requests to a single vde_switch set the
  50 variable VDEALLTAP to the vde socket.
  51 (sh,ksh or bash syntax):
  52 .RS
  53 .br
  54 .B
  55 export VDEALLTAP=/tmp/vde.ctl
  56 .RE
  57 (csh, tchs syntax):
  58 .RS
  59 .br
  60 .B
  61 setenv VDEALLTAP /tmp/vde.ctl
  62 .RE
  63
  64 It is also possible to set each single interface to different vde_switches
  65 by setting the environment variable with the same name of the interface.
  66 (sh,ksh or bash syntax):
  67 .RS
  68 .br
  69 .B
  70 export tap0=/tmp/vde.ctl
  71 .br
  72 .B
  73 export tap1=/tmp/myvde.ctl
  74 .br
  75 .B
  76 export ppc=/tmp/ppc.ctl
  77 .RE
  78 (csh, tchs syntax):
  79 .RS
  80 .br
  81 .B
  82 setenv tap0 /tmp/vde.ctl
  83 .br
  84 .B
  85 setenv tap1 /tmp/myvde.ctl
  86 .br
  87 .B
  88 setenv ppc /tmp/ppc.ctl
  89 .RE
  90 .br
  91
  92 The variable to set the specific interface is checked first then
  93 VDEALLTAP. VDEALLTAP thus works as a default choice for the vde switch
  94 to be used.
  95 If VDEALLTAP is not set and there is no specific environment variable
  96 (and for tun -- IFF_TUN interfaces) the kernel provided interface is used.
  97 In this latter case access to /dev/net/tun is required, generally root access.
  98 .br
  99 .SH NOTICE
 100 Virtual Distributed Ethernet is not related in any way with
 101 www.vde.com ("Verband der Elektrotechnik, Elektronik und Informationstechnik"
 102 i.e. the German "Association for Electrical, Electronic & Information
 103 Technologies").
 104 .SH SEE ALSO
 105 .BR vde_switch (1),
 106 .BR vdeq (1).
 107 .br
 108 .SH AUTHOR
 109 VDE is a project by Renzo Davoli <renzo@cs.unibo.it>