[font-ttf-scripts-perl] 02/02: add README.scripts to describe all the scripts
Daniel Glassey
wdg at moszumanska.debian.org
Tue Nov 10 12:36:48 UTC 2015
This is an automated email from the git hooks/post-receive script.
wdg pushed a commit to branch master
in repository font-ttf-scripts-perl.
commit c448b15273e8bcbd97a3cd3a3bf4c73b45249e60
Author: Daniel Glassey <wdg at debian.org>
Date: Tue Nov 10 12:16:51 2015 +0000
add README.scripts to describe all the scripts
---
debian/README.scripts | 251 ++++++++++++++++++++++++++++++++++++++
debian/font-ttf-scripts-perl.docs | 1 +
2 files changed, 252 insertions(+)
diff --git a/debian/README.scripts b/debian/README.scripts
new file mode 100644
index 0000000..6bf8861
--- /dev/null
+++ b/debian/README.scripts
@@ -0,0 +1,251 @@
+Introduction
+============
+
+SIL FontUtils collection provides command line tools for manipulating TrueType fonts. These tools are cross-platform and work on Windows, Mac, and Linux.
+
+Written in pure Perl, the source modules (Font::TTF::Scripts and the supporting library package Font::TTF) have been available for a number of years and are an essential tool of NRSI's font development processes. For Perl users the most up-to-date sources can be retrieved from our Subversion repositories.
+
+The utilities
+=============
+
+Command Synopsis
+----------------
+
+General font hacking and repairing:
+-----------------------------------
+
+hackos2
+.......
+
+hackos2 [-c hex] [-d directory] [-f fsSelection] [-p hex] [-q] [-t num] [-u hex] [-w width]
+Hacks various fields in the OS/2 table of a ttf file, including: fsType, panose, ulUnicodeRange, achVendID, fsSelection, usFirstCharIndex, usLastCharIndex and ulCodePageRange
+
+psfix
+.....
+
+psfix infile outfile
+Updates Postscript table to account for Postscript Unicode conventions.
+
+ttf2woff
+........
+
+ttf2woff [-m metadatafile] [-p privatefile] infile.ttf outfile.woff
+Converts a TTF file into a WOFF file appending optional metadata and private data.
+
+ttfascent
+.........
+
+ttfascent [-a num] [-d num] [-l num] infile [outfile]
+Opens infile (a .ttf file) changes the ascent and descent values in the Hhea and OS/2 table and then writes the resulting file to outfile if specified.
+
+ttfeval
+.......
+
+tteval [options] infont.ttf ...
+ttfeval is a wrapper for those one- or two-line font hacks. It does the work of including the Font:TTF module, opening the input font file, and optionally writing the output font file. You just supply the code in the middle.
+
+ttffeatparms
+............
+
+ttffeatparms [-d] [-c control.xml] infile.ttf outfile.ttf
+Adds feature parameters to Opentype stylistic set or character variants features
+
+ttfbboxfix
+..........
+
+ttfbboxfix [-v] in.ttf [out.ttf]
+Reports bounding box errors in a font. If out.ttf is provided, rewrite corrected font.
+
+ttfdeflang
+..........
+
+ttfdeflang -d lang infile.ttf outfile.ttf
+Creates a font with the given language id as being default.
+
+ttfname
+.......
+
+ttfname [-f "new_full_name"] -n "new_name" [-t num] [-q] in.ttf out.ttf
+Renames the TTF with the given name and outputs the newly named font.
+
+ttfremap
+........
+
+ttfremap -c file [-r] [-s | -u]
+Remaps the MS cmap of a font without removing any glyphs. Updates the OS/2 table according to first and last char of new cmap.
+
+ttfsetver
+.........
+
+ttfsetver [-d "description"] version infile outfile
+Sets font version (in both head and name tables).
+
+ttfsubset
+.........
+
+ttfsubset [options] infont outfont
+Opens infont (a .ttf file), subsets it according to the supplied options, then writes the resulting file to outfont.
+
+ttftable
+........
+
+ttftable [options] in.ttf [out.ttf]
+Opens in.ttf for reading, optionally imports, exports, and/or deletes tables from the font, then writes the modified font to out.ttf if provided.
+
+TTFBuilder / Attachment Point related:
+--------------------------------------
+
+add_classes
+...........
+
+add_classes -c classes.xml infile.xml
+Adds class information to an attachment point database.
+
+check_attach
+............
+
+check_attach [-z outfile.xml] infile.xml infile.ttf
+Checks an attachment point database against a font, checking that any contours are single point and any locations tie up with their corresponding contour, or that there exists a single point contour at a given location. This program can also generate missing information and write it to a new attachment point database.
+
+make_fea
+........
+
+make_fea [-a attach.xml] [-i file] [-l type [-s num]] [-n num] infile outfile
+Analyse the input font and attachment point database to generate Adobe Font Development Kit (AFDKO) Feature files, including classes for related glyphs and adding attachment point information.
+
+make_gdl
+........
+
+make_gdl [-a attach.xml] [-i file] [-l type [-s num]] [-n num] infont.ttf outGDL.txt
+Analyse the input font and attachment point database to generate gdl code including classes for related glyphs and adding attachment point information.
+
+make_volt
+.........
+
+make_volt [-t] [-a attach.xml] [-l ligtype] [-i file] [-n] infont.ttf outfile
+Analyse the input font and attachment point database to generate VOLT project code including classes for related glyphs and anchor point information. Can also merge existing volt code.
+
+sfd2ap
+......
+
+sfd2ap infile.sfd [outfile.xml]
+Reads a FontForge font file and extracts anchor point information into an XML attachment point database.
+
+ttfbuilder
+..........
+
+ttfbuilder [-a] [-h] -c config.xml [-x attach.xml] [-z out.xml] infile.ttf outfile.ttf
+Builds outfile.ttf from infile.ttf according to config.xml.
+
+volt2ap
+.......
+
+volt2ap [-t voltdat.txt] infile.ttf > outfile.xml
+Export glyph data, including anchors, to XML attachment point database
+
+VOLT related:
+-------------
+
+ttf2volt
+........
+
+ttf2volt [options] infontfile [outfontfile]
+Attempts to create a VOLT project from an existing OpenType font by reading and interpreting the existing GDEF, GPOS, and GSUB tables. Not every OpenType rule can be mimiced in VOLT; warnings are issued when ttf2volt cannot handle something.
+
+volt2ttf
+........
+
+volt2ttf [-a attach.xml] [-t volt.txt] infile.ttf outfile.ttf
+Compiles volt source into OT tables in the font. Think of this as a 3rd party command-line version of MS VOLT.
+
+TypeTuner related: (see http://scripts.sil.org/typetuner)
+---------------------------------------------------------
+
+ttflang2tuner
+.............
+
+ttflang2tuner [-c] [-v] infile.ttf ...
+Builds TypeTuner features configuration file(s) from the script and language tags contained in the GPOS and GSUB tables of OpenType font(s).
+
+typetuner
+.........
+
+typetuner -x <xml> <ttf> (create settings xml file from ttf)
+
+typetuner <xml> <ttf> (apply edited settings xml file to ttf)
+
+typetuner [<switches>] <command> [files, ...]
+Enables developers to create fonts which users can then alter (also using TypeTuner) to change default glyphs and behaviors.
+
+Fontforge related:
+------------------
+
+sfdmeld
+.......
+
+sfdmeld [-a ap.xml] [-p] structure.sfd design.sfd output.sfd
+Merges two FontForge font files such that the lookups and behaviour in the second (design) file is overridden by that in the first file.
+
+sfdmerge
+........
+
+sfdmerge [-r winner] base local other
+Does a 3 way ancestral merge of sfd files.
+
+Miscellaneous:
+--------------
+
+dumpfont
+........
+
+dumpfont [-t taglist] [-a attach.xml] font.ttf
+Dump font table structures. "taglist" is a comma-or space-separated list of tags specifying which tables to dump.
+
+fret
+....
+
+FRET [-f] [-g] [-r] [-s size] [-p package] [-q] font_file [out_file]
+Generates nice PDF reports on a font.
+
+Obsolete or outdated utilities
+------------------------------
+
+A number of utilities formerly installed with this package have been obsoleted by alternative tools or deemed to be low usage and so are no longer installed as executables by the standard installers (binary or source). However, the source bundle includes all of these in the Examples folder.
+name purpose replaced by
+eurofix Update legacy fonts for the Win98 change in codepage 1252
+thai2gdl Creates GDL for a Thai font
+thai2OT Creates OpenType tables for Thai font
+thai2volt Creates VOLT for a Thai font
+ttfenc Creates a Postscript mapping file for the given font
+VoltFixup "Smart" import of a VOLT project to a new font. make_volt
+VoltImportAnchors Imports anchor definitions from XML make_volt
+VoltExportAnchors Exports VOLT anchor definitions to XML volt2ap
+
+Usage
+
+All of the tools are commandline, so you will typically launch them by typing the command name and parameters into a command prompt.
+
+Most tools provides their own "usage" message explaining the parameters. To get the usage message, execute the command with no parameters. For example:
+
+$ttfname
+Usage:
+ ttfname [-f "full_name"] -n "name" [-t num] [-q] infile.ttf outfile.ttf
+ Renames the TTF with the given name and outputs the newly named font to out.ttf.
+
+Options:
+ -f "name" specifies new full name (optional) as opposed to the
+ default calculated form.
+ -l lang language number to use (default all langs)
+ if specified name entries will be added for all platforms and
+ encodings covered by the cmap if not already there
+ -n "name" specifies new font family name (not optional)
+ -p Don't update postscript font name
+ -q disable signon message
+ -r num Removes all strings of the given id
+ -s filename overrides -n and gets string from file. Useful for -t
+ -t num overrides the normal naming areas to change another
+ string -f becomes inactive. Use -l as well to create entry.
+ -w "name" overrides subfamily in the font (think weight). So a full name
+ may be made from -n and -w together.
+
+Note also that many of the commands now support a -h option for more complete help.
diff --git a/debian/font-ttf-scripts-perl.docs b/debian/font-ttf-scripts-perl.docs
new file mode 100644
index 0000000..5519cfa
--- /dev/null
+++ b/debian/font-ttf-scripts-perl.docs
@@ -0,0 +1 @@
+debian/README.scripts
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-perl/packages/font-ttf-scripts-perl.git
More information about the Pkg-perl-cvs-commits
mailing list