1faxrunq(1) mgetty+sendfax manual faxrunq(1)
2
6 faxrunq - send fax jobs queued by faxspool(1)
7
9 faxrunq
10
12 Run the fax queue set up by faxspool(1), try to send all faxes, record
13 result, remove job and send notify mails.
14 faxrunq looks for all the jobs queued by faxspool(1) to
16 /var/spool/fax/outgoing/*. For each job in the queue, faxrunq tries to
17 send it, using sendfax(8).
18 If the send succeeds, the job is removed from the queue, and a "suc‐
20 cess" mail is sent to the originator of the spooled job.
21 If the send fails, it's logged, and faxrunq proceeds to the next job.
23 If the job fails five times "fatally", that is, not with a locked or
24 engaged line, but with "NO CARRIER" (no fax machine, or line noise),
25 the job is suspended, and the requestor gets a mail, telling him so.
26 faxrunq can be run from the command line (but make sure the user doing
28 this has write access to the modem device and to the fax queue, that
29 is, usually this should be done by "fax" or "root"). In a production
30 environment, it's more useful to start faxrunq from cron(8) in regular
31 intervals, like "run it every 5 minutes". See the cron(8) and/or
32 crontab(1) man pages for this (which man page exists depends on your
33 system).
34
37 -q Tells faxrunq to be quiet, that is, suppress all status mes‐
38 sages. Error messages will still be printed.
39
42 /var/spool/fax/outgoing/stop
43 if this file exists, faxrunq (and faxrunqd) will do nothing.
44 You can use this to stop queue processing while testing some‐
45 thing, or if you know that the modem(s) are unavailable and do
46 not want to run into oany error messages, etc.
47 /var/spool/fax/outgoing/faxqueue_done
50 Every time faxrunq (or faxrunqd) run the fax queue, a time stamp
51 is written into that file. It is used by faxspool to display a
52 warning if the queue hasn't been run recently (so faxes may get
53 stuck).
54
57 Some aspects of the behaviour of faxrunq can be controlled by a config‐
58 uration file, /etc/mgetty+sendfax/faxrunq.config. In this file, you
59 can use the following options:
60 success-send-mail [y/n]
62 A boolean parameter that controls whether a mail will be sent
63 after successful completition of the fax job.
64 failure-send-mail [y/n]
67 A boolean parameter that controls whether a mail will be sent
68 after the fax job has failed more than the maximum number of
69 times.
70 success-call-program <name>
73 Here, you can specify a program that will be run when the fax
74 has been successfully sent. It will be passed two command line
75 parameters. The first is the full path to the fax JOB file (see
76 faxq(5)), the second is the last exit code from sendfax (for
77 success-call-program, this is always "0").
78 failure-call-program <name>
81 Similar to the "success-call-program", this program will be run
82 when the fax has been failed too often and faxrunq gives up.
83 This script could, for example, print out the fax on a printer
84 so that it can be sent manually on a paper fax machine.
85 maxfail-costly <n>
88 This specifies the number of times that a fax may fail
89 "fatally", that is, causing telephone costs (explained above).
90 The default value is 5.
91 maxfail-total <m>
94 This is the absolute maximum number of times that faxrunq will
95 try to send any given fax. The default value is 10. (Right now,
96 it's not yet implemented).
97 delete-sent-jobs [y/n]
100 Determines whether faxrunq should delete jobs after sending, or
101 leave them in the fax queue (while moving the "JOB" file to
102 "JOB.done") so that they can be seen at by "faxq -o". The
103 default value is "do not delete sent faxes".
104 acct-log <path>
107 Specifies where faxrunq should protocol success and failure of
108 each try to send a fax job. The default location is
109 /var/spool/fax/outgoing/acct.log.
110 There are some other options that are allowed, but ignored.
112 These are: max-modems, and faxrunqd-log.
113 They are used by faxrunqd(8) (which reads the same config file,
115 but has more options).
116
119 faxrunq doesn't handle proper time scheduling yet
120 Don't use faxrunq if you have malevolent users with access to the fax
122 spool. It doesn't handle all cases of file movement tricks correctly.
123 Use faxrunqd(8) instead, which does it correctly (this point is mostly
124 moot if the fax queue is set up correctly - that is, owned by 'fax',
125 mode 755, and faxrunq(1) is also run as user 'fax').
126
129 faxspool(1), sendfax(8), faxq(1), faxqueue(5), faxrunqd(8)
130
132 faxrunq is Copyright (C) 1993-2002 by Gert Doering, <gert@gree‐
133 nie.muc.de>.
134greenie 23 Nov 02 faxrunq(1)