FAXGETTY(8C)

FAXGETTY(8C)

faxcron Home Page System Administration Index faxinfo


NAME
       faxgetty - HylaFAX front-door process

SYNOPSIS
       /usr/local/sbin/faxgetty  [  -D  ] [ -p ] [ -q queue-dir ]
       device

DESCRIPTION
       faxgetty is the HylaFAX server program  that  listens  for
       incoming phone calls and either handles each call directly
       or hands it off to an appropriate  program.   In  addition
       faxgetty  monitors  modem  usage  and notifies the HylaFAX
       scheduler process when a modem's status changes; e.g. when
       a modem is busy with an outbound call.

       One  faxgetty  should be run for each facsimile modem on a
       machine.   faxgetty  is  typically  started  by  init(8C).
       faxgetty  can also be used with data-only modems; this may
       be desirable if some of  the  non-facsimile  features  are
       important, such as the support for screening calls accord-
       ing to Caller-ID information.

       faxgetty listens to its facsimile modem for incoming calls
       and  to  a  FIFO  special file on which it accepts command
       directives from administrative  commands  such  as  faxan-
       swer(8C)  and faxabort(8C).  faxgetty also catches SIGTERM
       and SIGINT signals; cleaning up  any  necessary  resources
       before exiting.

       Many  aspects of faxgetty operation are controlled through
       a configuration file.   In  particular,  for  faxgetty  to
       automatically  invoke  the  getty(8C)  program  to  handle
       incoming data connections the GettyArgs parameter must  be
       setup  in  the configuration file.  The configuration file
       is located in the spooler hierarchy in the  etc  subdirec-
       tory  and is named config.devid, where devid is an identi-
       fier derived from the name of the modem's device file; for
       example  ttym2  for  /dev/ttym2, term_10 for /dev/term/10.
       Consult config(5F) for detailed information  on  the  con-
       tents of configuration files.

OPTIONS
       -D        This  option  forces  faxgetty  to detach itself
                 from the  controlling  tty  from  which  it  was
                 invoked.   In normal operation faxgetty will not
                 dissassociate itself from the controlling tty.

       -p        Do not change the process priority when  receiv-
                 ing facsimile.  Normally faxgetty will raise its
                 priority to reduce i/o latency.  This option  is
                 useful for debugging.

       -q dir    The specified directory is treated as the spool-
                 ing   area.    The   default   spooling    area,
                 /var/spool/fax, is defined at the time the soft-
                 ware is built.

FILES
       /var/spool/fax/FIFO.device          FIFO special file for submitting commands
       /var/spool/fax/etc/config.device    device-specific configuration file

       Consult hylafax(5F)  for  a  complete  discussion  of  the
       structure and content of the spooling area.

SEE ALSO
       faxabort(8C) faxanswer(8C) faxconfig(8C) faxstate(8C) 
       faxq(8C) getty(8C) hylafax(5F) config(5F) 

faxcron Home Page System Administration Index faxinfo