.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.48)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Required to disable full justification in groff 1.23.0.
.if n .ds AD l
.\" ========================================================================
.\"
.IX Title "FRET 1"
.TH FRET 1 2026-10-03 "perl v5.44.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
fret \- Font REporting Tool
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 2
\&  fret [\-p package] [\-a ap.xml] [\-f] [\-g] [\-i re] [\-r] [\-s size] [\-q]
\&            font_file [out_file] [bounding_file]
.Ve
.PP
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.
.SH OPTIONS
.IX Header "OPTIONS"
If no out_file is given then out_file becomes font_file.pdf (removing .ttf
if present)
.PP
.Vb 10
\&  \-a ap.xml     Attachment point database file
\&  \-b            Draw bounding octogon. Outputs bounding file if specified.
\&  \-f            Don\*(Aqt 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\*(Aqt output curve point positions
\&                2 = bit 0       don\*(Aqt 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\*(Aqt output report lines, fill the page with glyph boxes
\&  \-s size       paper size: a4, ltr, legal
\&  \-?            longer help
.Ve
.SH DESCRIPTION
.IX Header "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.
.PP
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.
.PP
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.
.PP
If supplied, \-p must be the first option.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
ttfbuilder
.SH AUTHOR
.IX Header "AUTHOR"
Martin Hosken <http://scripts.sil.org/FontUtils>.
(see CONTRIBUTORS for other authors).
.SH LICENSING
.IX Header "LICENSING"
Copyright (c) 1998\-2016, SIL International (http://www.sil.org)
.PP
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.