ttname(1)

1TTNAME(1)                   General Commands Manual                  TTNAME(1)
2
3
4

NAME

6       ttname - CLI font metadata editor
7

SYNOPSIS

9       ttname [options] input_file [output_file]
10

DESCRIPTION

12       ttname  provides a simple CLI interface to edit the name table in True‐
13       Type or OpenType fonts, which contains metadata regarding the font.  It
14       uses the the same library underlying the venerable ttx(1) utility to do
15       it's work.
16

OPTIONS

18   UNIVERSAL OPTIONS
19       These options are valid regardless of whether you are using  ttname  to
20       read or write to font files.
21
22       input_file
23              The path to a OpenType of TrueType file
24
25       -a, --all
26              Operate  on  all  platform/encoding/language  combinations.   By
27              default, ttname will  only  operate  on  the  first  combination
28              found.  You probably want to use this option when writing.
29
30       -p, --platform
31              Specifies  the  OpenType  platform ID number to operate on.  You
32              can provide the numeric ID or use one  of  the  following  short
33              names:
34
35              unicode     for platform ID #0
36              iso         for platform ID #1
37              macintosh   for platform ID #2
38              windows     for platform ID #3
39              custom      for platform ID #4
40
41       -e, --encoding
42              Specifies  the  OpenType  platform encoding ID number to operate
43              on.
44
45       -l, --lang
46              Specifies the OpenType language encoding ID  number  to  operate
47              on.
48
49   READ OPTIONS
50       The  following  option  is only valid when you are using ttname to read
51       the metadata from
52
53       -n {nameID}, --record={nameID}
54              Specifies the OpenType name ID number to return on the  standard
55              output.   In  addition  to  using the numeric form, you can also
56              pass one of the short names listed below in WRITE OPTIONS.
57
58   WRITE OPTIONS
59       These options are only valid when ttname is used to write new  metadata
60       to font files.
61
62       --name{nameID}=*{DATA}*
63              Updates  the  OpenType name ID number {nameID} with the provided
64              {DATA}.
65       If the record does not exist, it will be created.  If -a is provided on
66       the  command  line,  the  same  name  ID  will be updated for all plat‐
67       form/encoding/language combinations that exist in the file.  Otherwise,
68       the specified or default platform/encoding/language are used.
69
70       In  addition  to  using the numeric form as above, ttname also supports
71       textual options for the well known name ID numbers,  which  range  from
72       0-.   Using  any  of the following is equivalent to passing the numeric
73       form as above.
74
75       --copyright
76              Updates name id #0, which contains the copyright notice.
77
78       --family
79              Updates name id #1, which contains the font family name.
80
81       --subfamily
82              Updates name id #2, which contains the font subfamily name.
83
84       --id   Updates name id #3, which contains a unique font identifier.
85
86       --name Updates name id #4, which contains the full font name.
87
88       --version
89              Updates name id #5, which contains a version string.
90
91       --ps-name
92              Updates name id #6, which contains the PostScript name.
93
94       --trademark
95              Updates name id #7, which contains trademark information.
96
97       --mfg-name
98              Updates name id #8, which contains the manufacturer name.
99
100       --designer
101              Updates name id #9, which contains the designer name.
102
103       --desc Updates name id #10, which contains a description of the font.
104
105       --vendor-url
106              Updates name id #11, which contains the URL of the font vendor.
107
108       --designer-url
109              Updates name  id  #12,  which  contains  the  URL  of  the  font
110              designer.
111
112       --license
113              Updates name id #13, which contains a license description.
114
115       --license-url
116              Updates name id #14, which contains the license info URL.
117
118       --pref-family
119              Updates name id #16, which contains the preferred family.
120
121       --pref-subfamily
122              Updates name id #17, which contains the preferred subfamily.
123
124       --compat-full
125              Updates  name  id  #18,  which  contains a compatible full name.
126              Used only by the Macintosh platform (platform ID #1).
127
128       --sample
129              Updates name id #19, which contains sample text.
130
131       --ps-cid-findfont-name
132              Updates name id #20, which contains the PostScript CID  findfont
133              name.
134
135       --wws-family
136              Updates name id #21, which contains the WWS family name.
137
138       --wws-subfamily
139              Updates name id #22, which contains the WWS subfamily name.
140

EXAMPLES

142       Display the name records from the first platform/encoding/language com‐
143       bination present in the font file:
144
145              ttname font.ttf
146
147       Display all name records in the font file:
148
149              ttname -a font.ttf
150
151       Display only the first copyright record in the font file:
152
153              ttname --record=copyright font.ttf
154
155       or use the number, if you don't know the name:
156
157              ttname -n0 font.ttf
158
159       Change the font designer's URL:
160
161              ttname --designer-url='http://www.example.com/' font.ttf
162
163       Again, you can use the number, which is useful for weird names:
164
165              ttname --name12='http://www.example.com/' font.ttf
166

BUGS

183       In the likely event that you encounter a bug, you can report it at:
184
185              <https://github.com/tchollingsworth/ttname/issues>
186
187       or contact the author listed below.
188

AUTHOR

190       T.C. Hollingsworth
191       <tchollingsworth@gmail.com>
192

COPYRIGHT

194       ttname is distributed under the simplified 2-clause BSD license.
195
196       Copyright 2013 T.C. Hollingsworth  <tchollingsworth@gmail.com>
197
198       Redistribution and use in source and binary forms, with or without mod‐
199       ification,  are  permitted  provided  that the following conditions are
200       met:
201
202       1. Redistributions of source  code  must  retain  the  above  copyright
203          notice, this list of conditions and the following disclaimer.
204
205       2. Redistributions  in  binary  form must reproduce the above copyright
206          notice, this list of conditions and the following disclaimer in  the
207          documentation and/or other materials provided with the distribution.
208
209       THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
210       IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT  NOT  LIMITED
211       TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTIC‐
212       ULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER  OR
213       CONTRIBUTORS  BE  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
214       EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,  BUT  NOT  LIMITED  TO,
215       PROCUREMENT  OF  SUBSTITUTE  GOODS  OR  SERVICES; LOSS OF USE, DATA, OR
216       PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY  OF
217       LIABILITY,  WHETHER  IN  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
218       NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT  OF  THE  USE  OF  THIS
219       SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
220
221
222
223                                August 25, 2013                      TTNAME(1)