contrib/groff/src/utils/afmtodit/afmtodit.man

   1 .ig
   2 Copyright (C) 1989-2000, 2001, 2002, 2003, 2005, 2006, 2008, 2009
   3   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 .
  21 .
  22 .\" Like TP, but if specified indent is more than half
  23 .\" the current line-length - indent, use the default indent.
  24 .de Tp
  25 .  ie \\n(.$=0:((0\\$1)*2u>(\\n(.lu-\\n(.iu)) .TP
  26 .  el .TP "\\$1"
  27 ..
  28 .
  29 .de OP
  30 .  ie \\n(.$-1 .RI "[\ \fB\\$1\fP\ " "\\$2" "\ ]"
  31 .  el .RB "[\ " "\\$1" "\ ]"
  32 ..
  33 .
  34 .
  35 .TH AFMTODIT @MAN1EXT@ "@MDATE@" "Groff Version @VERSION@"
  36 .
  37 .
  38 .SH NAME
  39 afmtodit \- create font files for use with groff \-Tps
  40 .
  41 .
  42 .SH SYNOPSIS
  43 .nr a \n(.j
  44 .ad l
  45 .nr i \n(.i
  46 .in +\w'\fBafmtodit 'u
  47 .ti \niu
  48 .B afmtodit
  49 .OP \-ckmnsvx
  50 .OP \-a n
  51 .OP \-d desc_file
  52 .OP \-e enc_file
  53 .OP \-f internal_name
  54 .OP \-i n
  55 .I afm_file
  56 .I map_file
  57 .I font
  58 .br
  59 .ad \na
  60 .
  61 .LP
  62 The whitespace between a command line option and its argument is optional.
  63 .
  64 .SH DESCRIPTION
  65 .B afmtodit
  66 creates a font file for use with groff and
  67 .BR grops .
  68 .
  69 .B afmtodit
  70 is written in perl;
  71 you must have perl version 5.004 or newer installed in order to run
  72 .BR afmtodit .
  73 .
  74 .LP
  75 .I afm_file
  76 is the AFM (Adobe Font Metric) file for the font.
  77 .
  78 .LP
  79 .I map_file
  80 is a file that says which groff character names map onto
  81 each PostScript character name;
  82 this file should contain a sequence of lines of the form
  83 .IP
  84 .I
  85 ps_char groff_char
  86 .LP
  87 where
  88 .I ps_char
  89 is the PostScript name of the character
  90 and
  91 .I groff_char
  92 is the groff name of the character (as used in the groff font file).
  93 .
  94 The same
  95 .I ps_char
  96 can occur multiple times in the file;
  97 each
  98 .I groff_char
  99 must occur at most once.
 100 .
 101 Lines starting with
 102 .B #
 103 and blank lines are ignored.
 104 .
 105 If the file isn't found in the current directory, it is searched in
 106 the `devps/generate' subdirectory of the default font directory.
 107 .
 108 .LP
 109 If a PostScript character is not mentioned in
 110 .IR map_file ,
 111 and a generic groff glyph name can't be deduced using the
 112 Adobe Glyph List (AGL, built into
 113 .BR afmtodit ),
 114 then
 115 .B afmtodit
 116 puts the PostScript character into the groff font file as an unnamed
 117 character which can only be accessed by the
 118 .B \eN
 119 escape sequence in
 120 .BR troff .
 121 In particular, this is true for glyph variants like `foo.bar'; all glyph
 122 names containing one or more periods are mapped to unnamed entities.
 123 .
 124 If option
 125 .B \-e
 126 is not specified, the encoding defined in the AFM file (i.e., entries
 127 with non-negative character codes) is used.
 128 .
 129 Please refer to section `Using Symbols' in the groff info file which
 130 describes how groff glyph names are constructed.
 131 .
 132 .LP
 133 Characters not encoded in the AFM file (i.e., entries which have \-1 as
 134 the character code) are still available in groff; they get glyph index
 135 values greater than 255 (or greater than the biggest character code used
 136 in the AFM file in the unlikely case that it is greater than 255) in the
 137 groff font file.
 138 .
 139 Glyph indices of unencoded characters don't have a specific order; it
 140 is best to access them with glyph names only.
 141 .
 142 .LP
 143 The groff font file will be output to a file called
 144 .IR font .
 145 .
 146 .LP
 147 If there is a downloadable font file for the font, it may be listed in
 148 the file
 149 .BR @FONTDIR@/devps/download ;
 150 see
 151 .BR grops (@MAN1EXT@).
 152 .
 153 .LP
 154 If the
 155 .B \-i
 156 option is used,
 157 .B afmtodit
 158 will automatically generate an italic correction,
 159 a left italic correction and a subscript correction
 160 for each character
 161 (the significance of these parameters is explained in
 162 .BR groff_font (@MAN5EXT@));
 163 these parameters may be specified for individual characters by
 164 adding to the
 165 .I afm_file
 166 lines of the form:
 167 .IP
 168 .BI italicCorrection\  ps_char\ n
 169 .br
 170 .BI leftItalicCorrection\  ps_char\ n
 171 .br
 172 .BI subscriptCorrection\  ps_char\ n
 173 .LP
 174 where
 175 .I ps_char
 176 is the PostScript name of the character,
 177 and
 178 .I n
 179 is the desired value of the corresponding parameter in thousandths of an em.
 180 .
 181 These parameters are normally needed only for italic (or oblique) fonts.
 182 .
 183 .
 184 .SH OPTIONS
 185 .TP
 186 .BI \-a n
 187 Use
 188 .I n
 189 as the slant parameter in the font file;
 190 this is used by groff in the positioning of accents.
 191 .
 192 By default
 193 .B afmtodit
 194 uses the negative of the ItalicAngle specified in the afm file;
 195 with true italic fonts it is sometimes desirable to use
 196 a slant that is less than this.
 197 .
 198 If you find that characters from an italic font have accents
 199 placed too far to the right over them,
 200 then use the
 201 .B \-a
 202 option to give the font a smaller slant.
 203 .
 204 .TP
 205 .B \-c
 206 Include comments in the font file in order to identify the PS font.
 207 .
 208 .TP
 209 .BI \-d desc_file
 210 The device description file is
 211 .I desc_file
 212 rather than the default
 213 .BR DESC .
 214 .
 215 If not found in the current directory, the `devps' subdirectory of the
 216 default font directory is searched (this is true for both the default
 217 device description file and a file given with option
 218 .BR \-d ).
 219 .
 220 .TP
 221 .BI \-e enc_file
 222 The PostScript font should be reencoded to use the encoding described
 223 in enc_file.
 224 .
 225 The format of
 226 .I enc_file
 227 is described in
 228 .BR grops (@MAN1EXT@).
 229 .
 230 If not found in the current directory, the `devps' subdirectory of the
 231 default font directory is searched.
 232 .
 233 .TP
 234 .BI \-f name
 235 The internal name of the groff font is set to
 236 .IR name .
 237 .
 238 .TP
 239 .BI \-i n
 240 Generate an italic correction for each character so that
 241 the character's width plus the character's italic correction
 242 is equal to
 243 .I n
 244 thousandths of an em
 245 plus the amount by which the right edge of the character's bounding box
 246 is to the right of the character's origin.
 247 .
 248 If this would result in a negative italic correction, use a zero
 249 italic correction instead.
 250 .
 251 .IP
 252 Also generate a subscript correction equal to the
 253 product of the tangent of the slant of the font and
 254 four fifths of the x-height of the font.
 255 .
 256 If this would result in a subscript correction greater than the italic
 257 correction, use a subscript correction equal to the italic correction
 258 instead.
 259 .
 260 .IP
 261 Also generate a left italic correction for each character
 262 equal to
 263 .I n
 264 thousandths of an em
 265 plus the amount by which the left edge of the character's bounding box
 266 is to the left of the character's origin.
 267 .
 268 The left italic correction may be negative unless option
 269 .B \-m
 270 is given.
 271 .
 272 .IP
 273 This option is normally needed only with italic (or oblique) fonts.
 274 .
 275 The font files distributed with groff were created using an option of
 276 .B \-i50
 277 for italic fonts.
 278 .
 279 .TP
 280 .B \-k
 281 Omit any kerning data from the groff font.
 282 This should be used only for mono-spaced fonts.
 283 .
 284 .TP
 285 .B \-m
 286 Prevent negative left italic correction values.
 287 .
 288 Roman font files distributed with groff were created with
 289 .B \-i0\ \-m
 290 to improve spacing with
 291 .BR @g@eqn (@MAN1EXT@).
 292 .
 293 .TP
 294 .B \-n
 295 Don't output a
 296 .B ligatures
 297 command for this font.
 298 .
 299 Use this with constant-width fonts.
 300 .
 301 .TP
 302 .B \-s
 303 The font is special.
 304 .
 305 The effect of this option is to add the
 306 .B special
 307 command to the font file.
 308 .
 309 .TP
 310 .B \-v
 311 Print version.
 312 .
 313 .TP
 314 .B \-x
 315 Don't use the built-in Adobe Glyph List.
 316 .
 317 .
 318 .SH FILES
 319 .Tp \w'\fB@FONTDIR@/devps/download'u+2n
 320 .B @FONTDIR@/devps/DESC
 321 Device description file.
 322 .
 323 .TP
 324 .BI @FONTDIR@/devps/ F
 325 Font description file for font
 326 .IR F .
 327 .
 328 .TP
 329 .B @FONTDIR@/devps/download
 330 List of downloadable fonts.
 331 .
 332 .TP
 333 .B @FONTDIR@/devps/text.enc
 334 Encoding used for text fonts.
 335 .
 336 .TP
 337 .B @FONTDIR@/devps/generate/textmap
 338 Standard mapping.
 339 .
 340 .
 341 .SH "SEE ALSO"
 342 .BR groff (@MAN1EXT@),
 343 .BR grops (@MAN1EXT@),
 344 .BR groff_font (@MAN5EXT@),
 345 .BR perl (1)
 346 .
 347 .LP
 348 The groff info file, section `Using Symbols'.
 349 .
 350 .\" Local Variables:
 351 .\" mode: nroff
 352 .\" End: