vde-2/doc/slirpvde.1

   1 .TH SLIRPVDE 1 "December 6, 2006" "Virtual Distributed Ethernet"
   2 .SH NAME
   3 slirpvde \- Virtual Distributed Ethernet-Slirp interface
   4 .SH SYNOPSIS
   5 .B slirpvde
   6 [
   7 .B \-sock
   8 .I socketpath
   9 ]
  10 [
  11 .B \-network
  12 .I netaddr
  13 ]
  14 [
  15 .B \-dhcp
  16 ]
  17 [
  18 .B \-L
  19 .I port
  20 .B :
  21 .I vde_host
  22 .B :
  23 .I vde_hostport
  24 ]
  25 [
  26 .B \-X
  27 .I vde_host
  28 [
  29 .B :
  30 .I display
  31 [
  32 .B .
  33 .I screen
  34 ]
  35 ]
  36 ]
  37 .br
  38 .B slirpvde
  39 [
  40 .B \-s
  41 .I socketpath
  42 ]
  43 [
  44 .B \-n
  45 .I netaddr
  46 ]
  47 [
  48 .B \-D
  49 ]
  50 [
  51 .B \-L
  52 .I port
  53 .B :
  54 .I vde_host
  55 .B :
  56 .I vde_hostport
  57 ]
  58 [
  59 .B \-X
  60 .I vde_host
  61 [
  62 .B :
  63 .I display
  64 [
  65 .B .
  66 .I screen
  67 ]
  68 ]
  69 ]
  70 .br
  71 .SH DESCRIPTION
  72 \fBslirpvde\fP
  73 is a slirp interface for a VDE network.
  74
  75 Slirpvde connects all the units (virtual or real machines) to the network
  76 of the host where slirpvde runs as it were a NAT/Masquerading router.
  77 The default route is the node 2 (10.0.2.2 in the default network
  78 configuration) and DNS is re-mapped in node 3 (10.0.2.3).
  79
  80 Slirpvde runs using standard user privileges (no need for root access):
  81 all the connections are re-generated by slirpvde itself.
  82
  83 IPv4 only. IPv6 is still unsupported.
  84
  85 \fB-sock\fP is used to specify the VDE switch (default /tmp/vde.ctl)
  86
  87 \fB-dhcp\fP turns on the dhcp server for the network autoconfiguration of
  88 all the units connected to the VDE.
  89
  90 \fB-netaddr\fP is used to specify the network address (default 10.0.2.0).
  91
  92 \fB-L \fIport\fR:\fIvde_host\fR:\fIvde_hostport\fR specifies a port redirection.
  93 All the packet received by the host running slirpvde at port \fIport\fR
  94 will be forwarded to \fIvde_host\fR at port \fIvde_hostport\fR.
  95
  96 \fB-X \fIvde_host\fR[:\fIdisplay\fR.[\fIscreen\fR]] is the option to
  97 redirect a X window screen. Slirpvde gets the first unused X display on the
  98 host running slirpvde and redirects all the requests to \fIvde_host\fR.
  99 \fIdisplay\fR and \fIscreen\fR] must be specified when different from :0.0.
 100
 101 .SH NOTICE
 102 Virtual Distributed Ethernet is not related in any way with
 103 www.vde.com ("Verband der Elektrotechnik, Elektronik und Informationstechnik"
 104 i.e. the German "Association for Electrical, Electronic & Information
 105 Technologies").
 106
 107 .SH SEE ALSO
 108 \fBvde_switch\fP(1),
 109 \fBvde_plug\fP(1),
 110 \fBvde_plug2tap\fP(1),
 111 \fBdpipe\fP(1).
 112 .br
 113 .SH AUTHOR
 114 VDE is a project by Renzo Davoli <renzo@cs.unibo.it>.
 115 Slirp code is by Danny Gasparovsky.
 116 Bootp/DHCP code is by Fabrice Bellard.