Initial import from FreeBSD RELENG_4:
[dragonfly.git] / contrib / groff / src / devices / grolbp / grolbp.man
1 '\" t
2 .\" The above line should force the use of tbl as a preprocessor
3 .\" vim: set syntax=nroff : 
4 .\" The above line should set vim into nroff mode
5 .ig
6 Copyright (C) 1994-2000, 2002 Free Software Foundation, Inc.
7
8 Permission is granted to make and distribute verbatim copies of
9 this manual provided the copyright notice and this permission notice
10 are preserved on all copies.
11
12 Permission is granted to copy and distribute modified versions of this
13 manual under the conditions for verbatim copying, provided that the
14 entire resulting derived work is distributed under the terms of a
15 permission notice identical to this one.
16
17 Permission is granted to copy and distribute translations of this
18 manual into another language, under the above conditions for modified
19 versions, except that this permission notice may be included in
20 translations approved by the Free Software Foundation instead of in
21 the original English.
22
23 Modified by Francisco Andrés Verdú <pandres@dragonet.es> for the grolbp
24 program.
25 ..
26 .de TQ
27 .br
28 .ns
29 .TP \\$1
30 ..
31 .\" Like TP, but if specified indent is more than half
32 .\" the current line-length - indent, use the default indent.
33 .de Tp
34 .ie \\n(.$=0:((0\\$1)*2u>(\\n(.lu-\\n(.iu)) .TP
35 .el .TP "\\$1"
36 ..
37 .TH GROLBP @MAN1EXT@ "@MDATE@" "Groff Version @VERSION@"
38 .
39 .SH NAME
40 grolbp \- groff driver for Canon CAPSL printers (LBP-4 and LBP-8 series laser printers).
41 .
42 .SH SYNOPSIS
43 .nr a \n(.j
44 .ad l
45 .nh
46 .nr i \n(.i
47 .in +\w'\fBgrolbp 'u
48 .ti \niu
49 .B grolpb
50 .de OP
51 .ie \\n(.$-1 .RI "[\ \fB\\$1\fP" "\\$2" "\ ]"
52 .el .RB "[\ " "\\$1" "\ ]"
53 ..
54 .OP \-l
55 .OP \-\-landscape
56 .OP \-v
57 .OP \-\-version
58 .OP \-c n
59 .OP \-\-copies= numcopies
60 .OP \-p paper_size
61 .OP \-\-papersize= paper_size
62 .OP \-o orientation
63 .OP \-\-orientation= orientation
64 .OP \-w width
65 .OP \-\-linewidth= width
66 .OP \-F dir
67 .OP \-\-fontdir= dir
68 .OP \-h
69 .OP \-\-help
70 .RI "[\ " files\|.\|.\|. "\ ]"
71 .br
72 .ad \na
73 .hy
74 .
75 .SH DESCRIPTION
76 .B grolbp
77 is a driver for
78 .B groff
79 that produces output in CAPSL and VDM format suitable for Canon LBP\-4 and
80 LBP\-8 printers.
81 .LP
82 For compatibility with grolj4 there is an additional drawing command
83 available:
84 .TP
85 .BI \eD'R\  dh\ dv '
86 Draw a rule (i.e.\ a solid black rectangle), with one corner at the current
87 position, and the diagonally opposite corner at the current position
88 .RI +( dh , dv ).
89 .SH OPTIONS
90 Note that there can be whitespace between a one-letter option and its
91 argument; on the other hand, there must be whitespace and/or an equal sign
92 (`=') between a long-name option and its argument.
93 .TP
94 .BI \-c numcopies
95 .TQ
96 .BI \-\-copies= numcopies
97 Print
98 .I numcopies
99 copies of each page.
100 .TP
101 .B \-l
102 .TQ
103 .B \-\-landscape
104 Print the document with a landscape orientation.
105 .TP
106 .BI \-p paper_size
107 .TQ
108 .BI \-\-papersize= paper_size
109 Set the paper size to
110 .IR paper_size ,
111 which must be a valid paper size description as indicated in the section
112 .BR "PAPER SIZES" .
113 .TP
114 .BI \-o orientation
115 .TQ
116 .BI \-\-orientation= orientation
117 Print the document with
118 .I orientation
119 orientation, which must be `portrait' or `landscape'.
120 .TP
121 .BI \-w width
122 .TQ
123 .BI \-\-linewidth= width
124 Set the default line thickness to
125 .I width
126 thousandths of an em.
127 If this option isn't specified, the line thickness defaults to 0.04\~em.
128 .TP
129 .B \-v
130 .TQ
131 .B \-\-version
132 Print the version number.
133 .TP
134 .BI \-F dir
135 .TQ
136 .BI \-\-fontdir= dir
137 Prepend directory
138 .IB dir /dev name
139 to the search path for font and device description files;
140 .I name
141 is the name of the device, usually
142 .BR lbp .
143 .TP
144 .B \-h
145 .TQ
146 .B \-\-help
147 Print a short help text.
148 .SH TYPEFACES
149 The driver supports the Dutch, Swiss and Swiss-Narrow scalable typefaces,
150 each one in the Regular, Bold, Italic and Bold-Italic styles.
151 Additionally, the Courier and Elite monospaced typefaces at the sizes 8 and
152 12 points (for Courier) resp. 8 and 10 points (for Elite) are supported,
153 each one in the Regular, Bold and Italic styles.
154 .PP
155 The following chart summarizes the font names you can use to access these
156 fonts:
157 .PP
158 .TS
159 tab(|) allbox center;
160 c c c c c
161 ab c c c c
162 .
163 Typeface | Regular | Bold | Italic | Bold-Italic
164 Dutch | TR | TB | TI | TBI
165 Swiss | HR | HB | HI | HBI
166 Swiss Narrow | HNR | HNB | HNI | HNBI
167 Courier | CR | CB | CI |
168 Elite | ER | EB | EI |
169 .TE
170 .PP
171 .SH PAPER SIZES
172 The paper size can be set in the
173 .B DESC
174 file or with command line options to
175 .BR grolbp .
176 If the paper size is specified both ways, the command line options take
177 precedence over the contents of the
178 .B DESC
179 file (this applies to the page orientation too).
180 .PP
181 See
182 .BR groff_font (@MAN1EXT@)
183 how to set the paper dimensions in the
184 .B DESC
185 file.
186 .PP
187 To set the paper size in the command line, add
188 .sp 1
189 .in +2m
190 .BI \-p \ paper-size
191 .in -2m
192 .sp 1
193 or
194 .sp 1
195 .in +2m
196 .BI \-\-papersize= paper-size
197 .in -2m
198 .sp 1
199 to the other
200 .B grolbp
201 options, where
202 .I paper-size
203 is in the same format as in the
204 .B DESC
205 file.
206 .PP
207 If no paper size is specified in the
208 .B DESC
209 file or the command line, a default size of A4 is used.
210 .SH PAGE ORIENTATION
211 As with the page size, the orientation of the printed page
212 .RB ( portrait
213 or
214 .BR landscape )
215 can be set in the
216 .B DESC
217 file or with command line options.
218 It is also case insensitive.
219 .PP
220 To set the orientation in the
221 .B DESC
222 file, insert a line with the following content:
223 .sp 1
224 .in +2m
225 .B orientation
226 .RB [ portrait | landscape ]
227 .in -2m
228 .sp 1
229 Only the first valid orientation command in the
230 .B DESC
231 file is used.
232 .PP
233 To set the page orientation with command line options you can use the
234 .B \-o
235 or
236 .B \-\-orientation
237 option with the same parameters
238 .RB ( portrait
239 or
240 .BR landscape )
241 as in the
242 .B DESC
243 file.
244 Or you can use the
245 .B \-l
246 option to force the pages to be printed in landscape.
247 .SH FONT FILE FORMAT
248 In addition to the usual commands described in
249 .BR groff_font (@MAN5EXT@),
250 .B grolbp
251 provides the command
252 .I lbpname
253 which sets the font name sent to the printer when requesting this font.
254 The syntax of this command is:
255 .sp 1
256 .in +2m
257 .B lbpname
258 .I printer_font_name
259 .in -2m
260 .IP \(bu
261 For bitmapped fonts,
262 .I printer_font_name
263 has the form
264 .sp 1
265 .in +2m
266 .RI N\(la base_fontname \(ra\(la font_style \(ra
267 .in -2m
268 .sp 1
269 .I base_fontname 
270 is the font name as it appears in the printers font listings without the
271 first letter, up to (but not including) the font size.
272 .I font_style
273 can be one of the letters
274 .BR R ,
275 .BR I ,
276 or
277 .BR B ,
278 indicating the font styles Roman, Italic and Bold respectively.
279 .IP
280 For instance, if the printer's 
281 .I font listing A
282 shows font `Nelite12I.ISO_USA', the corresponding entry in the font
283 description file is
284 .sp 1
285 .in +2m
286 .B lbpname NeliteI
287 .in -2m
288 .IP
289 Note that you may need to modify
290 .B grolbp
291 to add support for new bitmapped fonts, since the available font names and
292 font sizes of bitmapped fonts (as documented above) are hard-coded into the
293 program.
294 .IP \(bu
295 For scalable fonts,
296 .I printer_font_name
297 is identical to the font name as it appears in the printer's 
298 .IR "font listing A" .
299 .IP
300 For instance, to select the `Swiss' font in bold style, which appears in
301 the printer's
302 .I font listing A
303 as `Swiss-Bold', the required
304 .B lbpname
305 command line is
306 .sp 1
307 .in +2m
308 .B lbpname Swiss-Bold
309 .in -2m
310 .sp 1
311 .PP
312 The argument of
313 .B lbpname
314 is case sensitive.
315 .SH FILES
316 .TP
317 .B @FONTDIR@/devlbp/DESC
318 Device description file.
319 .TP
320 .BI @FONTDIR@/devlbp/ F
321 Font description file for font
322 .IR F .
323 .TP
324 .B @MACRODIR@/lbp.tmac
325 Macros for use with
326 .BR grolbp .
327 .SH SEE ALSO
328 .BR groff (@MAN1EXT@),
329 .BR @g@troff (@MAN1EXT@),
330 .BR groff_out (@MAN5EXT@),
331 .BR groff_font (@MAN5EXT@),
332 .BR groff_char (@MAN7EXT@)
333 .\"
334 .\" Local Variables:
335 .\" mode: nroff
336 .\" End: