summaryrefslogtreecommitdiffstats
path: root/doc/README.html.in
blob: f9f38882c1236cda87009e903e29debf7b1262af (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
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
<?xml version="1.0" encoding="iso-8859-15"?> <!-- -*-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>ivcall @PACKAGE_VERSION@</title>
<link rel="stylesheet" type="text/css" href="style.css" />
</head>

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

<p><i>Copyright 2002-2005 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">Sun Jan 23 2005: </div> <p class="news-text"><a
href="@PACKAGE_URL@ivcall-0.4.tar.gz">Version
0.4</a> released, changes include: cleanups, add softfax support using spandsp.</p>

<div class="news-date">Sat Jan 2004: </div> <p class="news-text"><a
href="@PACKAGE_URL@ivcall-0.3.tar.gz">Version
0.3</a> released, changes include: uucp locking fixes, <tt>ivcall</tt> may listen on wildcard MSNs now.</p>

<div class="news-date">Sun July 27 2003: </div> <p class="news-text"><a
href="@PACKAGE_URL@ivcall-0.2.tar.gz">Version
0.2</a> released, changes include: many fixes, autoconf support</p>

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

<p><tt>ivcall</tt> is a small utility which may be used to make automated
telephone calls with your <i><a href="http://www.isdn4linux.de/">isdn4linux</a></i> supported ISDN
card. Outgoing calls are
supported as well as incoming calls. The audio data recieved
from the peer is written to STDOUT, audio data read from STDIN
is send to the peer. The audio data is in raw 8 bit uLaw 8 KHz format,
without any headers.</p>

<p>Since release 0.4 <tt>ivcall</tt> supports sending and receiving
facsimiles using <a href="http://opencall.org/">spandsp</a> as
software modem for 9600bps connections (just fax, no data connections).</p>

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

<p>Version @PACKAGE_VERSION@ is stable and feature complete when used
to playback and record voice messages. The softfax is not reliable,
primarily due to the fact that isdn4linux is broken. </p>
  
<h2><a name="documentation">Documentation</a></h2>

<h3>Voice</h3>

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

<p>You may use <tt>ivcall</tt> as a Unix filter:

<pre>
ivcall LMSN RMSN < IFILE > OFILE
</pre>

<p>Replace <tt>LMSN</tt> by the local MSN and <tt>RMSN</tt> by the MSN
the program shall call. <tt>IFILE</tt> must be a raw uLAW 8 KHz
bytesized file, which is be played to the peer. <tt>OFILE</tT> is the
file the recorded audio data will be written to. It has the same
format as the input file. If no recording (or playback) is desired you
may pipe <tt>STDOUT</tt> (or <tt>STDIN</tt>) to <tt>/dev/null</tt>.

<p>Four detailed usage information try:</p>

<pre>ivcall --help</pre>

<p>If you want to create a sample playable with <tt>ivcall</tt> with your
soundcard, you'll need <tt>sox</tt>:</p>

<pre>$ rec -t raw -r 8000 -U -b FILE</pre>

<p>Don't forget to plug in a microphone and set the record volume with
<tt>aumix</tt> or something similar. However, it is recommended to create
audio samples with the telephone itself.</p>

<p>If you have a wave file you want to convert to a sample playable
with <tt>ivcall</tt> use <tt>sox</tt> as well:</p>

<pre>$ sox IFILE -t raw -r 8000 -U -b OFILE</pre>

<h3>Fax</h3>

<p>For receiving faxes use:</p>

<pre>$ ivcall -a -F foo.tif 47110815</pre>

<p>This will wait for an incoming fax call on MSN 47110815 and store the data in <tt>foo.tif</tt>.</p>

<p>For sending faxes use:</p>

<pre>$ ivcall -F bar.tif 47110815 08154711</pre>

<p>This will call 08154711 from the local MSN 47110815 and deliver
<tt>bar.tif</tt> to the peer. The image file has to be in TIFF format,
monochrome and either uncompressed or with G3 compression applied.</p>

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

<p>A newer Linux Kernel (I think 2.0 is good enough, alltough I tested it
only with 2.4) with a compatible device driver (<tt>isdn4linux</tt>).

<p><tt>ivcall</tt> was developed and tested on Debian GNU/Linux
"testing" from July 2003, it should work on most other Linux
distributions since it uses GNU autoconf for source code configuration.</p>

<p>For using <tt>ivcall</tt> has softfax you have to install <a href="http://opencall.org/">spandsp</a> 0.0.2pre10 or newer.</p>

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

<p>As this package is made with the GNU autotools 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>ivcall</tt>.</p>

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

<p>For the developers of <tt>awag</tt> (Stefan Szomraky), <tt>minicom</tt> (Miquel van Smoorenburg) and <tt>vbox</tt> (Michael Herold), since I looked
on their source codes for learning how to use the <tt>isdn4linux</tt> modem emulation</p>

<p>Steve Underwood for writing <tt>spandsp</tt></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@ivcall-@PACKAGE_VERSION@.tar.gz">@PACKAGE_VERSION@</a></p>

<p>Get <tt>ivcall</tt>'s development sources from the <a href="http://subversion.tigris.org/">Subversion</a> <a href="svn://seth.intheinter.net/ivcall">repository</a> (<a href="http://0pointer.de/cgi-bin/viewcvs.cgi/?root=ivcall">viewcvs</a>): </p>

<pre>svn checkout svn://seth.intheinter.net/ivcall/trunk ivcall</pre>

<p>If you want to be notified whenever I release a new version of this software use the subscription feature of <a href="http://freshmeat.net/projects/ivcall/">Freshmeat</a>.</p>

<hr/>
<address class="grey">Lennart Poettering &lt;@PACKAGE_BUGREPORT@&gt;, January 2005</address>
<div class="grey"><i>$Id$</i></div>

</body>
</html>