1SENDQ(5F)                                                            SENDQ(5F)


6       sendq/q* - HylaFAX outbound job description


9       Files  in the sendq directory specify transmission job requests.  These
10       files are created by hfaxd(8C), when submitting  a  job  on  behalf  of
11       sendfax(1)  or  sendpage(1).   Job description files also reside in the
12       doneq directory; they are moved there by faxq(8C) when a job completes.
14       Job description files are ASCII files with lines of the form
15            tag: value
16       where a tag is one of the identifiers described below and  a  value  is
17       either a string or number.  Values start at the first non-blank charac‐
18       ter after the ``:'' and continue to the end of the  line.   Lines  that
19       end  with  a  backslash character ``\'' are continued to the next line.
20       Numeric values are decimal integers, except for chophreshold  which  is
21       expressed as a floating point value.
23       The  following  table  lists the possible tags and the required type of
24       the associated value.
25              Tag             Type       Description
26              chopthreshold   float      page chopping threshold (inches)
27              commid          string     communication identifier for last call
28              company         string     receiver's company
29              conntime        integer    total connection time for all sessions
30              client          string     host that submitted the job
31              cover           string     continuation coverpage file
32              data            string     unprocessed document of indeterminate type
33              !data           string     processed document of indeterminate type
34              dataformat      string     data format used to transmit a facsimile
35              desiredbr       integer    desired maximum transmit speed
36              desireddf       integer    desired page data format
37              desiredec       integer    desired use of Error Correction Mode (ECM)
38              desiredst       integer    desired minimum scanline time
39              desiredtl       integer    whether or not to use tagline parameter
40              doneop          string     operation to perform when job is reaped
41              duration        integer    total duration time for all sessions
42              errorcode       string     job status error code
43              external        string     external form of dialstring
44              fax             string     document ready for transmission
45              faxnumber       string     origin number to use sending
46              faxname         string     origin name to use sending
47              groupid         integer    HylaFAX job group identifier
48              ignoremodembusy integer    whether or not to ignore a modem busy state
49              jobid           integer    HylaFAX job identifier
50              jobtag          string     user-specified job identifier
51              jobtype         string     job type identification string
52              killtime        integer    time to give up trying to send job
53              location        string     receiver's location
54              mailaddr        string     email address of sender
55              maxdials        integer    max number of times to dial
56              maxtries        integer    max number of attempts to send job
57              minbr           integer    minimum required transmit speed
58              modem           string     outgoing modem to use
59              ndials          integer    number of consecutive failed attempts to place call
60              nocountcover    integer    don't include these pages in counts
61              notify          string     email notification specification
62              npages          integer    number of pages transmitted
63              ntries          integer    number of attempts to send current page
64              number          string     dialstring to use in placing call
65              owner           string     user that owns the job
66              page            string     PIN in a page operation
67              pagechop        string     whitespace truncation handling
68              pagehandling    string     page analysis information
69              pagelength      integer    facsimile page length (millimeters)
70              pagewidth       integer    facsimile page width (millimeters)
71              passwd          string     info to send in HDLC PWD frame
72              pcl             string     unprocessed PCL document
73              !pcl            string     processed PCL document
74              poll            string     polling request
75              postscript      string     unprocessed POSTSCRIPT document
76              !postscript     string     processed POSTSCRIPT document
77              priority        integer    user-specified scheduling priority
78              probeonly       integer    if non-zero this identifies the probe type
79              receiver        string     receiver's identity
80              resolution      integer    vertical resolution of facsimile
81              retrytime       integer    time to use between job retries
82              returned        integer    indicates return status value for the job
83              schedpri        integer    current scheduling priority
84              sender          string     identity of sender
85              serverdocover   integer    whether or not to have the server create the cover page
86              signalrate      string     signalling rate at which a facsimile was sent
87              skippages       integer    skip this number of pages in the first document
88              skippedpages    integer    increment page counts by this number
89              state           integer    job scheduling state
90              status          string     job status
91              subaddr         string     info to send in HDLC SUB frame
92              tagline         string     tagline format string
93              tiff            string     unprocessed TIFF/F document
94              !tiff           string     processed TIFF/F document
95              timeofday       string     time of day restrictions
96              timezone        string     time zone to use for tagline formatting
97              totdials        integer    total number of phone calls
98              totpages        integer    total pages to transmit
99              tottries        integer    total number of attempts to send job
100              tsi             string     TSI to transmit when sending
101              tts             integer    time to send job
102              useccover       integer    whether or not to use a continuation cover page
103              usexvres        integer    whether or not to use highest vertical resolution


