Initial revision

git-svn-id: https://svn.ibp.de/svn/capisuite/trunk/capisuite@3 4ebea2bb-67d4-0310-8558-a5799e421b66
master
gernot 20 years ago
commit 4f7e2b2a4e
  1. 11
      .cvsignore
  2. 1
      AUTHORS
  3. 0
      ChangeLog
  4. 25
      Makefile.am
  5. 103
      NEWS
  6. 6
      README
  7. 24
      TODO
  8. 98
      acinclude.m4
  9. 38
      capisuite.cronin
  10. 72
      capisuite.spec
  11. 26
      configure.in
  12. 9
      docs/.cvsignore
  13. 969
      docs/Doxyfile.in
  14. 41
      docs/Makefile.am
  15. 11
      docs/mainpage.doxy
  16. 22
      docs/manual.README
  17. 1371
      docs/manual.docbook
  18. 180
      rc.capisuite.in
  19. 5
      scripts/.cvsignore
  20. 37
      scripts/Makefile.am
  21. 2
      scripts/README
  22. 125
      scripts/answering_machine.confin
  23. 168
      scripts/capisuitefax
  24. 340
      scripts/cs_helpers.pyin
  25. 142
      scripts/fax.confin
  26. 187
      scripts/idle.py
  27. 464
      scripts/incoming.py
  28. 59
      scripts/remote-connect.py
  29. BIN
      scripts/waves/..la
  30. 2
      scripts/waves/.cvsignore
  31. BIN
      scripts/waves/0.la
  32. BIN
      scripts/waves/1.la
  33. BIN
      scripts/waves/10.la
  34. BIN
      scripts/waves/11.la
  35. BIN
      scripts/waves/12.la
  36. BIN
      scripts/waves/13.la
  37. BIN
      scripts/waves/14.la
  38. BIN
      scripts/waves/15.la
  39. BIN
      scripts/waves/16.la
  40. BIN
      scripts/waves/17.la
  41. BIN
      scripts/waves/18.la
  42. BIN
      scripts/waves/19.la
  43. BIN
      scripts/waves/2.la
  44. BIN
      scripts/waves/20.la
  45. BIN
      scripts/waves/3.la
  46. BIN
      scripts/waves/30.la
  47. BIN
      scripts/waves/4.la
  48. BIN
      scripts/waves/40.la
  49. BIN
      scripts/waves/5.la
  50. BIN
      scripts/waves/50.la
  51. BIN
      scripts/waves/6.la
  52. BIN
      scripts/waves/60.la
  53. 52
      scripts/waves/7.la
  54. BIN
      scripts/waves/70.la
  55. BIN
      scripts/waves/8.la
  56. BIN
      scripts/waves/80.la
  57. BIN
      scripts/waves/9.la
  58. BIN
      scripts/waves/90.la
  59. 12
      scripts/waves/Makefile.am
  60. 2
      scripts/waves/README
  61. BIN
      scripts/waves/am.la
  62. BIN
      scripts/waves/anrufbeantworter-von.la
  63. BIN
      scripts/waves/ansage-gespeichert.la
  64. 1
      scripts/waves/beep.la
  65. BIN
      scripts/waves/bitte-nachricht.la
  66. BIN
      scripts/waves/bitte-neue-ansage-komplett.la
  67. BIN
      scripts/waves/bitte-neue-ansage-kurz.la
  68. BIN
      scripts/waves/ein.la
  69. BIN
      scripts/waves/erklaerung.la
  70. BIN
      scripts/waves/fernabfrage-aktiv.la
  71. BIN
      scripts/waves/fuer-neue-ansage-9.la
  72. BIN
      scripts/waves/fuer.la
  73. BIN
      scripts/waves/keine-weiteren-nachrichten.la
  74. BIN
      scripts/waves/nachricht-gelöscht.la
  75. BIN
      scripts/waves/nachricht.la
  76. BIN
      scripts/waves/nachrichten.la
  77. BIN
      scripts/waves/neue-ansage-lautet.la
  78. BIN
      scripts/waves/neue-nachricht.la
  79. BIN
      scripts/waves/neue-nachrichten.la
  80. BIN
      scripts/waves/uhr.la
  81. BIN
      scripts/waves/um.la
  82. 31
      scripts/waves/und.la
  83. BIN
      scripts/waves/von.la
  84. BIN
      scripts/waves/wenn-einverstanden-1.la
  85. BIN
      scripts/waves/zum-abhoeren-1.la
  86. 7
      src/.cvsignore
  87. 20
      src/Makefile.am
  88. 3
      src/application/.cvsignore
  89. 5
      src/application/Makefile.am
  90. 121
      src/application/applicationexception.h
  91. 590
      src/application/capisuite.cpp
  92. 277
      src/application/capisuite.h
  93. 1158
      src/application/capisuitemodule.cpp
  94. 124
      src/application/capisuitemodule.h
  95. 186
      src/application/idlescript.cpp
  96. 160
      src/application/idlescript.h
  97. 318
      src/application/incomingscript.cpp
  98. 216
      src/application/incomingscript.h
  99. 138
      src/application/pythonscript.cpp
  100. 115
      src/application/pythonscript.h
  101. Some files were not shown because too many files have changed in this diff Show More

@ -0,0 +1,11 @@
Makefile
Makefile.in
aclocal.m4
autom4te.cache
stamp-h1
config.*
configure
configure.scan
autoscan.log
capisuite.cron
rc.capisuite

@ -0,0 +1 @@
Gernot Hillier <gernot@hillier.de>

@ -0,0 +1,25 @@
spooldir = @localstatedir@/spool/capisuite
pkgsysconfdir = @sysconfdir@/capisuite
docdir = @docdir@
doc_DATA = COPYING NEWS README
EXTRA_DIST = rc.capisuite.in capisuite.spec capisuite.cronin
SUBDIRS = src scripts docs
all: capisuite.cron rc.capisuite
capisuite.cron: capisuite.cronin
rm -f $@
sed -e 's,@pkgsysconfdir\@,$(pkgsysconfdir),g' \
-e 's,@spooldir\@,$(spooldir),g' $< >$@
chmod a+x $@
rc.capisuite: rc.capisuite.in
rm -f $@
sed -e 's,@pkgsysconfdir\@,$(pkgsysconfdir),g' \
-e 's,@bindir\@,$(bindir),g' $< >$@
chmod a+x $@
clean-local:
rm -f rc.capisuite capisuite.cron

103
NEWS

