From ec5f0f5729a454e203621bbe66ac86028282b636 Mon Sep 17 00:00:00 2001
From: Lennart Poettering
Date: Sun, 7 Mar 2004 18:56:13 +0000
Subject: add documentation assorted other fixes
git-svn-id: file:///home/lennart/svn/public/pgets/trunk@4 768266df-afd4-0310-94a7-d396c829e022
---
Makefile.am | 6 +-
configure.ac | 35 ++++++++++--
doc/Makefile.am | 35 ++++++++++++
doc/README.html.in | 154 +++++++++++++++++++++++++++++++++++++++++++++++++++
doc/style.css | 32 +++++++++++
php/Makefile.am | 19 +++++++
php/pgets-intro.html | 3 +-
php/pgets.php | 3 +-
sql/Makefile.am | 19 +++++++
sql/pgets-access.sql | 6 +-
10 files changed, 300 insertions(+), 12 deletions(-)
create mode 100644 doc/Makefile.am
create mode 100644 doc/README.html.in
create mode 100644 doc/style.css
create mode 100644 php/Makefile.am
create mode 100644 sql/Makefile.am
diff --git a/Makefile.am b/Makefile.am
index 386d51d..34eb703 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -17,21 +17,21 @@
# Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
EXTRA_DIST=bootstrap.sh README LICENSE
-SUBDIRS=src #conf doc man
+SUBDIRS=src doc sql php
MAINTAINERCLEANFILES = README
noinst_DATA = README
README:
rm -f README
-# $(MAKE) -C doc README
+ $(MAKE) -C doc README
cd $(srcdir) && ln -s doc/README README
homepage: all dist
test -d $$HOME/homepage/lennart
mkdir -p $$HOME/homepage/lennart/projects/pgets
cp *.tar.gz $$HOME/homepage/lennart/projects/pgets
-# cp doc/style.css doc/README.html $$HOME/homepage/lennart/projects/pgets/
+ cp doc/style.css doc/README.html $$HOME/homepage/lennart/projects/pgets/
cp $$HOME/homepage/lennart/projects/pgets/README.html $$HOME/homepage/lennart/projects/pgets/index.html
distcleancheck:
diff --git a/configure.ac b/configure.ac
index 8d6e9e3..81725e2 100644
--- a/configure.ac
+++ b/configure.ac
@@ -42,11 +42,36 @@ if test "x$GCC" = "xyes" ; then
CFLAGS="$CFLAGS -pipe -Wall"
fi
-AC_CHECK_LIB([pq], [PQconnectdb])
-AC_CHECK_LIB([sqlite], [sqlite_open])
+# Check for PostgreSQL
+AC_ARG_ENABLE(postgres, AS_HELP_STRING(--disable-postgres,Don't build postgres client),
+[case "${enableval}" in
+ yes) postgres=yes ;;
+ no) postgres=no ;;
+ *) AC_MSG_ERROR(bad value ${enableval} for --disable-postgres) ;;
+esac],[postgres=yes])
+
+if test "x$postgres" = "xyes" ; then
+ AC_CHECK_LIB([pq], [PQconnectdb],,[AC_MSG_ERROR([*** Sorry, you have to install libpq or use --disable-postgres ***])])
+ AC_CHECK_HEADER([postgresql/libpq-fe.h],,[AC_MSG_ERROR([*** Sorry, you have to install postgresql-dev or use --disable-postgres ***])])
+fi
+
+
+AM_CONDITIONAL([POSTGRES], [test "x$postgres" = "xyes"])
+
+# Check for SQLite
+AC_ARG_ENABLE(sqlite, AS_HELP_STRING(--disable-sqlite,Don't build sqlite client),
+[case "${enableval}" in
+ yes) sqlite=yes ;;
+ no) sqlite=no ;;
+ *) AC_MSG_ERROR(bad value ${enableval} for --sqlite-postgres);;
+esac],[sqlite=yes])
+
+if test "x$sqlite" = "xyes" ; then
+ AC_CHECK_LIB([sqlite], [sqlite_open],,[AC_MSG_ERROR([*** Sorry, you have to install libsqlite or use --disable-sqlite ***])])
+ AC_CHECK_HEADER([sqlite.h],,[AC_MSG_ERROR([*** Sorry, you have to install libsqlite-dev or use --disable-sqlite ***])])
+fi
-AM_CONDITIONAL([POSTGRES], [true])
-AM_CONDITIONAL([SQLITE], [true])
+AM_CONDITIONAL([SQLITE], [test "x$sqlite" = "xyes"])
# Checks for header files.
AC_HEADER_STDC
@@ -85,5 +110,5 @@ fi
AM_CONDITIONAL([USE_LYNX], [test "x$lynx" = xyes])
-AC_CONFIG_FILES([src/Makefile Makefile]) # conf/Makefile doc/Makefile doc/README.html])
+AC_CONFIG_FILES([src/Makefile Makefile doc/Makefile doc/README.html php/Makefile sql/Makefile])
AC_OUTPUT
diff --git a/doc/Makefile.am b/doc/Makefile.am
new file mode 100644
index 0000000..a70ee0d
--- /dev/null
+++ b/doc/Makefile.am
@@ -0,0 +1,35 @@
+# $Id$
+
+# This file is part of pgets.
+#
+# pgets 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.
+#
+# pgets 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 pgets; 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..6dab3d0
--- /dev/null
+++ b/doc/README.html.in
@@ -0,0 +1,154 @@
+
+
+
+
+
+pgets @PACKAGE_VERSION@
+
+
+
+
+
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.
+
+
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.
+
+
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.
pgets is a simple Linux tool for reading stored call
+accounting data from Auerswald ETS 4308i PBX over a serial line into
+PostgreSQL or SQLite databases. pgets
+should be called by in regular time intervals (e.g. by cron)
+to update the database with all new data from the PBX.
+
+
pgets comes with a simple PHP based web frontend for querying
+the accumulated data.
Version @PACKAGE_VERSION@ works fine. While the C written transfer utility works
+with both SQLite and PostgreSQL databases, the PHP frontend is limited
+to PostgreSQL. This will probably change in future versions.
After installation you should create the database for
+pgets. For PostgreSQL this involves executing the SQL
+commands contained in the file sql/pgets-access.sql by piping
+them to psql:
+
+
psql template1 postgres < sql/pgets-access.sql
+
+
You probably want to edit pgets-access.sql before piping
+it to psql for using different passwords. For SQLite this is
+much simpler as it doesn't involve any access rights:
+
+
sqlite pgets.sqlite < sql/pgets.sql
+
+
After that you should create a cronjob for either pgets-postgres or pgets-sqlite:
This makes sure that the pgets database is updated once a
+day with all new call accounting data stored in the PBX. (This
+cron syntax is for a user cronjob, not a system wide one)
+The option -q disables verbose printing of the current status
+of pgets. With -b you may pass the database access
+information to pgets, this is either a PostgreSQL compatible
+connection string or a SQLite file name. Use -d to use a
+different serial port than /dev/ttyS0.
+
+
To use the PHP frontend copy php/pgets.php,
+php/style.css and php/pgets-intro.html into your web
+tree and activate PHP for it. Don't forget to enable the PostgreSQL
+module in php.ini. You may need to edit the top of
+pgets.php for the correct database access credentials.
A current Linux distribution on a machine with a serial port
+connected to the PBX. The RS2 port of PBX has to be in
+"Gesprächsdatenerfassung" mode. You may enable this mode by calling
+811118303.
+
+
pgets was developed and tested on Debian GNU/Linux
+"testing" from March 2004, it should work on most other Linux
+distributions since it uses GNU autoconf for source code
+configuration.
+
+
pgets requires the PostgreSQL and/or SQLite development
+library files for compilation.
As this package is made with the GNU autotools you should run
+./configure inside the distribution directory for configuring
+the source tree. After that you should run make for
+compilation and make install (as root) for installation of
+pgets.
+
+
By default the build system creates two
+executables. pgets-postgres with support for PostgreSQL
+databases and pgets-sqlite with support for SQLite. You may
+disable building either one by passing --disable-postgres
+resp. --disable-sqlite to configure.
If you want to be notified whenever I release a new version of this software use the subscription feature of Freshmeat.
+
+
+Lennart Poettering <@PACKAGE_BUGREPORT@>, March 2004
+
$Id$
+
+
+
diff --git a/doc/style.css b/doc/style.css
new file mode 100644
index 0000000..95cbd57
--- /dev/null
+++ b/doc/style.css
@@ -0,0 +1,32 @@
+/* $Id$ */
+
+/***
+ * This file is part of pgets.
+ *
+ * pgets 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.
+ *
+ * pgets 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 pgets; if not, write to the Free Software Foundation,
+ * Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
+ ***/
+
+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; }
+h1 { color: #00009F; }
+h2 { color: #00009F; }
+h3 { color: #00004F; margin-left: 0.5cm; }
+ul { margin-left: .5cm; }
+ol { margin-left: .5cm; }
+pre { margin-left: .5cm; background-color: #f0f0f0; padding: 0.4cm;}
+.grey { color: #afafaf; }
diff --git a/php/Makefile.am b/php/Makefile.am
new file mode 100644
index 0000000..5baf83a
--- /dev/null
+++ b/php/Makefile.am
@@ -0,0 +1,19 @@
+# $Id$
+
+# This file is part of pgets.
+#
+# pgets 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.
+#
+# pgets 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 pgets; if not, write to the Free Software Foundation,
+# Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
+
+EXTRA_DIST = style.css pgets.php pgets-intro.html
diff --git a/php/pgets-intro.html b/php/pgets-intro.html
index 98a66c2..625cd39 100644
--- a/php/pgets-intro.html
+++ b/php/pgets-intro.html
@@ -38,6 +38,7 @@