vde-2/doc/vdetaplib.1.in

   1 .TH VDETAPLIB 1 "December 6, 2006" "Virtual Distributed Ethernet"
   2 .SH NAME
   3 vdetaplib \- Virtual Distributed Ethernet tap emulation library
   4 .SH SYNOPSIS
   5 No synopsis
   6
   7 .br
   8 .SH DESCRIPTION
   9 \fBvdetaplib\fP
  10 is a library that emulates tap (tuntap level2 interface, see
  11 in kernel sources Documentation/networking/tun.c) and connects
  12 tap virtual interfaces to vde networks.
  13
  14 To use it, the libvdetab.so library must be preloaded
  15 (sh, ksh or bash syntax):
  16 .RS
  17 .br
  18 .B
  19 export LD_PRELOAD=%LIBEXECDIR%/libvdetap.so
  20 .RE
  21 (csh, tchs syntax):
  22 .RS
  23 .br
  24 .B
  25 setenv LD_PRELOAD %LIBEXECDIR%/libvdetap.so
  26 .RE
  27
  28 If you want to divert all tap requests to a single vde_switch set the
  29 variable VDEALLTAP to the vde socket.
  30 (sh, ksh or bash syntax):
  31 .RS
  32 .br
  33 .B
  34 export VDEALLTAP=/tmp/vde.ctl
  35 .RE
  36 (csh, tchs syntax):
  37 .RS
  38 .br
  39 .B
  40 setenv VDEALLTAP /tmp/vde.ctl
  41 .RE
  42
  43 It is also possible to set each single interface to different vde_switches
  44 by setting the environment variable with the same name of the interface.
  45 (sh, ksh or bash syntax):
  46 .RS
  47 .br
  48 .B
  49 export tap0=/tmp/vde.ctl
  50 .br
  51 .B
  52 export tap1=/tmp/myvde.ctl
  53 .br
  54 .B
  55 export ppc=/tmp/ppc.ctl
  56 .RE
  57 (csh, tchs syntax):
  58 .RS
  59 .br
  60 .B
  61 setenv tap0 /tmp/vde.ctl
  62 .br
  63 .B
  64 setenv tap1 /tmp/myvde.ctl
  65 .br
  66 .B
  67 setenv ppc /tmp/ppc.ctl
  68 .RE
  69 .br
  70
  71 The variable to set the specific interface is checked first then
  72 VDEALLTAP. VDEALLTAP thus works as a default choice for the vde switch
  73 to be used.
  74 If VDEALLTAP is not set and there is no specific environment variable
  75 (and for tun -- IFF_TUN interfaces) the kernel provided interface is used.
  76 In this latter case access to /dev/net/tun is required, generally root access.
  77 .br
  78 .SH NOTICE
  79 Virtual Distributed Ethernet is not related in any way with
  80 www.vde.com ("Verband der Elektrotechnik, Elektronik und Informationstechnik"
  81 i.e. the German "Association for Electrical, Electronic & Information
  82 Technologies").
  83
  84 .SH SEE ALSO
  85 \fBvde_switch\fP(1),
  86 \fBvdeq\fP(1).
  87 .br
  88 .SH AUTHOR
  89 VDE is a project by Renzo Davoli <renzo@cs.unibo.it>