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