loadlwipv6 inlined
[vde.git] / vde-2 / man / dpipe.1
blob09e706ea6f2d048a0614320294c8f59af026ce15
1 .TH DPIPE 1 "December 6, 2006" "Virtual Distributed Ethernet"
2 .SH NAME
3 dpipe \- bi-directional pipe command
4 .SH SYNOPSIS
5 .B dpipe 
6
7 .I command
9 .I args
12 .BI =
14 .I command
16 .I args
19 .br
20 .B dpipe 
21
22 .I command
24 .I args
27 .BI =
29 .I command
31 .I args
35 .BI =
37 .I command
39 .I args
43 ...
44 .br
45 .SH DESCRIPTION
46 \fBdpipe\fP is a general tool to run two commands diverting the
47 standard output of the first command into the standard input of the second
48 and vice-versa.
49 It is the bi-directional
50 extension of the \fB|\fP (pipe) syntax used by all the shells.
51 The \fB=\fP has been chosen as a metaphor of two parallel communication lines
52 between the commands.
53 It is also possible to concatenate several tools. Intermediate programs communicate
54 using standard input and standard output with the preceding tool and alternate standard input
55 and output (respectively file descriptors number 3 and 4) towards the following tool.
56 If an intermediate tool should process only the data flowing in one direction 
57 use \fB{\fP or \fB}\fP
58 as suffix for the preceding \fB=\fP and prefix of the following one.
59 .br
60 This tool has been written as a tool for the Virtual Distributed Ethernet.
61 .SH EXAMPLE
62 .B dpipe a = b
63 .br
64 processes a and b are bidirectionally connected: stdin of a is connected to stdout of b 
65 and vice-versa
66 .br
67 .B dpipe a = b = c
68 .br
69 a and b are connected as above. Alternate stdin of b is connected to stdout of c and
70 alternate stdout of b to stdin of c
71 .br
72 .B dpipe a =} b }= c
73 .br
74 This is a cycle of pipes: stdout of a is connected to stdin of b, stdout of b with stdin
75 of c, and stdout of c to stdin of a
76 .br
77 .B dpipe a =} b }={ c {= d = e
78 .br
79 all the notations can be mixed together.
80 this is a -> b -> d -> c and back to a; alternate ports of d are connected to e
81 .SH OPTIONS
82 no options.
83 .SH NOTICE
84 Virtual Distributed Ethernet is not related in any way with
85 www.vde.com ("Verband der Elektrotechnik, Elektronik und Informationstechnik"
86 i.e. the German "Association for Electrical, Electronic & Information
87 Technologies").
88 .SH SEE ALSO
89 \fBvde_switch\fP(1),
90 \fBvde_plug\fP(1),
91 \fBvde_plug2tap\fP(1),
92 \fBvdeq\fP(1).
93 \fBwirefilter\fP(1).
94 .br
95 .SH AUTHOR
96 VDE is a project by Renzo Davoli <renzo@cs.unibo.it>.