Debian Codegraph @

upstream/debian-trixie/man1/grolbp.1

raw
1 '\" t
2 .TH grolbp 1 "3 June 2025" "groff 1.23.0"
3 .SH Name
4 grolbp \-
5 .I groff
6 output driver for Canon CaPSL printers
7 .
8 .
9 .\" Modified from grolj4 man page by Francisco Andrés Verdú
10 .\" <[email protected]> for the grolbp program.
11 .
12 .
13 .\" ====================================================================
14 .\" Legal Terms
15 .\" ====================================================================
16 .\"
17 .\" Copyright (C) 1994-2020 Free Software Foundation, Inc.
18 .\"
19 .\" Permission is granted to make and distribute verbatim copies of this
20 .\" manual provided the copyright notice and this permission notice are
21 .\" preserved on all copies.
22 .\"
23 .\" Permission is granted to copy and distribute modified versions of
24 .\" this manual under the conditions for verbatim copying, provided that
25 .\" the entire resulting derived work is distributed under the terms of
26 .\" a permission notice identical to this one.
27 .\"
28 .\" Permission is granted to copy and distribute translations of this
29 .\" manual into another language, under the above conditions for
30 .\" modified versions, except that this permission notice may be
31 .\" included in translations approved by the Free Software Foundation
32 .\" instead of in the original English.
33 .
34 .
35 .\" Save and disable compatibility mode (for, e.g., Solaris 10/11).
36 .do nr *groff_grolbp_1_man_C \n[.cp]
37 .cp 0
38 .
39 .\" Define fallback for groff 1.23's MR macro if the system lacks it.
40 .nr do-fallback 0
41 .if !\n(.f .nr do-fallback 1 \" mandoc
42 .if \n(.g .if !d MR .nr do-fallback 1 \" older groff
43 .if !\n(.g .nr do-fallback 1 \" non-groff *roff
44 .if \n[do-fallback] \{\
45 . de MR
46 . ie \\n(.$=1 \
47 . I \%\\$1
48 . el \
49 . IR \%\\$1 (\\$2)\\$3
50 . .
51 .\}
52 .rr do-fallback
53 .
54 .
55 .\" ====================================================================
56 .SH Synopsis
57 .\" ====================================================================
58 .
59 .SY grolbp
60 .RB [ \-l ]
61 .RB [ \-c\~\c
62 .IR num-copies ]
63 .RB [ \-F\~\c
64 .IR font-directory ]
65 .RB [ \-o\~\c
66 .IR orientation ]
67 .RB [ \-p\~\c
68 .IR paper-format ]
69 .RB [ \-w\~\c
70 .IR width ]
71 .RI [ file\~ .\|.\|.]
72 .
73 .SY grolbp
74 [\c
75 .BI \-\-copies= num-copies\c
76 ] [\c
77 .BI \-\-fontdir= font-directory\c
78 ] [\c
79 .B \-\-landscape\c
80 ] [\c
81 .BI \-\-linewidth= width\c
82 ] [\c
83 .BI \-\-orientation= orientation\c
84 ] [\c
85 .BI \-\-papersize= paper-format\c
86 ]
87 .RI [ file\~ .\|.\|.]
88 .YS
89 .
90 .
91 .SY grolbp
92 .B \-h
93 .
94 .SY grolbp
95 .B \-\-help
96 .YS
97 .
98 .
99 .SY grolbp
100 .B \-v
101 .
102 .SY grolbp
103 .B \-\-version
104 .YS
105 .
106 .
107 .\" ====================================================================
108 .SH Description
109 .\" ====================================================================
110 .
111 This GNU
112 .I roff
113 output driver translates the output of
114 .MR \%troff 1
115 into a CaPSL and VDM format suitable for Canon LBP-4 and LBP-8 printers.
116 .
117 Normally,
118 .I grolbp
119 is invoked by
120 .MR groff 1
121 when the latter is given the
122 .RB \[lq] \-T\~lbp \[rq]
123 option.
124 .
125 (In this installation,
126 .B \%ps
127 is the default output device.)
128 .
129 Use
130 .IR groff 's
131 .B \-P
132 option to pass any options shown above to
133 .IR grolbp .
134 .
135 If no
136 .I file
137 arguments are given,
138 or if
139 .I file
140 is \[lq]\-\[rq],
141 .I grolbp
142 reads the standard input stream.
143 .
144 Output is written to the standard output stream.
145 .
146 .
147 .\" ====================================================================
148 .SS Typefaces
149 .\" ====================================================================
150 .
151 The driver supports the Dutch,
152 Swiss,
153 and Swiss-Narrow scalable typefaces,
154 each in the regular,
155 bold,
156 italic,
157 and bold-italic styles.
158 .
159 Additionally,
160 the bitmapped,
161 monospaced Courier and Elite typefaces are available in regular,
162 bold,
163 and
164 italic styles;
165 Courier at 8 and 12 points,
166 Elite at 8 and 10 points.
167 .
168 The following chart summarizes the
169 .I groff
170 font names used to access them.
171 .
172 .
173 .P
174 .TS
175 tab(|) allbox center;
176 Cb Cb Cb Cb Cb
177 L L L L L
178 .
179 Typeface | Roman | Bold | Italic | Bold-Italic
180 Dutch | TR | TB | TI | TBI
181 Swiss | HR | HB | HI | HBI
182 Swiss Narrow | HNR | HNB | HNI | HNBI
183 Courier | CR | CB | CI |
184 Elite | ER | EB | EI |
185 .TE
186 .
187 .
188 .\" ====================================================================
189 .SS "Paper format, orientation, and device description file"
190 .\" ====================================================================
191 .
192 .I grolbp
193 supports paper formats
194 .RB \[lq] A4 \[rq],
195 .RB \[lq] letter \[rq],
196 .RB \[lq] legal \[rq],
197 and
198 .RB \[lq] executive \[rq].
199 .
200 These are matched case-insensitively.
201 .
202 The
203 .BR \-p ,
204 .B \-\-papersize
205 option overrides any setting in the device description file
206 .IR DESC .
207 .
208 If neither specifies a paper format,
209 A4 is assumed.
210 .
211 .
212 .P
213 In its
214 .I DESC
215 file,
216 .I grolbp
217 (case-insensitively) recognizes an
218 .B orientation
219 directive accepting one mandatory argument,
220 .B portrait
221 or
222 .BR landscape .
223 .
224 The first valid orientation directive encountered controls.
225 .\" XXX: This is inconsistent with other description file processing.
226 .
227 The
228 .BR \-l ,
229 .BR \-o ,
230 and
231 .B \-\-orientation
232 command-line options
233 override any setting in
234 .IR DESC .
235 .
236 If none of the foregoing specify the orientation,
237 portrait is assumed.
238 .
239 .
240 .\" ====================================================================
241 .SS "Font description files"
242 .\" ====================================================================
243 .
244 In addition to the font description file directives documented in
245 .MR groff_font 5 ,
246 .I grolbp
247 recognizes
248 .BR lbpname ,
249 which maps the
250 .I groff
251 font name to the font name used internally by the printer.
252 .
253 Its syntax is as follows.
254 .RS
255 .EX
256 .RI lbpname\~ printer-font-name
257 .EE
258 .RE
259 .
260 .
261 .BR lbpname 's
262 argument is case-sensitive.
263 .
264 The printer's font names are encoded as follows.
265 .
266 .
267 .P
268 For bitmapped fonts,
269 .I printer-font_name
270 has the form
271 .RS
272 .EX
273 .RI N\[la] base-font-name \[ra]\[la] font-style \[ra]
274 .EE
275 .RE
276 .I base-font-name
277 is the font name as it appears in the printer's font listings without
278 the first letter,
279 up to
280 (but not including)
281 the font size.
282 .
283 .I font-style
284 can be one of the letters
285 .BR R ,
286 .BR I ,
287 or
288 .BR B ,
289 .\" The bold-italic style apparently was not supported for bitmap fonts.
290 indicating the roman,
291 italic,
292 and bold styles,
293 respectively.
294 .
295 For instance,
296 if the printer's \[lq]font listing A\[rq]
297 shows \[lq]Nelite12I.ISO_USA\[rq],
298 the corresponding entry in the
299 .I groff
300 font description file is
301 .RS
302 .EX
303 lbpname NeliteI
304 .EE
305 .RE
306 .
307 You may need to modify
308 .I grolbp
309 to add support for new bitmapped fonts,
310 since the available font names and font sizes of bitmapped fonts
311 (as documented above)
312 are hard-coded into the program.
313 .
314 .
315 .P
316 For scalable fonts,
317 .I printer-font-name
318 is identical to the font name as it appears in the printer's \[lq]font
319 listing A\[rq].
320 .
321 For instance,
322 to select the \[lq]Swiss\[rq] font in bold-italic style,
323 which appears in the font listing
324 as \%\[lq]Swiss\-BoldOblique\[rq],
325 .RS
326 .EX
327 lbpname Swiss\-BoldOblique
328 .EE
329 .RE
330 is the required directive,
331 and this is what we find in the
332 .I groff
333 font description file
334 .I HBI
335 for the
336 .B lbp
337 device.
338 .
339 .
340 .\" ====================================================================
341 .SS "Drawing commands"
342 .\" ====================================================================
343 .
344 For compatibility with
345 .MR grolj4 1 ,
346 an additional drawing command is available.
347 .
348 .
349 .TP
350 .BI \[rs]D\[aq]R\~ "dh dv" \[aq]
351 Draw a rule
352 (solid black rectangle)
353 with one corner at the drawing position,
354 and the diagonally opposite corner at the drawing position
355 .RI +( dh , dv ).
356 .\" XXX , at which the drawing position will be afterward. ?
357 .
358 .
359 .\" ====================================================================
360 .SH Options
361 .\" ====================================================================
362 .
363 .B \-h
364 and
365 .B \-\-help
366 display a usage message,
367 while
368 .B \-v
369 and
370 .B \-\-version
371 show version information;
372 all exit afterward.
373 .
374 .
375 .TP
376 .BI \-c " num-copies"
377 .TQ
378 .BI \-\-copies= num-copies
379 Produce
380 .I num-copies
381 copies of each page.
382 .
383 .
384 .TP
385 .BI \-F " font-directory"
386 .TQ
387 .BI \-\-fontdir= font-directory
388 Prepend directory
389 .RI font-directory /dev name
390 to the search path for font and device description files;
391 .I name
392 is the name of the device,
393 usually
394 .BR lbp .
395 .
396 .
397 .TP
398 .B \-l
399 .TQ
400 .B \-\-landscape
401 Format the document in landscape orientation.
402 .
403 .
404 .TP
405 .BI \-o " orientation"
406 .TQ
407 .BI \-\-orientation= orientation
408 Format the document in the given
409 .IR orientation ,
410 which must be
411 .RB \%\[lq] portrait \[rq]
412 or
413 .RB \%\[lq] landscape \[rq].
414 .
415 .
416 .TP
417 .BI \-p " paper-format"
418 .TQ
419 .BI \-\-papersize= paper-format
420 Set the paper format to
421 .IR paper-format ,
422 which must be a valid paper format as described above.
423 .
424 .
425 .TP
426 .BI \-w " width"
427 .TQ
428 .BI \-\-linewidth= width
429 Set the default line thickness to
430 .I width
431 thousandths of an em;
432 the default is
433 .B 40
434 (0.04\~em).
435 .
436 .
437 .\" ====================================================================
438 .SH Environment
439 .\" ====================================================================
440 .
441 .TP
442 .I GROFF_FONT_PATH
443 lists directories in which to seek the selected output device's
444 directory of device and font description files.
445 .
446 See
447 .MR \%troff 1
448 and
449 .MR groff_font 5 .
450 .
451 .
452 .\" ====================================================================
453 .SH Files
454 .\" ====================================================================
455 .
456 .TP
457 .I /usr/\:\%share/\:\%groff/\:\%1.23.0/\:\%font/\:\%devlbp/\:DESC
458 describes the
459 .B lbp
460 output device.
461 .
462 .
463 .TP
464 .IR /usr/\:\%share/\:\%groff/\:\%1.23.0/\:\%font/\:\%devlbp/ F
465 describes the font known
466 .RI as\~ F
467 on device
468 .BR lbp .
469 .
470 .
471 .TP
472 .I /usr/\:\%share/\:\%groff/\:\%1.23.0/\:\%tmac/\:lbp\:.tmac
473 defines macros for use with the
474 .B lbp
475 output device.
476 .
477 It is automatically loaded by
478 .I troffrc
479 when the
480 .B lbp
481 output device is selected.
482 .
483 .
484 .\" ====================================================================
485 .SH "See also"
486 .\" ====================================================================
487 .
488 .MR groff 1 ,
489 .MR \%troff 1 ,
490 .MR groff_out 5 ,
491 .MR groff_font 5 ,
492 .MR groff_char 7
493 .
494 .
495 .\" Restore compatibility mode (for, e.g., Solaris 10/11).
496 .cp \n[*groff_grolbp_1_man_C]
497 .do rr *groff_grolbp_1_man_C
498 .
499 .
500 .\" Local Variables:
501 .\" fill-column: 72
502 .\" mode: nroff
503 .\" End:
504 .\" vim: set filetype=groff textwidth=72: