r2test.conf.5

.TH "r2test.conf" "5" "1.0.0" "Moises Silva" ""
.SH "NAME"
r2test.conf \- OpenR2 r2test program configuration file
.SH "SYNOPSIS"
/etc/openr2/r2test.conf
.SH "DESCRIPTION"
This file defines the behavior of the \fBr2test\fP program
.PP 
This file works pretty much like Asterisk zapata.conf file, the \fBchannel\fR
parameter will create a R2 context with the specified range of channels and
will take all the preceding parameters as configuration.
.PP 

.SH "SYNTAX"
No spaces are allowed in parameter definition, lines starting with \fB#\fR
or spaces will be ignored
.BR 
.PP 
This definition will not be read properly

.I param = value

This definition will be read fine

.I param=value

.PP 
.SH "OPTIONS"
.TP 
\fBcategory\fR=\fI<NATIONAL_SUBSCRIBER, NATIONAL_PRIORITY_SUBSCRIBER, INTERNATIONAL_SUBSCRIBER, INTERNATIONAL_PRIORITY_SUBSCRIBER>\fR
Defines the call category of subscriber. Defaults to \fINATIONAL_SUBSCRIBER\fR
.TP 
\fBloglevel\fR=\fI<all,error,warning,debug,notice,cas,mf,stack,nothing>\fR
Defines the log level for debugging purposes. Defaults to \fIall\fR

\fBerror, warning, debug, notice\fR These options are self-descriptive

\fBcas\fR is for logging ABCD CAS tx and rx

\fBmf\fR is for logging of the Multi Frequency tones

\fBstack\fR is for very verbose output of the channel and context call stack,
only useful if you are debugging a crash or want to learn how the library works.
The stack logging will be only enabled if the OpenR2 library was compiled with
\-DOR2_TRACE_STACKS

\fBall\fR is a special value to log all the activity

\fBnothing\fR is a clean-up value, in case you want to not log any activity
for a channel or group of channels

You can mix up values, like: \fBloglevel\fR=\fIerror,debug,mf\fR to log just
\fBerror\fR, \fBdebug\fR and multi frequency messages

.TP 
\fBcallfile\fR=\fI<yes|no>\fR
Call files useful to debug signaling issues are dumped in the current directory
if this parameter is enabled. Defaults to \fIno\fR

.TP 
\fBvariant\fR=\fI<br,mx,ar,itu>\fR
R2 country variant. Defaults to \fImx\fR

.TP 
.B maxani
How much ANI to expect. Defaults to 10

.TP 
.B maxdnis
How much DNIS to expect. Defaults to 4

.TP 
\fBgetanifirst\fR=<yes|no>
Whether or not we want to request ANI first. Defaults to \fIno\fR

.TP 
\fBusedahdimf\fR=\fI<yes|no>\fR
Whether to use the built-in OpenR2 MF tone generation or DAHDI MF tone
generation. DAHDI is faster since it does not require to copy user space
buffers to the kernel, however this option will only be available when the
configure script detects DAHDI support for MF R2 tone generation.
Defaults to \fIno\fR

.TP 
\fBmfthreshold\fR
MF threshold in milliseconds. This is the amount of time a R2 MF signal is
required to be ON or OFF after has been detected to be handled. 0 means as soon
as we detect a signal we handle it. This aids when a buggy generator or
detector causes small false positives. Defaults to \fI0\fR

.TP 
\fBmfbacktimeout\fR
MF backward timeout in milliseconds to use OpenR2 default just specify any
negative number or comment this line. Defaults to \fI\-1\fR

.TP 
\fBmeteringpulsetimeout\fR
Value in milliseconds for the metering pulse timeout, any negative value means
\fIdefault\fR. Defaults to \fI\-1\fR

.TP 
\fBcollectcalls\fR=\fI<yes|no>\fR
Whether to accept collect calls (see also \fBdoubleanswer\fR). Defaults to \fIno\fR

.TP
\fBchargecalls\fR=\fI<yes|no>\fR
Wheter to charge calls. Defaults to \fIno\fR

.TP 
\fBdoubleanswer\fR=\fI<yes|no>\fR
This option are related but independent of \fBcollectcalls\fR. If you have problems
to block collect calls using Group B signals (\fBcollectcalls\fR), enable this
option. Defaults to \fIno\fR

.TP 
\fBimmediateaccept\fR=\fI<yes|no>\fR
Whether to skip Group B/II signals and go directly to the accepted state for an
incoming call. Defaults to \fIno\fR

.TP 
.B advancedprotocolfile
This option is for advanced users only! Define a file that contains hacks to
R2 protocol. This allow advanced users to fine tune the library or make test
with specific scenarios to include in the library in the future.

.TP
\fBplayaudio\fR=\fI<yes|no>\fR
This feature allows you to play an alaw audio file for incoming/outgoing calls.
Defaults to \fIno\fR

.TP
.B audiofile
If you set \fBplayaudio\fR=\fIyes\fR you should provide the path to the audio file

.TP 
.B channel
Define range of channels to configure using previous options. The channel range
must be specified, unless you will use only one channel. If this option is
specified after \fBdnid\fR, \fBcid\fR and \fBcaller\fR that options will be
used. Defaults to

.br 
.br 
channel=1\-15
.br 
channel=17\-31

.TP 
.B dnid
Defines the destination number. Only used if .B caller = yes

.TP 
.B cid
Defines the caller id number. Only used if .B caller = yes


.TP 
\fBcaller\fR=\fI<yes|no>\fR
Whether or not the group of channels will start a call to the specified dnid.
Defaults to \fIyes\fR


.SH "FILES"
.TP 
.I /etc/openr2/r2test.conf
.TP 
.I /etc/openr2/r2proto.conf
.SH "SEE ALSO"
.BR r2test(8)
.SH "AUTHOR"
.PP 
This manual page was written by Alexandre Cavalcante Alencar
.br 
<alexandre.alencar@gmail.com>
.PP 
Permission is granted to copy, distribute and/or modify this document under
the terms of the GNU General Public License, Version 2 any later version
published by the Free Software Foundation.