vde-2/man/slirpvde.1

   1 .TH SLIRPVDE 1 "June 15, 2008" "Virtual Distributed Ethernet"
   2 .SH NAME
   3 slirpvde \- Virtual Distributed Ethernet-Slirp interface
   4 .SH SYNOPSIS
   5 .B slirpvde
   6 .I OPTIONS
   7 .SH DESCRIPTION
   8 \fBslirpvde\fP
   9 is a slirp interface for a VDE network.
  10
  11 Slirpvde connects all the units (virtual or real machines) to the network
  12 of the host where slirpvde runs as it were a NAT/Masquerading router.
  13 The default route is the node 2 (10.0.2.2 in the default network
  14 configuration) and DNS is re-mapped in node 3 (10.0.2.3).
  15
  16 Slirpvde runs using standard user privileges (no need for root access):
  17 all the connections are re-generated by slirpvde itself.
  18
  19 IPv4 only. IPv6 is still unsupported (will be supported when slirpvde will be
  20 rewritten using the LWIPv6 network stack).
  21
  22 .SH OPTIONS
  23 .TP
  24 \fB-s, --sock, --socket, --vdesock, --unix\fP \fIdirectory\fP
  25 specify the VDE switch directory (default /var/run/vde.ctl).
  26 .TP
  27 \fB-p, --pidfile\fP \fIfilename\fP
  28 specify the name of the file which contains the PID of slirpvde.
  29 .TP
  30 \fB-g, --group\fP \fIgroup\fP
  31 specify the UNIX group for the VDE communication socket.
  32 .TP
  33 \fB-m, --mod\fP \fImode\fP
  34 specify the octal UNIX permissions for the VDE communication socket.
  35 .TP
  36 \fB-d, --daemon\fP
  37 detach from terminal and run \fBslirpvde\fP in background.
  38 .TP
  39 \fB-D, --dhcp\fP
  40 turn on the DHCP server for the network autoconfiguration of
  41 all the units connected to the VDE.
  42 .TP
  43 \fB-n, --network\fP \fIaddress\fP
  44 specify the network address (default 10.0.2.0).
  45 .TP
  46 \fB-L \fIport\fR:\fIvde_host\fR:\fIvde_hostport\fR
  47 specifyes a port redirection.
  48 All the packet received by the host running slirpvde at port \fIport\fR
  49 will be forwarded to \fIvde_host\fR at port \fIvde_hostport\fR.
  50 .TP
  51 \fB-X \fIvde_host\fR[:\fIdisplay\fR.[\fIscreen\fR]]i
  52 redirect a X window screen of a virtual machine. Slirpvde gets the first unused X display on the
  53 host running slirpvde and redirects all the requests to \fIvde_host\fR.
  54 \fIdisplay\fR and \fIscreen\fR] must be specified when different from :0.0.
  55 .TP
  56 \fB-x \fIport\fR:\fIunix_socket_path\fR]
  57 redirect a port of the virtual router (usually 10.0.2.2) to a unix stream socket.
  58 It is used for example to redirect a X display of the hosting computer on the virtual network. e.g. -x6000:/tmp/.X11-unix/X0. (A suitable xhost configuration is needed (e.g. 'xhost local:').
  59
  60 .SH NOTICE
  61 Virtual Distributed Ethernet is not related in any way with
  62 www.vde.com ("Verband der Elektrotechnik, Elektronik und Informationstechnik"
  63 i.e. the German "Association for Electrical, Electronic & Information
  64 Technologies").
  65
  66 .SH SEE ALSO
  67 \fBvde_switch\fP(1),
  68 \fBvde_plug\fP(1),
  69 \fBvde_plug2tap\fP(1),
  70 \fBdpipe\fP(1).
  71 .br
  72 .SH AUTHOR
  73 VDE is a project by Renzo Davoli <renzo@cs.unibo.it>.
  74 Slirp code is by Danny Gasparovsky.
  75 Bootp/DHCP code is by Fabrice Bellard.