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

NAME

6       faxqclean - HylaFAX queue cleaner process
7

SYNOPSIS

9       /usr/sbin/faxqclean [ options ]
10

DESCRIPTION

12       faxqclean  is  a  program  that  processes  completed  HylaFAX jobs and
13       expunges unreferenced document files.  This program is intended  to  be
14       invoked by cron(8C) on behalf of the super user (i.e. root) one or more
15       times a day.  For example, the following crontab entry might  be  setup
16       for root to run faxqclean each hour.
17         0   *    *    *    *   /usr/sbin/faxqclean
18
19       When  faxqclean  is  run it scans the doneq subdirectory in the HylaFAX
20       spooling area and process each job according to the doneop field speci‐
21       fied  in  the  job  description  file;  c.f.  sendq(5F).  Jobs that are
22       marked for removal are purged and references to documents are  removed.
23       Jobs  that  are  marked  for  archival may be archived depending on the
24       options supplied on the command line.
25
26       After scanning for completed jobs faxqclean scans the docq subdirectory
27       and builds up a table of document files.  Files that are not referenced
28       by any job and that are older than a specified threshold are removed.
29

OPTIONS

31       -a        Enable job archiving support.
32
33       -A        This option forces archiving even if 'doneop'  in  the  queue
34                 file  is  not  'archive', i.e. even if the user submitted the
35                 job without specifying the -A flag to sendfax
36
37       -j secs   Set the job age threshold (in seconds) that controls how long
38                 jobs  may  reside  in  the  doneq directory before being pro‐
39                 cessed.  By default this value is 15  minutes  (15*60  =  900
40                 seconds).
41
42       -d secs   Set the document age threshold (in seconds) that controls how
43                 long unreferenced files may  reside  in  the  docq  directory
44                 before being removed.  By default this value is 1 hour (60*60
45                 = 3600 seconds).
46
47       -n        Do not carry out any work; just  show  what  would  be  done.
48                 This  option is useful together with the -t option for debug‐
49                 ging.
50
51       -q dir    The specified directory is treated as the spooling area.  The
52                 default  spooling area, /var/spool/hylafax, is defined at the
53                 time the software is built.
54
55       -s script Specifies a custom script to be used for archiving.  This  is
56                 given relative to the spooling area, /var/spool/hylafax.  The
57                 default script is bin/archive found in the spooling area.
58
59       -t        Trace in great detail exactly what faxqclean is doing.   Mes‐
60                 sages are sent to the standard output.
61
62       -v        Print  messages  on the standard output about jobs removed or
63                 archived and about document files removed.
64

FILES

66       /var/spool/hylafax/doneq      directory to scan for completed jobs
67       /var/spool/hylafax/docq       directory to scan for unreferenced documents
68       /var/spool/hylafax/archive    directory where archived jobs are placed
69
70       Consult hylafax-server(5F) for a complete discussion of  the  structure
71       and content of the spooling area.
72

SEE ALSO

74       faxq(8C), hylafax-server(5F), sendq(5F), doneq(5F), archive(5F).
75
76
77
78                                March 14, 1996                   FAXQCLEAN(8C)
Impressum