Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

vboxgetty(8) [centos man page]

vboxgetty(8)						    Linux System Administration 					      vboxgetty(8)

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/doc/isdnutils/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/doc/isdnutils/examples 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>/stan- dard.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. ISDN 4 Linux 3.13 2000/09/15 vboxgetty(8)

Check Out this Related Man Page

vboxtcl(5)						    Linux System Administration 						vboxtcl(5)

NAME
vboxtcl - tcl commands for vboxgetty CONTENT
With vbox version 2.0, tcl can be used as a script language to act on incoming calls. Incoming calls are still taken by vboxgetty, but further actions are made by the tcl script. VARIABLES
These are additional variables supplied by vboxgetty. vbox_var_bindir directory with vbox commands. vbox_var_savename name for this message to save. The name is constructed from time and process id. It's a good idea to use this name, but you can also use a different name. vbox_var_rectime maximum seconds to record. vbox_var_spooldir path of the users spool directory (/var/spool/vbox/<user>). vbox_var_checknew path for new files (/var/spool/vbox/<user>/incoming). vbox_msg_standard filename with full path of the message to play as the standard message (/var/spool/vbox/<user>/messages/standard.msg). vbox_msg_beep filename with full path of the message to play as beep (/var/spool/vbox/<user>/messages/beep.msg). vbox_msg_timeout filename with full path of the message to play after a timeout (/var/spool/vbox/<user>/messages/timeout.msg). vbox_caller_id CALLERID of current caller. If unknown, this is "0". vbox_caller_phone full phone number of current caller. If unknown, this is "*** Unknown ***". vbox_caller_name name of current caller. If unknown, this is "*** Unknown ***". vbox_user_name name of the user that runs this vboxgetty. vbox_user_home home directory of the user that runs this vboxgetty. vbox_flag_standard this is TRUE if the script should play the standard message, and FALSE if the script should not. vbox_flag_beep this is TRUE if the script should play the beep message, and FALSE if the script should not. vbox_flag_timeout this is TRUE if the script should play the timeout message, and FALSE if the script should not. vbox_flag_record this is TRUE if the script should record a message, and FALSE if the script should not. FUNCTIONS
vboxgetty also provides some additional functions to the user. Return Codes Most functions will use these return codes: ERROR An error occurred. HANGUP The connection was ended. Script should end now. OK The whole message was played, nothing occurred. Any other error code is a touchtone sequence, that was detected during playing the message. vbox_breaklist <add|rem> <sequence> [...] With this command you can control which touchtone sequences vboxgetty will recognize. Touchtone sequences have the format *NUMBER#, where NUMBER is a sequence of the characters 0-9 and A-D. Even single numbers must be given in the format *NUMBER#. Vboxgetty detects if the caller gives a number as a single digit or as a part of a sequence. add <sequence> [...] Add a touchtone sequence to breaklist. You can add up to 8 sequences at one time. rem <sequence> [...] Remove a touchtone sequence from breaklist. You can remove up to 8 sequences at one time. You can use all to remove all sequences. vbox_put_message <message> Play a message and returns an error code depending on the reason to stop playing. Default return codes. message full name of the message file (with path). vbox_get_message <savename> <timelimit> Records a message. Default return codes. Options are: savename full name of the file for saving the message. timelimit maximum time to record the message. vbox_wait <seconds> Waits for several seconds for an input from caller. Default return codes. Options are: seconds time to wait. vbox_init_touchtones Clears vboxgetty touchtone sequence. Normal way is to append all new touchtones to the sequence, the sequence is only cleared when a "*" touchtone is received. vbox_pause <ms> waits a specific number of milliseconds. ms number of milliseconds to wait. vbox_get_nr_new_messages <messagebox> Return the number of new messages in the directory. messagebox the directory to scan vbox_get_nr_all_messages <messagebox> Return the number of messages in the directory. messagebox the directory to scan SEE ALSO
Look at the tcl documentation for any tcl specific questions. For vbox : vboxgetty(8), vboxgetty.conf(5), vbox.conf(5) AUTHOR
This manual page was written by Andreas Jellinghaus <aj@dungeon.inka.de>, for Debian GNU/Linux and isdn4linux. ISDN 4 Linux 3.1pre4 2000/09/15 vboxtcl(5)
Man Page