Debian Codegraph @

upstream/debian-unstable/man1/grolbp.1

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