Multiple tap/grab support for kvde_switch
[vde.git] / vde-2 / man / slirpvde.1
blobf9c8bf2c69f105bfc2d68ae48a07ffac914993f5
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
8 .I socketdir
10 .SH DESCRIPTION
11 \fBslirpvde\fP 
12 is a slirp interface for a VDE network.
14 Slirpvde connects all the units (virtual or real machines) to the network
15 of the host where slirpvde runs as it were a NAT/Masquerading router.
16 The default route is the node 2 (10.0.2.2 in the default network
17 configuration) and DNS is re-mapped in node 3 (10.0.2.3).
19 Slirpvde runs using standard user privileges (no need for root access): 
20 all the connections are re-generated by slirpvde itself.
22 IPv4 only. IPv6 is still unsupported (will be supported when slirpvde will be
23 rewritten using the LWIPv6 network stack).
25 .SH OPTIONS
26 .TP
27 \fB-s, --sock, --socket, --vdesock, --unix\fP \fIdirectory\fP
28 specify the VDE switch directory (default /var/run/vde.ctl).
29 The VDE switch directory can be also specified at the end of
30 the command, as illustrated by the optional parameter \fIsocketdir\fP
31 in the synopsis section, above.
32 When '-' is used in place of the VDE switch directory, \fBslirpvde\fP
33 works as a plug (see vde_plug(1)).
34 The command:
35 .br
36 .in +5
37 .B dpipe vde_plug = ssh remote.machine.org slirpvde -
38 .in -5
39 .br
40 which is the same as:
41 .br
42 .in +5
43 .B dpipe vde_plug = ssh remote.machine.org slirpvde -s -
44 .in -5
45 .br
46 connects the default local switch to a remote slirpvde.
47 .TP
48 \fB-p, --pidfile\fP \fIfilename\fP
49 specify the name of the file which contains the PID of slirpvde.
50 .TP
51 \fB-g, --group\fP \fIgroup\fP
52 specify the UNIX group for the VDE communication socket.
53 .TP
54 \fB-m, --mod\fP \fImode\fP
55 specify the octal UNIX permissions for the VDE communication socket.
56 .TP
57 \fB-P, --port\fP \fIport\fP
58 specify the port of the vde switch whern slirpvde must be connected.
59 .TP
60 \fB-d, --daemon\fP
61 detach from terminal and run \fBslirpvde\fP in background.
62 .TP
63 \fB-H, --host\fP \fIaddress\fP \fR[ \fB / \fI masklen \fR]
64 specify the host address (default 10.0.2.2/24).
65 This option automatically defines the network. 
66 e.g.
67 .in +5
68 \fB -H 192.168.55.1 \fR
69 .in -5
70 or:
71 .in +5
72 \fB --host 10.1.2.3/16 \fR
73 .in -5
74 The default value for \fImasklen\fR is 24.
75 If the host part of the address is zero this option defines only
76 the network. The default host addr is addr 2, the default dns proxy is 3.
77 e.g.
78 .in +5
79 \fB -H 10.1.0.0/16 \fR
80 .in -5
81 defines the network only. The host address is 10.1.0.2 and the DNS proxy
82 10.1.0.3.
83 .TP
84 \fB-n, --network\fP \fIaddress\fP \fR[ \fB / \fI masklen \fR]
85 specify the network address (default 10.0.2.0/24).
86 Deprecated, it has been included for back compatibility only. It is 
87 an alias of \fB-H, --host\fR. 
88 .TP
89 \fB-N, --dns\fP \fIaddress\fP
90 Specify the address of the dns server. If this is an address inside
91 the slirp network, slirvde acts as a dns proxy on that address.
92 The slirpvde dhcp server sends this dns address to the clients.
93 By default this is the host number 3 in the slirpvde network. Using the
94 default network it is 10.0.2.3.
95 Warning: do not use the same address for host and dns.
96 .TP
97 \fB-D, --dhcp\fP
98 turn on the DHCP server for the network autoconfiguration of
99 all the units connected to the VDE.
100 It is possible to specify the start address assigned by the DHCP server 
101 as follows:
102 .in +5
103 \fB --dhcp=10.1.1.44 \fR
104 .in -5
105 DHCP assign addresses starting at host number 15 by default. Using the
106 default network it starts from 10.0.2.15
108 \fB-L \fIport\fR:\fIvde_host\fR:\fIvde_hostport\fR
109 specifyes a TCP port redirection.
110 All the TCP packets received by the host running slirpvde at port \fIport\fR
111 will be forwarded to \fIvde_host\fR at port \fIvde_hostport\fR.
113 \fB-U \fIport\fR:\fIvde_host\fR:\fIvde_hostport\fR
114 specifyes a UDP port redirection.
115 All the UDP packets received by the host running slirpvde at port \fIport\fR
116 will be forwarded to \fIvde_host\fR at port \fIvde_hostport\fR.
118 \fB-X \fIvde_host\fR[:\fIdisplay\fR.[\fIscreen\fR]]i
119 redirect a X window screen of a virtual machine. Slirpvde gets the first unused X display on the
120 host running slirpvde and redirects all the requests to \fIvde_host\fR.
121 \fIdisplay\fR and \fIscreen\fR] must be specified when different from :0.0.
123 \fB-x \fIport\fR:\fIunix_socket_path\fR]
124 redirect a port of the virtual router (usually 10.0.2.2) to a unix stream socket.
125 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:').
127 \fB-t, --tftp\fP \fIpathname\fR
128 slirpvde enables a tftp server sharing (read-only) the directory at \fIpathname\fR.
130 \fB-q, --quiet\fP
131 Quiet;   do   not  write  anything  to  standard  output.
133 .SH NOTICE
134 Virtual Distributed Ethernet is not related in any way with
135 www.vde.com ("Verband der Elektrotechnik, Elektronik und Informationstechnik"
136 i.e. the German "Association for Electrical, Electronic & Information
137 Technologies").
139 .SH SEE ALSO
140 \fBvde_switch\fP(1),
141 \fBvde_plug\fP(1),
142 \fBvde_plug2tap\fP(1),
143 \fBdpipe\fP(1).
145 .SH AUTHOR
146 VDE is a project by Renzo Davoli <renzo@cs.unibo.it>.
147 Slirp code is by Danny Gasparovsky.
148 Bootp/DHCP code is by Fabrice Bellard.