1FAXGETTY(8C)                                                      FAXGETTY(8C)
2
3
4

NAME

6       faxgetty - HylaFAX front-door process
7

SYNOPSIS

9       /usr/sbin/faxgetty [ -D ] [ -p ] [ -q queue-dir ] [ -c config ] device
10

DESCRIPTION

12       faxgetty  is the HylaFAX server program that listens for incoming phone
13       calls and either handles each call directly  or  hands  it  off  to  an
14       appropriate  program.   In  addition  faxgetty monitors modem usage and
15       notifies the HylaFAX scheduler process when a modem's  status  changes;
16       e.g. when a modem is busy with an outbound call.
17
18       One  faxgetty  should  be  run  for  each facsimile modem on a machine.
19       faxgetty is typically started by init(8C).  faxgetty can also  be  used
20       with data-only modems; this may be desirable if some of the non-facsim‐
21       ile features are important, such as the  support  for  screening  calls
22       according to Caller-ID information.
23
24       faxgetty  listens  to  its  facsimile modem for incoming calls and to a
25       FIFO special file on which it accepts command directives from  adminis‐
26       trative commands such as faxanswer(8C) and faxabort(8C).  faxgetty also
27       catches SIGTERM and SIGINT signals; cleaning up any necessary resources
28       before exiting.
29
30       Many  aspects of faxgetty operation are controlled through a configura‐
31       tion file.  In particular, for faxgetty  to  automatically  invoke  the
32       getty(8C)  program  to  handle  incoming data connections the GettyArgs
33       parameter must be setup in the configuration file.   The  configuration
34       file is located in the spooler hierarchy in the etc subdirectory and is
35       named config.devid, where devid is an identifier derived from the  name
36       of  the  modem's device file; for example ttym2 for /dev/ttym2, term_10
37       for /dev/term/10.  Consult hylafax-config(5F) for detailed  information
38       on the contents of configuration files.
39

OPTIONS

41       -D        This  option  forces  faxgetty to detach itself from the con‐
42                 trolling tty from which it was invoked.  In normal  operation
43                 faxgetty  will  not  disassociate itself from the controlling
44                 tty.
45
46       -p        Do not change the process priority when receiving  facsimile.
47                 Normally  faxgetty  will  raise  its  priority  to reduce i/o
48                 latency.  This option is useful for debugging.
49
50       -q dir    The specified directory is treated as the spooling area.  The
51                 default  spooling area, /var/spool/hylafax, is defined at the
52                 time the software is built.
53
54       -c config Treat config as a configuration parameter specification  that
55                 is  interpreted  after  reading  the per-device configuration
56                 file.  For example, ``-c sessiontracing:0x4f'' would set  the
57                 SessionTracing  configuration parameter to ``0x4f'', overrid‐
58                 ing any setting in the configuration file.
59

FILES

61       /var/spool/hylafax/FIFO.device          FIFO special file for submitting commands
62       /var/spool/hylafax/etc/config.device    device-specific configuration file
63
64       Consult hylafax-server(5F) for a complete discussion of  the  structure
65       and content of the spooling area.
66

SEE ALSO

68       faxabort(8C),  faxlock(8C), faxanswer(8C), faxconfig(8C), faxstate(8C),
69       faxq(8C), getty(8C), hylafax-server(5F), hylafax-config(5F)
70
71
72
73                                 July 31, 1995                    FAXGETTY(8C)
Impressum