@ -0,0 +1,103 @@
0.01 (tag CAPISUITE_001):
=========================
* changed name from CapiCom to CapiSuite (name conflict with MS crypto API)
* added doxygen-created documentation for classes and python exported functions
* get_DTMF() was renamed to read_DTMF() and can wait for DTMF now
* connect_telephony() renamed to connect_voice()
0.02 (tag CAPISUITE_002):
=========================
* many bug fixes as usual (SEGV, ...)
* service constants SERVICE_VOICE, SERVICE_FAXG3 and SERVICE_OTHER
available in python now, no need to use CIP values any more
* audio_send and audio_receive return length in seconds now
* added support for idle script which can initiate outgoing calls
0.03 (tag CAPISUITE_003):
=========================
* improvement in idle script handling, own class for it (IdleScript)
* new classes for Python script handling (PythonScript) and derived classes
(IncomingScript & IdleScript)
* new python functions call_voice and call_faxG3 to initiate outgoing calls
* changed python exception handling to allow multiple calls in one script to be
handled correctly
* python functions disconnect() and reject() wait for complete disconnection and
return the disconnect cause now
* assure nice disconnection in any error case (hopefully)
* when error occured in script, physical connection is finished immediately leading
to an error visible at the sending side (e.g. when using the fax protocol)
* cleaned up python reference counting and threads, no known memory leaks any more
* many changes to support outgoing calls (new module, many small changes)
* Connection objects will be destroyed by application level now so dangling pointers
are avoided
* exception handling generally improved
0.1 (tag CAPISUITE_01):
=======================
* "make install" and "make dist" work now, use config.h
* added main docu page for doxygen
* added capisuitefax-script (command line tool for sending faxes)
* added support for sending faxes in idle.py
* added support for "capisuite.conf" (global configuration file)
* capisuite can write its output to logfiles now
* faxsend module added, new python function fax_send()
* idle script will be disabled after 10 subsequent errors
* B3 disconnect cause now returned by disconnect() python function
0.2 (tag CAPISUITE_02):
=======================
* log improvements: log-level configurable (see capisuite.conf), appending log-file instead of re-creating
* configure allows to set docdir with --with-docdir
* CapiSuite can be finished using Ctrl-C and SIGTERM nicely
* very limited support for reload (kill -1) - only re-activates de-actived idle script yet,
no reload of configuration
* all configuration for the scripts put in own config file
* support for various new configuration options, multi-user-ready scripts (different user dirs in spool_dir/users)
* audio_receive does truncate recorded silence away
* remote inquiry supports recording of own announcement
* commandline option "-d" runs CapiSuite as daemon
* new python commands: capisuite.log and capisuite.error let scripts write messages to the CapiSuite log
and error log
0.2.1 (tag CAPISUITE_021):
==========================
* many document improvements (new DocBook manual)
0.3 (tag CAPISUITE_03):
=======================
* split up script configuration in two files (anwering machine, fax),
some new features configurable now (e.g. actions)
0.3.1 (tag CAPISUITE_031):
==========================
* dist: included spec and init file in CVS and dist
* scripts: use different sendqueues for each user
* core: fixed some bugs:
- capisuite.error() didn't work,
- logging in outgoing connections didn't work
- callingParty wasn't set correctly
* scripts: answering machine switches to fax when incoming service indicator says fax
* scripts: sayNumber can now handle all number from 0 to 99, so all dates and times are
now said nearly correctly for the remote inquiry
* scripts: fixed a typo in incoming.py
* docs: added ISDN/CAPI error codes to manual
0.3.2 (tag CAPISUITE_032):
==========================
* core: finally got rid of the CommonC++ library:
- threading implemented using native pthread_* calls
- rewritten CapiSuite::parseConfigFile() to use STL string routines
- changed Connection class to use pthread_mutex_*
* scripts: fixed bug which lead to hanging processes of externally started
progs like sendmail
* scripts: minor fixes
0.4 (tag CAPISUITE_04):
=======================
* added cron script for cleaning up spool dirs
* fixed bug in rc.capisuite (was also started when not configured)
* scripts: remote inquiry supports new and old messages now
* scripts: capisuitefax can show sendqueue and delete jobs now

@ -0,0 +1,6 @@
CapiSuite
=========
For the documentation see the created HTML documents
situated in docs/manual/index.html or in the installed version see
PREFIX/share/doc/capisuite/manual/index.html

24
TODO

@ -0,0 +1,24 @@
CRITICAL:
- finish manual.docbook, provide simple examples
- somewhere there's a bad thing (tm) which holds the python global lock
despite it mustn't (try incoming + outgoing call at the same time,
idlescript will stop working sometime...)
IMPORTANT:
- fax headline
NICE:
- ?valgrind-clean the used libs and Python?
- support more than one send_controller
- don't use 34xx codes, define constants instead and print meaningful messages
- include email account check in idly.py
- add docbook -> html to Makefile.am
- any solution for sending fax when having no fax config?
FUTURE PLANS:
- setuid away from root (problem: chown of recorded file to user)
- log syntax errors in scripts, too
- PyRun_SimpleFile must be replaced by PyRun_File for this IMHO
- test-implement the whole application part in Python
- rewrite capisuitefax and idle.py to use named socket communication

