TITLE

fret - Font REporting Tool

SYNOPSIS

  fret [-p package] [-a ap.xml] [-f] [-g] [-i re] [-r] [-s size] [-q] font_file [out_file]
Generates a report on a font according to a particular package. In some
contexts the package may be over-ridden. Paper size may also be specified.

OPTIONS

If no out_file is given then out_file becomes font_file.pdf (removing .ttf if present)

  -a ap.xml     Attachment point database file
  -f            Don't try to save memory on large fonts (>1000 glyphs)
  -g            Add one glyph per page report following summary report
  -h            Mode for glyph per page output. Bitfield:
                1 = bit 0       don't output curve point positions
                2 = bit 0       don't output attachment point positions
  -i re         Regular expression that identifies what attachment points
                to include in the report
  -m points     Sets glyph size in the box regardless of what is calculated
                Regardless of the consequences for clashes
  -o sort       Define sort order. Can be combinations of u (Unicode),
                p (postname), or i (glyph index). When supplied, priority
                is u, then p, then i. Default upi.
  -p package    Perl package specification to use for report information
                (must be first option)
  -q            quiet mode
  -r            Don't output report lines, fill the page with glyph boxes
  -s size       paper size: a4, ltr, legal
  -?            longer help

DESCRIPTION

FRET creates a PDF report from a TrueType font containing information about every glyph in the font. It sorts the glyphs by Unicode identifier and then for those glyphs with no Unicode identifier it sorts them by glyph name and then by glyph number.

In addition it is possible to get a report including a page per glyph with a large outline of each glyph perhaps with the drawn points.

If the optional ap.xml file is specified on the command line then attachment point information is included in the report. See ttfbuilder for details of the ap.xml file format. Only attachment points that match the regular expression supplied via the -i option will be included.

If supplied, -p must be the first option.

SEE ALSO

ttfbuilder

AUTHOR

Martin Hosken Martin_Hosken@sil.org (see CONTRIBUTORS for other authors).

LICENSING

Copyright (c) 1998-2013, SIL International (http://www.sil.org)

This script is released under the terms of the Artistic License 2.0. For details, see the full text of the license in the file LICENSE.