Moved to standard repository layout

git-svn-id: file:///home/lennart/svn/public/ivcall/trunk@2 e0b13411-74c3-0310-b366-a0654dd0340f
author: Lennart Poettering <lennart@poettering.net> 2003-07-27 19:18:57 +0000
committer: Lennart Poettering <lennart@poettering.net> 2003-07-27 19:18:57 +0000
commit: 91263ea95ec16bb376245c6931ea28d65bdcdc88 (patch)
tree: e4caa5a43070c71fb016f8cb31dc81e6551f2b16 /doc
3 files changed, 178 insertions, 0 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am
new file mode 100644
index 0000000..a6b9bb7
--- /dev/null
+++ b/doc/Makefile.am
@@ -0,0 +1,35 @@
+# $Id$
+
+# This file is part of ivcall.
+#
+# ivcall 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.
+#
+# ivcall 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.
+#
+# You should have received a copy of the GNU General Public License
+# along with ivcall; if not, write to the Free Software Foundation,
+# Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
+
+noinst_DATA = README.html README
+EXTRA_DIST = $(noinst_DATA) style.css README.html.in
+
+MAINTAINERCLEANFILES = README README.html
+CLEANFILES =
+
+if USE_LYNX
+README: README.html
+	lynx --dump $^ | sed 's,file://localhost/.*/doc/README.html,README,' > $@
+
+CLEANFILES += README
+endif
+
+tidy: README.html
+	tidy -e < README.html
+
+.PHONY: tidy
diff --git a/doc/README.html.in b/doc/README.html.in
new file mode 100644
index 0000000..bf7a739
--- /dev/null
+++ b/doc/README.html.in
@@ -0,0 +1,131 @@
+<?xml version="1.0" encoding="iso-8895-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,2003 Lennart Poettering &lt;mzvscyhtq [at] itaparica.org&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 July 27 2003: </div> <p class="news-text"><a
+href="http://www.stud.uni-hamburg.de/~lennart/projects/ivcall/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>
+
+ <h2><a name="status">Status</a></h2>
+
+<p>Version @PACKAGE_VERSION@ is stable and feature complete.</p>
+  
+<h2><a name="documentation">Documentation</a></h2>
+
+<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>
+
+<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>
+
+<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>
+
+<h2><a name="download">Download</a></h2>
+
+<p>The newest release is always available from <a href="http://www.stud.uni-hamburg.de/~lennart/projects/ivcall/">http://www.stud.uni-hamburg.de/~lennart/projects/ivcall/</a></p>
+
+<p>The current release is <a href="http://www.stud.uni-hamburg.de/~lennart/projects/ivcall/ivcall-@PACKAGE_VERSION@.tar.gz">@PACKAGE_VERSION@</a></p>
+
+<hr/>
+<address>Lennart Poettering &lt;mzvscyhtq [at] itaparica.org&gt;, July 2003</address>
+<div><i>$Id$</i></div>
+
+</body>
+</html>
diff --git a/doc/style.css b/doc/style.css
new file mode 100644
index 0000000..0a40aef
--- /dev/null
+++ b/doc/style.css
@@ -0,0 +1,12 @@
+/* $Id$ */
+body { color: black; background-color: white; margin: 0.5cm; } 
+a:link, a:visited { color: #900000; }       
+p { margin-left: 0.5cm; margin-right: 0.5cm; }
+div.news-date { margin-left: 0.5cm; font-size: 80%; color: #4f0000; } 
+p.news-text { margin-left: 1cm; }
+ul { margin-left: .5cm; }
+ol { margin-left: .5cm; }
+h1 { color: #00009F; }
+h2 { color: #00009F; }
+h3 { color: #00004F; margin-left: 0.5cm; }
+pre { margin-left: .5cm; background-color: #f0f0f0; padding: 0.4cm;}
author	Lennart Poettering <lennart@poettering.net>	2003-07-27 19:18:57 +0000
committer	Lennart Poettering <lennart@poettering.net>	2003-07-27 19:18:57 +0000
commit	91263ea95ec16bb376245c6931ea28d65bdcdc88 (patch)
tree	e4caa5a43070c71fb016f8cb31dc81e6551f2b16 /doc