contrib/groff/src/utils/hpftodit/hpftodit.man

   1 .tr ~
   2 .ig
   3 Copyright (C) 1994-2000, 2001, 2003, 2004 Free Software Foundation, Inc.
   4
   5 Permission is granted to make and distribute verbatim copies of
   6 this manual provided the copyright notice and this permission notice
   7 are preserved on all copies.
   8
   9 Permission is granted to copy and distribute modified versions of this
  10 manual under the conditions for verbatim copying, provided that the
  11 entire resulting derived work is distributed under the terms of a
  12 permission notice identical to this one.
  13
  14 Permission is granted to copy and distribute translations of this
  15 manual into another language, under the above conditions for modified
  16 versions, except that this permission notice may be included in
  17 translations approved by the Free Software Foundation instead of in
  18 the original English.
  19 ..
  20 .\" Like TP, but if specified indent is more than half
  21 .\" the current line-length - indent, use the default indent.
  22 .de Tp
  23 .ie \\n(.$=0:((0\\$1)*2u>(\\n(.lu-\\n(.iu)) .TP
  24 .el .TP "\\$1"
  25 ..
  26 .de CW
  27 .ie \\n(.$>2 \&\\$1\f(CR\\$2\fP\\$3
  28 .el \&\f(CR\\$1\fP\\$2
  29 ..
  30 .tr ~
  31 .TH HPFTODIT @MAN1EXT@ "@MDATE@" "Groff Version @VERSION@"
  32 .\" --------------------------------------------------------------------------
  33 .SH NAME
  34 .\" --------------------------------------------------------------------------
  35 hpftodit \- create font description files for use with groff \-Tlj4
  36 .\" --------------------------------------------------------------------------
  37 .SH SYNOPSIS
  38 .\" --------------------------------------------------------------------------
  39 .B hpftodit
  40 [
  41 .B \-adqsv
  42 ]
  43 [
  44 .BI \-i n
  45 ]
  46 .I tfm_file
  47 .I map_file
  48 .I font
  49 .PP
  50 It is possible to have whitespace between the
  51 .B \-i
  52 option and its parameter.
  53 .\" --------------------------------------------------------------------------
  54 .SH DESCRIPTION
  55 .\" --------------------------------------------------------------------------
  56 .B hpftodit
  57 creates a font file for use with a Hewlett-Packard LaserJet~4\(enseries
  58 (or newer) printer with
  59 .BR "groff \-Tlj4" ,
  60 using data from an HP tagged font metric (TFM) file.
  61 .I tfm_file
  62 is the name of the TFM file for the font; Intellifont and
  63 TrueType TFM files are supported, but symbol set TFM files are not.
  64 .I map_file
  65 is a file giving the groff names for characters in the font; this file
  66 should consist of a sequence of lines of the form:
  67 .IP
  68 .I
  69 m u c1 c2 \fR.\|.\|. [
  70 .CW #
  71 .I comment
  72 ]
  73 .LP
  74 where
  75 .I m
  76 is a decimal integer giving the MSL number of the character,
  77 .I u
  78 is a hexadecimal integer giving the Unicode value of the character,
  79 and
  80 .IR c1 ,
  81 .IR c2 ", .\|.\|."
  82 are the groff names of the character.
  83 The values can be separated by any whitespace; the Unicode value must
  84 use uppercase digits A\^\(en\^F, and must be without a leading
  85 .CW ` 0x ',
  86 .CW ` u ',
  87 or
  88 .CW ` U+ '.
  89 Unicode values corresponding to composite glyphs are decomposed; e.g.,
  90 .CW ` u00C0 '
  91 becomes
  92 .CW ` u0041_0300 '.
  93 The name for a glyph without a groff name may be given as
  94 .CW u \fIXXXX\fP
  95 if the glyph corresponds to a Unicode value, or as an unnamed glyph
  96 .CW ` --- '.
  97 If the given Unicode value is in the Private Use Area
  98 (0xE000\^\(en\^0xF8FF), the glyph is included as an unnamed glyph.
  99 Refer to
 100 .BR groff_diff (@MAN1EXT@)
 101 for additional information about unnamed glyphs and how to access them.
 102 .LP
 103 Blank lines and lines beginning with
 104 .CW ` # '
 105 are ignored.
 106 A
 107 .CW ` # '
 108 following one or more groff names begins a comment.
 109 Because
 110 .CW ` # '
 111 is a valid groff name, it must appear first in a list of
 112 groff names if a comment is included, e.g.,
 113 .IP
 114 .CW "3   0023   #   # number sign"
 115 .LP
 116 or
 117 .IP
 118 .CW "3   0023   # sh   # number sign"
 119 .LP
 120 rather than
 121 .IP
 122 .CW "3   0023   sh #   # number sign"
 123 .LP
 124 which will treat the first
 125 .CW ` # '
 126 as the beginning of the comment.
 127 .LP
 128 .I font
 129 is the name of the groff font file.
 130 The groff font file is written to
 131 .IR font ;
 132 if
 133 .I font
 134 is specified as
 135 .CW ` - ',
 136 the output is written to the standard output.
 137 .LP
 138 The
 139 .B \-s
 140 option should be given if the font is special
 141 (a font is
 142 .I special
 143 if
 144 .B troff
 145 should search it whenever
 146 a character is not found in the current font).
 147 If the font is special,
 148 it should be listed in the
 149 .B fonts
 150 command in the DESC file;
 151 if it is not special, there is no need to list it, since
 152 .B troff
 153 can automatically mount it when it's first used.
 154 .LP
 155 If the
 156 .B \-i
 157 option is used,
 158 .B hpftodit
 159 automatically will generate an italic correction,
 160 a left italic correction and a subscript correction
 161 for each character
 162 (the significance of these parameters is explained in
 163 .BR groff_font (@MAN5EXT@)).
 164 .\" --------------------------------------------------------------------------
 165 .SH OPTIONS
 166 .\" --------------------------------------------------------------------------
 167 .TP
 168 .B \-a
 169 Include characters in the TFM file that are not included in the map
 170 file.
 171 A glyph with corresponding Unicode value is given the name
 172 .RI u XXXX ;
 173 a glyph without a Unicode value is included as an unnamed glyph
 174 \&`\-\^\-\^\-'.
 175 A glyph with a Unicode value in the Private Use Area
 176 (0xE000\^\(en\^0xF8FF) also is included as an unnamed glyph.
 177 .IP
 178 This option provides a simple means of adding Unicode-named and unnamed
 179 glyphs to a font without including them in the map file, but it affords
 180 little control over which glyphs are placed in a regular font and which
 181 are placed in a special font.
 182 The presence or absence of the
 183 .B \-s
 184 option has some effect on which glyphs are included: without the
 185 .B \-s
 186 option, only the \(lqtext\(rq symbol sets are searched for matching
 187 glyphs; with the
 188 .B \-s
 189 option, only the \(lqmathematical\(rq symbol sets
 190 are searched.
 191 Nonetheless, restricting the symbol sets searched isn't very
 192 selective\(emmany glyphs are placed in both regular and special fonts.
 193 Normally, the
 194 .B \-a
 195 option should be used only as a last resort.
 196 .\" --------------------------------------------------------------------------
 197 .TP
 198 .B \-d
 199 Dump information about the TFM file to the standard output; this option
 200 can be useful for ensuring that a TFM file is a proper match for a font,
 201 and that the contents of the TFM file are suitable.
 202 The information includes the values of important TFM tags, and a listing
 203 (by MSL number for Intellifont TFM files or by Unicode value for
 204 TrueType TFM files) of the glyphs included in the TFM file.
 205 The unit of measure `DU' for some tags indicates design units; there are
 206 8782 design units per em for Intellifont fonts, and 2048 design units
 207 per em for TrueType fonts.
 208 Note that the accessibility of a glyph depends on its inclusion in a
 209 symbol set; some TFM files list many glyphs but only a few symbol sets.
 210 .IP
 211 The glyph listing includes the glyph index within the TFM file, the MSL
 212 or Unicode value, and the symbol set and character code that will be
 213 used to print the glyph.
 214 If
 215 .I map_file
 216 is given,
 217 groff names are given for matching glyphs.
 218 If only the glyph index and MSL or Unicode value are given, the glyph
 219 does not appear in any supported symbol set and cannot be printed.
 220 .IP
 221 With the
 222 .B \-d
 223 option,
 224 .I map_file
 225 is optional, and
 226 .I font
 227 is ignored if given.
 228 .\" --------------------------------------------------------------------------
 229 .TP
 230 .B \-q
 231 Suppress warnings about characters in the map file that were not found
 232 in the TFM file.
 233 Warnings never are given for unnamed glyphs or by glyphs named by their
 234 Unicode values.
 235 This option is useful when sending the output of
 236 .B hpftodit
 237 to the standard output.
 238 .\" --------------------------------------------------------------------------
 239 .TP
 240 .B \-v
 241 Print the
 242 .B hpftodit
 243 version number.
 244 .\" --------------------------------------------------------------------------
 245 .TP
 246 .B \-s
 247 The font is special.
 248 This option adds the
 249 .B special
 250 command to the font file, and affects the order in which HP symbol sets
 251 are searched for each glyph.
 252 Without the
 253 .B \-s
 254 option, the \(lqtext\(rq sets are searched before
 255 the \(lqmathematical\(rq symbol sets.
 256 With the
 257 .B \-s
 258 option, the search order is reversed.
 259 .\" --------------------------------------------------------------------------
 260 .TP
 261 .BI \-i n
 262 Generate an italic correction for each character so that the character's
 263 width plus the character's italic correction is equal to
 264 .I n
 265 thousandths of an em plus the amount by which the right edge of the
 266 character's bounding is to the right of the character's origin.
 267 If this would result in a negative italic correction, use a zero italic
 268 correction instead.
 269 .IP
 270 Also generate a subscript correction equal to the
 271 product of the tangent of the slant of the font and
 272 four fifths of the x-height of the font.
 273 If this would result in a subscript correction greater than the italic
 274 correction, use a subscript correction equal to the italic correction
 275 instead.
 276 .IP
 277 Also generate a left italic correction for each character
 278 equal to
 279 .I n
 280 thousandths of an em plus the amount by which the left edge of the
 281 character's bounding box is to the left of the character's origin.
 282 The left italic correction may be negative.
 283 .IP
 284 This option normally is needed only with italic or oblique fonts;
 285 a value of 50 (0.05 em) usually is a reasonable choice.
 286 .\" --------------------------------------------------------------------------
 287 .SH FILES
 288 .\" --------------------------------------------------------------------------
 289 .ad 0
 290 .TP \w'\fB@FONTDIR@/devlj4/generate/\fP\fI*\fP.map'u+2n
 291 .B @FONTDIR@/devlj4/DESC
 292 Device description file.
 293 .TP
 294 .BI @FONTDIR@/devlj4/ F
 295 Font description file for font
 296 .IR F .
 297 .TP
 298 .BI @FONTDIR@/devlj4/generate/ * .map
 299 Symbol mapping files
 300 .\" --------------------------------------------------------------------------
 301 .SH "SEE ALSO"
 302 .\" --------------------------------------------------------------------------
 303 .BR groff (@MAN1EXT@),
 304 .BR groff_diff (@MAN1EXT@),
 305 .BR grolj4 (@MAN1EXT@),
 306 .BR groff_font (@MAN5EXT@),
 307 .BR lj4_font (@MAN5EXT@)
 308 .
 309 .\" Local Variables:
 310 .\" mode: nroff
 311 .\" End: