.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" 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
.\" ========================================================================
.\"
.IX Title "OT2KPX 1"
.TH OT2KPX 1 2023-12-30 fontools "Marc Penninga"
.\" 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
ot2kpx \- extract kerning information from OpenType fonts
.SH SYNOPSIS
.IX Header "SYNOPSIS"
\&\fBot2kpx\fR [ \fI\-afm\fR | \fI\-kpx\fR | \fI\-lua\fR ] \fB<fontfile>\fR
.SH DESCRIPTION
.IX Header "DESCRIPTION"
\&\fBot2kpx\fR extract the kerning data from OpenType fonts and prints it
to \f(CW\*(C`stdout\*(C'\fR, either in Adobe's KPX format (for adding to an \fIafm\fR file)
or as a Luatex custom feature, for use with the \f(CW\*(C`\edirectlua\*(C'\fR command.
.SH "OPTIONS AND ARGUMENTS"
.IX Header "OPTIONS AND ARGUMENTS"
.IP \fB\-help\fR 4
.IX Item "-help"
Print a short help text and exit.
.IP \fB\-version\fR 4
.IX Item "-version"
Print \fBot2kpx\fR's version and exit.
.IP "\fB\-afm\fR, \fB\-kpx\fR" 4
.IX Item "-afm, -kpx"
Output the kerning data in Adobe's KPX format, as used in \fIafm\fR files.
This is the default output format.
.IP \fB\-lua\fR 4
.IX Item "-lua"
Output the kerning data as a Luatex custom font feature,
to be included in a \f(CW\*(C`\edirectlua\*(C'\fR command.
.IP \fB<fontfile>\fR 4
.IX Item "<fontfile>"
The OpenType font (both \fIotf\fR and \fIttf\fR format are supported).
.SH RESTRICTIONS
.IX Header "RESTRICTIONS"
.IP \fB\-\fR 4
.IX Item "-"
\&\fBot2kpx\fR doesn't implement all of the OpenType specification.
Things that are missing include: support for font files containing
multiple fonts, LookupTables with LookupTypes other than 2,
"kern" tables with format other than 0 and ValueRecords with
other types of data than just XAdvance data.
.Sp
Most of these limitations won't matter, since the missing features
are rare (the only fonts I know of that use them are the non-western fonts
that come with Adobe Reader). Furthermore, many of these features define
(according to the OpenType specification) \fI"subtle, device-dependent
adjustments at specific font sizes or device resolutions"\fR;
since there's no way to express such adjustments in \fIafm\fR format,
ignoring them seems to be the only option anyway.
.IP \fB\-\fR 4
.IX Item "-"
\&\fBot2kpx\fR collects kerning data first from the "kern" table, then from
all LookupTables associated with the "kern" feature; if a kerning pair
occurs multiple times, the first value seen is chosen.
There are (or may be) several issues with this approach:
.RS 4
.IP \- 4
The OpenType specification says that fonts in \fIotf\fR format shouldn't
use the "kern" table at all, just the lookups from the "GPOS" table.
Many such fonts do, however, contain a "kern" table, but no "GPOS" table;
so we use the "kern" table anyway.
.IP \- 4
Instead of reading all LookupTables, it might be better to let the user
specify a script and language and process only the LookupTables for
those values.
However, at least in the fonts I checked, all script/language combinations
eventually point to the \fIsame\fR "kern" LookupTables, so this approach
wouldn't make any difference (apart from further complicating the code).
.RE
.RS 4
.RE
.SH AUTHOR
.IX Header "AUTHOR"
Marc Penninga <marcpenninga@gmail.com>
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright (C) 2005\-2023 Marc Penninga.
.SH LICENSE
.IX Header "LICENSE"
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published
by the Free Software Foundation, either version 2 of the License,
or (at your option) any later version.
A copy of the GNU General Public License is included with \fBot2kpx\fR;
see the file \fIGPLv2.txt\fR.
.SH DISCLAIMER
.IX Header "DISCLAIMER"
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
See the GNU General Public License for more details.
.SH VERSION
.IX Header "VERSION"
This document describes \fBot2kpx\fR version 20231230.
.SH "RECENT CHANGES"
.IX Header "RECENT CHANGES"
(See the source code for the rest of the story.)
.IP \fI2019\-05\-20\fR 12
.IX Item "2019-05-20"
Added the \fI\-version\fR option.
.IP \fI2019\-04\-15\fR 12
.IX Item "2019-04-15"
Added the \fI\-lua\fR command-line option to get output in Luatex's
custom feature format.