106       Note that all files must be owned by the fax user.  Pathnames for docu‐
107       ment  files  must be relative to the top of the HylaFAX spooling direc‐
108       tory and not include ``..''.
110       chopthreshold The minimum trailing whitespace  (in  inches)  that  must
111                     appear on a page for it to be considered for ``page chop‐
112                     ping''.  If this parameter  is  not  specified  then  the
113                     value  specified  by  the PageChopThreshold configuration
114                     parameter is used; see hylafax-config(5F).
116       commid        The communication identifier for the last  outbound  call
117                     placed  for  this  job.   This  string  is  of  the  form
118                     ``XXXXXXXX'' where XXXXXXXX is a decimal sequence  number
119                     in the range 1-99999999.
121       client        The  fully  qualified hostname for the machine from which
122                     the job was submitted.  If the hostname is unknown at the
123                     time  the  job  is  submitted,  then  the host address in
124                     Internet  standard  ``.''  (dot)  notation  is   supplied
125                     instead.
127       company       The  receiver's  company  name  as  specified with the -x
128                     option to sendfax(1).  This value is used only when  cre‐
129                     ating continuation cover pages.
131       conntime      The  total connection time in seconds for all of the ses‐
132                     sions for this job.
134       cover         The pathname of a continuation cover page to  send.   The
135                     file must be TIFF/F (i.e. it must already be prepared for
136                     transmission).  This document will be transmitted  before
137                     any  other  documents listed in the file.  See ContCover‐
138                     Page and ContCoverCmd in hylafax-config(5F).
140       data          The pathname of a document to send.  Once a document  has
141                     been  processed, it is marked as !data so that subsequent
142                     retries do not reprocess the document.
144       dataformat    The format used to transmit facsimile data.  This item is
145                     recorded  by faxsend(8C) so that notify(8C) can return it
146                     in a notification message.
148       desiredbr     The desired signalling rate to use for page  data  trans‐
149                     missions: 0 for 2400 bps, 1 for 4800 bps, 2 for 7200 bps,
150                     3 for 9600 bps, 4 for 12000 bps, 5 for 14400 bps,  6  for
151                     16800  bps, 7 for 19200 bps, 8 for 21600 bps, 9 for 24000
152                     bps, 10 for 26400 bps, 11 for 28800  bps,  12  for  31200
153                     bps, and 13 for 33600 bps (default).
155       desireddf     The  desired  data  format to use for page data transmis‐
156                     sions: 0 for 1-D MH, 1 for 2-D MR,  3  for  2-D  MR  with
157                     uncompressed data, and 4 for 2-D MMR (default).
159       desiredec     Which  type  of  Error Correction Mode (ECM) to use: 0 to
160                     disable, 1 for 64-byte ECM, 2 for 256-byte ECM (default).
162       desiredst     The desired minimum scanline time to use  for  page  data
163                     transmissions:  0  for  0 ms (default), 1 for 5 ms, 2 for
164                     10ms/5ms, 3 for 10ms, 4 for 20ms/10ms, 5 for 20ms, 6  for
165                     40ms/20ms, and 7 for 40ms.  This value is used in select‐
166                     ing the negotiated session parameters.
168       desiredtl     Whether or not to use the format string specified by  the
169                     tagline  job  parameter when imaging taglines on document
170                     pages.  If this value is  non-zero  then  per-job  format
171                     string is used; otherwise the tagline format string spec‐
172                     ified in the  server  configuration  file  is  used;  see
173                     TagLineFormat in hylafax-config(5F).
175       doneop        The  treatment  the  job  should be given when it is pro‐
176                     cessed by the faxqclean(8C) job cleaner program.  The may
177                     be one of remove (to expunge the job description file and
178                     all associated  documents  that  are  not  referenced  by
179                     another  job)  or  archive  (to  request that the job and
180                     associated documents be archived on the server  machine).
181                     Consult  faxqclean more details on other information that
182                     may be included in this string.
184       duration      The total duration time in seconds for all  sessions  for
185                     this job.
187       errorcode     The  codified form of the status message intended for use
188                     by clients which provide customized status messages keyed
189                     from this standard index.
191       external      The external form of the dialstring.  This string is used
192                     instead of the dialstring in any status and log messages.
193                     Clients  can  protect  private information such as access
194                     codes that must be placed in dialstrings by  supplying  a
195                     ``cleansed'' version of the dialstring.
197       fax           The  pathname  of  a  TIFF/F  document  that is ready for
198                     transmission.  If  the  pathname  string  has  a  leading
199                     ``xx:'',  then  ``xx''  is interpreted to be the index of
200                     the first directory in the file to transmit  (directories
201                     are numbered starting at zero).
203       faxnumber     The originating number to use when sending a fax.  Paral‐
204                     lels FAXNumber device config option.
206       faxname       The originating name to use when sending a fax.
208       groupid       The job group identifier, an integer number in the  range
209                     1  to 32000 assigned to each group of jobs by the HylaFAX
210                     software.  Each job in a group of jobs submitted  at  the
211                     same time is assigned the same value by the HylaFAX soft‐
212                     ware.
214       ignoremodembusy
215                     1 if the job should ignore a modem busy status  (requires
216                     server configuration to allow) 0 otherwise.
218       jobid         The  job identifier, a unique integer number in the range
219                     1 to 32000 assigned to each job by the HylaFAX software.
221       jobtag        A user-specified string that is intended for  identifica‐
222                     tion purposes.  If this string is defined, it is returned
223                     to the user in notification messages instead of  the  job
224                     identifier.
226       killtime      The  time  to  kill  this job, expressed in seconds since
227                     00:00:00 GMT, January 1, 1970.
229       location      The receiver's location as specified with the  -y  option
230                     to  sendfax(1).   This  value  is used only when creating
231                     continuation cover pages.
233       mailaddr      The electronic mail address to  which  notification  mes‐
234                     sages should be directed.
236       maxdials      The  maximum  number  of times the server should dial the
237                     phone.  If the job cannot be completed in this number  of
238                     calls, it is terminated.
240       maxtries      The  maximum number of times the server should attempt to
241                     send a job; where an attempt is defined to be  a  session
242                     that  makes  it  past  Phase A of the CCITT T.30 protocol
243                     (for facsimile), or similar.  If the job cannot  be  com‐
244                     pleted in this number of tries, it is terminated.
246       minsp         The  minimum signalling rate to use for transmitting page
247                     data: 0 for 2400 bps (default), 1 for  4800  bps,  2  for
248                     7200  bps,  3  for 9600 bps, 4 for 12000 bps, 5 for 14400
249                     bps, 6 for 16800 bps, 7 for 19200 bps, 8 for 21600 bps, 9
250                     for 24000 bps, 10 for 26400 bps, 11 for 28800 bps, 12 for
251                     31200 bps, and 13 for 33600 bps.
253       modem         The outgoing modem to use to send the job, or ``any''  if
254                     any available modem is acceptable.
256       owner         The  identity  of  the user that owns the job.  Typically
257                     the owner is  the  user  that  created  the  job,  though
258                     clients  with  administrative  privileges  can change the
259                     ownership of jobs.  The value is the string specified  in
260                     the USER command passed to hfaxd(8C) when a client logins
261                     in to the server.
263       nocountcover  Indicates the number of pages at the first document  that
264                     should be ignored in page counting for the tagline.
266       notify        A specification of whether the sender wants notification:
267                     whenever the job is requeued after a  failed  attempt  to
268                     transmit  (``when  requeued''), when the job is completed
269                     (``when   done''),   either   of   the   above    (``when
270                     done+requeued''), or not at all (``none'').
272       npages        The number of pages in the facsimile, including the cover
273                     page, that have been successfully transmitted.
275       ntries        The number of unsuccessful attempts that have  been  made
276                     to transmit the current page.
278       ndials        The number of consecutive unsuccessful attempts to estab‐
279                     lish carrier with the the remote device.
281       number        The dialstring to use to call the destination device.
283       page          a string with PIN and to use in processing a page  trans‐
284                     mit request.
286       pagechop      Whether  or not to automatically truncate trailing white‐
287                     space on pages of outbound  facsimile;  see  PageChop  in
288                     hylafax-config(5F).  The possible values are: ``default''
289                     to use the setting of the PageChop configuration  parame‐
290                     ter, ``none'' to disable page chopping, ``all'' to enable
291                     chopping of all pages, and ``last'' to enable chopping of
292                     the last page of each document.
294       pagehandling  A  string  that contains per-page information used during
295                     facsimile transmission.  Most of the information is  used
296                     in  the negotiation of session capabilities with optional
297                     information used in the implementation of page  chopping.
298                     The  string has five characters, say xxxxc, for each page
299                     to be transmitted.  The xxxx characters are a hex-encoded
300                     specification  of  the  session  capabilities required to
301                     transmit the page.  The c  character  is  one  of  ``M'',
302                     ``S'', and ``P''; where: ``M'' indicates there is another
303                     page to follow and that the page requires different  T.30
304                     session  parameters  be  negotiated (an EOM code is to be
305                     transmitted).  ``S'' indicates there is another  page  to
306                     follow, but the page uses the same session parameters (an
307                     MPS.  code is to be transmitted).  ``P''  indicates  this
308                     is  the last page to be transmitted (an EOP code is to be
309                     transmitted).  In addition, if  page  chopping  has  been
310                     enabled and the page has enough trailing whitespace to be
311                     a candidate, then each three  character  string  will  be
312                     followed  by  a  string  of  the  form  ``ZXXXX'',  where
313                     ``XXXX'' is a 4 digit hex-encoded count of the number  of
314                     bytes of data to send for a chopped page.
316       pagelength    The desired page length in millimeters.
318       pagewidth     The desired page width in millimeters.
320       pcl           The pathname of a PCL document to send.  Once a PCL docu‐
321                     ment has been processed by faxsend, it is marked as  !pcl
322                     so that subsequent retries do not reprocess the document.
324       poll          The  value is a Caller Identification String (CIS) to use
325                     in making a polling request.  If no CIS is specified then
326                     faxsend  will  form  one from the FAXNumber configuration
327                     parameter.
329       postscript    The pathname of a POSTSCRIPT® document to send.   Once  a
330                     POSTSCRIPT  document has been processed by faxsend, it is
331                     marked as !postscript so that subsequent retries  do  not
332                     reprocess the document.
334       probeonly     If  ``1'' then the call will terminate as complete when a
335                     fax connection is established.  If ``2''  then  the  call
336                     will  terminate as complete after fax handshaking signals
337                     are properly received from the receiver.  In neither case
338                     are the documents actually transmitted.
340       receiver      The receiver's name.  This value is used only when creat‐
341                     ing continuation cover pages.
343       resolution    The desired vertical resolution in lines per inch.   This
344                     value should be either 98 or 196.
346       retrytime     The  time,  in  seconds, to delay between each attempt to
347                     transmit a job that fails because of a communication-ori‐
348                     ented  problem.  Normally jobs are scheduled according to
349                     a collection of configuration parameters that  are  tuned
350                     for  the specific reason of each failure; e.g. see JobRe‐
351                     qProto in hylafax-config(5F).
353       returned      Used internally to determine the last return value of the
354                     job send attempt.
356       sender        The ``full name'' of the sender of the facsimile.
358       serverdocover 1 if the job should have a server-generated cover page, 0
359                     otherwise.
361       signalrate    The signalling rate  used  to  transmit  facsimile  data.
362                     This  item  is recorded by faxsend(8C) so that notify(8C)
363                     can return it in a notification message.
365       skippages     Indicates to the server to skip-over this number of pages
366                     in  the  first document submitted, but to indicate in the
367                     page counts as if they were already transmitted (i.e.  in
368                     a previous job).  The server moves this number from skip‐
369                     pages into skippedpages as soon as the document  prepara‐
370                     tion occurs.
372       skippedpages  Indicates  to the server to increment page counts by this
373                     number as if that number of pages were transmitted  in  a
374                     previous job.
376       state         The job scheduling state.  Recognized values are: 1 (sus‐
377                     pended, not being scheduled), 2 (pending, waiting for the
378                     time to send), 3 (sleeping, waiting for a scheduled time‐
379                     out), 4 (blocked, waiting for concurrent activity to  the
380                     same destination to complete), 5 (ready, ready to be pro‐
381                     cessed  except  for  available  resources),  6   (active,
382                     actively being processed by HylaFAX), 7 (done, processing
383                     completed with success), and 8 (failed,  processing  com‐
384                     pleted with a failure).
386       status        Status  information  about  the current state of the job.
387                     Typically this is the reason why the last attempt to send
388                     the facsimile failed.
390       subaddr       The  SubAddress  information  to  transmit when sending a
391                     facsimile.  This string should be used by the receiver to
392                     route received facsimile documents.
394       tagline       The  format string to use in imaging taglines on outgoing
395                     documents.  Note that this parameter is only used if  the
396                     desiredtl parameter is non-zero.
398       tiff          The  pathname  of a TIFF/F document to send.  Once a TIFF
399                     document has been processed by faxsend, it is  marked  as
400                     !tiff  so  that  subsequent  retries do not reprocess the
401                     document.
403       timeofday     The time-of-day restrictions to place on  the  job.   The
404                     syntax  is identical to the similar TimeOfDay server-con‐
405                     figuration option found in hylafax-config(5F).
407       timezone      The time zone locale setting to use  in  tagline  format‐
408                     ting.
410       totdials      The total number of times the server has placed a call to
411                     the receiving phone number.
413       totpages      The total number of pages to be transmitted.
415       tottries      The total number of attempts to transmit a job; see  max‐
416                     tries above.
418       tsi           TSI to use when sending.  This is only used if the device
419                     has been configured to allow it.  Otherwise, the  config‐
420                     ured LocalIdentifier.  is used.
422       tts           The  time to send the job.  If this value is non-zero, it
423                     is number of seconds since 00:00:00 GMT, January 1, 1970.
424                     Otherwise, a value of 0 is interpreted to mean process as
425                     soon as possible.
427       useccover     1 if the job should use a continuation cover page  during
428                     retransmission, 0 otherwise.
430       usexvres      1  if  the  job  should use the highest possible vertical
431                     resolution, 0 otherwise.  See  hylafax-server(5F)  for  a
432                     description of continuation cover pages.


435       sendfax(1),   faxq(8C),   faxqclean(8C),   faxsend(8C),   pagesend(8C),
436       hfaxd(8C), hylafax-config(5F)
440                                 May 12, 1996                        SENDQ(5F)