1FAXCOVER(1) General Commands Manual FAXCOVER(1)
2
6 faxcover - generate a POSTSCRIPT cover page for an outgoing facsimile
7
9 faxcover [ options ] -f from-name -n fax-number
10
12 faxcover generates a POSTSCRIPT® cover page document on the standard
13 output. The cover page fills the entire area of a default page and is
14 created according to the information supplied on the command line and a
15 cover sheet template file.
16 faxcover is normally invoked by the sendfax(1) program to generate a
18 cover page for each outgoing facsmile.
19 faxcover works by creating a POSTSCRIPT dictionary that contains defi‐
21 nitions for the variable information that is to be placed on the fac‐
22 simile cover page. Specifically, a dictionary with the following sym‐
23 bols are defined:
24 Symbol Description Symbol Description
25 to destination person from sending person
26 to-company destination company from-company sender's company
27 to-location destination geographic location from-location sender geographic location
28 to-voice-number person's voice phone number from-voice-number sender's voice phone number
29 to-fax-number destination fax phone number from-fax-number sender's fax phone number
30 from-mail-address sender's e-mail address
31 comments unbroken comment string commentsX X'th line of comments
32 regarding Re: subject CommentX similar to commentsX
33 pageWidth page width in millimeters page-count # pages other than cover page
34 pageLength page length in millimeters todays-date current date and time
35 If the comments string is longer than maxlencomments characters, it is
37 broken, on word boundaries or instances of ``\n´´, into multiple POST‐
38 SCRIPT strings commentsX where X is the line number; e.g. comments2
39 for the second line of comments. Long substrings without whitespace
40 which exceed maxlencomments are also broken. By default faxcover will
41 generate 20 commentsX strings, emitting null string values for empty
42 lines. This number can be changed with the -m option; see below. max‐
43 lencomments is changed with the -z option; see below.
44 Note that use of commentsX with non-fixed-width fonts can lead to spa‐
46 tial problems where characters run off the edge of the generated cover
47 page. In such cases, use of BreakIntoLines (see below) may be a more
48 suitable approach.
49 CommentX is similar to commentsX except that its values are created
51 only by breaking comments on instances of ``\n´´ and not otherwise.
52 maxlines does not affect CommentX
53 faxcover also emits a POSTSCRIPT procedure for breaking comment strings
55 into multiple lines using the POSTSCRIPT font metric information. This
56 procedure is named BreakIntoLines and has the following usage conven‐
57 tion:
58 %<line-width> <line-height> <x> <y> <string> BreakIntoLines -
60 eg
62 /rule (_____________________________________________) def
63 /lw rule stringwidth pop def /lh 30 def
64 /y 191.4 def /x 0 def
65 y -30 0 { x exch moveto rule show } for
66 lw lh x y comments BreakIntoLines
67 where the width of the rule controls the length of each line of com‐
68 ments (note that it is made slightly shorter here for the purpose of
69 presentation), x and y are initialized to coordinate locations on the
70 page where the comment string should be imaged, and the number 30 is
71 the inter-line spacing appropriate for the font used to image the com‐
72 ment lines.
73 If information is unavailable for an item, the associated POSTSCRIPT
75 symbol is defined to be a null string.
76 Following the definition prologue, a cover sheet template file is
78 copied. This file is expected to be a POSTSCRIPT program that uses the
79 generated strings to create a cover page. The template must include a
80 showpage operator to cause the page to be imaged. The above symbols
81 will be defined in the current dictionary. A trailing end operator is
82 supplied by faxcover, so any manipulation of the dictionary stack
83 should leave the current dictionary on the top of the stack on comple‐
84 tion.
85
87 -c comments Use comments for the comment string. You may use '\n' to
88 break it into several lines on generated the cover page.
89 -C file Use file as the template file. The default template file
91 is named faxcover.ps. The template file can also be speci‐
92 fied by setting the FAXCOVER environment variable. If the
93 template filename is not an absolute pathname, then fax‐
94 cover looks first for this file in the home directory of
95 the sender. If no such file is present, then it looks in
96 the library directory where the HylaFAX client application
97 data are installed. If no template file is located, fax‐
98 cover will terminate without generating a cover page.
99 -D format Use format as the formatting specification passed to strf‐
101 time(3) when generating the time and date placed on the
102 cover page.
103 -f name Use name for the sender's identity.
105 -l location Use location for the geographic location of the destination
107 company.
108 -L location Use location for the geographic location of the sender's
110 company.
111 -m maxlines indicates the maximum number of commentsX lines to gener‐
113 ate.
114 -M address Use address for the sender's e-mail address.
116 -n number Use number for the destination fax machine number.
118 -N number Use number for the sender's fax machine number.
120 -p count Use count for the count of pages to follow the cover page.
122 -r regarding
124 Use regarding for the ``Re:'' field.
125 -s size Set the page size to use for the transmitted facsimile.
127 Facsimile are normally imaged with a system-default page
128 size (usually letter-size pages, 8.5" by 11", for sites in
129 North America). Alternate page sizes are specified symbol‐
130 ically using either the name or abbreviation of an entry in
131 the pagesizes(5F) database; e.g. a3 (ISO A3), a4 (ISO A4),
132 a5 (ISO A5), a6 (ISO A6), b4 (ISO B4), na-let (North Ameri‐
133 can Letter), us-leg (American Legal), us-led (American
134 Ledger), us-exe (American Executive), jp-let (Japanese Let‐
135 ter), and jp-leg (Japanese Legal). Comparisons are case-
136 insensitive and any match of a substring of the full page-
137 size name is sufficient; e.g. ``legal'' would match ``Amer‐
138 ican Legal''.
139 Note that it may not be permissible to image into the full
141 page area; the guaranteed reproducible area for a page is
142 typically inset. Also, note that while arbitrary page
143 sizes can be specified through the page size database, only
144 a limited set of page dimensions are supported by the Group
145 3 facsimile protocol. Thus if an odd-size facsimile is
146 submitted for transmission it may not be possible to deter‐
147 mine if it can be sent until the fax server establishes
148 communication with the remote facsimile machine.
149 -t name Use name for the receiver's identity.
151 -v number Use number for the receiver's voice phone number.
153 -V number Use number for the sender's voice phone number.
155 -x company Use company for the destination company name.
157 -X company Use company for the sender's company name.
159 -z maxlencomments
161 indicates the maximum length in number of characters
162 allowed in a commentsX string.
163
165 Complaints about not being able to locate a template file.
166
168 ~/.faxdb personal fax number database
169 ~/.hylarc per-user configuration file
170 /etc/hylafax/hyla.conf system-wide configuration file
171 /etc/hylafax/faxcover.ps default cover page template
172 /etc/hylafax/pagesizes page size database
173
175 faxcover should be able to determine the appropriate length of com‐
176 mentsX strings by using font metric information.
177
179 hylafax-client(1), sendfax(1) edit-faxcover(1)
180 January 06, 2001 FAXCOVER(1)