ttx¶
usage: ttx [options] inputfile1 [… inputfileN]
TTX – From OpenType To XML And Back
- If an input file is a TrueType or OpenType font file, it will be
decompiled to a TTX file (an XML-based text format).
- If an input file is a TTX file, it will be compiled to whatever
format the data is in, a TrueType or OpenType/CFF font file.
- Output files are created so they are unique: an existing file is
never overwritten.
General options: -h Help: print this message. –version: show version and exit. -d <outputfolder> Specify a directory where the output files are
to be created.
- -o <outputfile> Specify a file to write the output to. A special
value of - would use the standard output.
-f Overwrite existing output file(s), ie. don’t append numbers. -v Verbose: more messages will be written to stdout about what
is being done.
- -q Quiet: No messages will be written to stdout about what
is being done.
-a allow virtual glyphs ID’s on compile or decompile.
Dump options: -l List table info: instead of dumping to a TTX file, list some
minimal info about each table.
- -t <table> Specify a table to dump. Multiple -t options
are allowed. When no -t option is specified, all tables will be dumped.
- -x <table> Specify a table to exclude from the dump. Multiple
-x options are allowed. -t and -x are mutually exclusive.
- -s Split tables: save the TTX data into separate TTX files per
table and write one small TTX file that contains references to the individual table dumps. This file can be used as input to ttx, as long as the table files are in the same directory.
- -g Split glyf table: Save the glyf data into separate TTX files
per glyph and write a small TTX for the glyf table which contains references to the individual TTGlyph elements. NOTE: specifying -g implies -s (no need for -s together with -g)
- -i Do NOT disassemble TT instructions: when this option is given,
all TrueType programs (glyph programs, the font program and the pre-program) will be written to the TTX file as hex data instead of assembly. This saves some time and makes the TTX file smaller.
- -z <format> Specify a bitmap data export option for EBDT:
{‘raw’, ‘row’, ‘bitwise’, ‘extfile’} or for the CBDT: {‘raw’, ‘extfile’} Each option does one of the following:
- -z raw
export the bitmap data as a hex dump
- -z row
export each row as hex data
- -z bitwise
export each row as binary in an ASCII art style
- -z extfile
export the data as external files with XML references
If no export format is specified ‘raw’ format is used.
- -e Don’t ignore decompilation errors, but show a full traceback
and abort.
- -y <number> Select font number for TrueType Collection (.ttc/.otc),
starting from 0.
- –unicodedata <UnicodeData.txt> Use custom database file to write
character names in the comments of the cmap TTX output.
- –newline <value> Control how line endings are written in the XML
file. It can be ‘LF’, ‘CR’, or ‘CRLF’. If not specified, the default platform-specific line endings are used.
Compile options: -m Merge with TrueType-input-file: specify a TrueType or OpenType
font file to be merged with the TTX file. This option is only valid when at most one TTX file is specified.
- -b Don’t recalc glyph bounding boxes: use the values in the TTX
file as-is.
- –recalc-timestamp Set font ‘modified’ timestamp to current time.
By default, the modification time of the TTX file will be used.
–no-recalc-timestamp Keep the original font ‘modified’ timestamp. –flavor <type> Specify flavor of output font file. May be ‘woff’
or ‘woff2’. Note that WOFF2 requires the Brotli Python extension, available at https://github.com/google/brotli
- –with-zopfli Use Zopfli instead of Zlib to compress WOFF. The Python
extension is available at https://pypi.python.org/pypi/zopfli
-
class
fontTools.ttx.
Options
(rawOptions, numFiles)[source]¶ -
allowVID
= False¶
-
bitmapGlyphDataFormat
= 'raw'¶
-
disassembleInstructions
= True¶
-
flavor
= None¶
-
ignoreDecompileErrors
= True¶
-
listTables
= False¶
-
mergeFile
= None¶
-
newlinestr
= None¶
-
outputDir
= None¶
-
outputFile
= None¶
-
overWrite
= False¶
-
quiet
= False¶
-
recalcBBoxes
= True¶
-
recalcTimestamp
= None¶
-
splitGlyphs
= False¶
-
splitTables
= False¶
-
unicodedata
= None¶
-
useZopfli
= False¶
-
verbose
= False¶
-