1faxqueue(5)                  mgetty+sendfax manual                 faxqueue(5)
2
3
4

NAME

6       faxqueue - sendfax fax spool queue control files
7

SYNOPSIS

9       /var/spool/fax/outgoing/F*/JOB
10

DESCRIPTION

12       The  JOB  files  in the subdirectories of the outgoing fax spool direc‐
13       tory, /var/spool/fax/outgoing build up a queue of faxes to be  sent  by
14       faxrunq(1).  They  are  created  by  faxspool(1),  can  be  viewed with
15       faxq(1), and be deleted by faxrm(1).
16
17

FORMAT

19       The format of the JOB file is as follows:
20
21       Each line consists of a leading keyword and associated  data  (rest  of
22       the  line).  Some are required, some others are optional. The currently
23       implemented keywords are:
24
25       phone <number>
26              The telephone number to send the fax to. Required.
27
28       user <user>
29              The originating user name (on the local machine). If  no  "mail"
30              field  is  present, this user will get the status mail about the
31              fax. Required.
32
33       mail <email>
34              If this field is present, faxrunq(1) will send its  status  mail
35              to  the  address  given  here.  If  not, faxrunq(1) will use the
36              "user" field.  Optional.
37
38       input <file(s)>
39              The file names passed to faxspool(1).  Optional,  used  only  by
40              faxq(1).
41
42       pages <file(s)>
43              The  file names, relative to the directory where the JOB file is
44              found, that are to be sent with sendfax(8). The  files  have  to
45              exist,  and  be  readable  by  the  user  that  runs faxrunq(1).
46              Required, except if "poll" is used, then it's optional.
47
48       priority <0-9>
49              This can be used to set the priority for this  job  in  the  fax
50              queue (higher priority jobs get sent before all lower-pri jobs).
51              So far, only faxrunqd uses this field, faxrunq does  NOT.  9  is
52              the highest, 0 the lowest priority. 5 is the default.
53
54       Status <message>
55              Automatically  appended  by faxrunq(1) after each run, tells the
56              reader about successful and unsuccessful tries to send this job.
57              If  more  than  five  "FATAL"  errors are listed, the fax job is
58              removed from the queue.
59
60       verbose_to <blurb>
61              A  plain-text  description  of  the  receiver  of  the  fax.  Is
62              returned,  if  present,  in  the  mail  messages  "your  fax  to
63              <blurb>". Optional.
64
65       time <hhmm>
66              If present, faxrunq won't send this job before the  given  time.
67              The  format  must  be exactly "hhmm", in 24-hr-format, otherwise
68              faxrunq won't understand it. Optional.   (Notice:  this  implies
69              "stop trying after midnight, until hh:mm next day")
70
71       time <hhmm>-<hhmm>
72              This  format  specifies  a  time window when sending this fax is
73              permitted, e.g. "time 2300-0500".  This format will only work if
74              you use faxrunqd, as support for it has not been implemented for
75              faxrunq yet.
76
77       poll   Flag token.  If present, faxrunq will  try  to  poll  the  given
78              phone number for documents (see "sendfax -p").
79
80       normal_res
81              Flag  token.   If present, faxrunq will transmit all pages using
82              normal resolution (see "sendfax -n").
83
84       acct_handle <arbitrary string>
85              This is a pure comment field, but sendfax(8) will  log  it  into
86              its transaction log file. So this can be used as a customer han‐
87              dle, a job number, whatever you need  to  get  the  phone  bills
88              charged  to  the  customer  (the programs won't look at it, just
89              pass it through). Optional.
90
91       subject <arbitrary string>
92              This is also a pure comment field, used only  for  informational
93              purposes.  faxrunq will return it in the sucess/failure mail. If
94              you use faxspool -s <subj>, it will put this string on the cover
95              page and in the JOB file.
96
97

PERMISSIONS

99       Starting    with    mgetty    1.1.29,    the    fax   spool   directory
100       /var/spool/fax/outgoing is no longer  world-writeable.   It  should  be
101       owned  by  the  user  'fax'  and  be  mode  755.   The  faxrunq(1)  and
102       faxrunqd(1) programs should also be run under that user ID if possible.
103
104       If the fax spool directory is world- or group-writeable,  there  are  a
105       number  of  denial  of  service or file overwrite / file access attacks
106       possible that it's very hard to guard against. So don't do this!
107
108       If the fax spool directory has the proper permissions, there  are  cur‐
109       rently  no  known attacks against faxrunq/faxrunqd, even if they run as
110       "root", but it's always more safe to run as untrusted user.
111
112
113

PROCESSING

115       While a given JOB file is processed by faxrunq(1), it's locked  against
116       sending  it  multiple  times  by temporarily renaming it to JOB.locked,
117       thus it may happen that a faxq(1) command  doesn't  show  this  job.  (
118       faxrunqd(8)  is  a  bit smarter and does the locking by creating a hard
119       link).
120
121       When a job is successfully sent, it's not deleted but the JOB  file  is
122       renamed  to JOB.done.  Because of this, you can still see old jobs with
123       "faxq -o". You should regularly clean up the  outgoing  fax  directory,
124       removing  old  faxes.  If  you  don't  want  this  behaviour,  edit the
125       faxrunq(1) config file and enable the option delete-sent-jobs yes
126
127       When a job cannot be sent after several tries (excluding normal  diffi‐
128       culties  like  the called number being busy or the modem being in use),
129       the JOB file is renamed to JOB.suspended.  To re-queue this  job,  call
130       faxq -r -- this renames the JOB file back.
131
132

SEE ALSO

134       faxrunq(1), faxspool(1), faxrm(1), faxq(1), faxrunqd(8)
135
136
137
138greenie                            23 Nov 02                       faxqueue(5)
Impressum