summaryrefslogtreecommitdiffstats
path: root/doc/README.html.in
blob: 88ed4dec1d524222c228bb50f85972f16947d027 (plain)
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
134
135
136
137
138
139
<?xml version="1.0" encoding="iso-8859-1"?> <!-- -*-html-helper-*- -->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">

<head>
<title>bidilink @PACKAGE_VERSION@</title>
<link rel="stylesheet" type="text/css" href="style.css" />
</head>

<body>
<h1><a name="top">bidilink @PACKAGE_VERSION@</a></h1>

<p><i>Copyright 2003 Lennart Poettering &lt;@PACKAGE_BUGREPORT@&gt;</i></p>

<ul class="toc">
    <li><a href="#license">License</a></li>
    <li><a href="#news">News</a></li>
    <li><a href="#overview">Overview</a></li>
    <li><a href="#status">Status</a></li>
    <li><a href="#documentation">Documentation</a></li>
    <li><a href="#requirements">Requirements</a></li>
    <li><a href="#installation">Installation</a></li>
    <li><a href="#acks">Acknowledgements</a></li>
    <li><a href="#download">Download</a></li>
</ul>

<h2><a name="license">License</a></h2>

<p>This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License as
published by the Free Software Foundation; either version 2 of the
License, or (at your option) any later version.</p>

<p>This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.</p>

<p>You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.</p>

<h2><a name="news">News</a></h2>

<div class="news-date">Wed Jan 14 2004: </div>

<p class="news-text"><a href="@PACKAGE_URL@bidilink-0.1.tar.gz">Version 0.1</a> released, initial release.</p>

<h2><a name="overview">Overview</a></h2>

<p><tt>bidilink</tt> is a general purpose Unix tool for linking two
bidirectional data streams together. It extends the standard Unix
"filter" paradigma to bidrectional streams.</p>

<h2><a name="status">Status</a></h2>

<p>Version @PACKAGE_VERSION@ is more or less stable. Its has the following stream drivers:</p>

<ul>
  <li><tt>std:</tt> - <tt>STDIN</tt>, <tt>STDOUT</tt> of the process</li>
  <li><tt>exec:PROGRAM</tt> - <tt>fork()</tt> off a process and use its <tt>STDIN</tt> and <tt>STDOUT</tt></li>
  <li><tt>tty:TTYDEVICE</tt> - Open a TTY device (like a serial port) as client</li>
  <li><tt>pty:[PTYNAME]</tt> - Allocate a pseudo TTY device as master</li>
  <li><tt>tcp-client:HOSTNAME:PORT</tt> - Connect to another or the local host via TCP/IP</li>
  <li><tt>tcp-server:[IPADDRESS:]PORT</tt> - Listen on a local port and wait for an incoming connection</li>
  <li><tt>unix-client:SOCKNAME</tt> - Connect to a local Unix domain socket</li>
  <li><tt>unix-server:SOCKNAME</tt> - Listen on a local Unix domain socket</li>
</ul>

<p>More drivers are planned, including:</p>

<ul>
  <li><tt>dsp:</tt> - Full duplex audio with OSS (Open Sound System)</li>
  <li><tt>tun:</tt> - Raw network access using the TUN subsystem</li>
  <li><tt>tap:</tt> - Raw network access using the TAP subsystem</li>
 </ul>

<h2><a name="documentation">Documentation</a></h2>

 <p>Have a look on the man page <a href="@PACKAGE_URL@bidilink.1.xml"><tt>bidilink(1)</tt></a>. (An XSLT capable browser is required)</p>

 <p><tt>bidilink</tt> may be used in several different ways. Some examples follow.</p>

<h3>Forward a serial port of another machine to a local pseudo TTY</h3>

<pre>bidilink "exec:ssh OTHERMACHINE bidilink tty:/dev/ttyS0" pty:/dev/rmodem</pre>

<p><i>This will create a symbolic link <tt>/dev/rmodem</tt> to the
allocated pseudo TTY device. Point your application to the device to
use the forwarded port. This requires that <tt>bidilink</tt> is
installed on both the local machine and the remote machine. The pseudo tty is compatible with <tt>pppd</tt> or <tt>minicom</tt>.</i></p>

<h3>Bind a local serial port to a local TCP port</h3>

<pre>bidilink tty:/dev/ttyS0 tcp-server:4711</pre>

<p><i>Use <tt>telnet localhost 4711</tt> to connect to the device</i></p>

<h3>Bind a remote TCP port to a local pseudo TTY</h3>

<pre>bidilink pty:/dev/rmodem tcp-client:OTHERMACHINE:4711</pre>

<p><i>This may be used as client to the server trick descibed above.</i></p>

<h3>Open a local Unix socket (<tt>SOCK_STREAM</tt>) to the Internet:</h3>

<pre>bidilink tcp-server:4711 unix-client:/tmp/.esd/socket</pre>

<h2><a name="requirements">Requirements</a></h2>

<p>A recent Linux distribution. Probably, it is simple to port <tt>bidilink</tt> to other platforms, but this has not been done yet.</p>

<h2><a name="installation">Installation</a></h2>

<p>As this package is made with the GNU <tt>autotools</tt> you should run
<tt>./configure</tt> inside the distribution directory for configuring
the source tree. After that you should run <tt>make</tt> for
compilation and <tt>make install</tt> (as root) for installation of
<tt>bidilink</tt>.</p>

<h2><a name="acks">Acknowledgements</a></h2>

<p>None so far</p>

<h2><a name="download">Download</a></h2>

<p>The newest release is always available from <a href="@PACKAGE_URL@">@PACKAGE_URL@</a></p>

<p>The current release is <a href="@PACKAGE_URL@bidilink-@PACKAGE_VERSION@.tar.gz">@PACKAGE_VERSION@</a></p>

<p>Get <tt>bidilink</tt>'s development sources from the <a href="http://subversion.tigris.org/">Subversion</a> <a href="https://seth.intheinter.net:8081/svn/bidilink/">repository</a>.</p>

<hr/>
<address class="grey">Lennart Poettering &lt;@PACKAGE_BUGREPORT@&gt;, January 2004</address>

<div class="grey"><i>$Id$</i></div>

</body>
</html>