~ubuntu-branches/ubuntu/maverick/fonttools/maverick

« back to all changes in this revision

Viewing changes to Doc/ttx.1

  • Committer: Bazaar Package Importer
  • Author(s): Paul Wise
  • Date: 2008-07-24 00:03:02 UTC
  • mfrom: (2.1.8 intrepid)
  • Revision ID: james.westby@ubuntu.com-20080724000302-0tediu4ysxkn6dyy
Tags: 2.2-2
* Fix dependencies to use Numpy instead of Numeric (Closes: #492010)
* Drop unneeded quilt build-dependency
* Support noopt in DEB_BUILD_OPTIONS
* Complies with policy 3.8.0, update Standards-Version

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.Dd May 18, 2004
 
2
.\" ttx is not specific to any OS, but contrary to what groff_mdoc(7)
 
3
.\" seems to imply, entirely omitting the .Os macro causes 'BSD' to
 
4
.\" be used, so I give a zero-width space as its argument.
 
5
.Os \&
 
6
.\" The "FontTools Manual" argument apparently has no effect in
 
7
.\" groff 1.18.1. I think it is a bug in the -mdoc groff package.
 
8
.Dt TTX 1 "FontTools Manual"
 
9
.Sh NAME
 
10
.Nm ttx
 
11
.Nd tool for manipulating TrueType and OpenType fonts
 
12
.Sh SYNOPSIS
 
13
.Nm
 
14
.Bk
 
15
.Op Ar option ...
 
16
.Ek
 
17
.Bk
 
18
.Ar file ...
 
19
.Ek
 
20
.Sh DESCRIPTION
 
21
.Nm
 
22
is a tool for manipulating TrueType and OpenType fonts.  It can convert
 
23
TrueType and OpenType fonts to and from an
 
24
.Tn XML Ns -based format called
 
25
.Tn TTX .
 
26
.Tn TTX
 
27
files have a
 
28
.Ql .ttx
 
29
extension.
 
30
.Pp
 
31
For each
 
32
.Ar file
 
33
argument it is given,
 
34
.Nm
 
35
detects whether it is a
 
36
.Ql .ttf ,
 
37
.Ql .otf
 
38
or
 
39
.Ql .ttx
 
40
file and acts accordingly: if it is a
 
41
.Ql .ttf
 
42
or
 
43
.Ql .otf
 
44
file, it generates a
 
45
.Ql .ttx
 
46
file; if it is a
 
47
.Ql .ttx
 
48
file, it generates a
 
49
.Ql .ttf
 
50
or
 
51
.Ql .otf
 
52
file.
 
53
.Pp
 
54
By default, every output file is created in the same directory as the
 
55
corresponding input file and with the same name except for the
 
56
extension, which is substituted appropriately.
 
57
.Nm
 
58
never overwrites existing files; if neccesary, it appends a suffix to
 
59
the output file name before the extension, as in
 
60
.Pa Arial#1.ttf .
 
61
.Ss "General options"
 
62
.Bl -tag -width ".Fl t Ar table"
 
63
.It Fl h
 
64
Display usage information.
 
65
.It Fl d Ar dir
 
66
Write the output files to directory
 
67
.Ar dir
 
68
instead of writing every output file to the same directory as the
 
69
corresponding input file.
 
70
.It Fl v
 
71
Be verbose.  Write more messages to the standard output describing what
 
72
is being done.
 
73
.It Fl a
 
74
Allow virtual glyphs ID's on compile or decompile.
 
75
.El
 
76
.Ss "Dump options"
 
77
The following options control the process of dumping font files
 
78
(TrueType or OpenType) to
 
79
.Tn TTX
 
80
files.
 
81
.Bl -tag -width ".Fl t Ar table"
 
82
.It Fl l
 
83
List table information.  Instead of dumping the font to a
 
84
.Tn TTX
 
85
file, display minimal information about each table.
 
86
.It Fl t Ar table
 
87
Dump table
 
88
.Ar table .
 
89
This option may be given multiple times to dump several tables at
 
90
once.  When not specified, all tables are dumped.
 
91
.It Fl x Ar table
 
92
Exclude table
 
93
.Ar table
 
94
from the list of tables to dump.  This option may be given multiple
 
95
times to exclude several tables from the dump.  The
 
96
.Fl t
 
97
and
 
98
.Fl x
 
99
options are mutually exclusive.
 
100
.It Fl s
 
101
Split tables.  Dump each table to a separate
 
102
.Tn TTX
 
103
file and write (under the name that would have been used for the output
 
104
file if the
 
105
.Fl s
 
106
option had not been given) one small
 
107
.Tn TTX
 
108
file containing references to the individual table dump files.  This
 
109
file can be used as input to
 
110
.Nm
 
111
as long as the referenced files can be found in the same directory.
 
112
.It Fl i
 
113
.\" XXX: I suppose OpenType programs (exist and) are also affected.
 
114
Don't disassemble TrueType instructions.  When this option is specified,
 
115
all TrueType programs (glyph programs, the font program and the
 
116
pre-program) are written to the
 
117
.Tn TTX
 
118
file as hexadecimal data instead of
 
119
assembly.  This saves some time and results in smaller
 
120
.Tn TTX
 
121
files.
 
122
.It Fl e
 
123
Don't ignore decompilation errors, but show a full traceback and abort.
 
124
.El
 
125
.Ss "Compilation options"
 
126
The following options control the process of compiling
 
127
.Tn TTX
 
128
files into font files (TrueType or OpenType):
 
129
.Bl -tag -width ".Fl t Ar table"
 
130
.It Fl m Ar fontfile
 
131
Merge the input
 
132
.Tn TTX
 
133
file
 
134
.Ar file
 
135
with
 
136
.Ar fontfile .
 
137
No more than one
 
138
.Ar file
 
139
argument can be specified when this option is used.
 
140
.It Fl b
 
141
Don't recalculate glyph bounding boxes.  Use the values in the
 
142
.Tn TTX
 
143
file as is.
 
144
.El
 
145
.Sh "THE TTX FILE FORMAT"
 
146
You can find some information about the
 
147
.Tn TTX
 
148
file format in
 
149
.Pa documentation.html .
 
150
In particular, you will find in that file the list of tables understood by
 
151
.Nm
 
152
and the relations between TrueType GlyphIDs and the glyph names used in
 
153
.Tn TTX
 
154
files.
 
155
.Sh EXAMPLES
 
156
In the following examples, all files are read from and written to the
 
157
current directory.  Additionally, the name given for the output file
 
158
assumes in every case that it did not exist before
 
159
.Nm
 
160
was invoked.
 
161
.Pp
 
162
Dump the TrueType font contained in
 
163
.Pa FreeSans.ttf
 
164
to
 
165
.Pa FreeSans.ttx :
 
166
.Pp
 
167
.Dl ttx FreeSans.ttf
 
168
.Pp
 
169
Compile
 
170
.Pa MyFont.ttx
 
171
into a TrueType or OpenType font file:
 
172
.Pp
 
173
.Dl ttx MyFont.ttx
 
174
.Pp
 
175
List the tables in
 
176
.Pa FreeSans.ttf
 
177
along with some information:
 
178
.Pp
 
179
.Dl ttx -l FreeSans.ttf
 
180
.Pp
 
181
Dump the
 
182
.Sq cmap
 
183
table from
 
184
.Pa FreeSans.ttf
 
185
to
 
186
.Pa FreeSans.ttx :
 
187
.Pp
 
188
.Dl ttx -t cmap FreeSans.ttf
 
189
.Sh NOTES
 
190
On MS\-Windows and MacOS,
 
191
.Nm
 
192
is available as a graphical application to which files can be dropped.
 
193
.Sh SEE ALSO
 
194
.Pa documentation.html
 
195
.Pp
 
196
.Xr fontforge 1 ,
 
197
.Xr ftinfo 1 ,
 
198
.Xr gfontview 1 ,
 
199
.Xr xmbdfed 1 ,
 
200
.Xr Font::TTF 3pm
 
201
.Sh AUTHORS
 
202
.Nm
 
203
was written by
 
204
.An -nosplit
 
205
.An "Just van Rossum" Aq just@letterror.com .
 
206
.Pp
 
207
This manual page was written by
 
208
.An "Florent Rougon" Aq f.rougon@free.fr
 
209
for the Debian GNU/Linux system based on the existing FontTools
 
210
documentation.  It may be freely used, modified and distributed without
 
211
restrictions.
 
212
.\" For Emacs:
 
213
.\" Local Variables:
 
214
.\" fill-column: 72
 
215
.\" sentence-end: "[.?!][]\"')}]*\\($\\| $\\|   \\|  \\)[       \n]*"
 
216
.\" sentence-end-double-space: t
 
217
.\" End: