vde-2/man/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=%PKGLIBDIR%/libvdetap.so
  20 .RE
  21 (csh, tchs syntax):
  22 .RS
  23 .br
  24 .B
  25 setenv LD_PRELOAD %PKGLIBDIR%/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 .br
  31 (sh, ksh or bash syntax):
  32 .RS
  33 .br
  34 .B
  35 export VDEALLTAP=/tmp/vde.ctl
  36 .RE
  37 (csh, tchs syntax):
  38 .RS
  39 .br
  40 .B
  41 setenv VDEALLTAP /tmp/vde.ctl
  42 .RE
  43
  44 It is possible to set each single interface to different vde_switches
  45 by setting the environment variable with the same name of the interface.
  46 .br
  47 (sh, ksh or bash syntax):
  48 .RS
  49 .br
  50 .B
  51 export tap0=/tmp/vde.ctl
  52 .br
  53 .B
  54 export tap1=/tmp/myvde.ctl
  55 .br
  56 .B
  57 export ppc=/tmp/ppc.ctl
  58 .RE
  59 (csh, tchs syntax):
  60 .RS
  61 .br
  62 .B
  63 setenv tap0 /tmp/vde.ctl
  64 .br
  65 .B
  66 setenv tap1 /tmp/myvde.ctl
  67 .br
  68 .B
  69 setenv ppc /tmp/ppc.ctl
  70 .RE
  71 .br
  72
  73 It is also possible to specify \fBport\fP, \fBgroup\fP or \fBmode\fP for a given
  74 interface setting environment variables as in the following example.
  75 .br
  76 (sh, ksh or bash syntax):
  77 .RS
  78 .br
  79 .B
  80 export tap0_port=5
  81 .br
  82 .B
  83 export tap0_group=vde-net
  84 .br
  85 .B
  86 export tap0_mode=0660
  87 .RE
  88 (csh, tchs, syntax):
  89 .RS
  90 .br
  91 .B
  92 setenv tap0_port 5
  93 .br
  94 .B
  95 setenv tap0_group vde-net
  96 .br
  97 .B
  98 setenv tap0_mode 0660
  99 .RE
 100 .br
 101
 102 The variable to set the specific interface is checked first then
 103 VDEALLTAP. VDEALLTAP thus works as a default choice for the vde switch
 104 to be used.
 105 If VDEALLTAP is not set and there is no specific environment variable
 106 (and for tun -- IFF_TUN interfaces) the kernel provided interface is used.
 107 In this latter case access to /dev/net/tun is required, generally root access.
 108 .br
 109 .SH NOTICE
 110 Virtual Distributed Ethernet is not related in any way with
 111 www.vde.com ("Verband der Elektrotechnik, Elektronik und Informationstechnik"
 112 i.e. the German "Association for Electrical, Electronic & Information
 113 Technologies").
 114
 115 .SH SEE ALSO
 116 \fBvde_switch\fP(1),
 117 \fBvdeq\fP(1).
 118 .br
 119 .SH AUTHOR
 120 VDE is a project by Renzo Davoli <renzo@cs.unibo.it>