Hi,
In Debian there is a goal to have man pages for all executables. There
aren't any for the freetype2-demo programs yet, which is considered a
bug: http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=131137.
Please find attached some minimal draft man pages, mainly based upon the
usage output of the various tools. Any kind of feedback/review is
appreciated since I hardly know anything about freetype, and whether you
are interested in adding man pages upstream at all.
Kind regards,
Nis
.TH ftview 1 July 2013 FreeType User Manuals
.SH NAME
.PP
ftview \- simple glyph viewer
.SH SYNOPSIS
.B ftview
.RI [ options ]
.I pt font
.SH DESCRIPTION
.B ftview
is a simple glyph viewer and part of the FreeType project.
.TP
.B pt
The point size for the given resolution.
If resolution is 72dpi, this directly gives the ppem value (pixels per
EM).
.TP
.B font
The font file(s) to display.
For Type 1 font files, ftview also tries to attach the corresponding
metrics file (with extension .afm or .pfm).
.SH OPTIONS
.TP
.BI \-r\ R
Use resolution
.I R
dpi (default: 72dpi).
.TP
.BI \-f\ index
Specify first index to display (default: 0).
.TP
.BI \-e\ enc
Specify encoding tag (default: no encoding).
Common values: unic (Unicode), symb (symbol),
ADOB (Adobe standard), ADBC (Adobe custom).
.TP
.B \-D
Dump cache usage statistics.
.TP
.BI \-m\ text
Use
.I text
for rendering.
.TP
.BI \-l\ mode
Change rendering mode (0 =
.I mode
= 6).
.TP
.B \-p
Preload file in memory to simulate memory-mapping.
.TH ftvalid 1 July 2013 FreeType User Manuals
.SH NAME
.PP
ftvalid \- font layout table validator
.SH SYNOPSIS
.B ftvalid
.RI [ options ]
.I fontfile
.SH DESCRIPTION
.B ftvalid
is a layout table validator from the FreeType project.
.SH OPTIONS
.TP
.BI \-f\ index
Select font index (default: 0).
.TP
.BI \-t\ validator
Select validator. Available validators: ot gx ckern
.TP
.BI \-T\ sfnt:tabl:enam:es
Select snft table names to be validated. `:' is for separating table names.
Supported tables in ot validator are:
BASE GDEF GPOS GSUB JSTF MATH
Supported tables in gx validator are:
feat mort morx bsln just kern opbd trak prop lcar
.TP
.BI \-T\ ms:apple
[ckern] Select (a) classic kern dialect(s) for validation. `:' is for
separating dialect names. If more than one dialects is specified, all
dialects are accepted when validating.
Supported dialects in ckern validator are: ms apple
.TP
.BI \-L
List the layout related SFNT tables available in the font file. Choice
of validator with -t option affects on the listing.
ckern is applicable to kern table. -L lists dialects supported in ckern
validator only if kern table is available in the font file.
.TP
.BI \-v\ validation_level
Validation level. validation_level = 0...2 (0: default, 1: tight, 2:
paranoid)
.SH ENVIRONMENT VARIABLES
.TP
.B FT2_DEBUG
You can specify trace components and their levels[1-7] to it like
FT2_DEBUG=module1:level module2:level
Available components for ot validator: otvmodule otvcommon otvbase
otvgdef otvgpos otvgsub otvjstf
Available components for gx validator: gxvmodule gxvcommon gxvfeat
gxvmort gxvmorx gxvbsln gxvjust gxvkern gxvopbd gxvtrak gxvprop gxvlcar
Only gxvkern is available for ckern validator.
.TH ftlint 1 August 2013 Freetype User Manuals
.SH NAME
.PP
ftlint \- simple font tester
.SH SYNOPSIS
.B ftlint
.I ppem
.IR fontname [ .ttf|.ttc ]
.RI [ fontname2.. ]
.SH DESCRIPTION
The
.B ftlint
font tester is part of the FreeType project. It does not have any
options.
.TH ftgrid 1 August 2013 Freetype User Manuals
.SH NAME
.PP
ftgrid \- simple glyph grid viewer
.SH SYNOPSIS
.B ftgrid
.RI [ options ]
.I pt font ...
.SH DESCRIPTION
.B ftgrid
is a simple glyph grid viewer, part of the FreeType Project.
.TP
.B pt
The point size for the given resolution. If resolution is 72dpi, this
directly gives the ppem value (pixels per EM).
.TP
.B font
The font file(s) to display. For Type 1 font files, ftgrid also tries
to attach the corresponding metrics file (with extension `.afm' or
`.pfm').
.SH OPTIONS
.TP
.BI \-r\ R
Use resolution
.I R
dpi (default: 72dpi).
.TP
.BI \-f\ index
Specify first index to display (default: 0).
.TH ftstring 1 August 2013 Freetype User Manuals
.SH NAME
.PP
ftstring \- string viewer
.SH SYNOPSIS
.B ftstring
.RI [ options ]
.I pt font ...
.SH DESCRIPTION
The
.B ftstring
demo program is a string viewer, part of the FreeType project.
.TP
.B pt
The point size for the given resolution.
If resolution is 72dpi, this directly gives the
ppem value (pixels per EM).
.TP
.B font
The font file(s) to display.
For Type 1 font files, ftview also tries to attach
the corresponding metrics file (with extension
`.afm' or `.pfm').
.SH OPTIONS
.TP
.BI \-r\ R
Use resolution
.I R
dpi (default: 72dpi).
.TP
.BI \-e\ enc
Specify encoding tag (default: no encoding).
Common values: `unic' (Unicode), `symb' (symbol),
`ADOB' (Adobe standard), `ADBC' (Adobe custom).
.TP
.BI \-m\ text
Use `text' for rendering.
.TH ftmulti 1 August 2013 Freetype User Manuals
.SH NAME
