src/utils/addftinfo/addftinfo.man

   1 .TH ADDFTINFO @MAN1EXT@ "@MDATE@" "Groff Version @VERSION@"
   2 .SH NAME
   3 addftinfo \- add information to troff font files for use with groff
   4 .
   5 .
   6 .\" --------------------------------------------------------------------
   7 .\" License
   8 .\" --------------------------------------------------------------------
   9 .
  10 .de co
  11 Copyright \[co] 1989-2014 Free Software Foundation, Inc.
  12
  13 Permission is granted to make and distribute verbatim copies of
  14 this manual provided the copyright notice and this permission notice
  15 are preserved on all copies.
  16
  17 Permission is granted to copy and distribute modified versions of this
  18 manual under the conditions for verbatim copying, provided that the
  19 entire resulting derived work is distributed under the terms of a
  20 permission notice identical to this one.
  21
  22 Permission is granted to copy and distribute translations of this
  23 manual into another language, under the above conditions for modified
  24 versions, except that this permission notice may be included in
  25 translations approved by the Free Software Foundation instead of in
  26 the original English.
  27 ..
  28 .
  29 .\" --------------------------------------------------------------------
  30 .\" Characters
  31 .\" --------------------------------------------------------------------
  32 .
  33 .\" Ellipsis ...
  34 .ie t .ds EL \fS\N'188'\fP
  35 .el .ds EL \&.\|.\|.\&\
  36 .\" called with \*(EL
  37 .
  38 .
  39 .\" --------------------------------------------------------------------
  40 .SH SYNOPSIS
  41 .\" --------------------------------------------------------------------
  42 .
  43 .B addftinfo
  44 [
  45 .B \-v
  46 ]
  47 [
  48 .IR "param-option value" \*(EL
  49 ]
  50 .I res
  51 .I unitwidth
  52 .I font
  53 .
  54 .
  55 .\" --------------------------------------------------------------------
  56 .SH DESCRIPTION
  57 .\" --------------------------------------------------------------------
  58 .
  59 .B addftinfo
  60 reads a troff font file and adds some additional font-metric
  61 information that is used by the groff system.
  62 .
  63 The font file with the information added is written on the standard
  64 output.
  65 .
  66 The information added is guessed using some parametric information
  67 about the font and assumptions about the traditional troff names for
  68 characters.
  69 .
  70 The main information added is the heights and depths of characters.
  71 .
  72 The
  73 .I res
  74 and
  75 .I unitwidth
  76 arguments should be the same as the corresponding parameters in the
  77 DESC file;
  78 .I font
  79 is the name of the file describing the font;
  80 if
  81 .I font
  82 ends with
  83 .B I
  84 the font will be assumed to be italic.
  85 .
  86 .
  87 .\" --------------------------------------------------------------------
  88 .SH OPTIONS
  89 .\" --------------------------------------------------------------------
  90 .
  91 .B \[en]v
  92 prints the version number.
  93 .
  94 .
  95 .LP
  96 All other options change one of the parameters that are used to derive
  97 the heights and depths.
  98 .
  99 Like the existing quantities in the font file, each
 100 .I value
 101 is in
 102 .RI inches/ res
 103 for a font whose point size is
 104 .IR unitwidth .
 105 .
 106 .I param-option
 107 must be one of:
 108 .
 109 .TP
 110 .B \[en]x\-height
 111 The height of lowercase letters without ascenders such as x.
 112 .
 113 .TP
 114 .B \[en]fig-height
 115 The height of figures (digits).
 116 .
 117 .TP
 118 .B \[en]asc-height
 119 The height of characters with ascenders, such as b, d or l.
 120 .
 121 .TP
 122 .B \[en]body\-height
 123 The height of characters such as parentheses.
 124 .
 125 .TP
 126 .B \[en]cap-height
 127 The height of uppercase letters such as A.
 128 .
 129 .TP
 130 .B \[en]comma\-depth
 131 The depth of a comma.
 132 .
 133 .TP
 134 .B \[en]desc\-depth
 135 The depth of characters with descenders, such as p, q, or y.
 136 .
 137 .TP
 138 .B \[en]body\-depth
 139 The depth of characters such as parentheses.
 140 .
 141 .
 142 .LP
 143 .B addftinfo
 144 makes no attempt to use the specified parameters to guess the
 145 unspecified parameters.
 146 .
 147 If a parameter is not specified the default will be used.
 148 .
 149 The defaults are chosen to have the reasonable values for a Times
 150 font.
 151 .
 152 .
 153 .\" --------------------------------------------------------------------
 154 .SH "SEE ALSO"
 155 .\" --------------------------------------------------------------------
 156 .
 157 .BR groff_font (@MAN5EXT@),
 158 .BR groff (@MAN1EXT@),
 159 .BR groff_char (@MAN7EXT@)
 160 .
 161 .
 162 .P
 163 Watch a man\-page
 164 .IB name ( n )
 165 with
 166 .RS
 167 .EX
 168 .BI "man" " n name"
 169 .EE
 170 .RE
 171 in text mode and with
 172 .RS
 173 .EX
 174 .BI "groffer" " n name"
 175 .EE
 176 .RE
 177 in graphical mode (PDF, etc.).
 178 .
 179 .
 180 .\" --------------------------------------------------------------------
 181 .SH COPYING
 182 .\" --------------------------------------------------------------------
 183 .co
 184 .
 185 .
 186 .\" Local Variables:
 187 .\" mode: nroff
 188 .\" End: