src/devices/grolbp/grolbp.1.man

   1 '\" t
   2 .TH GROLBP @MAN1EXT@ "@MDATE@" "groff @VERSION@"
   3 .SH NAME
   4 grolbp \- groff driver for Canon CAPSL printers (LBP-4 and LBP-8 \
   5 series laser printers)
   6 .
   7 .
   8 .\" Save and disable compatibility mode (for, e.g., Solaris 10/11).
   9 .do nr grolbp_C \n[.C]
  10 .cp 0
  11 .
  12 .
  13 .\" Modified by Francisco Andrés Verdú <pandres@dragonet.es> for the
  14 .\" grolbp program.
  15 .
  16 .
  17 .\" ====================================================================
  18 .\" Legal Terms
  19 .\" ====================================================================
  20 .\"
  21 .\" Copyright (C) 1994-2018 Free Software Foundation, Inc.
  22 .\"
  23 .\" Permission is granted to make and distribute verbatim copies of this
  24 .\" manual provided the copyright notice and this permission notice are
  25 .\" preserved on all copies.
  26 .\"
  27 .\" Permission is granted to copy and distribute modified versions of
  28 .\" this manual under the conditions for verbatim copying, provided that
  29 .\" the entire resulting derived work is distributed under the terms of
  30 .\" a permission notice identical to this one.
  31 .\"
  32 .\" Permission is granted to copy and distribute translations of this
  33 .\" manual into another language, under the above conditions for
  34 .\" modified versions, except that this permission notice may be
  35 .\" included in translations approved by the Free Software Foundation
  36 .\" instead of in the original English.
  37 .
  38 .
  39 .\" ====================================================================
  40 .SH SYNOPSIS
  41 .\" ====================================================================
  42 .
  43 .SY grolbp
  44 .OP \-l
  45 .OP \-c num-copies
  46 .OP \-F font-directory
  47 .OP \-o orientation
  48 .OP \-p paper-size
  49 .OP \-w width
  50 .RI [ file
  51 \&.\|.\|.\&]
  52 .SY grolbp
  53 [\c
  54 .BI \-\-copies= num-copies\c
  55 ] [\c
  56 .BI \-\-fontdir= font-directory\c
  57 ] [\c
  58 .B \-\-landscape\c
  59 ] [\c
  60 .BI \-\-linewidth= width\c
  61 ] [\c
  62 .BI \-\-orientation= orientation\c
  63 ] [\c
  64 .BI \-\-papersize= paper-size\c
  65 ]
  66 .RI [ file
  67 \&.\|.\|.\&]
  68 .YS
  69 .
  70 .SY grolbp
  71 .B \-h
  72 .SY grolbp
  73 .B \-\-help
  74 .YS
  75 .
  76 .SY grolbp
  77 .B \-v
  78 .SY grolbp
  79 .B \-\-version
  80 .YS
  81 .
  82 .
  83 .\" ====================================================================
  84 .SH DESCRIPTION
  85 .\" ====================================================================
  86 .
  87 .B grolbp
  88 is a driver for
  89 .B groff
  90 that produces output in CAPSL and VDM format suitable for Canon LBP-4
  91 and LBP-8 printers.
  92 .
  93 .
  94 .LP
  95 For compatibility with
  96 .BR grolj4 (@MAN1EXT@)
  97 there is an additional drawing command available:
  98 .
  99 .TP
 100 .BI \eD'R\  dh\ dv '
 101 Draw a rule
 102 (i.e., a solid black rectangle),
 103 with one corner at the current position,
 104 and the diagonally opposite corner at the current
 105 position
 106 .RI +( dh , dv ).
 107 .
 108 .
 109 .\" ====================================================================
 110 .SH OPTIONS
 111 .\" ====================================================================
 112 .
 113 Note that there can be whitespace between a one-letter option and its
 114 argument;
 115 on the other hand, there must be whitespace and/or an equal sign
 116 (\(oq=\(cq) between a long-name option and its argument.
 117 .
 118 .
 119 .TP
 120 .BI \-c " num-copies"
 121 .TQ
 122 .BI \-\-copies= num-copies
 123 Print
 124 .I num-copies
 125 copies of each page.
 126 .
 127 .
 128 .TP
 129 .BI \-F " font-directory"
 130 .TQ
 131 .BI \-\-fontdir= font-directory
 132 Prepend directory
 133 .RI font-directory /dev name
 134 to the search path for font and device description files;
 135 .I name
 136 is the name of the device, usually
 137 .BR lbp .
 138 .
 139 .
 140 .TP
 141 .B \-h
 142 .TQ
 143 .B \-\-help
 144 Print a short help text.
 145 .
 146 .
 147 .TP
 148 .B \-l
 149 .TQ
 150 .B \-\-landscape
 151 Print the document with a landscape orientation.
 152 .
 153 .
 154 .TP
 155 .BI \-o " orientation"
 156 .TQ
 157 .BI \-\-orientation= orientation
 158 Print the document with
 159 .I orientation
 160 orientation, which must be \(oqportrait\(cq or \(oqlandscape\(cq.
 161 .
 162 .
 163 .TP
 164 .BI \-p " paper-size"
 165 .TQ
 166 .BI \-\-papersize= paper-size
 167 Set the paper size to
 168 .IR paper-size ,
 169 which must be a valid paper size description as indicated in section
 170 \[lq]Paper Sizes\[rq], below.
 171 .
 172 .
 173 .TP
 174 .B \-v
 175 .TQ
 176 .B \-\-version
 177 Print the version number.
 178 .
 179 .
 180 .TP
 181 .BI \-w " width"
 182 .TQ
 183 .BI \-\-linewidth= width
 184 Set the default line thickness to
 185 .I width
 186 thousandths of an em.
 187 .
 188 If this option isn't specified, the line thickness defaults to 0.04\~em.
 189 .
 190 .
 191 .\" ====================================================================
 192 .SH TYPEFACES
 193 .\" ====================================================================
 194 .
 195 The driver supports the Dutch, Swiss and Swiss-Narrow scalable
 196 typefaces, each one in the Regular, Bold, Italic and Bold-Italic styles.
 197 .
 198 Additionally, the Courier and Elite monospaced typefaces at the sizes 8
 199 and 12 points (for Courier) resp.\& 8 and 10 points (for Elite) are
 200 supported, each one in the Regular, Bold and Italic styles.
 201 .
 202 .
 203 .PP
 204 The following chart summarizes the font names you can use to access
 205 these fonts:
 206 .
 207 .
 208 .PP
 209 .TS
 210 tab(|) allbox center;
 211 c c c c c
 212 ab c c c c
 213 .
 214 Typeface | Regular | Bold | Italic | Bold-Italic
 215 Dutch | TR | TB | TI | TBI
 216 Swiss | HR | HB | HI | HBI
 217 Swiss Narrow | HNR | HNB | HNI | HNBI
 218 Courier | CR | CB | CI |
 219 Elite | ER | EB | EI |
 220 .TE
 221 .
 222 .
 223 .\" ====================================================================
 224 .SH PAPER SIZES
 225 .\" ====================================================================
 226 .
 227 The paper size can be set in the
 228 .I DESC
 229 file or with command-line options to
 230 .BR grolbp .
 231 If the paper size is specified both ways, the command-line options take
 232 precedence over the contents of the
 233 .I DESC
 234 file (this applies to the page orientation too).
 235 .
 236 .
 237 .PP
 238 See
 239 .BR groff_font (@MAN5EXT@)
 240 how to set the paper dimensions in the
 241 .I DESC
 242 file.
 243 .
 244 .
 245 .PP
 246 To set the paper size in the command line, add
 247 .sp 1
 248 .in +2m
 249 .BI \-p \ paper-size
 250 .in -2m
 251 .sp 1
 252 or
 253 .sp 1
 254 .in +2m
 255 .BI \-\-papersize= paper-size
 256 .in -2m
 257 .sp 1
 258 to the other
 259 .B grolbp
 260 options, where
 261 .I paper-size
 262 is in the same format as in the
 263 .I DESC
 264 file.
 265 .
 266 .
 267 .PP
 268 If no paper size is specified in the
 269 .I DESC
 270 file or the command line, a default size of A4 is used.
 271 .
 272 .
 273 .\" ====================================================================
 274 .SH PAGE ORIENTATION
 275 .\" ====================================================================
 276 .
 277 As with the page size, the orientation of the printed page
 278 .RB ( portrait
 279 or
 280 .BR landscape )
 281 can be set in the
 282 .I DESC
 283 file or with command-line options.
 284 .
 285 It is also case insensitive.
 286 .
 287 .
 288 .PP
 289 To set the orientation in the
 290 .I DESC
 291 file, insert a line with the following content:
 292 .sp 1
 293 .in +2m
 294 .B orientation
 295 .RB [ portrait | landscape ]
 296 .in -2m
 297 .sp 1
 298 .
 299 Only the first valid orientation command in the
 300 .I DESC
 301 file is used.
 302 .
 303 .
 304 .PP
 305 To set the page orientation with command-line options you can use the
 306 .B \-o
 307 or
 308 .B \-\-orientation
 309 option with the same parameters
 310 .RB ( portrait
 311 or
 312 .BR landscape )
 313 as in the
 314 .I DESC
 315 file.
 316 Or you can use the
 317 .B \-l
 318 option to force the pages to be printed in landscape.
 319 .
 320 .
 321 .\" ====================================================================
 322 .SH FONT FILE FORMAT
 323 .\" ====================================================================
 324 .
 325 In addition to the usual commands described in
 326 .BR groff_font (@MAN5EXT@),
 327 .B grolbp
 328 provides the command
 329 .I lbpname
 330 which sets the font name sent to the printer when requesting this font.
 331 .
 332 The syntax of this command is:
 333 .sp 1
 334 .in +2m
 335 .B lbpname
 336 .I printer_font_name
 337 .in -2m
 338 .
 339 .IP \(bu
 340 For bitmapped fonts,
 341 .I printer_font_name
 342 has the form
 343 .sp 1
 344 .in +2m
 345 .RI N\(la base_fontname \(ra\(la font_style \(ra
 346 .in -2m
 347 .sp 1
 348 .I base_fontname
 349 is the font name as it appears in the printers font listings without the
 350 first letter, up to (but not including) the font size.
 351 .I font_style
 352 can be one of the letters
 353 .BR R ,
 354 .BR I ,
 355 or
 356 .BR B ,
 357 indicating the font styles Roman, Italic and Bold respectively.
 358 .
 359 .IP
 360 For instance, if the printer's
 361 .I font listing A
 362 shows font \(oqNelite12I.ISO_USA\(cq, the corresponding entry in the
 363 font description file is
 364 .sp 1
 365 .in +2m
 366 .B lbpname NeliteI
 367 .in -2m
 368 .
 369 .IP
 370 Note that you may need to modify
 371 .B grolbp
 372 to add support for new bitmapped fonts, since the available font names
 373 and font sizes of bitmapped fonts (as documented above) are hard-coded
 374 into the program.
 375 .
 376 .IP \(bu
 377 For scalable fonts,
 378 .I printer_font_name
 379 is identical to the font name as it appears in the printer's
 380 .IR "font listing A" .
 381 .
 382 .IP
 383 For instance, to select the \(oqSwiss\(cq font in bold style, which
 384 appears in the printer's
 385 .I font listing A
 386 as \(oqSwiss-Bold\(cq, the required
 387 .B lbpname
 388 command line is
 389 .sp 1
 390 .in +2m
 391 .B lbpname Swiss-Bold
 392 .in -2m
 393 .sp 1
 394 .
 395 .PP
 396 The argument of
 397 .B lbpname
 398 is case sensitive.
 399 .
 400 .
 401 .\" ====================================================================
 402 .SH ENVIRONMENT
 403 .\" ====================================================================
 404 .
 405 .TP
 406 .I GROFF_FONT_PATH
 407 A list of directories in which to search for the
 408 .IR dev name
 409 directory in addition to the default ones.
 410 .
 411 See
 412 .BR @g@troff (@MAN1EXT@)
 413 and
 414 .BR \%groff_font (@MAN5EXT@)
 415 for more details.
 416 .
 417 .
 418 .\" ====================================================================
 419 .SH FILES
 420 .\" ====================================================================
 421 .
 422 .TP
 423 .I @FONTDIR@/devlbp/DESC
 424 Device description file.
 425 .
 426 .TP
 427 .IR @FONTDIR@/devlbp/ F
 428 Font description file for font
 429 .IR F .
 430 .
 431 .TP
 432 .I @MACRODIR@/lbp.tmac
 433 Macros for use with
 434 .BR grolbp .
 435 .
 436 .
 437 .\" ====================================================================
 438 .SH SEE ALSO
 439 .\" ====================================================================
 440 .
 441 .BR groff (@MAN1EXT@),
 442 .BR @g@troff (@MAN1EXT@),
 443 .BR groff_out (@MAN5EXT@),
 444 .BR groff_font (@MAN5EXT@),
 445 .BR groff_char (@MAN7EXT@)
 446 .
 447 .
 448 .\" Restore compatibility mode (for, e.g., Solaris 10/11).
 449 .cp \n[grolbp_C]
 450 .
 451 .
 452 .\"
 453 .\" Local Variables:
 454 .\" mode: nroff
 455 .\" End:
 456 .\" vim: set filetype=groff: