src/utils/addftinfo/addftinfo.1.man

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