bionic (8) vboxgetty.8.gz

Provided by: isdnvboxserver_3.25+dfsg1-9ubuntu2_amd64 bug

NAME

       vboxgetty - isdn voice box (getty)

SYNOPSIS

       vboxgetty [OPTION] [OPTION] [...]

DESCRIPTION

       Vboxgetty is the heart of vbox: it watches the isdn system and waits for incoming voice calls,

OPTIONS

       -f, --file FILE
              Config file to use. Default is the file '/etc/isdn/vboxgetty.conf'.

       -d, --device TTY
              ISDNdevice to use. You must use this option!

       -h, --help
              Show summary of options.

       -v, --version
              Show version of program.

CONFIGURING VBOX

       vboxgetty  should  be  started  from  the  init  process.  To  do this you need one line per vboxgetty in
       /etc/inittab like this one:

       I5:2345:respawn:/usr/sbin/vboxgetty -d /dev/ttyI5

       The next step is to set up a working  configuration  for  all  ports  in  /etc/isdn/vboxgetty.conf:  read
       vboxgetty.conf(5)    how    to    do    this    and    look    at    the    example    config   file   in
       /usr/share/doc/isdnvboxserver/examples.

       You   should   then   create   the   spool   directories   for   each    user:    /var/spool/vbox/<user>,
       /var/spool/vbox/<user>/incoming  and  /var/spool/vbox/<user>/messages.  Copy  the  example  config  files
       vbox.conf and standard.tcl from /usr/share/isdnvboxserver/default/ to  /var/spool/vbox/<user>,  read  the
       man pages vbox.conf(5) and vboxtcl(5) and edit these config files.

       Change the owner of all files in /var/spool/vbox/<user> with "chown <user>.<group> /var/spool/vbox/<user>
       -Rv" and correct the permissions with "chmod o-rwx,g-rwx /var/spool/vbox/<user> -Rv".

       The last step: run "init q" to force init to reread /etc/inittab

HOW IT WORKS

       For each line in /etc/inittab one vboxgetty is started by init.  Make sure the first field (ID)  and  the
       device file are different. Each vboxgetty does this:

       First  /etc/isdn/vbox.conf  is  read, the global settings are loaded and then the port specific settings.
       Then vboxgetty waits for an incoming call.

       On an incoming call vboxgetty reads /var/spool/vbox/<user>/vbox.conf (unless you change that  name),  and
       vboxgetty  determines if it should take that call or how many RINGs it should wait. It also gets the name
       of the standard message, beep message, timeout message, if these should be played and an  alias  for  the
       current caller, if there is one.

       If  vbox  has  waited  enough RINGs and the caller is still ringing, it takes the call and starts the tcl
       script /var/spool/vbox/<user>/standard.tcl (unless you change that name), and this  script  will  do  the
       rest (normally: play standard and beep message, record and then play timeout message).

FILES

       /etc/isdn/vboxgetty.conf
              default config file

       /etc/inittab
              init starts vboxgetty via this file.

       /etc/isdn/vboxgetty.conf
              the global vbox config file

       /var/spool/vbox/<user>/vbox.conf
              the per user configuration file for this port

       /var/spool/vbox/<user>/standard.tcl
              the tcl script used to communicate with the caller

       /var/run/vboxgetty-<device>.pid
              process id of the vboxgetty

       /var/log/vbox/vboxgetty-<device>.log
              logfile of the vboxgetty

SEE ALSO

       vboxgetty.conf(5), vbox.conf(5), vboxtcl(5), isdntime(5)

AUTHOR

       This  manual  page  was  written  by  Andreas  Jellinghaus <aj@dungeon.inka.de>, for Debian GNU/Linux and
       isdn4linux.