Adjusted docbook paths.

Paths may be Debian specific.
This commit is contained in:
Lars Immisch 2012-03-07 11:28:33 +01:00
parent 86bb0773b4
commit 786e54a23a
6 changed files with 758 additions and 578 deletions

View File

@ -30,17 +30,17 @@ manual-de-prepare:
manual-de.docbook > manual-de.docbook.new
mv manual-de.docbook.new manual-de.docbook
xmllint --noout --valid manual-de.docbook
manual-html: manual.docbook
xsltproc --stringparam profile.condition html -o manual-profiled.docbook \
/usr/share/xml/docbook/stylesheet/nwalsh/current/profiling/profile.xsl \
/usr/share/xml/docbook/stylesheet/nwalsh/profiling/profile.xsl \
manual.docbook
xsltproc --stringparam chunker.output.encoding UTF-8 \
--stringparam chunker.output.doctype-public "-//W3C//DTD XHTML 1.0 Transitional//EN" \
--stringparam chunker.output.doctype-system "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd" \
-o manual/ /usr/share/xml/docbook/stylesheet/nwalsh/current/xhtml/chunk.xsl manual-profiled.docbook
-o manual/ /usr/share/xml/docbook/stylesheet/nwalsh/xhtml/chunk.xsl manual-profiled.docbook
rm manual-profiled.docbook
cp -r /usr/share/xml/docbook/stylesheet/nwalsh/current/images/ manual/ # missing images...
cp -r /usr/share/xml/docbook/stylesheet/nwalsh/images/ manual/ # missing images...
if test ! -d manual/images/callouts; then \
echo "manual pages weren't created succesful." ;\
exit 1; \
@ -49,42 +49,42 @@ manual-html: manual.docbook
manual-de-html: manual-de.docbook
xsltproc --stringparam profile.condition html -o manual-profiled.docbook \
/usr/share/xml/docbook/stylesheet/nwalsh/current/profiling/profile.xsl \
/usr/share/xml/docbook/stylesheet/nwalsh/profiling/profile.xsl \
manual-de.docbook
xsltproc --stringparam chunker.output.encoding UTF-8 \
--stringparam chunker.output.doctype-public "-//W3C//DTD XHTML 1.0 Transitional//EN" \
--stringparam chunker.output.doctype-system "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd" \
-o manual-de/ /usr/share/xml/docbook/stylesheet/nwalsh/current/xhtml/chunk.xsl manual-profiled.docbook
-o manual-de/ /usr/share/xml/docbook/stylesheet/nwalsh/xhtml/chunk.xsl manual-profiled.docbook
rm manual-profiled.docbook
cp -r /usr/share/xml/docbook/stylesheet/nwalsh/current/images/ manual-de/ # missing images...
cp -r /usr/share/xml/docbook/stylesheet/nwalsh/images/ manual-de/ # missing images...
if test ! -d manual-de/images/callouts; then \
echo "manual wasn't created succesful." ;\
exit 1; \
fi
tar czf capisuite-manual-de-$(VERSION).tar.gz manual-de
capisuite.8 capisuite.conf.5 fax.conf.5 answering_machine.conf.5 capisuitefax.1: manual.docbook
xsltproc --stringparam profile.condition man -o manual-profiled.docbook \
/usr/share/xml/docbook/stylesheet/nwalsh/current/profiling/profile.xsl \
/usr/share/xml/docbook/stylesheet/nwalsh/profiling/profile.xsl \
manual.docbook
xsltproc /usr/share/xml/docbook/stylesheet/nwalsh/current/manpages/docbook.xsl \
xsltproc /usr/share/xml/docbook/stylesheet/nwalsh/manpages/docbook.xsl \
manual-profiled.docbook
rm manual-profiled.docbook
manual-pdf: manual.docbook
xsltproc --stringparam profile.condition pdf -o manual.xml \
/usr/share/xml/docbook/stylesheet/nwalsh/current/profiling/profile.xsl \
/usr/share/xml/docbook/stylesheet/nwalsh/profiling/profile.xsl \
manual.docbook
db2pdf manual.xml
-rm CATALOG.local manual.aux manual.log manual.out manual.tex suse-*.dsl manual.xml
manual-de-pdf: manual-de.docbook
xsltproc --stringparam profile.condition pdf -o manual-de.xml \
/usr/share/xml/docbook/stylesheet/nwalsh/current/profiling/profile.xsl \
/usr/share/xml/docbook/stylesheet/nwalsh/profiling/profile.xsl \
manual-de.docbook
db2pdf manual-de.xml
-rm CATALOG.local manual-de.aux manual-de.log manual-de.out manual-de.tex suse-*.dsl manual-de.xml
reference-html: Doxyfile.in
sed -e 's,@VERSION\@,$(VERSION),g' \
-e 's,@capisuite_sources\@,$(top_srcdir)/src,g' \
@ -97,7 +97,7 @@ reference-html: Doxyfile.in
fi
rm Doxyfile
tar czf capisuite-reference-$(VERSION).tar.gz reference
install-data-local:
if test -d reference; then \
$(mkinstalldirs) $(DESTDIR)$(docdir)/reference ; \

View File