@ -0,0 +1,98 @@
#
# Autoconf macros for configuring the build of Python extension modules
#
# $Header: /root/cvs2svn/capisuite/capisuite/acinclude.m4,v 1.1 2003/02/19 08:19:52 gernot Exp $
#
# taken out of Postgres CVS by Gernot Hillier
#
# CS_SET_DOCDIR
# -------------
# Set the name of the docdir to the given value. This is not nice, but I
# found no other name to do it than with AC_ARG_WITH. Please tell me if
# you have better ideas...
AC_DEFUN(CS_SET_DOCDIR,
[AC_ARG_WITH(docdir,
AC_HELP_STRING([--with-docdir=DOCDIR],
[use DOCDIR to install documentation to (default is PREFIX/share/doc/capisuite)]),
docdir=$withval, docdir=$datadir/doc/capisuite)
AC_SUBST(docdir)
])
# PGAC_CHECK_PYTHON_DIRS
# -----------------------
# Determine the name of various directory of a given Python installation.
AC_DEFUN([PGAC_CHECK_PYTHON_DIRS],
[AC_REQUIRE([AM_PATH_PYTHON])
AC_MSG_CHECKING([Python installation directories])
python_version=`${PYTHON} -c "import sys; print sys.version[[:3]]"`
python_prefix=`${PYTHON} -c "import sys; print sys.prefix"`
python_execprefix=`${PYTHON} -c "import sys; print sys.exec_prefix"`
python_libdir=`${PYTHON} -c "from distutils import sysconfig; print sysconfig.get_python_lib(1,1)"`
python_configdir="${python_libdir}/config"
python_moduledir="${python_libdir}/site-packages"
python_moduleexecdir="${python_libdir}/site-packages"
python_includespec="-I${python_prefix}/include/python${python_version}"
python_linkforshared=`${PYTHON} -c "import distutils.sysconfig; print distutils.sysconfig.get_config_var('LINKFORSHARED')"`
if test "$python_prefix" != "$python_execprefix"; then
python_includespec="-I${python_execprefix}/include/python${python_version} $python_includespec"
fi
AC_SUBST(python_version)[]dnl
AC_SUBST(python_prefix)[]dnl
AC_SUBST(python_execprefix)[]dnl
AC_SUBST(python_configdir)[]dnl
AC_SUBST(python_moduledir)[]dnl
AC_SUBST(python_moduleexecdir)[]dnl
AC_SUBST(python_includespec)[]dnl
AC_SUBST(python_linkforshared)[]dnl
# This should be enough of a message.
if test "$python_prefix" != "$python_execprefix"; then
AC_MSG_RESULT([$python_libdir and $python_execprefix])
else
AC_MSG_RESULT([$python_libdir])
fi
])# _PGAC_CHECK_PYTHON_DIRS
# PGAC_CHECK_PYTHON_MODULE_SETUP
# ------------------------------
# Finds things required to build a Python extension module.
# This used to do more, that's why it's separate.
#
# It would be nice if we could check whether the current setup allows
# the build of the shared module. Future project.
AC_DEFUN([PGAC_CHECK_PYTHON_MODULE_SETUP],
[
AC_REQUIRE([PGAC_CHECK_PYTHON_DIRS])
])# PGAC_CHECK_PYTHON_MODULE_SETUP
# PGAC_CHECK_PYTHON_EMBED_SETUP
# -----------------------------
# Courtesy of the INN 2.3.1 package...
AC_DEFUN([PGAC_CHECK_PYTHON_EMBED_SETUP],
[AC_REQUIRE([PGAC_CHECK_PYTHON_DIRS])
AC_MSG_CHECKING([how to link an embedded Python application])
if test ! -f "$python_configdir/Makefile"; then
AC_MSG_RESULT(no)
AC_MSG_ERROR([Python Makefile not found])
fi
_python_libs=`grep '^LIBS=' $python_configdir/Makefile | sed 's/^.*=//'`
_python_libc=`grep '^LIBC=' $python_configdir/Makefile | sed 's/^.*=//'`
_python_libm=`grep '^LIBM=' $python_configdir/Makefile | sed 's/^.*=//'`
_python_liblocalmod=`grep '^LOCALMODLIBS=' $python_configdir/Makefile | sed 's/^.*=//'`
_python_libbasemod=`grep '^BASEMODLIBS=' $python_configdir/Makefile | sed 's/^.*=//'`
pgac_tab=" " # tab character
python_libspec=`echo X"$_python_libs $_python_libc $_python_libm -lpython$python_version $_python_liblocalmod $_python_libbasemod" | sed -e 's/^X//' -e "s/[[ $pgac_tab]][[ $pgac_tab]]*/ /g"`
LIBS="$LIBS $python_libspec"
LDFLAGS="$LDFLAGS -L$python_configdir $python_linkforshared"
AC_MSG_RESULT([${python_libspec}])
AC_SUBST(LIBS)[]dnl
AC_SUBST(LDFLAGS)
])# PGAC_CHECK_PYTHON_EMBED_SETUP

