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

NAME

6       pdf2fax  -  image Portable Document Format file for facsimile transmis‐
7       sion by HylaFAX
8

SYNOPSIS

10       /var/spool/hylafax/bin/pdf2fax [ options ] [ files...  ]
11

DESCRIPTION

13       pdf2fax takes Portable Document Format (PDF) input and generates a TIFF
14       Class  F image file suitable for facsimile transmission.  It is usually
15       invoked by the HylaFAX scheduler process,  faxq(8C).   PDF  imaging  is
16       typically done using the freely available Ghostscript software.
17
18       pdf2fax is actually a link (symbolic or otherwise) to the script appro‐
19       priate  for  the  PDF  imaging  tool.   The  link  is  setup  when  the
20       faxsetup(8C)  script  is  run to configure a HylaFAX server machine for
21       use.
22
23       Input files containing PDF may be specified on the  command  line.   If
24       none are given, then pdf2fax will read from standard input.
25
26       By  default, pdf2fax will generate a 98 line/inch output document whose
27       page width is 1728 pixels and page length is 297 mm (a standard A4 page
28       at  low resolution).  Horizontal resolution is always 204 dpi.  Command
29       line options may be used to select alternate  vertical  resolution  and
30       page dimensions.
31
32       If  no  filename  is  given,  pdf2fax writes its output to a file named
33       pdf.fax; the -o option can be used to specify an alternate filename.
34
35       By default, output is compressed using the standard Group 3 1D-encoding
36       scheme,  with EOL codes padded to byte boundaries.  If the -2 option is
37       specified, output is encoded with  the  optional  Group  3  2D-encoding
38       scheme (EOL codes are still padded to byte boundaries).
39
40       This  script can modify outgoing facsimile, such as watermarking, To do
41       this create a shell script etc/FaxModify  in  the  spooling  area  that
42       alters the document.
43
44       Note  that  bin/pdf2fax  is  usually just a link to a shell script that
45       invokes the appropriate PDF RIP to do the work.
46

OPTIONS

48       The following operations are recognized:
49
50       -1        Write Group 3 1D-encoded data to the output file.
51
52       -2        Write Group 3 2D-encoded data to the output file.
53
54       -3        Write Group 4 MMR-encoded data to the output file.
55
56       -color    Write color data to an output file (possibly a separate  file
57                 if Group 3 or Group 4 data is also being output).
58
59       -i jobid  How the server references the associated Job ID number
60
61       -m pages  Set  the  maximum  number  of pages that are permitted in the
62                 output file.  If more pages are present in the input document
63                 then abort processing.
64
65       -o file   Write  output  to  the  specified file instead of the default
66                 pdf.fax filename.
67
68       -w width  Set the output page width, in pixels.  By default, pages  are
69                 1728 pixels wide.
70
71       -l length Set the output page length in millimeters.  By default, pages
72                 are 297 millimeters long.
73
74       -r vres   Set the vertical resolution, in lines/inch, at which to image
75                 the PDF.
76

RUNTIME ENVIRONMENT

78       Before  user-supplied  PDF  is passed to the PDF interpreter, a limited
79       number of operators are defined.  These operators  are  operators  com‐
80       monly  found in a LaserWriter printer and (sometimes) generated by Mac‐
81       intosh-based applications.
82
83       The default Display PDF-based execution  environment  includes  support
84       for the following fonts:
85       AvantGarde-Book           Helvetica-Bold                  Palatino-BoldItalic
86       AvantGarde-BookOblique    Helvetica-BoldOblique           Palatino-Italic
87       AvantGarde-Demi           Helvetica-Narrow                Palatino-Roman
88       AvantGarde-DemiOblique    Helvetica-Narrow-Bold           StoneSerif
89       Bookman-Demi              Helvetica-Narrow-BoldOblique    Symbol
90       Bookman-DemiItalic        Helvetica-Narrow-Oblique        Tekton
91       Bookman-Light             Helvetica-Oblique               Times-Bold
92       Bookman-LightItalic       Lithos-Bold                     Times-BoldItalic
93       Courier                   NewCenturySchlbk-Bold           Times-Italic
94       Courier-Bold              NewCenturySchlbk-BoldItalic     Times-Roman
95       Courier-BoldOblique       NewCenturySchlbk-Italic         ZapfChancery-MediumItalic
96       Courier-Oblique           NewCenturySchlbk-Roman          ZapfDingbats
97       Helvetica                 Palatino-Bold
98       Note  that this is the same set of fonts supported by the DPS extension
99       to the X server.
100
101       The default Ghostscript-based environment is  more  uncertain;  consult
102       the  Ghostscript documentation for information on what fonts are avail‐
103       able.
104

BUGS

106       Output from the Display PDF version of this command is encoded  accord‐
107       ing to the Display PDF binary encoding protocol.
108
109       Ghostscript-based  versions  of this program fail to exit with non-zero
110       status when an invalid PDF document is processed; this makes  it  prob‐
111       lematic  for  the  HylaFAX  queue  manager  to determine when a problem
112       arises when preparing a job for transmission.
113

SEE ALSO

115       sendfax(1), faxq(8C), hylafax-server(5F)
116
117
118
119                                March 08, 2001                     PDF2FAX(8C)
Impressum