@ -1,173 +1,236 @@
.\"Generated by db2man.xsl. Don't modify this, modify the source.
.de Sh \" Subsection
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Ip \" List item
.br
.ie \\n(.$>=3 .ne \\$3
.el .ne 3
.IP "\\$1" \\$2
..
.TH "ANSWERING_MACHINE" 5 "" "" ""
.SH NAME
'\" t
.\" Title: answering_machine.conf
.\" Author: Gernot Hillier <gernot@hillier.de>
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 03/07/2012
.\" Manual: CapiSuite 0.5.cvs
.\" Source: [FIXME: source]
.\" Language: English
.\"
.TH "ANSWERING_MACHINE\&." "5" "03/07/2012" "[FIXME: source]" "CapiSuite 0.5.cvs"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
answering_machine.conf \- configuration of CapiSuite answering machine
.SH "DESCRIPTION"
.PP
This file holds all available config options for the answering machine provided by the default scripts distributed with CapiSuite\&. It is read from \fI/etc/capisuite/answering_machine\&.conf\fR or \fI/usr/local/etc/capisuite/answering_machine\&.conf\fR (depending on the installation)\&.
This file holds all available config options for the answering machine provided by the default scripts distributed with
CapiSuite\&. It is read from
/etc/capisuite/answering_machine\&.conf
or
/usr/local/etc/capisuite/answering_machine\&.conf
(depending on the installation)\&.
.PP
It is divided into one or more sections\&. A section begins with the section name in square brackets like [section] while the options are key="value" lines\&.
It is divided into one or more sections\&. A section begins with the section name in square brackets like
[section]
while the options are
key="value"
lines\&.
.PP
A special section called [GLOBAL] and one section for each user called [<username>] are required\&.The <username> must be a valid system user\&.
A special section called
[GLOBAL]
and one section for each user called
[<username>]
are required\&.
\fIThe \fR\fI<username>\fR\fI must be a valid system user\fR\&.
.PP
The [GLOBAL]\-section defines some global options like pathnames and default settings for options that can be overridden in the user\-sections\&. The user\-sections hold all the options which belong to a particular user\&.
The
[GLOBAL]\-section defines some global options like pathnames and default settings for options that can be overridden in the user\-sections\&. The user\-sections hold all the options which belong to a particular user\&.
.SH "THE [GLOBAL] SECTION"
.TP
\fBaudio_dir="/path/to/audiodir/"\fR
The answering machine script uses several wave files, for example a global announcement if the user hasn't set his own and some spoken word fragments for the remote inquiry and the menu presented there\&. These audio files are searched in this directory\&. If user_audio_files is enabled (see \fBuser_audio_files\fR), each user can also provide his own audio snippets in his user_dir (see \fBvoice_user_dir\fR)\&.
This option is mandatory\&.
.TP
\fBvoice_user_dir="/path/to/userdir/"\fR
This directory is used to save user specific data to\&. It must exist and the user CapiSuite runs as must have write permission to it\&. It will contain one subdirectory for each configured user (named like his userid)\&. The following subdirectories are used below the user\-specific dir:
.RS
.TP
\fIuser_dir/username/\fR
Here the user may provide his own audio_files (see also option \fBuser_audio_files\fR below)\&. The user defined announcement is also saved here\&.
.TP
\fIuser_dir/username/received/\fR
Received voice calls are saved here\&.
.RE
.IP
This option is mandatory\&.
.TP
\fBuser_audio_files="0"\fR
If set to 1, each user may provide his own audio files in his user directory (see \fBvoice_user_dir\fR)\&. If set to 0, only the audio_dir (see \fBvoice_audio_dir\fR) will be searched\&.
This option is optional\&. If not set, it defaults to not reading own user audio files (0)\&.
.TP
\fBvoice_delay="15"\fR
Sets the default value for the delay for accepting an incoming call in (in seconds)\&. A value of 10 means that the answering machine accepts incoming calls 10 seconds after the incoming connection request\&. This value can be overwritten in the user sections individually\&.
This option is mandatory\&.
.TP
\fBannouncement="announcement\&.la"\fR
Sets the default name to use for user announcements\&. The announcements are searched in \fIuser_dir/username/announcement\fR then\&. If not found, a global announcement containing the called MSN will be played\&. This value can be overwritten in the user sections individually\&.
This option is optional\&. If not set, it defaults to "announcement\&.la"\&.
.TP
\fBrecord_length="60"\fR
Default setting for the maximum record length in seconds\&. This value can be overwritten in the user sections individually\&.
This option is optional\&. If not set, it defaults to 60 seconds\&.
.TP
\fBrecord_silence_timeout="5"\fR
Default setting for the record silence timeout in seconds\&. When set to a value greater than 0, the recording will be aborted if silence is detected for the given amount of seconds\&. Set this to 0 to disable it\&. This value can be overwritten in the user sections individually\&.
This option is optional\&. If not set, it defaults to 5 seconds\&.
.TP
\fBvoice_email_from="<mailaddress>"\fR
You can set a default originator ("From"\-address) for the e\-mails CapiSuite sends here\&.
This option is optional\&. If you set this to an empty string, the destinator is used as originator (i\&.e\&. if "gernot" receives a voice call, the mail comes from "gernot" to "gernot")\&.
.SH "THE USER SECTIONS"
.TP
\fBvoice_delay\fR
User specific value for the corresponding global option
.TP
\fBannouncement\fR
User specific value for the corresponding global option
.TP
\fBrecord_length\fR
User specific value for the corresponding global option
.TP
\fBrecord_silence_timeout\fR
User specific value for the corresponding global option
.TP
\fBvoice_email_from\fR
User specific value for the corresponding global option
.TP
\fBvoice_numbers="<number1>,<number2>,\&.\&.\&."\fR
A list containing the numbers on which this user wants to receive incoming voice calls\&. These numbers are used to differ between users \- so the same number must not appear in more than one user section! The numbers are separated with commas and no blanks are allowed\&. The answering machine script does also automatic fax detection, so a fax can be sent to this number\&. When this list is set to *,all incoming calls will be accepted for this user (use with care!)\&. This is only useful for a setup with only one user which wants to receive any call\&.
If for any reason no destination number is signalled for special MSNs (austrian telecom seems to do this for the main MSN, where it is called "Global Call"), you can use the special sign \- which means "no destination number available"\&.
This option is optional\&. If not set, the user won't receive voice calls\&.
.TP
\fBvoice_email=""\fR
If given, this string indicates email\-addresses where the received faxes and voice calls will be sent to\&. If it is empty, they will be sent to the user account on the system CapiSuite is running on\&. More addresses are separated by commas\&. If you don't want emails to be sent at all, use the action option (see \fBvoice_action\fR)\&.
This option is optional\&. If not set, the calls are mailed to the system account\&.
.TP
\fBpin="<your PIN>"\fR
The answering machine also supports a remote inquiry function\&. This function is used by entering a PIN (Personal Identification Number) while the announcement is played\&. This PIN can be setup here\&. If you don't want to use the remote inquiry function, just use an empty PIN setting\&. The PIN doesn't have a maximal length \- but perhaps you should not use 200 digits or you perhaps won't be able to remember them (I won't at least)\&. ;\-)
This option is optional\&. If not set, remote inquiry is disabled\&.
.TP
\fBvoice_action="MailAndSave"\fR
Here you can define what action will be taken when a call is received\&. Currently, three possible actions are supported:
.RS
.TP
\fBMailAndSave\fR
The received call will be mailed to the given address (see\fBvoice_email\fR above) and saved to the \fIvoice_user_dir\fR (see global options)
.TP
\fBSaveOnly\fR
The call will be only saved to the \fIvoice_user_dir\fR (see global options)
.TP
\fBNone\fR
Only the announcement will be played \- no recording is done\&.
.RE
.IP
This option is mandatory\&.
.SH "SEE ALSO"
.PP
\fBcapisuite\fR(8), \fBcapisuite\&.conf\fR(5), \fBfax\&.conf\fR(5), \fBcapisuitefax\fR(1)
.SH AUTHOR
Gernot Hillier <gernot@hillier\&.de>.
\fBaudio_dir="/path/to/audiodir/"\fR
.RS 4
The answering machine script uses several wave files, for example a global announcement if the user hasn\*(Aqt set his own and some spoken word fragments for the remote inquiry and the menu presented there\&. These audio files are searched in this directory\&. If user_audio_files is enabled (see
\fBuser_audio_files\fR), each user can also provide his own audio snippets in his user_dir (see
\fBvoice_user_dir\fR)\&.
.sp
This option is mandatory\&.
.RE
.PP
\fBvoice_user_dir="/path/to/userdir/"\fR
.RS 4
This directory is used to save user specific data to\&. It must exist and the user
CapiSuite
runs as must have write permission to it\&. It will contain one subdirectory for each configured user (named like his userid)\&. The following subdirectories are used below the user\-specific dir:
.PP
user_dir/username/
.RS 4
Here the user may provide his own audio_files (see also option
\fBuser_audio_files\fR
below)\&. The user defined announcement is also saved here\&.
.RE
.PP
user_dir/username/received/
.RS 4
Received voice calls are saved here\&.
.RE
.sp
This option is mandatory\&.
.RE
.PP
\fBuser_audio_files="0"\fR
.RS 4
If set to
1, each user may provide his own audio files in his user directory (see
\fBvoice_user_dir\fR)\&. If set to
0, only the audio_dir (see
\fBvoice_audio_dir\fR) will be searched\&.
.sp
This option is optional\&. If not set, it defaults to not reading own user audio files (0)\&.
.RE
.PP
\fBvoice_delay="15"\fR
.RS 4
Sets the default value for the delay for accepting an incoming call in (in seconds)\&. A value of
10
means that the answering machine accepts incoming calls 10 seconds after the incoming connection request\&. This value can be overwritten in the user sections individually\&.
.sp
This option is mandatory\&.
.RE
.PP
\fBannouncement="announcement\&.la"\fR
.RS 4
Sets the default name to use for user announcements\&. The announcements are searched in
user_dir/username/announcement
then\&. If not found, a global announcement containing the called MSN will be played\&. This value can be overwritten in the user sections individually\&.
.sp
This option is optional\&. If not set, it defaults to "announcement\&.la"\&.
.RE
.PP
\fBrecord_length="60"\fR
.RS 4
Default setting for the maximum record length in seconds\&. This value can be overwritten in the user sections individually\&.
.sp
This option is optional\&. If not set, it defaults to 60 seconds\&.
.RE
.PP
\fBrecord_silence_timeout="5"\fR
.RS 4
Default setting for the record silence timeout in seconds\&. When set to a value greater than 0, the recording will be aborted if silence is detected for the given amount of seconds\&. Set this to 0 to disable it\&. This value can be overwritten in the user sections individually\&.
.sp
This option is optional\&. If not set, it defaults to 5 seconds\&.
.RE
.PP
\fBvoice_email_from="<mailaddress>"\fR
.RS 4
You can set a default originator ("From"\-address) for the e\-mails
CapiSuite
sends here\&.
.sp
This option is optional\&. If you set this to an empty string, the destinator is used as originator (i\&.e\&. if "gernot" receives a voice call, the mail comes from "gernot" to "gernot")\&.
.RE
.SH "THE USER SECTIONS"
.PP
\fBvoice_delay\fR
.RS 4
User specific value for the corresponding global option
.RE
.PP
\fBannouncement\fR
.RS 4
User specific value for the corresponding global option
.RE
.PP
\fBrecord_length\fR
.RS 4
User specific value for the corresponding global option
.RE
.PP
\fBrecord_silence_timeout\fR
.RS 4
User specific value for the corresponding global option
.RE
.PP
\fBvoice_email_from\fR
.RS 4
User specific value for the corresponding global option
.RE
.PP
\fBvoice_numbers="<number1>,<number2>,\&.\&.\&."\fR
.RS 4
A list containing the numbers on which this user wants to receive incoming voice calls\&. These numbers are used to differ between users \- so the same number must not appear in more than one user section! The numbers are separated with commas and
\fIno blanks\fR
are allowed\&. The answering machine script does also automatic fax detection, so a fax can be sent to this number\&. When this list is set to
*,
\fIall\fR
incoming calls will be accepted for this user (use with care!)\&. This is only useful for a setup with only one user which wants to receive any call\&.
.sp
If for any reason
\fIno destination\fR
number is signalled for special MSNs (austrian telecom seems to do this for the main MSN, where it is called "Global Call"), you can use the special sign
\-
which means "no destination number available"\&.
.sp
This option is optional\&. If not set, the user won\*(Aqt receive voice calls\&.
.RE
.PP
\fBvoice_email=""\fR
.RS 4
If given, this string indicates email\-addresses where the received faxes and voice calls will be sent to\&. If it is empty, they will be sent to the user account on the system
CapiSuite
is running on\&. More addresses are separated by commas\&. If you don\*(Aqt want emails to be sent at all, use the action option (see
\fBvoice_action\fR)\&.
.sp
This option is optional\&. If not set, the calls are mailed to the system account\&.
.RE
.PP
\fBpin="<your PIN>"\fR
.RS 4
The answering machine also supports a remote inquiry function\&. This function is used by entering a PIN (Personal Identification Number) while the announcement is played\&. This PIN can be setup here\&. If you don\*(Aqt want to use the remote inquiry function, just use an empty PIN setting\&. The PIN doesn\*(Aqt have a maximal length \- but perhaps you should not use 200 digits or you perhaps won\*(Aqt be able to remember them (I won\*(Aqt at least)\&. ;\-)
.sp
This option is optional\&. If not set, remote inquiry is disabled\&.
.RE
.PP
\fBvoice_action="MailAndSave"\fR
.RS 4
Here you can define what action will be taken when a call is received\&. Currently, three possible actions are supported:
.PP
\fBMailAndSave\fR
.RS 4
The received call will be mailed to the given address (see
\fBvoice_email\fR
above) and saved to the
voice_user_dir
(see global options)
.RE
.PP
\fBSaveOnly\fR
.RS 4
The call will be only saved to the
voice_user_dir
(see global options)
.RE
.PP
\fBNone\fR
.RS 4
Only the announcement will be played \- no recording is done\&.
.RE
.sp
This option is mandatory\&.
.RE
.SH "SEE ALSO"
.PP
capisuite(8), capisuite\&.conf(5), fax\&.conf(5), capisuitefax(1)
.SH "AUTHOR"
.PP
\fBGernot Hillier\fR <\&gernot@hillier.de\&>
.RS 4
Author.
.RE

View File

@ -1,56 +1,68 @@
.\"Generated by db2man.xsl. Don't modify this, modify the source.
.de Sh \" Subsection
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Ip \" List item
.br
.ie \\n(.$>=3 .ne \\$3
.el .ne 3
.IP "\\$1" \\$2
..
.TH "CAPISUITE" 8 "" "" ""
.SH NAME
capisuite \- Python-scriptable ISDN telecommunication suite
'\" t
.\" Title: capisuite
.\" Author: Gernot Hillier <gernot@hillier.de>
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 03/07/2012
.\" Manual: CapiSuite 0.5.cvs
.\" Source: [FIXME: source]
.\" Language: English
.\"
.TH "CAPISUITE" "8" "03/07/2012" "[FIXME: source]" "CapiSuite 0.5.cvs"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
capisuite \- Python\-scriptable ISDN telecommunication suite
.SH "DESCRIPTION"
.PP
CapiSuite is a Python\-scriptable ISDN telecommunication suite\&. It uses the new CAPI interface for accessing your ISDN\-hardware \- so you'll need a card for which a CAPI compatible driver is available\&. Currently these are all cards manufactured by AVM and some Eicon cards\&.
CapiSuite
is a Python\-scriptable ISDN telecommunication suite\&. It uses the new CAPI interface for accessing your ISDN\-hardware \- so you\*(Aqll need a card for which a CAPI compatible driver is available\&. Currently these are all cards manufactured by AVM and some Eicon cards\&.
.PP
This man page only gives a short introduction, for the real documentation please see the HTML or PDF manual distributed with CapiSuite\&.
This man page only gives a short introduction, for the real documentation please see the HTML or PDF manual distributed with
CapiSuite\&.
.PP
CapiSuite tries to give the user the ability to code his own ISDN applications without having to fiddle around with all the dirty programming details like callback functions, data buffers, protocol settings and so on\&.
CapiSuite
tries to give the user the ability to code his own ISDN applications without having to fiddle around with all the dirty programming details like callback functions, data buffers, protocol settings and so on\&.
.PP
I took a scripting language which is (in my opinion) very easy to understand, to use and to learn \- especially for beginners: Python\&. I extended it with some functions providing the basic ISDN "building blocks" for the users application\&. Behind these functions the heart of CapiSuite implements all the dirty details a user isn't interested in\&. My goal was to make script\-coding as simple as possible but to also give you the flexibility to realize what you want\&.
I took a scripting language which is (in my opinion) very easy to understand, to use and to learn \- especially for beginners: Python\&. I extended it with some functions providing the basic ISDN "building blocks" for the users application\&. Behind these functions the heart of
CapiSuite
implements all the dirty details a user isn\*(Aqt interested in\&. My goal was to make script\-coding as simple as possible but to also give you the flexibility to realize what you want\&.
.PP
To give you an impression, coding a simple answering machine is as easy as:.IP .nf def callIncoming (call, service, call_from, call_to): connect_voice (call, 10) # answer call after 10 secs audio_send (call, "announcemnt\&.la") # play announcement audio_send (call, "beep\&.la") # play beep audio_receive (call, "call\&.la", 10) # record call .fi
To give you an impression, coding a simple answering machine is as easy as:
.sp .if n \{\ .RS 4 .\} .nf def callIncoming (call, service, call_from, call_to): connect_voice (call, 10) # answer call after 10 secs audio_send (call, "announcemnt\&.la") # play announcement audio_send (call, "beep\&.la") # play beep audio_receive (call, "call\&.la", 10) # record call .fi .if n \{\ .RE .\}
.PP
Of course some details are missing like creating a unique filename or storing the additional information (called and calling party numbers, time, \&.\&.\&.) \- but I assume you got my idea\&.
.PP
And \- don't be afraid \- if you just want to have a normal answering machine or send and receive some fax documents, you can use the default scripts distributed with CapiSuite\&. They give you already some nice features \- e\&.g\&. the answering machine is multi\-user ready, supports automatic fax detection and remote inquiry functions\&. You'll only need to tell CapiSuite some details like your own number, record an own announcement and that's it\&.
And \- don\*(Aqt be afraid \- if you just want to have a normal answering machine or send and receive some fax documents, you can use the default scripts distributed with
CapiSuite\&. They give you already some nice features \- e\&.g\&. the answering machine is multi\-user ready, supports automatic fax detection and remote inquiry functions\&. You\*(Aqll only need to tell
CapiSuite
some details like your own number, record an own announcement and that\*(Aqs it\&.
.PP
So CapiSuite is already equipped for your daily telecommunication needs \- but if you don't like to do the things the way I do \- just change it or completely do it on your own\&. And if you write nice scripts or have changes to my default scripts, I would love to get and perhaps make them available for all users if you don't mind\&.
So
CapiSuite
is already equipped for your daily telecommunication needs \- but if you don\*(Aqt like to do the things the way I do \- just change it or completely do it on your own\&. And if you write nice scripts or have changes to my default scripts, I would love to get and perhaps make them available for all users if you don\*(Aqt mind\&.
.SH "SEE ALSO"
.PP
\fBcapisuite\&.conf\fR(5), \fBfax\&.conf\fR(5), \fBanswering_machine\&.conf\fR(5), \fBcapisuitefax\fR(1)
.SH AUTHOR
Gernot Hillier <gernot@hillier\&.de>.
capisuite\&.conf(5), fax\&.conf(5), answering_machine\&.conf(5), capisuitefax(1)
.SH "AUTHOR"
.PP
\fBGernot Hillier\fR <\&gernot@hillier.de\&>
.RS 4
Author.
.RE

View File

@ -1,75 +1,104 @@
.\"Generated by db2man.xsl. Don't modify this, modify the source.
.de Sh \" Subsection
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Ip \" List item
.br
.ie \\n(.$>=3 .ne \\$3
.el .ne 3
.IP "\\$1" \\$2
..
.TH "CAPISUITE.CONF" 5 "" "" ""
.SH NAME
'\" t
.\" Title: capisuite.conf
.\" Author: Gernot Hillier <gernot@hillier.de>
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 03/07/2012
.\" Manual: CapiSuite 0.5.cvs
.\" Source: [FIXME: source]
.\" Language: English
.\"
.TH "CAPISUITE\&.CONF" "5" "03/07/2012" "[FIXME: source]" "CapiSuite 0.5.cvs"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
capisuite.conf \- configuration of the CapiSuite daemon
.SH "DESCRIPTION"
.PP
The options for the CapiSuite daemon are configured here\&. They will be presented in brief here \- for further details please refer to the comments in the configuration file itself\&.
The options for the
CapiSuite
daemon are configured here\&. They will be presented in brief here \- for further details please refer to the comments in the configuration file itself\&.
.SH "OPTIONS"
.TP
\fBincoming_script="/path/to/incoming\&.py"\fR
This option tells CapiSuite which script should be executed at incoming calls\&. Only change this if you want to use your own script\&.
.TP
\fBidle_script="/path/to/idle\&.py"\fR
This option reflects the path and name of the idle script\&. This script is called in regular intervalls to check if any outgoing call should be done\&. As above, the default should be ok if you don't use your own script\&.
.TP
\fBidle_script_interval="30"\fR
Here you can define how often the idle script should be executed\&. The number given is the interval between subsequent invocations in seconds\&. Lesser numbers give you quicker response to queued jobs but also a higher system load\&. The default should be ok in most cases\&.
.TP
\fBlog_file="/path/to/capisuite\&.log"\fR
This file will be used for all "normal" messages printed byCapiSuite telling you what it does\&. Error messages are written to a special log (see below)\&.
.TP
\fBlog_level="1"\fR
You can define how detailled the log output of CapiSuite will be\&. The default will give you some informational messages for each incoming and outgoing call and should be enough for normal use\&. I would recommend to only increase it if you encounter some problems\&. Logs of higher level are mainly intended for developers, so just use them if you want to report a problem or have some know\-how of the CAPI interface and the internals of CapiSuite\&.
.TP
\fBlog_error="/path/to/capisuite\&.error"\fR
All errors which CapiSuite detects internally and in your scripts will end up here\&. They are written to an extra file so that they don't get lost in the normal log\&. Please check this log regularly for any messages \- especially when you encounter problems\&. Please report all messages you don't understand and which aren't caused by your own script\-modifications to the CapiSuite team\&.
.TP
\fBDDI_length="0"\fR
When your ISDN card is connected to an ISDN interface in PtP mode, i\&.e\&. if you use DDI which, in understandable words mean you have only one ISDN phone number and can define your own extensions as you like, you have to set the length of your extension numbers here\&. In Germany, PtP mode is called "Anlagenanschluss"\&. Let's say you use 1234\-000 till 1234\-999, then your DDI_length would be 3\&. If you set this to 0, DDI/PtP is disabled\&.
If you're not sure what all this should mean, then chances are high you don't use DDI and can leave this option as it is\&.
.TP
\fBDDI_base_length="0"\fR
This option is only used when DDI_length is not 0\&. This is the length of your base number \- in the example above it would be 4\&.
.TP
\fBDDI_stop_numbers=""\fR
If you usually use extension numbers of a specified length, but also want to use some shorter ones (e\&.g\&. the "\-0" extension for you switchboard), then you can list these shorter extensions here, separated by commas\&.
.SH "SEE ALSO"
.PP
\fBcapisuite\fR(8), \fBfax\&.conf\fR(5), \fBanswering_machine\&.conf\fR(5), \fBcapisuitefax\fR(1)
.SH AUTHOR
Gernot Hillier <gernot@hillier\&.de>.
\fBincoming_script="/path/to/incoming\&.py"\fR
.RS 4
This option tells
CapiSuite
which script should be executed at incoming calls\&. Only change this if you want to use your own script\&.
.RE
.PP
\fBidle_script="/path/to/idle\&.py"\fR
.RS 4
This option reflects the path and name of the idle script\&. This script is called in regular intervalls to check if any outgoing call should be done\&. As above, the default should be ok if you don\*(Aqt use your own script\&.
.RE
.PP
\fBidle_script_interval="30"\fR
.RS 4
Here you can define how often the idle script should be executed\&. The number given is the interval between subsequent invocations in seconds\&. Lesser numbers give you quicker response to queued jobs but also a higher system load\&. The default should be ok in most cases\&.
.RE
.PP
\fBlog_file="/path/to/capisuite\&.log"\fR
.RS 4
This file will be used for all "normal" messages printed by
CapiSuite
telling you what it does\&. Error messages are written to a special log (see below)\&.
.RE
.PP
\fBlog_level="1"\fR
.RS 4
You can define how detailled the log output of
CapiSuite
will be\&. The default will give you some informational messages for each incoming and outgoing call and should be enough for normal use\&. I would recommend to only increase it if you encounter some problems\&. Logs of higher level are mainly intended for developers, so just use them if you want to report a problem or have some know\-how of the CAPI interface and the internals of
CapiSuite\&.
.RE
.PP
\fBlog_error="/path/to/capisuite\&.error"\fR
.RS 4
All errors which
CapiSuite
detects internally and in your scripts will end up here\&. They are written to an extra file so that they don\*(Aqt get lost in the normal log\&. Please check this log regularly for any messages \- especially when you encounter problems\&. Please report all messages you don\*(Aqt understand and which aren\*(Aqt caused by your own script\-modifications to the
CapiSuite
team\&.
.RE
.PP
\fBDDI_length="0"\fR
.RS 4
When your ISDN card is connected to an ISDN interface in PtP mode, i\&.e\&. if you use DDI which, in understandable words mean you have only one ISDN phone number and can define your own extensions as you like, you have to set the length of your extension numbers here\&. In Germany, PtP mode is called "Anlagenanschluss"\&. Let\*(Aqs say you use 1234\-000 till 1234\-999, then your DDI_length would be 3\&. If you set this to 0, DDI/PtP is disabled\&.
.sp
If you\*(Aqre not sure what all this should mean, then chances are high you don\*(Aqt use DDI and can leave this option as it is\&.
.RE
.PP
\fBDDI_base_length="0"\fR
.RS 4
This option is only used when DDI_length is not 0\&. This is the length of your base number \- in the example above it would be 4\&.
.RE
.PP
\fBDDI_stop_numbers=""\fR
.RS 4
If you usually use extension numbers of a specified length, but also want to use some shorter ones (e\&.g\&. the "\-0" extension for you switchboard), then you can list these shorter extensions here, separated by commas\&.
.RE
.SH "SEE ALSO"
.PP
capisuite(8), fax\&.conf(5), answering_machine\&.conf(5), capisuitefax(1)
.SH "AUTHOR"
.PP
\fBGernot Hillier\fR <\&gernot@hillier.de\&>
.RS 4
Author.
.RE

View File

@ -1,106 +1,116 @@
.\"Generated by db2man.xsl. Don't modify this, modify the source.
.de Sh \" Subsection
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Ip \" List item
.br
.ie \\n(.$>=3 .ne \\$3
.el .ne 3
.IP "\\$1" \\$2
..
.TH "CAPISUITEFAX" 1 "" "" ""
.SH NAME
'\" t
.\" Title: capisuitefax
.\" Author: Gernot Hillier <gernot@hillier.de>
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 03/07/2012
.\" Manual: CapiSuite 0.5.cvs
.\" Source: [FIXME: source]
.\" Language: English
.\"
.TH "CAPISUITEFAX" "1" "03/07/2012" "[FIXME: source]" "CapiSuite 0.5.cvs"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
capisuitefax \- sending faxes with the CapiSuite default scripts
.SH "SYNOPSIS"
.ad l
.hy 0
.HP 13
.HP \w'\fBcapisuitefax\fR\ 'u
\fBcapisuitefax\fR [\-q] [\-n] [\-u\ \fIuser\fR] [\-A\ \fIadr\fR] [\-S\ \fIsubj\fR] \-d\ \fInumber\fR file...
.ad
.hy
.ad l
.hy 0
.HP 13
.HP \w'\fBcapisuitefax\fR\ 'u
\fBcapisuitefax\fR [\-q] \-a\ \fIid\fR
.ad
.hy
.ad l
.hy 0
.HP 13
.HP \w'\fBcapisuitefax\fR\ 'u
\fBcapisuitefax\fR \-h
.ad
.hy
.ad l
.hy 0
.HP 13
.HP \w'\fBcapisuitefax\fR\ 'u
\fBcapisuitefax\fR \-l
.ad
.hy
.SH "DESCRIPTION"
.PP
The default scripts for CapiSuite come with the tool \fBcapisuitefax\fR for sending faxes\&.
The default scripts for
CapiSuite
come with the tool
\fBcapisuitefax\fR
for sending faxes\&.
.PP
It will be called with some parameters telling it which file to send (it currently only supports PostScript and PDF files) and to which number\&. It will then enqueue the job converted to the right format into the send queue from which it's collected by another CapiSuite script and sent to the destination\&. If the sending was completed successfully or failed finally after trying for some time, the according user will get an email telling him/her what has happened\&.
It will be called with some parameters telling it which file to send (it currently only supports PostScript and PDF files) and to which number\&. It will then enqueue the job converted to the right format into the send queue from which it\*(Aqs collected by another
CapiSuite
script and sent to the destination\&. If the sending was completed successfully or failed finally after trying for some time, the according user will get an email telling him/her what has happened\&.
.SH "OPTIONS"
.TP
\fB\-a id\fR
Abort the job with the given id\&. To get a job id, use the \fB\-l\fR option\&.
.TP
\fB\-A adr\fR
The addressee of the fax\&. This option is (currently) only for informational purposes and will be quoted in the sent status mail\&.
.TP
\fB\-d number\fR
The number which should be called (destination of the fax)
.TP
\fB\-h\fR
Show a short commandline help
.TP
\fB\-l\fR
Shows the jobs which are currently in the send queue\&.
.TP
\fB\-n\fR
Don't use the configured dial prefix for this job\&. Useful for internal jobs\&.
.TP
\fB\-q\fR
Be quiet, don't output informational messages
.TP
\fB\-S subj\fR
A subject for the fax\&. This option is (currently) only for informational purposes and will be quoted in the sent status mail\&.
.TP
\fB\-u user\fR
Send fax as another user\&. Only allowed if \fBcapisuitefax\fR is called as user root\&. This is mainly helpful for realizing extensions to e\&.g\&. do network faxing\&.
.TP
\fBfile\&.\&.\&.\fR
One or more PostScript/PDF files to send to this destination\&. More than one PostScript file will produce several separate fax jobs\&.
.SH "SEE ALSO"
.PP
\fBcapisuite\fR(8), \fBcapisuite\&.conf\fR(5), \fBfax\&.conf\fR(5), \fBanswering_machine\&.conf\fR(5)
.SH AUTHOR
Gernot Hillier <gernot@hillier\&.de>.
\fB\-a id\fR
.RS 4
Abort the job with the given id\&. To get a job id, use the
\fB\-l\fR
option\&.
.RE
.PP
\fB\-A adr\fR
.RS 4
The addressee of the fax\&. This option is (currently) only for informational purposes and will be quoted in the sent status mail\&.
.RE
.PP
\fB\-d number\fR
.RS 4
The number which should be called (destination of the fax)
.RE
.PP
\fB\-h\fR
.RS 4
Show a short commandline help
.RE
.PP
\fB\-l\fR
.RS 4
Shows the jobs which are currently in the send queue\&.
.RE
.PP
\fB\-n\fR
.RS 4
Don\*(Aqt use the configured dial prefix for this job\&. Useful for internal jobs\&.
.RE
.PP
\fB\-q\fR
.RS 4
Be quiet, don\*(Aqt output informational messages
.RE
.PP
\fB\-S subj\fR
.RS 4
A subject for the fax\&. This option is (currently) only for informational purposes and will be quoted in the sent status mail\&.
.RE
.PP
\fB\-u user\fR
.RS 4
Send fax as another user\&. Only allowed if
\fBcapisuitefax\fR
is called as user
root\&. This is mainly helpful for realizing extensions to e\&.g\&. do network faxing\&.
.RE
.PP
\fBfile\&.\&.\&.\fR
.RS 4
One or more PostScript/PDF files to send to this destination\&. More than one PostScript file will produce several separate fax jobs\&.
.RE
.SH "SEE ALSO"
.PP
capisuite(8), capisuite\&.conf(5), fax\&.conf(5), answering_machine\&.conf(5)
.SH "AUTHOR"
.PP
\fBGernot Hillier\fR <\&gernot@hillier.de\&>
.RS 4
Author.
.RE

View File

@ -1,198 +1,264 @@
.\"Generated by db2man.xsl. Don't modify this, modify the source.
.de Sh \" Subsection
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Ip \" List item
.br
.ie \\n(.$>=3 .ne \\$3
.el .ne 3
.IP "\\$1" \\$2
..
.TH "FAX.CONF" 5 "" "" ""
.SH NAME
'\" t
.\" Title: fax.conf
.\" Author: Gernot Hillier <gernot@hillier.de>
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 03/07/2012
.\" Manual: CapiSuite 0.5.cvs
.\" Source: [FIXME: source]
.\" Language: English
.\"
.TH "FAX\&.CONF" "5" "03/07/2012" "[FIXME: source]" "CapiSuite 0.5.cvs"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
fax.conf \- configuration of the CapiSuite fax services
.SH "DESCRIPTION"
.PP
This file holds all available config options for the fax services provided by the default scripts distributed with CapiSuite\&. It is read from \fI/etc/capisuite/fax\&.conf\fR or\fI/usr/local/etc/capisuite/fax\&.conf\fR (depending on the installation)\&.
This file holds all available config options for the fax services provided by the default scripts distributed with
CapiSuite\&. It is read from
/etc/capisuite/fax\&.conf
or
/usr/local/etc/capisuite/fax\&.conf
(depending on the installation)\&.
.PP
It is divided into one or more sections\&. A section begins with the section name in square brackets like [section] while the options are key="value" lines\&.
It is divided into one or more sections\&. A section begins with the section name in square brackets like
[section]
while the options are
key="value"
lines\&.
.PP
A special section called [GLOBAL] and one section for each user called [<username>] are required\&.The <username> must be a valid system user\&.
A special section called
[GLOBAL]
and one section for each user called
[<username>]
are required\&.
\fIThe \fR\fI<username>\fR\fI must be a valid system user\fR\&.
.PP
The [GLOBAL]\-section defines some global options like pathnames and default settings for options that can be overridden in the user\-sections\&. The user\-sections hold all the options which belong to a particular user\&.
The
[GLOBAL]\-section defines some global options like pathnames and default settings for options that can be overridden in the user\-sections\&. The user\-sections hold all the options which belong to a particular user\&.
.SH "THE [GLOBAL] SECTION"
.TP
\fBspool_dir="/path/to/spooldir/"\fR
This directory is used to archive sent (or failed) jobs\&. It must exist and the user CapiSuite runs as must have write permission to its subdirectories\&. Two subdirectories are used:
.RS
.TP
\fIspooldir/done/\fR
Jobs finished successfully are moved to this directory\&.
.TP
\fIspooldir/failed/\fR
Job which have failed finally end up here\&.
.RE
.IP
This option is mandatory\&.
.TP
\fBfax_user_dir="/path/to/userdir/"\fR
This directory is used to store fax jobs and received documents to\&. It must exist and the user CapiSuite runs as must have write permission to it\&. It will contain one subdirectory for each configured user (named like his userid)\&. The following subdirectories are used below the user\-specific dir:
.RS
.TP
\fIuser_dir/username/received/\fR
Received faxes are saved here\&.
.TP
\fIuser_dir/username/sendq/\fR
Fax files to be sent are queued here by \fBcapisuitefax\fR\&.
.RE
.IP
This option is mandatory\&.
.TP
\fBsend_tries="10"\fR
When a fax can't be sent to the destination for any reason, it's tried for several times\&. This setting limits the number of tries\&. If all tries failed, the job will be moved to the failed dir (see \fBfax_spool_dir\fR) and the user will get a mail\&.
This option is optional\&. If not given, it defaults to 10 tries\&.
.TP
\fBsend_delays="60,60,60,300,300,3600,3600,18000,36000"\fR
When a fax can't be sent to the destination for any reason, it's tried again\&. This setting specifies the delays in seconds between subsequent tries\&. The different values are separated with commas and no blanks\&. The list should have send_tries\-1 (see \fBfax_send_tries\fR) values \- if not, surplus entries are ignored and missing entries are filled up with the last value\&. The default should just be ok giving you increasing delays for up to 10 tries\&.
This option is optional\&. If not given, it defaults to the list shown above\&.
.TP
\fBsend_controller="1"\fR
If you have more than one ISDN controller installed (some active cards for more than one basic rate interface like the AVM C2 or C4 are also represented as multiple controllers for CAPI applications like CapiSuite), you can decide which controller (and therefore which basic rate interface) should be used for sending your faxes\&. All controllers are numbered starting with 1\&. If you're not sure which controller has which number, increase the log level to at least 2 in CapiSuite (see [xref to sect2]), restart it and have a look in the log file where all controllers will be listed then\&. Unfortunately, CapiSuite isn't able to use more than one controller for sending faxes at the moment, so no list is allowed here\&. If you have only one controller, just leave it at 1
This option is optional\&. If not given, it defaults controller 1\&.
.TP
\fBoutgoing_MSN="<your MSN>"\fR
This number is used as our own number for outgoing calls\&. If it's not given, the first number of fax_numbers is used (see user sections)\&. If this one is also empty, the user can't send faxes\&. Please replace with one valid MSN of your ISDN interface or leave empty\&. This value can be overwritten in the user sections individually\&.
This option is optional\&. If not given, it defaults to empty\&.
.TP
\fBoutgoing_timeout="60"\fR
Default setting which defines how many seconds we will wait for a successful connection after dialing the number\&. This value can be overwritten in the user sections individually\&.
This option is optional\&. If not given, it defaults to 60 seconds\&.
.TP
\fBdial_prefix=""\fR
If anything is entered here, it will be used as a prefix which is added to any number given to \fBcapisuitefax\fR as prefix\&. This is e\&.g\&. very helpful if your ISDN adapter is connected to a PBX which needs "0" for external calls\&. It's also possible to disable its usage later for a certain fax document, so setting this will certainly not prevent you from placing internal calls without prefix\&.
This option is optional\&. If not given, it defaults to an empty prefix\&.
.TP
\fBfax_stationID="<your faxID>"\fR
Default fax station ID to use when sending a fax document\&. The station ID is usually the number of your fax station in international format, so an example would be "+49 89 123456" for a number in Munich, Germany\&. Station IDs may only consist of the "+"\-sign, spaces and the digits 0\-9\&. The maximal length is 20\&. This value can be overwritten in the user sections individually\&.
This option is mandatory\&.
.TP
\fBfax_headline="<your faxheadline>"\fR
Default fax headline to use when sending a fax document\&. Where and if this headline will be presented depends on the implementation of your CAPI driver\&. The headline should have a reasonable length to fit on the top of a page, but there's no definite limit given\&.
This option is optional\&. If not given, it defaults to an empty headline\&.
.TP
\fBfax_email_from="<mailaddress>"\fR
You can set a default originator ("From"\-address) for the e\-mails CapiSuite sends here\&.
This option is optional\&. If you set this to an empty string, the destinator is used as originator (i\&.e\&. if "gernot" receives a fax, the mail comes from "gernot" to "gernot")\&.
.SH "THE USER SECTIONS"
.TP
\fBoutgoing_MSN\fR
User specific value for the corresponding global option
.TP
\fBoutgoing_timeout\fR
User specific value for the corresponding global option
.TP
\fBfax_stationID\fR
User specific value for the corresponding global option
.TP
\fBfax_headline\fR
User specific value for the corresponding global option
.TP
\fBfax_email_from\fR
User specific value for the corresponding global option
.TP
\fBfax_numbers="<number1>,<number2>,\&.\&.\&."\fR
A list containing the numbers on which this user wants to receive incoming fax calls\&. These numbers are used to differ between users \- so the same number must not appear in more than one user section! The numbers are separated with commas and no blanks are allowed\&. The first number of the list also serves as our own number for sending a fax if outgoing_MSN is not set (see \fBoutgoing_MSN\fR)\&.
If you want to use the same number for receiving fax and voice calls, pleasedo not enter it here\&. Use the voice_numbers option instead (see \fBanswering_machine\&.conf\fR(5)) \- the answering machine has a built in fax detection and can also receive faxes\&.
When this list is set to *,all incoming calls will be accepted for this user (use with care!)\&. This is only useful for a setup with only one user which wants to receive any call as fax\&.
If for any reason no destination number is signalled for special MSNs (austrian telecom seems to do this for the main MSN, where it is called "Global Call"), you can use the special sign \- which means "no destination number available"\&.
This option is optional\&. If not given, the user can't receive fax documents\&.
.TP
\fBfax_email=""\fR
If given, this string indicates email\-addresses where the received faxes will be sent to\&. More addresses are separated by commas\&. If it is empty, they will be sent to the user account on the system CapiSuite is running on\&. The address is also used to send status reports for sent fax jobs to\&. If you don't want emails to be sent at all, use the action option (see option \fBfax_action\fR) below\&.
This option is optional\&. If not given, the mail is sent to the system account\&.
.TP
\fBfax_action="MailAndSave"\fR
Here you can define what action will be taken when a call is received\&. Currently, two possible actions are supported:
.RS
.TP
\fBMailAndSave\fR
The received call will be mailed to the given address (see\fBfax_email\fR above) and saved to the \fBfax_user_dir\fR (see global options)
.TP
\fBSaveOnly\fR
The call will be only saved to the fax_user_dir (see global options)
.RE
.IP
This option is mandatory\&.
.SH "SEE ALSO"
.PP
\fBcapisuite\fR(8), \fBcapisuite\&.conf\fR(5), \fBanswering_machine\&.conf\fR(5), \fBcapisuitefax\fR(1)
.SH AUTHOR
Gernot Hillier <gernot@hillier\&.de>.
\fBspool_dir="/path/to/spooldir/"\fR
.RS 4
This directory is used to archive sent (or failed) jobs\&. It must exist and the user
CapiSuite
runs as must have write permission to its subdirectories\&. Two subdirectories are used:
.PP
spooldir/done/
.RS 4
Jobs finished successfully are moved to this directory\&.
.RE
.PP
spooldir/failed/
.RS 4
Job which have failed finally end up here\&.
.RE
.sp
This option is mandatory\&.
.RE
.PP
\fBfax_user_dir="/path/to/userdir/"\fR
.RS 4
This directory is used to store fax jobs and received documents to\&. It must exist and the user
CapiSuite
runs as must have write permission to it\&. It will contain one subdirectory for each configured user (named like his userid)\&. The following subdirectories are used below the user\-specific dir:
.PP
user_dir/username/received/
.RS 4
Received faxes are saved here\&.
.RE
.PP
user_dir/username/sendq/
.RS 4
Fax files to be sent are queued here by
\fBcapisuitefax\fR\&.
.RE
.sp
This option is mandatory\&.
.RE
.PP
\fBsend_tries="10"\fR
.RS 4
When a fax can\*(Aqt be sent to the destination for any reason, it\*(Aqs tried for several times\&. This setting limits the number of tries\&. If all tries failed, the job will be moved to the failed dir (see
\fBfax_spool_dir\fR) and the user will get a mail\&.
.sp
This option is optional\&. If not given, it defaults to 10 tries\&.
.RE
.PP
\fBsend_delays="60,60,60,300,300,3600,3600,18000,36000"\fR
.RS 4
When a fax can\*(Aqt be sent to the destination for any reason, it\*(Aqs tried again\&. This setting specifies the delays in seconds between subsequent tries\&. The different values are separated with commas and
\fIno blanks\fR\&. The list should have send_tries\-1 (see
\fBfax_send_tries\fR) values \- if not, surplus entries are ignored and missing entries are filled up with the last value\&. The default should just be ok giving you increasing delays for up to 10 tries\&.
.sp
This option is optional\&. If not given, it defaults to the list shown above\&.
.RE
.PP
\fBsend_controller="1"\fR
.RS 4
If you have more than one ISDN controller installed (some active cards for more than one basic rate interface like the AVM C2 or C4 are also represented as multiple controllers for CAPI applications like
CapiSuite), you can decide which controller (and therefore which basic rate interface) should be used for sending your faxes\&. All controllers are numbered starting with 1\&. If you\*(Aqre not sure which controller has which number, increase the log level to at least 2 in
CapiSuite
(see
the section called \(lqConfiguration of CapiSuite\(rq), restart it and have a look in the log file where all controllers will be listed then\&. Unfortunately,
CapiSuite
isn\*(Aqt able to use more than one controller for sending faxes at the moment, so no list is allowed here\&. If you have only one controller, just leave it at
1
.sp
This option is optional\&. If not given, it defaults controller 1\&.
.RE
.PP
\fBoutgoing_MSN="<your MSN>"\fR
.RS 4
This number is used as our own number for outgoing calls\&. If it\*(Aqs not given, the first number of fax_numbers is used (see user sections)\&. If this one is also empty, the user can\*(Aqt send faxes\&. Please replace with one valid MSN of your ISDN interface or leave empty\&. This value can be overwritten in the user sections individually\&.
.sp
This option is optional\&. If not given, it defaults to empty\&.
.RE
.PP
\fBoutgoing_timeout="60"\fR
.RS 4
Default setting which defines how many seconds we will wait for a successful connection after dialing the number\&. This value can be overwritten in the user sections individually\&.
.sp
This option is optional\&. If not given, it defaults to 60 seconds\&.
.RE
.PP
\fBdial_prefix=""\fR
.RS 4
If anything is entered here, it will be used as a prefix which is added to any number given to
\fBcapisuitefax\fR
as prefix\&. This is e\&.g\&. very helpful if your ISDN adapter is connected to a PBX which needs "0" for external calls\&. It\*(Aqs also possible to disable its usage later for a certain fax document, so setting this will certainly not prevent you from placing internal calls without prefix\&.
.sp
This option is optional\&. If not given, it defaults to an empty prefix\&.
.RE
.PP
\fBfax_stationID="<your faxID>"\fR
.RS 4
Default fax station ID to use when sending a fax document\&. The station ID is usually the number of your fax station in international format, so an example would be "+49 89 123456" for a number in Munich, Germany\&. Station IDs may only consist of the "+"\-sign, spaces and the digits 0\-9\&. The maximal length is 20\&. This value can be overwritten in the user sections individually\&.
.sp
This option is mandatory\&.
.RE
.PP
\fBfax_headline="<your faxheadline>"\fR
.RS 4
Default fax headline to use when sending a fax document\&. Where and if this headline will be presented depends on the implementation of your CAPI driver\&. The headline should have a reasonable length to fit on the top of a page, but there\*(Aqs no definite limit given\&.
.sp
This option is optional\&. If not given, it defaults to an empty headline\&.
.RE
.PP
\fBfax_email_from="<mailaddress>"\fR
.RS 4
You can set a default originator ("From"\-address) for the e\-mails
CapiSuite
sends here\&.
.sp
This option is optional\&. If you set this to an empty string, the destinator is used as originator (i\&.e\&. if "gernot" receives a fax, the mail comes from "gernot" to "gernot")\&.
.RE
.SH "THE USER SECTIONS"
.PP
\fBoutgoing_MSN\fR
.RS 4
User specific value for the corresponding global option
.RE
.PP
\fBoutgoing_timeout\fR
.RS 4
User specific value for the corresponding global option
.RE
.PP
\fBfax_stationID\fR
.RS 4
User specific value for the corresponding global option
.RE
.PP
\fBfax_headline\fR
.RS 4
User specific value for the corresponding global option
.RE
.PP
\fBfax_email_from\fR
.RS 4
User specific value for the corresponding global option
.RE
.PP
\fBfax_numbers="<number1>,<number2>,\&.\&.\&."\fR
.RS 4
A list containing the numbers on which this user wants to receive incoming fax calls\&. These numbers are used to differ between users \- so the same number must not appear in more than one user section! The numbers are separated with commas and
\fIno blanks\fR
are allowed\&. The first number of the list also serves as our own number for sending a fax if outgoing_MSN is not set (see
\fBoutgoing_MSN\fR)\&.
.sp
If you want to use the same number for receiving fax and voice calls, please
\fIdo not\fR
enter it here\&. Use the voice_numbers option instead (see
answering_machine\&.conf(5)) \- the answering machine has a built in fax detection and can also receive faxes\&.
.sp
When this list is set to
*,
\fIall\fR
incoming calls will be accepted for this user (use with care!)\&. This is only useful for a setup with only one user which wants to receive any call as fax\&.
.sp
If for any reason
\fIno destination\fR
number is signalled for special MSNs (austrian telecom seems to do this for the main MSN, where it is called "Global Call"), you can use the special sign
\-
which means "no destination number available"\&.
.sp
This option is optional\&. If not given, the user can\*(Aqt receive fax documents\&.
.RE
.PP
\fBfax_email=""\fR
.RS 4
If given, this string indicates email\-addresses where the received faxes will be sent to\&. More addresses are separated by commas\&. If it is empty, they will be sent to the user account on the system
CapiSuite
is running on\&. The address is also used to send status reports for sent fax jobs to\&. If you don\*(Aqt want emails to be sent at all, use the action option (see option
\fBfax_action\fR) below\&.
.sp
This option is optional\&. If not given, the mail is sent to the system account\&.
.RE
.PP
\fBfax_action="MailAndSave"\fR
.RS 4
Here you can define what action will be taken when a call is received\&. Currently, two possible actions are supported:
.PP
\fBMailAndSave\fR
.RS 4
The received call will be mailed to the given address (see
\fBfax_email\fR
above) and saved to the
\fBfax_user_dir\fR
(see global options)
.RE
.PP
\fBSaveOnly\fR
.RS 4
The call will be only saved to the fax_user_dir (see global options)
.RE
.sp
This option is mandatory\&.
.RE
.SH "SEE ALSO"
.PP
capisuite(8), capisuite\&.conf(5), answering_machine\&.conf(5), capisuitefax(1)
.SH "AUTHOR"
.PP
\fBGernot Hillier\fR <\&gernot@hillier.de\&>
.RS 4
Author.
.RE