loadlwipv6 inlined
[vde.git] / vde-2 / man / slirpvde.1
blob04364523d3d5d72016b2ee56b49cf0c38f62dd31
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
7 .B \-sock
8 .I socketpath
11 .B \-network
12 .I netaddr
15 .B \-dhcp
18 .B \-L
19 .I port
20 .B :
21 .I vde_host
22 .B :
23 .I vde_hostport
26 .B \-X
27 .I vde_host
29 .B :
30 .I display
32 .B .
33 .I screen
37 .br
38 .B slirpvde
40 .B \-s
41 .I socketpath
44 .B \-n
45 .I netaddr
48 .B \-D
51 .B \-L
52 .I port
53 .B :
54 .I vde_host
55 .B :
56 .I vde_hostport
59 .B \-X
60 .I vde_host
62 .B :
63 .I display
65 .B .
66 .I screen
71 .B \-x
72 .I port
73 .B :
74 .I unix_socket_path
76 .br
77 .SH DESCRIPTION
78 \fBslirpvde\fP 
79 is a slirp interface for a VDE network.
81 Slirpvde connects all the units (virtual or real machines) to the network
82 of the host where slirpvde runs as it were a NAT/Masquerading router.
83 The default route is the node 2 (10.0.2.2 in the default network
84 configuration) and DNS is re-mapped in node 3 (10.0.2.3).
86 Slirpvde runs using standard user privileges (no need for root access): 
87 all the connections are re-generated by slirpvde itself.
89 IPv4 only. IPv6 is still unsupported.
91 \fB-sock\fP is used to specify the VDE switch (default /tmp/vde.ctl)
93 \fB-dhcp\fP turns on the dhcp server for the network autoconfiguration of
94 all the units connected to the VDE.
96 \fB-network\fP is used to specify the network address (default 10.0.2.0).
98 \fB-L \fIport\fR:\fIvde_host\fR:\fIvde_hostport\fR specifies a port redirection.
99 All the packet received by the host running slirpvde at port \fIport\fR
100 will be forwarded to \fIvde_host\fR at port \fIvde_hostport\fR.
102 \fB-X \fIvde_host\fR[:\fIdisplay\fR.[\fIscreen\fR]] is the option to
103 redirect a X window screen of a virtual machine. Slirpvde gets the first unused X display on the
104 host running slirpvde and redirects all the requests to \fIvde_host\fR.
105 \fIdisplay\fR and \fIscreen\fR] must be specified when different from :0.0.
107 \fB-x \fIport\fR:\fIunix_socket_path\fR] is the option to
108 redirect a port of the virtual router (usually 10.0.2.2) to a unix stream socket.
109 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:').
110 .SH NOTICE
111 Virtual Distributed Ethernet is not related in any way with
112 www.vde.com ("Verband der Elektrotechnik, Elektronik und Informationstechnik"
113 i.e. the German "Association for Electrical, Electronic & Information
114 Technologies").
116 .SH SEE ALSO
117 \fBvde_switch\fP(1),
118 \fBvde_plug\fP(1),
119 \fBvde_plug2tap\fP(1),
120 \fBdpipe\fP(1).
122 .SH AUTHOR
123 VDE is a project by Renzo Davoli <renzo@cs.unibo.it>.
124 Slirp code is by Danny Gasparovsky.
125 Bootp/DHCP code is by Fabrice Bellard.