@ -0,0 +1,38 @@
#!/bin/sh
#
# capisuite. CapiSuite cleanup script, should be run regularly
# by cron. It's only useful for the default scripts provided
# with CapiSuite.
#
# It will read a central configuration file placed in
# /etc/capisuite/cronjob.conf where you must define a variable
# called MAX_DAYS which defines how many days a received or sent
# file may stay in the spool dirs.
#
# Author: Gernot Hillier <gernot@hillier.de>
#
#
# paranoia settings
#
umask 022
PATH=/sbin:/bin:/usr/sbin:/usr/bin
export PATH
# do nothing if there is no global config
test -r @pkgsysconfdir@/cronjob.conf || exit
for i in @spooldir@/users/*/received @spooldir@/done @spooldir@/failed; do
# reset defaults
test -r @pkgsysconfdir@/cronjob.conf && . @pkgsysconfdir@/cronjob.conf
# user can overwrite default values
test -r $i/cronjob.conf && . $i/cronjob.conf
test "$MAX_DAYS" -gt 0 2> /dev/null || continue
find $i/. -name "*fax-[0-9]*.*" ! -type d ! -type s -atime +$MAX_DAYS -exec rm {} \;
find $i/. -name "*voice-[0-9]*.*" ! -type d ! -type s -atime +$MAX_DAYS -exec rm {} \;
done;
exit 0

@ -0,0 +1,72 @@
#
# spec file for package capisuite
#
# Author: Gernot Hillier <gernot@hillier.de>
#
# This spec file was developed for the use with SuSE Linux. But it
# should also work for any other distribution with slight changes.
# If you created your own RPM, please tell me and I'll happily include
# the spec or a link to your RPM on the homepage.
# neededforbuild capi4linux gcc-c++ libstdc++-devel libxml2-devel python python-devel
Name: capisuite
License: GPL
Group: Applications/Communications
Autoreqprov: on
Version: 0.3
Release: 0
Requires: sfftobmp sox
Summary: capisuite
Source0: capisuite-%{version}.tar.gz
Source1: rc.capisuite
Url: http://www.capisuite.de
BuildRoot: %{_tmppath}/%{name}-%{version}-build
PreReq: %insserv_prereq
%description
CapiSuite is a ISDN telecommunication suite providing easy to use
telecommunication functions which can be controlled from Python scripts.
It uses a CAPI-compatible driver for accessing the ISDN-hardware, so you'll
need a Eicon or AVM card with the according driver.
CapiSuite is distributed with two example scripts for call incoming handling
and fax sending. See /usr/share/capisuite/scripts and
/usr/share/doc/packages/capisuite for further information.
Authors:
--------
Gernot Hillier
%prep
%setup
./configure --prefix=/usr --sysconfdir=/etc --localstatedir=/var --with-docdir=/usr/share/doc/packages/capisuite
%build
make
%install
make DESTDIR=$RPM_BUILD_ROOT install
mkdir -p $RPM_BUILD_ROOT/etc/init.d
mkdir -p $RPM_BUILD_ROOT/usr/sbin
install -g root -m 755 -o root %{SOURCE1} $RPM_BUILD_ROOT/etc/init.d/capisuite
ln -sf ../../etc/init.d/capisuite $RPM_BUILD_ROOT/usr/sbin/rccapisuite
%clean
rm -rf $RPM_BUILD_ROOT
%files
%config /etc/capisuite/capisuite.conf
%config /etc/capisuite/fax.conf
%config /etc/capisuite/answering_machine.conf
/usr/bin/capisuite
/usr/bin/capisuitefax
%doc /usr/share/doc/packages/capisuite
/usr/share/capisuite
/usr/lib/capisuite
/var/spool/capisuite
/usr/%{_lib}/python2.2/site-packages/cs_helpers.py
/etc/init.d/capisuite
/usr/sbin/rccapisuite

@ -0,0 +1,26 @@
AC_INIT(src/main.cpp)
AM_INIT_AUTOMAKE(capisuite,0.4)
AM_CONFIG_HEADER(config.h)
AC_LANG_CPLUSPLUS
AC_PROG_CC
AC_PROG_CXX
AC_PROG_INSTALL
AC_PROG_RANLIB
AC_PROG_MAKE_SET
AC_PATH_PROG(doxygen,doxygen)
dnl suggested by autoscan:
AC_CHECK_FUNCS([gettimeofday])
AC_CHECK_HEADERS([sys/time.h])
AC_HEADER_TIME
CS_SET_DOCDIR
AC_CHECK_LIB(capi20,capi20_register,,AC_MSG_ERROR(libcapi20 not found))
AC_CHECK_LIB(pthread,pthread_create,,AC_MSG_ERROR(libpthread not found))
AM_PATH_PYTHON(2.2)
PGAC_CHECK_PYTHON_EMBED_SETUP
CPPFLAGS='-DLOCALSTATEDIR=\"$(localstatedir)\" -DPKGDATADIR=\"$(pkgdatadir)\" -DPKGSYSCONFDIR=\"$(sysconfdir)/capisuite\" -DPKGLIBDIR=\"$(pkglibdir)\" $(python_includespec)'
AC_OUTPUT(Makefile src/Makefile src/backend/Makefile src/modules/Makefile src/application/Makefile scripts/Makefile scripts/waves/Makefile docs/Makefile)

@ -0,0 +1,9 @@
reference
reference/*
manual
manual/*
susebuch
susebuch/*
Doxyfile
Makefile
Makefile.in

@ -0,0 +1,969 @@
# Doxyfile 1.2.17
# This file describes the settings to be used by the documentation system
# doxygen (www.doxygen.org) for a project
#
# All text after a hash (#) is considered a comment and will be ignored
# The format is:
# TAG = value [value, ...]
# For lists items can also be appended using:
# TAG += value [value, ...]
# Values that contain spaces should be placed between quotes (" ")
#---------------------------------------------------------------------------
# General configuration options
#---------------------------------------------------------------------------
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
# by quotes) that should identify the project.
PROJECT_NAME = CapiSuite
# The PROJECT_NUMBER tag can be used to enter a project or revision number.
# This could be handy for archiving the generated documentation or
# if some version control system is used.
PROJECT_NUMBER = @version@
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
# base path where the generated documentation will be put.
# If a relative path is entered, it will be relative to the location
# where doxygen was started. If left blank the current directory will be used.
OUTPUT_DIRECTORY = .
# The OUTPUT_LANGUAGE tag is used to specify the language in which all
# documentation generated by doxygen is written. Doxygen will use this
# information to generate all constant output in the proper language.
# The default language is English, other supported languages are:
# Brazilian, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch,
# Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en
# (Japanese with english messages), Korean, Norwegian, Polish, Portuguese,
# Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish and Ukrainian.
OUTPUT_LANGUAGE = English
# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
# documentation are documented, even if no documentation was available.
# Private class members and static file members will be hidden unless
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
EXTRACT_ALL = NO
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
# will be included in the documentation.
EXTRACT_PRIVATE = YES
# If the EXTRACT_STATIC tag is set to YES all static members of a file
# will be included in the documentation.
EXTRACT_STATIC = YES
# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
# defined locally in source files will be included in the documentation.
# If set to NO only classes defined in header files are included.
EXTRACT_LOCAL_CLASSES = NO
# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
# undocumented members of documented classes, files or namespaces.
# If set to NO (the default) these members will be included in the
# various overviews, but no documentation section is generated.
# This option has no effect if EXTRACT_ALL is enabled.
HIDE_UNDOC_MEMBERS = NO
# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
# undocumented classes that are normally visible in the class hierarchy.
# If set to NO (the default) these class will be included in the various
# overviews. This option has no effect if EXTRACT_ALL is enabled.
HIDE_UNDOC_CLASSES = NO
# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
# include brief member descriptions after the members that are listed in
# the file and class documentation (similar to JavaDoc).
# Set to NO to disable this.
BRIEF_MEMBER_DESC = YES
# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
# the brief description of a member or function before the detailed description.
# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
# brief descriptions will be completely suppressed.
REPEAT_BRIEF = YES
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
# Doxygen will generate a detailed section even if there is only a brief
# description.
ALWAYS_DETAILED_SEC = YES
# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited
# members of a class in the documentation of that class as if those members were
# ordinary class members. Constructors, destructors and assignment operators of
# the base classes will not be shown.
INLINE_INHERITED_MEMB = NO
# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
# path before files name in the file list and in the header files. If set
# to NO the shortest path that makes the file name unique will be used.
FULL_PATH_NAMES = NO
# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
# can be used to strip a user defined part of the path. Stripping is
# only done if one of the specified strings matches the left-hand part of
# the path. It is allowed to use relative paths in the argument list.
STRIP_FROM_PATH =
# The INTERNAL_DOCS tag determines if documentation
# that is typed after a \internal command is included. If the tag is set
# to NO (the default) then the documentation will be excluded.
# Set it to YES to include the internal documentation.
INTERNAL_DOCS = NO
# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
# doxygen to hide any special comment blocks from generated source code
# fragments. Normal C and C++ comments will always remain visible.
STRIP_CODE_COMMENTS = YES
# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
# file names in lower case letters. If set to YES upper case letters are also
# allowed. This is useful if you have classes or files whose names only differ
# in case and if your file system supports case sensitive file names. Windows
# users are adviced to set this option to NO.
CASE_SENSE_NAMES = YES
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
# (but less readable) file names. This can be useful is your file systems
# doesn't support long names like on DOS, Mac, or CD-ROM.
SHORT_NAMES = NO
# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
# will show members with their full class and namespace scopes in the
# documentation. If set to YES the scope will be hidden.
HIDE_SCOPE_NAMES = NO
# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
# will generate a verbatim copy of the header file for each class for
# which an include is specified. Set to NO to disable this.
VERBATIM_HEADERS = YES
# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
# will put list of the files that are included by a file in the documentation
# of that file.
SHOW_INCLUDE_FILES = YES
# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
# will interpret the first line (until the first dot) of a JavaDoc-style
# comment as the brief description. If set to NO, the JavaDoc
# comments will behave just like the Qt-style comments (thus requiring an
# explict @brief command for a brief description.
JAVADOC_AUTOBRIEF = NO
# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
# treat a multi-line C++ special comment block (i.e. a block of //! or ///
# comments) as a brief description. This used to be the default behaviour.
# The new default is to treat a multi-line C++ comment block as a detailed
# description. Set this tag to YES if you prefer the old behaviour instead.
MULTILINE_CPP_IS_BRIEF = NO
# If the DETAILS_AT_TOP tag is set to YES then Doxygen
# will output the detailed description near the top, like JavaDoc.
# If set to NO, the detailed description appears after the member
# documentation.
DETAILS_AT_TOP = NO
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
# member inherits the documentation from any documented member that it
# reimplements.
INHERIT_DOCS = YES
# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
# is inserted in the documentation for inline members.
INLINE_INFO = YES
# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
# will sort the (detailed) documentation of file and class members
# alphabetically by member name. If set to NO the members will appear in
# declaration order.
SORT_MEMBER_DOCS = YES
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
# tag is set to YES, then doxygen will reuse the documentation of the first
# member in the group (if any) for the other members of the group. By default
# all members of a group must be documented explicitly.
DISTRIBUTE_GROUP_DOC = NO
# The TAB_SIZE tag can be used to set the number of spaces in a tab.
# Doxygen uses this value to replace tabs by spaces in code fragments.
TAB_SIZE = 8
# The GENERATE_TODOLIST tag can be used to enable (YES) or
# disable (NO) the todo list. This list is created by putting \todo
# commands in the documentation.
GENERATE_TODOLIST = YES
# The GENERATE_TESTLIST tag can be used to enable (YES) or
# disable (NO) the test list. This list is created by putting \test
# commands in the documentation.
GENERATE_TESTLIST = YES
# The GENERATE_BUGLIST tag can be used to enable (YES) or
# disable (NO) the bug list. This list is created by putting \bug
# commands in the documentation.
GENERATE_BUGLIST = YES
# This tag can be used to specify a number of aliases that acts
# as commands in the documentation. An alias has the form "name=value".
# For example adding "sideeffect=\par Side Effects:\n" will allow you to
# put the command \sideeffect (or @sideeffect) in the documentation, which
# will result in a user defined paragraph with heading "Side Effects:".
# You can put \n's in the value part of an alias to insert newlines.
ALIASES =
# The ENABLED_SECTIONS tag can be used to enable conditional
# documentation sections, marked by \if sectionname ... \endif.
ENABLED_SECTIONS =
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
# the initial value of a variable or define consist of for it to appear in
# the documentation. If the initializer consists of more lines than specified
# here it will be hidden. Use a value of 0 to hide initializers completely.
# The appearance of the initializer of individual variables and defines in the
# documentation can be controlled using \showinitializer or \hideinitializer
# command in the documentation regardless of this setting.
MAX_INITIALIZER_LINES = 30
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
# only. Doxygen will then generate output that is more tailored for C.
# For instance some of the names that are used will be different. The list
# of all members will be omitted, etc.
OPTIMIZE_OUTPUT_FOR_C = NO
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources
# only. Doxygen will then generate output that is more tailored for Java.
# For instance namespaces will be presented as packages, qualified scopes
# will look different, etc.
OPTIMIZE_OUTPUT_JAVA = NO
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
# at the bottom of the documentation of classes and structs. If set to YES the
# list will mention the files that were used to generate the documentation.
SHOW_USED_FILES = YES
#---------------------------------------------------------------------------
# configuration options related to warning and progress messages
#---------------------------------------------------------------------------
# The QUIET tag can be used to turn on/off the messages that are generated
# by doxygen. Possible values are YES and NO. If left blank NO is used.
QUIET = NO
# The WARNINGS tag can be used to turn on/off the warning messages that are
# generated by doxygen. Possible values are YES and NO. If left blank
# NO is used.
WARNINGS = YES
# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
# automatically be disabled.
WARN_IF_UNDOCUMENTED = YES
# The WARN_FORMAT tag determines the format of the warning messages that
# doxygen can produce. The string should contain the $file, $line, and $text
# tags, which will be replaced by the file and line number from which the
# warning originated and the warning text.
WARN_FORMAT = "$file:$line: $text"
# The WARN_LOGFILE tag can be used to specify a file to which warning
# and error messages should be written. If left blank the output is written
# to stderr.
WARN_LOGFILE =
#---------------------------------------------------------------------------
# configuration options related to the input files
#---------------------------------------------------------------------------
# The INPUT tag can be used to specify the files and/or directories that contain
# documented source files. You may enter file names like "myfile.cpp" or
# directories like "/usr/src/myproject". Separate the files or directories
# with spaces.
INPUT = @capisuite_sources@ @srcdir@
# If the value of the INPUT tag contains directories, you can use the
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
# and *.h) to filter out the source-files in the directories. If left
# blank the following patterns are tested:
# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp
# *.h++ *.idl *.odl
FILE_PATTERNS = *.cpp *.h *.doxy
# The RECURSIVE tag can be used to turn specify whether or not subdirectories
# should be searched for input files as well. Possible values are YES and NO.
# If left blank NO is used.
RECURSIVE = YES
# The EXCLUDE tag can be used to specify files and/or directories that should
# excluded from the INPUT source files. This way you can easily exclude a
# subdirectory from a directory tree whose root is specified with the INPUT tag.
EXCLUDE =
# The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories
# that are symbolic links (a Unix filesystem feature) are excluded from the input.
EXCLUDE_SYMLINKS = NO
# If the value of the INPUT tag contains directories, you can use the
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
# certain files from those directories.
EXCLUDE_PATTERNS =
# The EXAMPLE_PATH tag can be used to specify one or more files or
# directories that contain example code fragments that are included (see
# the \include command).
EXAMPLE_PATH =
# If the value of the EXAMPLE_PATH tag contains directories, you can use the
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
# and *.h) to filter out the source-files in the directories. If left
# blank all files are included.
EXAMPLE_PATTERNS =
# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
# searched for input files to be used with the \include or \dontinclude
# commands irrespective of the value of the RECURSIVE tag.
# Possible values are YES and NO. If left blank NO is used.
EXAMPLE_RECURSIVE = NO
# The IMAGE_PATH tag can be used to specify one or more files or
# directories that contain image that are included in the documentation (see
# the \image command).
IMAGE_PATH =
# The INPUT_FILTER tag can be used to specify a program that doxygen should
# invoke to filter for each input file. Doxygen will invoke the filter program
# by executing (via popen()) the command <filter> <input-file>, where <filter>
# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
# input file. Doxygen will then use the output that the filter program writes
# to standard output.
INPUT_FILTER =
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
# INPUT_FILTER) will be used to filter the input files when producing source
# files to browse.
FILTER_SOURCE_FILES = NO
#---------------------------------------------------------------------------
# configuration options related to source browsing
#---------------------------------------------------------------------------
# If the SOURCE_BROWSER tag is set to YES then a list of source files will
# be generated. Documented entities will be cross-referenced with these sources.
SOURCE_BROWSER = NO
# Setting the INLINE_SOURCES tag to YES will include the body
# of functions and classes directly in the documentation.
INLINE_SOURCES = NO
# If the REFERENCED_BY_RELATION tag is set to YES (the default)
# then for each documented function all documented
# functions referencing it will be listed.
REFERENCED_BY_RELATION = YES
# If the REFERENCES_RELATION tag is set to YES (the default)
# then for each documented function all documented entities
# called/used by that function will be listed.
REFERENCES_RELATION = YES
#---------------------------------------------------------------------------
# configuration options related to the alphabetical class index
#---------------------------------------------------------------------------
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
# of all compounds will be generated. Enable this if the project
# contains a lot of classes, structs, unions or interfaces.
ALPHABETICAL_INDEX = YES
# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
# in which this list will be split (can be a number in the range [1..20])
COLS_IN_ALPHA_INDEX = 5
# In case all classes in a project start with a common prefix, all
# classes will be put under the same header in the alphabetical index.
# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
# should be ignored while generating the index headers.
IGNORE_PREFIX =
#---------------------------------------------------------------------------
# configuration options related to the HTML output
#---------------------------------------------------------------------------
# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
# generate HTML output.
GENERATE_HTML = YES
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
# put in front of it. If left blank `html' will be used as the default path.
HTML_OUTPUT = reference
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
# doxygen will generate files with .html extension.
HTML_FILE_EXTENSION = .html
# The HTML_HEADER tag can be used to specify a personal HTML header for
# each generated HTML page. If it is left blank doxygen will generate a
# standard header.
HTML_HEADER =
# The HTML_FOOTER tag can be used to specify a personal HTML footer for
# each generated HTML page. If it is left blank doxygen will generate a
# standard footer.
HTML_FOOTER =
# The HTML_STYLESHEET tag can be used to specify a user defined cascading
# style sheet that is used by each HTML page. It can be used to
# fine-tune the look of the HTML output. If the tag is left blank doxygen
# will generate a default style sheet
HTML_STYLESHEET =
# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
# files or namespaces will be aligned in HTML using tables. If set to
# NO a bullet list will be used.
HTML_ALIGN_MEMBERS = YES
# If the GENERATE_HTMLHELP tag is set to YES, additional index files
# will be generated that can be used as input for tools like the
# Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
# of the generated HTML documentation.
GENERATE_HTMLHELP = NO
# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
# be used to specify the file name of the resulting .chm file. You
# can add a path in front of the file if the result should not be
# written to the html output dir.
CHM_FILE =
# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
# be used to specify the location (absolute path including file name) of
# the HTML help compiler (hhc.exe). If non empty doxygen will try to run
# the html help compiler on the generated index.hhp.
HHC_LOCATION =
# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
# controls if a separate .chi index file is generated (YES) or that
# it should be included in the master .chm file (NO).
GENERATE_CHI = NO
# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
# controls whether a binary table of contents is generated (YES) or a
# normal table of contents (NO) in the .chm file.
BINARY_TOC = NO
# The TOC_EXPAND flag can be set to YES to add extra items for group members
# to the contents of the Html help documentation and to the tree view.
TOC_EXPAND = NO
# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
# top of each HTML page. The value NO (the default) enables the index and
# the value YES disables it.
DISABLE_INDEX = NO
# This tag can be used to set the number of enum values (range [1..20])
# that doxygen will group on one line in the generated HTML documentation.
ENUM_VALUES_PER_LINE = 4
# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
# generated containing a tree-like index structure (just like the one that
# is generated for HTML Help). For this to work a browser that supports
# JavaScript and frames is required (for instance Mozilla, Netscape 4.0+,
# or Internet explorer 4.0+). Note that for large projects the tree generation
# can take a very long time. In such cases it is better to disable this feature.
# Windows users are probably better off using the HTML help feature.
GENERATE_TREEVIEW = NO
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
# used to set the initial width (in pixels) of the frame in which the tree
# is shown.
TREEVIEW_WIDTH = 250
#---------------------------------------------------------------------------
# configuration options related to the LaTeX output
#---------------------------------------------------------------------------
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
# generate Latex output.
GENERATE_LATEX = NO
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
# put in front of it. If left blank `latex' will be used as the default path.
LATEX_OUTPUT = latex
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be invoked. If left blank `latex' will be used as the default command name.
LATEX_CMD_NAME = latex
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
# generate index for LaTeX. If left blank `makeindex' will be used as the
# default command name.
MAKEINDEX_CMD_NAME = makeindex
# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
# LaTeX documents. This may be useful for small projects and may help to
# save some trees in general.
COMPACT_LATEX = NO
# The PAPER_TYPE tag can be used to set the paper type that is used
# by the printer. Possible values are: a4, a4wide, letter, legal and
# executive. If left blank a4wide will be used.
PAPER_TYPE = a4wide
# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
# packages that should be included in the LaTeX output.
EXTRA_PACKAGES =
# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
# the generated latex document. The header should contain everything until
# the first chapter. If it is left blank doxygen will generate a
# standard header. Notice: only use this tag if you know what you are doing!
LATEX_HEADER =
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
# is prepared for conversion to pdf (using ps2pdf). The pdf file will
# contain links (just like the HTML output) instead of page references
# This makes the output suitable for online browsing using a pdf viewer.
PDF_HYPERLINKS = YES
# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
# plain latex in the generated Makefile. Set this option to YES to get a
# higher quality PDF documentation.
USE_PDFLATEX = YES
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
# command to the generated LaTeX files. This will instruct LaTeX to keep
# running if errors occur, instead of asking the user for help.
# This option is also used when generating formulas in HTML.
LATEX_BATCHMODE = NO
#---------------------------------------------------------------------------
# configuration options related to the RTF output
#---------------------------------------------------------------------------
# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
# The RTF output is optimised for Word 97 and may not look very pretty with
# other RTF readers or editors.
GENERATE_RTF = NO
# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
# put in front of it. If left blank `rtf' will be used as the default path.
RTF_OUTPUT = rtf
# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
# RTF documents. This may be useful for small projects and may help to
# save some trees in general.
COMPACT_RTF = NO
# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
# will contain hyperlink fields. The RTF file will
# contain links (just like the HTML output) instead of page references.
# This makes the output suitable for online browsing using WORD or other
# programs which support those fields.
# Note: wordpad (write) and others do not support links.
RTF_HYPERLINKS = NO
# Load stylesheet definitions from file. Syntax is similar to doxygen's
# config file, i.e. a series of assigments. You only have to provide
# replacements, missing definitions are set to their default value.
RTF_STYLESHEET_FILE =
# Set optional variables used in the generation of an rtf document.
# Syntax is similar to doxygen's config file.
RTF_EXTENSIONS_FILE =
#---------------------------------------------------------------------------
# configuration options related to the man page output
#---------------------------------------------------------------------------
# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
# generate man pages
GENERATE_MAN = NO
# The MAN_OUTPUT tag is used to specify where the man pages will be put.
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
# put in front of it. If left blank `man' will be used as the default path.
MAN_OUTPUT = man
# The MAN_EXTENSION tag determines the extension that is added to
# the generated man pages (default is the subroutine's section .3)
MAN_EXTENSION = .3
# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
# then it will generate one additional man file for each entity
# documented in the real man page(s). These additional files
# only source the real man page, but without them the man command
# would be unable to find the correct page. The default is NO.
MAN_LINKS = NO
#---------------------------------------------------------------------------
# configuration options related to the XML output
#---------------------------------------------------------------------------
# If the GENERATE_XML tag is set to YES Doxygen will
# generate an XML file that captures the structure of
# the code including all documentation. Note that this
# feature is still experimental and incomplete at the
# moment.
GENERATE_XML = NO
#---------------------------------------------------------------------------
# configuration options for the AutoGen Definitions output
#---------------------------------------------------------------------------
# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
# generate an AutoGen Definitions (see autogen.sf.net) file
# that captures the structure of the code including all
# documentation. Note that this feature is still experimental
# and incomplete at the moment.
GENERATE_AUTOGEN_DEF = NO
#---------------------------------------------------------------------------
# Configuration options related to the preprocessor
#---------------------------------------------------------------------------
# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
# evaluate all C-preprocessor directives found in the sources and include
# files.
ENABLE_PREPROCESSING = YES
# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
# names in the source code. If set to NO (the default) only conditional
# compilation will be performed. Macro expansion can be done in a controlled
# way by setting EXPAND_ONLY_PREDEF to YES.
MACRO_EXPANSION = NO
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
# then the macro expansion is limited to the macros specified with the
# PREDEFINED and EXPAND_AS_PREDEFINED tags.
EXPAND_ONLY_PREDEF = NO
# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
# in the INCLUDE_PATH (see below) will be search if a #include is found.
SEARCH_INCLUDES = YES
# The INCLUDE_PATH tag can be used to specify one or more directories that
# contain include files that are not input files but should be processed by
# the preprocessor.
INCLUDE_PATH =
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
# patterns (like *.h and *.hpp) to filter out the header-files in the
# directories. If left blank, the patterns specified with FILE_PATTERNS will
# be used.
INCLUDE_FILE_PATTERNS =
# The PREDEFINED tag can be used to specify one or more macro names that
# are defined before the preprocessor is started (similar to the -D option of
# gcc). The argument of the tag is a list of macros of the form: name
# or name=definition (no spaces). If the definition and the = are
# omitted =1 is assumed.
PREDEFINED =
# If the MACRO_EXPANSION and EXPAND_PREDEF_ONLY tags are set to YES then
# this tag can be used to specify a list of macro names that should be expanded.
# The macro definition that is found in the sources will be used.
# Use the PREDEFINED tag if you want to use a different macro definition.
EXPAND_AS_DEFINED =
# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
# doxygen's preprocessor will remove all function-like macros that are alone
# on a line, have an all uppercase name, and do not end with a semicolon. Such
# function macros are typically used for boiler-plate code, and will confuse the
# parser if not removed.
SKIP_FUNCTION_MACROS = YES
#---------------------------------------------------------------------------
# Configuration::addtions related to external references
#---------------------------------------------------------------------------
# The TAGFILES tag can be used to specify one or more tagfiles.
TAGFILES =
# When a file name is specified after GENERATE_TAGFILE, doxygen will create
# a tag file that is based on the input files it reads.
GENERATE_TAGFILE =
# If the ALLEXTERNALS tag is set to YES all external classes will be listed
# in the class index. If set to NO only the inherited external classes
# will be listed.
ALLEXTERNALS = NO
# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
# in the modules index. If set to NO, only the current project's groups will
# be listed.
EXTERNAL_GROUPS = YES
# The PERL_PATH should be the absolute path and name of the perl script
# interpreter (i.e. the result of `which perl').
PERL_PATH = /usr/bin/perl
#---------------------------------------------------------------------------
# Configuration options related to the dot tool
#---------------------------------------------------------------------------
# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
# generate a inheritance diagram (in Html, RTF and LaTeX) for classes with base or
# super classes. Setting the tag to NO turns the diagrams off. Note that this
# option is superceded by the HAVE_DOT option below. This is only a fallback. It is
# recommended to install and use dot, since it yield more powerful graphs.
CLASS_DIAGRAMS = YES
# If set to YES, the inheritance and collaboration graphs will hide
# inheritance and usage relations if the target is undocumented
# or is not a class.
HIDE_UNDOC_RELATIONS = YES
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
# available from the path. This tool is part of Graphviz, a graph visualization
# toolkit from AT&T and Lucent Bell Labs. The other options in this section
# have no effect if this option is set to NO (the default)
HAVE_DOT = NO
# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
# will generate a graph for each documented class showing the direct and
# indirect inheritance relations. Setting this tag to YES will force the
# the CLASS_DIAGRAMS tag to NO.
CLASS_GRAPH = YES
# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
# will generate a graph for each documented class showing the direct and
# indirect implementation dependencies (inheritance, containment, and
# class references variables) of the class with other documented classes.
COLLABORATION_GRAPH = YES
# If set to YES, the inheritance and collaboration graphs will show the
# relations between templates and their instances.
TEMPLATE_RELATIONS = YES
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
# tags are set to YES then doxygen will generate a graph for each documented
# file showing the direct and indirect include dependencies of the file with
# other documented files.
INCLUDE_GRAPH = YES
# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
# documented header file showing the documented files that directly or
# indirectly include this file.
INCLUDED_BY_GRAPH = YES
# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
# will graphical hierarchy of all classes instead of a textual one.
GRAPHICAL_HIERARCHY = YES
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
# generated by dot. Possible values are png, jpg, or gif
# If left blank png will be used.
DOT_IMAGE_FORMAT = png
# The tag DOT_PATH can be used to specify the path where the dot tool can be
# found. If left blank, it is assumed the dot tool can be found on the path.
DOT_PATH =
# The DOTFILE_DIRS tag can be used to specify one or more directories that
# contain dot files that are included in the documentation (see the
# \dotfile command).
DOTFILE_DIRS =
# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
# (in pixels) of the graphs generated by dot. If a graph becomes larger than
# this value, doxygen will try to truncate the graph, so that it fits within
# the specified constraint. Beware that most browsers cannot cope with very
# large images.
MAX_DOT_GRAPH_WIDTH = 1024
# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
# (in pixels) of the graphs generated by dot. If a graph becomes larger than
# this value, doxygen will try to truncate the graph, so that it fits within
# the specified constraint. Beware that most browsers cannot cope with very
# large images.
MAX_DOT_GRAPH_HEIGHT = 1024
# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
# generate a legend page explaining the meaning of the various boxes and
# arrows in the dot generated graphs.
GENERATE_LEGEND = YES
# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
# remove the intermedate dot files that are used to generate
# the various graphs.
DOT_CLEANUP = YES
#---------------------------------------------------------------------------
# Configuration::addtions related to the search engine
#---------------------------------------------------------------------------
# The SEARCHENGINE tag specifies whether or not a search engine should be
# used. If set to NO the values of all tags below this one will be ignored.
SEARCHENGINE = NO
# The CGI_NAME tag should be the name of the CGI script that
# starts the search engine (doxysearch) with the correct parameters.
# A script with this name will be generated by doxygen.
CGI_NAME = search.cgi
# The CGI_URL tag should be the absolute URL to the directory where the
# cgi binaries are located. See the documentation of your http daemon for
# details.
CGI_URL =
# The DOC_URL tag should be the absolute URL to the directory where the
# documentation is located. If left blank the absolute path to the
# documentation, with file:// prepended to it, will be used.
DOC_URL =
# The DOC_ABSPATH tag should be the absolute path to the directory where the
# documentation is located. If left blank the directory on the local machine
# will be used.
DOC_ABSPATH =
# The BIN_ABSPATH tag must point to the directory where the doxysearch binary
# is installed.
BIN_ABSPATH = /usr/local/bin/
# The EXT_DOC_PATHS tag can be used to specify one or more paths to
# documentation generated for other projects. This allows doxysearch to search
# the documentation for these projects as well.
EXT_DOC_PATHS =

@ -0,0 +1,41 @@
docdir = @docdir@
EXTRA_DIST = Doxyfile.in mainpage.doxy manual.docbook manual.README
all: docs
docs: Doxyfile
if test "x$(doxygen)" != "x"; then \
$(doxygen) Doxyfile ;\
fi
dist-hook: Doxyfile
$(doxygen) Doxyfile
mkdir $(distdir)/reference
cp $(srcdir)/reference/* $(distdir)/reference/
mkdir $(distdir)/manual
cp $(srcdir)/manual/* $(distdir)/manual/
Doxyfile: Doxyfile.in
sed -e 's,@version\@,$(VERSION),g' \
-e 's,@capisuite_sources\@,$(top_srcdir)/src,g' \
-e 's,@srcdir\@,$(srcdir),g' $< >$@
install-data-local:
$(mkinstalldirs) $(DESTDIR)$(docdir)/reference ; \
(cd reference; for i in *; do \
$(INSTALL_DATA) $$i $(DESTDIR)$(docdir)/reference/$$i ;\
done;)
$(mkinstalldirs) $(DESTDIR)$(docdir)/manual ; \
(cd manual; for i in *; do \
$(INSTALL_DATA) $$i $(DESTDIR)$(docdir)/manual/$$i ;\
done;)
uninstall-local:
rm -rf $(DESTDIR)$(docdir)
clean-local:
rm -f Doxyfile
maintainer-clean-local:
rm -rf reference manual;

@ -0,0 +1,11 @@
/** @mainpage %CapiSuite Documentation
This is the reference manual describing the internal structures of %CapiSuite. If you're interested in developing,
you're right here.
@htmlonly
If you "just" want to use it, please refer to <a href="../manual/index.html">../manual/index.html</a>.
@endhtmlonly
Thx!
@author Gernot Hillier <gernot@hillier.de>
*/

