-
Notifications
You must be signed in to change notification settings - Fork 11
/
Copy pathlibvdeplug_slirp.1.html
133 lines (112 loc) · 5.31 KB
/
libvdeplug_slirp.1.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
Content-type: text/html; charset=UTF-8
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of LIBVDEPLUG_SLIRP</TITLE>
</HEAD><BODY>
<H1>LIBVDEPLUG_SLIRP</H1>
Section: User Commands (1)<BR>Updated: October 2020<BR><A HREF="#index">Index</A>
<A HREF="/#/man/index">Return to Main Contents</A><HR>
<A NAME="lbAB"> </A>
<H2>NAME</H2>
<B>libvdeplug_slirp</B> - slirp vdeplug module
<A NAME="lbAC"> </A>
<H2>SYNOPSIS</H2>
libvdeplug_slirp.so
<A NAME="lbAD"> </A>
<H2>DESCRIPTION</H2>
This is the libvdeplug module to join TCP-IP networks using the slirp emulator.
<P>
This module of libvdeplug4 can be used in any program supporting vde like <B>vde_plug</B>, <B>vdens</B>, <B>kvm</B>, <B>qemu</B>, <B>user-mode-linux</B> and <B>virtualbox</B>.
<P>
The vde_plug_url syntax of this module is the following: ``` <A HREF="slirp://[/OPTION][/OPTION]">slirp://[/OPTION][/OPTION]</A>
<A NAME="lbAE"> </A>
<H2>OPTIONS</H2>
<DL COMPACT>
<DT><B>v4</B> <B>v6</B><DD>
provide IPv4 or IPv6 service <I>only</I>. Both family of protocols are enabled if both <B>v4</B> and <B>v6</B> options are present of if neither of them have been specified.
<DT><B>addr</B>=<I>IPv4Addr</I>/<I>prefix</I> or <B>host</B>=<I>IPv4addr</I>/<I>prefix</I><DD>
Set the IPv4 address of slirp (default value 10.0.2.2/24).
<DT><B>addr6</B>=<I>IPv6Addr</I>/<I>prefix</I> or <B>host6</B>=<I>IPv6addr</I>/<I>prefix</I><DD>
Set the IPv6 address of slirp (default value fd00::2/64).
<DT><B>hostname</B>=<I>name</I><DD>
define the hostname (default value: slirp)
<DT><B>tftp_server_name</B>=<I>name</I><DD>
define the hostname of the dhcp server
<DT><B>tftp_path</B>=<I>path</I><DD>
define the path of the directory whose contents are available by the tftp service
<DT><B>bootfile</B>=<I>path</I><DD>
define the path of the bootfile (for bootp)
<DT><B>dhcp</B>=<I>dhcpIPv4addr</I><DD>
set the lowest IP address assigned by dhcp
<DT><B>vnameserver</B>=<I>IPv4Addr</I><DD>
set the address of the IPv4 DNS proxy
<DT><B>vnameserver6</B>=<I>IPv6Addr</I><DD>
set the address of the IPv6 DNS proxy
<DT><B>vdnssearch</B>=<I>list of domains</I><DD>
set the default domains for the neame resolution e.g. <B>vdnssearch=foo.com,bar.org</B>
<DT><B>vdomainname</B>=<I>name</I><DD>
set the domain name
<DT><B>mtu</B>=<I>int_value</I><DD>
define the MTU
<DT><B>mru</B>==<I>int_value</I><DD>
define the MRU
<DT><B>disable_host_loopback</B><DD>
disable loopback
<DT><B>tcpfwd</B>=[<I>hostIP</I><B>:</B>]<I>hostport</I><B>:</B><I>guestIP</I><B>:</B><I>guestport</I><B>[,</B>[<I>hostIP</I><B>:</B>]<I>hostport</I><B>:</B><I>guestIP</I><B>:</B><I>guestport</I>]...]<DD>
forward TCP port(s).
<DT><B>udpfwd</B>=[<I>hostIP</I><B>:</B>]<I>hostport</I><B>:</B><I>guestIP</I><B>:</B><I>guestport</I><B>[,</B>[<I>hostIP</I><B>:</B>]<I>hostport</I><B>:</B><I>guestIP</I><B>:</B><I>guestport</I>]...]<DD>
forward UDP port(s).
<DT><B>unixfwd</B>=[<I>slirpIP</I><B>:</B>]<I>slirpport</I><B>:</B><I>path</I><B>[,</B>[<I>slirpIP</I><B>:</B>]<I>slirpport</I><B>:</B><I>path</I>...]<DD>
forward TCP port(s) (from the virtual network) to PF_UNIX socket(s) (commonly used to forward ports to a X server) <I>still unsupported by libslirp</I>.
<DT><B>cmdfwd</B>=[<I>slirpIP</I><B>:</B>]<I>slirpport</I><B>:</B><I>cmd</I><B>[,</B>[<I>slirpIP</I><B>:</B>]<I>slirpport</I><B>:</B><I>path</I>...]<DD>
forward TCP port(s) (from the virtual network) to external command(s).
<DT><B>verbose</B><DD>
print a table of slirp service configuration.
</DL>
<A NAME="lbAF"> </A>
<H2>EXAMPLES</H2>
This vde_plug_url enables both IPv4 and IPv6 (using the default configuration)
<P>
<B>slirp://</B>
<P>
Like the previous example but it prints the table of the configuration options
<P>
<B><A HREF="slirp:///verbose">slirp:///verbose</A></B>
<P>
When a program uses the following vde_plug_url:
<P>
<B><A HREF="slirp:///tcpfwd=8080:10.0.2.15:80">slirp:///tcpfwd=8080:10.0.2.15:80</A></B>
<P>
tcp connections to the host computer port 8080 (any interface) are forwarded to 10.0.2.15 port 80
<P>
<B><A HREF="slirp:///tcpfwd=8080:10.0.2.15:80/cmdfwd=10.0.2.5:6000:'socat">slirp:///tcpfwd=8080:10.0.2.15:80/cmdfwd=10.0.2.5:6000:'socat</A> STDIO UNIX:"/tmp/.X11-unix/X0"'</B>
<P>
like the previous one plus this uses socat to forward all X-windows requests to 10.0.2.5:0 (port 6000) to the local server of the display <B>:0</B>.
<A NAME="lbAG"> </A>
<H2>NOTICE</H2>
Virtual Distributed Ethernet is not related in any way with <A HREF="http://www.vde.com">www.vde.com</A> ("Verband der Elektrotechnik, Elektronik und Informationstechnik" i.e. the German "Association for Electrical, Electronic & Information Technologies").
<A NAME="lbAH"> </A>
<H2>SEE ALSO</H2>
<B><A HREF="/#/man/man1/vde_plug.1.html">vde_plug</A></B>(1)
<A NAME="lbAI"> </A>
<H2>AUTHOR</H2>
VirtualSquare. Project leader: Renzo Davoli
<P>
<HR>
<A NAME="index"> </A><H2>Index</H2>
<DL>
<DT><A HREF="#lbAB">NAME</A><DD>
<DT><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT><A HREF="#lbAD">DESCRIPTION</A><DD>
<DT><A HREF="#lbAE">OPTIONS</A><DD>
<DT><A HREF="#lbAF">EXAMPLES</A><DD>
<DT><A HREF="#lbAG">NOTICE</A><DD>
<DT><A HREF="#lbAH">SEE ALSO</A><DD>
<DT><A HREF="#lbAI">AUTHOR</A><DD>
</DL>
<HR>
This document was created by
<A HREF="/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 15:22:07 GMT, November 27, 2023
</BODY>
</HTML>