FAXCRON(8C)

FAXCRON(8C)

faxconfig Home Page System Administration Index faxgetty

NAME
       faxcron - HylaFAX routine maintenance script

SYNOPSIS
       /usr/local/sbin/faxcron [ -n ] [ -l lastrun ]

DESCRIPTION
       faxcron is a command script that does routine upkeep tasks
       in a HylaFAX spooling directory hierarchy.  This script is
       intended  to be invoked from cron(8C) on behalf of the fax
       user once a day, with the standard output sent by mail  to
       the  HylaFAX  administrator.   For  example, the following
       crontab might be setup for the fax user:
         25   23    *    *    *   sh /usr/local/sbin/faxcron | mail FaxMaster

       The faxcron script does the following work:

       +o  report statistics for facsimile transmitted  since  the
          last time faxcron was run.

       +o  report statistics for facsimile transmitted in the past
          week.

       +o  report statistics for facsimile received since the last
          time faxcron was run.

       +o  report  statistics  for  facsimile received in the past
          week.

       +o  report any recent calls that  failed  suspiciously  and
          return the associated trace log;

       +o  purge  data  that  is  30 days or older from the remote
          machine information directory;

       +o  delete information that is 30 days or older  from  ses-
          sion trace log files;

       +o  remove files from the tmp directory that are older than
          1 day;

       +o  remove received facsimile that are 7 days or older;

       +o  report sites that are currently having  jobs  rejected;
          and

       +o  force all session log files to be owned by the fax user
          and kept with protection mode 644.

OPTIONS
       -n        Forces  faxcron  to  run  without  updating  any
                 files.

       -l lastrun
                 Forces  the notion of the last time that faxcron
                 was run to be lastrun.  The value of lastrun  is
                 a  date  and  time string of the form ``MM/DD/YY
                 HH:MM''  (the   date(1)   format   string   ``%D
                 %H:%M'').

       -info n   Set  the  expiration  time  for data in the info
                 database to be n days.

       -log n    Set the expiration time for session log data  to
                 be n days.

       -rcv n    Set   the  expiration  time  for  files  in  the
                 received facsimile queue to be n days.

       -tmp n    Set the expiration time for  files  in  the  tmp
                 directory to be n days.

       -mode m   Set the file protection mode for session logs to
                 m (a command line argument to chmod(1)).

NOTES
       This script requires nawk(1) or gawk(1)  and  a  date  (1)
       program that supports the ``+format'' option.

       If session logs are to be kept private this script must be
       modified to filter out sensitive information such as call-
       ing  card  numbers.   (It  should also be run with ``-mode
       0600'' so that session log files are  not  publicly  read-
       able.)

FILES
       /var/spool/fax                  spooling area
       /var/spool/fax/etc/lastrun      timestamp of last run
       /usr/local/sbin/xferstats       for generating transmit statistics
       /usr/local/sbin/recvstats       for generating receive statistics
       /tmp/faxcronXXXX                temporary file for truncating session logs
       /tmp/faxlogXXXX                 temporary file for logs of failed calls

SEE ALSO
       cron(8C) faxq(8C) faxgetty(8C) faxsend(8C) xfer- 
       stats(8C) recvstats(8C) hylafax(5F) 

faxconfig Home Page System Administration Index faxgetty