@ -0,0 +1,22 @@
The CapiSuite manual is written in the DocBook format. Only
read on if you want to change it. You'll need some knowledge
of DocBook and the appropriate tools for that.
Otherwise just use the prepared HTML documentation which
will be installed in your doc_dir when you do "make install".
Have a look into /usr/local/share/doc/capisuite/manual/
after the installation and please READ it. :-)
------ Only experts read on here, please ------
You can create HTML pages by using tools like xsltproc and
the DocBook stylesheets of Norman Walsh.
An example of how to call xsltproc:
xsltproc -o manual/ /usr/share/sgml/docbook/docbook-xsl-stylesheets/xhtml/chunk.xsl manual.docbook
To validate the document, use e.g. xmllint:
xmllint --noout --valid manual.docbook

File diff suppressed because it is too large Load Diff

@ -0,0 +1,180 @@
#! /bin/bash
# Copyright (c) 1995-2002 SuSE Linux AG, Nuernberg, Germany.
# All rights reserved.
#
# Author: Kurt Garloff <feedback@suse.de>, Gernot Hillier <gernot@hillier.de>
#
# This file was written for the use with SuSE Linux, but it should
# (hopefully) work for any other LSB compliant distribution. If you need to
# modify it, I'll welcome your feedback. TIA!
#
# /etc/init.d/capisuite
# and its symbolic link
# /usr/sbin/rccapisuite
#
# system startup script for the CapiSuite daemon
#
# LSB compatible service control script; see http://www.linuxbase.org/spec/
#
### BEGIN INIT INFO
# Provides: capisuite
# Required-Start: $syslog $remote_fs isdn
# X-UnitedLinux-Should-Start: $time ypbind sendmail
# Required-Stop: $syslog $remote_fs isdn
# X-UnitedLinux-Should-Stop: $time ypbind sendmail
# Default-Start: 3 5
# Default-Stop: 0 1 2 6
# Short-Description: CapiSuite daemon providing ISDN fax and voice services
# Description: Start CapiSuite to use the default scripts included
# for the ISDN fax and answering machine. It tests for configured
# fax and answering machine users so please modify if you want
# to use your own scripts!
### END INIT INFO
#
# Check for missing binaries (stale symlinks should not happen)
CAPISUITE_BIN=@bindir@/capisuite
test -x $CAPISUITE_BIN || exit 5
# Check for existence of needed config file and read it
CAPISUITE_CONFIG=@pkgsysconfdir@/capisuite.conf
test -r $CAPISUITE_CONFIG || exit 6
# Shell functions sourced from /etc/rc.status:
# rc_check check and set local and overall rc status
# rc_status check and set local and overall rc status
# rc_status -v ditto but be verbose in local rc status
# rc_status -v -r ditto and clear the local rc status
# rc_status -s display "skipped" and exit with status 3
# rc_status -u display "unused" and exit with status 3
# rc_failed set local and overall rc status to failed
# rc_failed <num> set local and overall rc status to <num>
# rc_reset clear local rc status (overall remains)
# rc_exit exit appropriate to overall rc status
# rc_active checks whether a service is activated by symlinks
# rc_splash arg sets the boot splash screen to arg (if active)
. /etc/rc.status
# Reset status of this service
rc_reset
# Return values acc. to LSB for all commands but status:
# 0 - success
# 1 - generic or unspecified error
# 2 - invalid or excess argument(s)
# 3 - unimplemented feature (e.g. "reload")
# 4 - user had insufficient privileges
# 5 - program is not installed
# 6 - program is not configured
# 7 - program is not running
# 8--199 - reserved (8--99 LSB, 100--149 distrib, 150--199 appl)
#
# Note that starting an already running service, stopping
# or restarting a not-running service as well as the restart
# with force-reload (in case signaling is not supported) are
# considered a success.
case "$1" in
start)
echo -n "Starting CapiSuite "
configured=yes
# Check if there are configured users for fax or
# answering machine. Otherwise exit.
# IMPORTANT: Change this or comment it out if you want to use
# your own CapiSuite scripts.
while read -r sec rest ; do
if [ "${sec:0:1}" = "[" -a "$sec" != "[GLOBAL]" ]; then
configured_fax=yes
break
fi
done < <(cat @pkgsysconfdir@/fax.conf)
while read -r sec rest ; do
if [ "${sec:0:1}" = "[" -a "$sec" != "[GLOBAL]" ]; then
configured_voice=yes
break
fi
done < <(cat @pkgsysconfdir@/answering_machine.conf)
test "$configured_fax" -o "$configured_voice" || configured=no
# end check for configured users
## Start daemon with startproc(8). If this fails
## the return value is set appropriately by startproc.
if [ $configured = "yes" ]; then
startproc $CAPISUITE_BIN -d
else
rc_failed 6
fi
# Remember status and be verbose
rc_status -v
;;
stop)
echo -n "Shutting down CapiSuite "
## Stop daemon with killproc(8) and if this fails
## killproc sets the return value according to LSB.
killproc -TERM $CAPISUITE_BIN
# Remember status and be verbose
rc_status -v
;;
try-restart)
## Do a restart only if the service was active before.
## Note: try-restart is not (yet) part of LSB (as of 1.2)