- moved DEBUGOPT, PACKETCOUNT, PLUGIN in --enable-experimental configure
[vde.git] / vde-2 / doc / vde_plug2tap.1
blob0c1057fde29b86cefbbb743437f44ca929bcfda1
1 .TH VDE_PLUG2TAP 1 "December 5, 2006" "Virtual Distributed Ethernet"
2 .SH NAME
3 vde_plug2tap \- Virtual Distributed Ethernet plug-to-tap
4 .SH SYNOPSIS
5 .B vde_plug2tap 
6 [OPTION]... \fItap_name\fP
7 .br
8 .SH DESCRIPTION
9 .B vde_plug2tap 
10 is a plug to be connected into a VDE switch.
11 All the data that is catched by the plug is sent to the tap interface 
12 .I tap_name 
13 and everything from that interface is injected in the switch.
15 .SH OPTIONS
16 .TP
17 \fB\-p\fP, \fB\-\-port\fP=\fIportnum\fP
18 It is possible to decide which port of the switch to use.
19 When this option is not specified the switch assigns the first
20 available unused port (if any).
21 It is possible to connect several cables in the same switch port:
22 in this way all this cables work concurrently.
23 It means that packet can result as duplicate but no ARP table loops are
24 generated.
25 Is useful when vde is used for mobility. Several physical interfaces can
26 be used at a time during handoffs to prevent hichups in connectivity.
27 .TP
28 \fB\-g\fP, \fB\-\-group\fP=\fIgroup\fP
29 group ownership of the communication socket. For security when more
30 want to share a switch it is better to use a unix group to own the comm sockets
31 so that the network traffic cannot be sniffed.
32 .TP
33 \fB\-m\fP, \fB\-\-mod\fP=\fIoctal-mode\fP
34 octal chmod like permissions for the comm sockets
35 .TP
36 \fB\-s\fP, \fB\-\-sock\fP=\fIsocket\fP
37 specify the UNIX socket to be used by local programs for joining the VDE.
38 The default value is "/tmp/vde.ctl".
39 .TP
40 \fB\-d\fP, \fB\-\-daemon\fP
41 start vde_plug2tap as a background process
42 .TP
43 \fB\-P\fP, \fB\-\-pidfile\fP=\fIpidfile\fP
44 put the process ID of vde_plug2tap in \fIpidfile\fP. Can be used with
45 \fB\-\-daemon\fP to store the PID for future killing.
46 .TP
47 \fB\-h\fP, \fB\-\-help\fP
48 show a brief help
50 .SH NOTICE
51 Virtual Distributed Ethernet is not related in any way with
52 www.vde.com ("Verband der Elektrotechnik, Elektronik und Informationstechnik"
53 i.e. the German "Association for Electrical, Electronic & Information
54 Technologies").
56 .SH SEE ALSO
57 \fBvde_switch\fP(1),
58 \fBvde_plug\fP(1),
59 \fBvdeq\fP(1),
60 \fBdpipe\fP(1).
61 .br
62 .SH AUTHOR
63 VDE is a project by Renzo Davoli <renzo@cs.unibo.it>