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