faxqueue(5) mgetty+sendfax manual faxqueue(5) NNAAMMEE faxqueue - sendfax fax spool queue control files SSYYNNOOPPSSIISS //vvaarr//ssppooooll//ffaaxx//oouuttggooiinngg//FF**//JJOOBB DDEESSCCRRIIPPTTIIOONN The _J_O_B files in the subdirectories of the outgoing fax spool directory, _/_v_a_r_/_s_p_o_o_l_/_f_a_x_/_o_u_t_g_o_i_n_g build up a queue of faxes to be sent by faxrunq(1). They are created by faxspool(1), can be viewed with faxq(1), and be deleted by faxrm(1). FFOORRMMAATT The format of the JOB file is as follows: Each line consists of a leading keyword and associated data (rest of the line). Some are required, some others are optional. The currently implemented keywords are: pphhoonnee <> The telephone number to send the fax to. Required. uusseerr <> The originating user name (on the local machine). If no "mail" field is present, this user will get the status mail about the fax. Required. mmaaiill <> If this field is present, faxrunq(1) will send its status mail to the address given here. If not, faxrunq(1) will use the "user" field. Optional. iinnppuutt <> The file names passed to faxspool(1). Optional, used only by faxq(1). ppaaggeess <> The file names, relative to the directory where the JOB file is found, that are to be sent with send- fax(8). The files have to exist, and be readable by the user that runs faxrunq(1). Required, except if "poll" is used, then it's optional. pprriioorriittyy <<00--99>> This can be used to set the priority for this job in the fax queue (higher priority jobs get sent before all lower-pri jobs). So far, only _f_a_x_r_u_n_q_d uses this field, _f_a_x_r_u_n_q does NOT. 9 is the high- est, 0 the lowest priority. 5 is the default. SSttaattuuss <> Automatically appended by faxrunq(1) after each greenie 23 Nov 02 1 faxqueue(5) mgetty+sendfax manual faxqueue(5) run, tells the reader about successful and unsuc- cessful tries to send this job. If more than five "FATAL" errors are listed, the fax job is removed from the queue. vveerrbboossee__ttoo <> A plain-text description of the receiver of the fax. Is returned, if present, in the mail messages "your fax to ". Optional. ttiimmee <> If present, _f_a_x_r_u_n_q won't send this job before the given time. The format must be exactly "hhmm", in 24-hr-format, otherwise faxrunq won't understand it. Optional. ppoollll Flag token. If present, faxrunq will try to poll the given phone number for documents (see "sendfax -p"). nnoorrmmaall__rreess Flag token. If present, faxrunq will transmit all pages using normal resolution (see "sendfax -n"). aacccctt__hhaannddllee <> This is a pure comment field, but sendfax(8) will log it into its transaction log file. So this can be used as a customer handle, a job number, what- ever you need to get the phone bills charged to the customer (the programs won't look at it, just pass it through). Optional. ssuubbjjeecctt <> This is also a pure comment field, used only for informational purposes. _f_a_x_r_u_n_q will return it in the sucess/failure mail. If you use _f_a_x_s_p_o_o_l _-_s _<_s_u_b_j_>_, it will put this string on the cover page and in the JOB file. PPEERRMMIISSSSIIOONNSS Starting with mgetty 1.1.29, the fax spool directory /var/spool/fax/outgoing is no longer world-writeable. It should be owned by the user 'fax' and be mode 755. The faxrunq(1) and faxrunqd(1) programs should also be run under that user ID if possible. If the fax spool directory is world- or group-writeable, there are a number of denial of service or file overwrite / file access attacks possible that it's very hard to guard against. So don't do this! If the fax spool directory has the proper permissions, there are currently no known attacks against greenie 23 Nov 02 2 faxqueue(5) mgetty+sendfax manual faxqueue(5) faxrunq/faxrunqd, even if they run as "root", but it's always more safe to run as untrusted user. PPRROOCCEESSSSIINNGG While a given JOB file is processed by faxrunq(1), it's locked against sending it multiple times by temporarily renaming it to _J_O_B_._l_o_c_k_e_d_, thus it may happen that a faxq(1) command doesn't show this job. ( _f_a_x_r_u_n_q_d_(_8_) is a bit smarter and does the locking by creating a hard link). When a job is successfully sent, it's not deleted but the JOB file is renamed to _J_O_B_._d_o_n_e_. Because of this, you can still see old jobs with "faxq -o". You should regularly clean up the outgoing fax directory, removing old faxes. If you don't want this behaviour, edit the faxrunq(1) con- fig file and enable the option _d_e_l_e_t_e_-_s_e_n_t_-_j_o_b_s _y_e_s When a job cannot be sent after several tries (excluding normal difficulties like the called number being busy or the modem being in use), the JOB file is renamed to _J_O_B_._s_u_s_p_e_n_d_e_d_. To re-queue this job, call _f_a_x_q _-_r -- this renames the JOB file back. SSEEEE AALLSSOO faxrunq(1), faxspool(1), faxrm(1), faxq(1), faxrunqd(8) greenie 23 Nov 02 3 .