summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/man/man1/autoinst.1
blob: a3062269cd72638f950fdc419d24301faecda504 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
.\"
.\" 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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    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 turned on, 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
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "AUTOINST 1"
.TH AUTOINST 1 "2013-10-01" "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"
autoinst \- wrapper around the LCDF TypeTools,
for installing OpenType fonts in LaTeX.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
\&\fBautoinst\fR [\fIoptions\fR] \fBfontfile(s)\fR
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Eddie Kohler's \fI\s-1LCDF\s0 TypeTools\fR are superb tools for installing 
OpenType fonts in LaTeX, but they can be hard to use: 
they need many, often long, command lines 
and don't generate the \fIfd\fR and \fIsty\fR files LaTeX needs.
\&\fBautoinst\fR simplifies the use of the \fITypeTools\fR for font installation
by generating and executing all commands for \fIotftotfm\fR
and by creating and installing all necessary \fIfd\fR and \fIsty\fR files.
.PP
Given a family of font files (in \fIotf\fR or \fIttf\fR format),
\&\fBautoinst\fR will create several LaTeX font families:
.RS 2
.IP "\-" 3
Four text families (with lining and oldstyle digits, in both tabular
and proportional variants), each with the following shapes:
.RS 3
.RS 2
.IP "\fIn\fR" 6
.IX Item "n"
Roman text
.IP "\fIit\fR" 6
.IX Item "it"
Italic (or oblique) text
.IP "\fIsc\fR" 6
.IX Item "sc"
Small caps
.IP "\fIsw\fR" 6
.IX Item "sw"
Swash
.IP "\fItl\fR" 6
.IX Item "tl"
Titling shape. Meant for all-caps text only (even though it sometimes contains
lowercase glyphs as well), where letterspacing and the positioning of
punctuation characters have been adjusted to suit all-caps text.
(This shape is only generated for the families with lining digits, 
since old-style digits make no sense with all-caps text.)
.IP "\fIscit\fR" 6
.IX Item "scit"
Italic small caps
.IP "\fInw\fR" 6
.IX Item "nw"
\&\*(L"Upright swash\*(R"; usually normal text with some \*(L"oldstyle\*(R" ligatures,
such as ct, sp and st.
.IP "\fItlit\fR" 6
.IX Item "tlit"
Italic titling
.RE
.RS 2
.RE
.RE
.RS 3
.RE
.IP "\-" 3
For each text family: a family of TS1\-encoded symbol fonts,
in roman and italic shapes.
.IP "\-" 3
Four families with superiors, inferiors, numerators and denominators,
in roman and italic shapes.
.IP "\-" 3
An ornament family, in roman and italic shapes.
.RE
.RS 2
.RE
.PP
Of course, if the fonts don't contain oldstyle digits, small caps etc.,
the corresponding shapes and families are not created.
Furthermore, the creation of most families and shapes can be controlled by
command-line options (see \*(L"COMMAND-LINE \s-1OPTIONS\*(R"\s0 below).
.PP
These families use the \fIFontPro\fR project's naming scheme: 
\&\fI<FontFamily>\-<Suffix>\fR, where \fI<Suffix>\fR is:
.IP "\fI\s-1LF\s0\fR" 8
.IX Item "LF"
proportional (i.e., figures have varying widths) lining figures
.IP "\fI\s-1TLF\s0\fR" 8
.IX Item "TLF"
tabular (i.e., all figures have the same width) lining figures
.IP "\fIOsF\fR" 8
.IX Item "OsF"
proportional oldstyle figures
.IP "\fITOsF\fR" 8
.IX Item "TOsF"
tabular oldstyle figures
.IP "\fISup\fR" 8
.IX Item "Sup"
superior characters (many fonts have only an incomplete set of superior
characters: digits, some punctuation and the letters \fIabdeilmnorst\fR;
normal forms are used for other characters)
.IP "\fIInf\fR" 8
.IX Item "Inf"
inferior characters; usually only digits and some punctuation,
normal forms for other characters
.IP "\fIOrn\fR" 8
.IX Item "Orn"
ornaments
.IP "\fINumr\fR" 8
.IX Item "Numr"
numerators
.IP "\fIDnom\fR" 8
.IX Item "Dnom"
denominators
.PP
The generated fonts are named \fI<FontName>\-<suffix>\-<shape>\-<enc>\fR,
where \fI<suffix>\fR is the same as above (but in lowercase),
\&\fI<shape>\fR is either empty, \*(L"sc\*(R", \*(L"swash\*(R" or \*(L"titling\*(R",
and \fI<enc>\fR is the encoding.
A typical name in this scheme is \*(L"LinLibertineO\-osf\-sc\-ly1\*(R".
.SS "On the choice of text encoding"
.IX Subsection "On the choice of text encoding"
By default, \fBautoinst\fR generates text fonts with \s-1OT1, T1\s0 and \s-1LY1\s0
encodings, and the generated style files use \s-1LY1\s0 as the default text encoding.
\&\s-1LY1\s0 has been chosen over T1 because it has some empty slots to accomodate
the additional ligatures provided by many OpenType fonts.
Different encodings can be chosen using the \fI\-encoding\fR command-line option 
(see \*(L"COMMAND-LINE \s-1OPTIONS\*(R"\s0 below).
.SS "Using the fonts in your LaTeX documents"
.IX Subsection "Using the fonts in your LaTeX documents"
\&\fBautoinst\fR generates a style file for using the font in LaTeX documents,
named \fI<FontFamily>.sty\fR. This style file also takes care of loading the
\&\fIfontenc\fR and \fItextcomp\fR packages.
To use the font, simply put \f(CW\*(C`\eusepackage{\f(CI<FontFamily>\f(CW}\*(C'\fR
in the preamble of your document.
.PP
This style file defines a number of options:
.ie n .IP """lining"", ""oldstyle"", ""tabular"", ""proportional""" 4
.el .IP "\f(CWlining\fR, \f(CWoldstyle\fR, \f(CWtabular\fR, \f(CWproportional\fR" 4
.IX Item "lining, oldstyle, tabular, proportional"
Choose which figure style to use. 
The defaults are \*(L"oldstyle\*(R" and \*(L"proportional\*(R" (if available).
.ie n .IP """scale=\f(CI<number>\f(CW""" 4
.el .IP "\f(CWscale=\f(CI<number>\f(CW\fR" 4
.IX Item "scale=<number>"
Scale the font by a factor of \fI<number>\fR.
For example: to increase the size of the font by 5%, use 
\&\f(CW\*(C`\eusepackage[scale=1.05]{\f(CI<FontFamily>\f(CW}\*(C'\fR. 
May also be spelled \f(CW\*(C`scaled\*(C'\fR.
.Sp
This option is only available when you have the \fIxkeyval\fR package installed.
.ie n .IP """ultrablack"", ""ultrabold"", ""heavy"", ""extrablack"", ""black"", ""extrabold"", ""demibold"", ""semibold"", ""bold""" 4
.el .IP "\f(CWultrablack\fR, \f(CWultrabold\fR, \f(CWheavy\fR, \f(CWextrablack\fR, \f(CWblack\fR, \f(CWextrabold\fR, \f(CWdemibold\fR, \f(CWsemibold\fR, \f(CWbold\fR" 4
.IX Item "ultrablack, ultrabold, heavy, extrablack, black, extrabold, demibold, semibold, bold"
Choose the weight that LaTeX will use for the \*(L"bold\*(R" weight.
.ie n .IP """light"", ""medium"", ""regular""" 4
.el .IP "\f(CWlight\fR, \f(CWmedium\fR, \f(CWregular\fR" 4
.IX Item "light, medium, regular"
Choose the weight that LaTeX will use for the \*(L"regular\*(R" weight.
.PP
These last two groups of options will only work if
you have the \fImweights\fR package installed.
.PP
The style file will also try to load the \fIfontaxes\fR package 
(available on \s-1CTAN\s0),
which gives easy access to various font shapes and styles.
Using the machinery set up by \fIfontaxes\fR, the generated style file 
defines a number of commands (which take the text to be typeset as argument)
and declarations (which don't take arguments, but affect all text up to
the end of the current group) of its own:
.PP
.Vb 1
\&    DECLARATION     COMMAND         SHORT FORM OF COMMAND
\&
\&    \etlshape        \etexttitling    \etexttl
\&    \esufigures      \etextsuperior   \etextsu
\&    \einfigures      \etextinferior   \etextin
.Ve
.PP
In addition, the \f(CW\*(C`\eswshape\*(C'\fR and \f(CW\*(C`\etextsw\*(C'\fR commands are redefined to place
swash on the secondary shape axis (\fIfontaxes\fR places it on the primary
shape axis); this makes these commands behave properly when nested, so that
\&\f(CW\*(C`\eswshape\eupshape\*(C'\fR will give upright swash.
.PP
There are no commands for accessing the numerator and denominator
fonts; these can be selected using \fIfontaxes\fR' standard commands,
e.g., \f(CW\*(C`\efontfigurestyle{numerator}\eselectfont\*(C'\fR.
.PP
The style file also provides a command \f(CW\*(C`\eornament{\f(CI<number>\f(CW}\*(C'\fR,
where \f(CW\*(C`\f(CI<number>\f(CW\*(C'\fR is a number from 0 to the total number of
ornaments minus one. Ornaments are always typeset using the current family,
series and shape. A list of all ornaments in a font can be created by
running LaTeX on the file \fInfssfont.tex\fR (part of a standard
LaTeX installation) and supplying the name of the ornament font.
.PP
To access the ornaments, \fBautoinst\fR creates a font-specific encoding file
\&\fI<FontFamily>_orn.enc\fR, 
but only if that file doesn't yet exist in the current directory.
This is a deliberate feature that allows you to provide your own
encoding vector, e.g. if your fonts use non-standard glyph names for ornaments.
.PP
These commands are only generated for existing shapes and number styles;
no commands are generated for shapes and styles that don't exist, 
or whose generation has been turned off using command-line options.
Also: these commands are built on top of \fIfontaxes\fR;
if that package cannot be found, you're limited to using the
lower-level commands from standard \s-1NFSS \s0(\f(CW\*(C`\efontfamily\*(C'\fR, \f(CW\*(C`\efontseries\*(C'\fR,
\&\f(CW\*(C`\efontshape\*(C'\fR etc.).
.SS "Using multiple font families in one document"
.IX Subsection "Using multiple font families in one document"
Style files generated by versions of \fBautoinst\fR older dan 2013\-07\-25
redefined \f(CW\*(C`\emddefault\*(C'\fR and \f(CW\*(C`\ebfdefault\*(C'\fR, whereas newer style files 
use the \fImweights\fR package instead. 
If you use multiple \fBautoinst\fR\-generated font familes in the same document, 
it is best if all style files are generated by the same version of 
\&\fBautoinst\fR; re-generate the older families if necessary.
.SS "\s-1NFSS\s0 codes"
.IX Subsection "NFSS codes"
\&\s-1NFSS\s0 identifies fonts by a combination of family, series (weight plus width),
shape and size.
\&\fBautoinst\fR parses the output of \f(CW\*(C`otfinfo \-\-info\*(C'\fR to determine
these parameters. When this fails
(e.g., because the font family contains uncommon widths or weights),
\&\fBautoinst\fR ends up with different fonts having the \fIsame\fR values
for these font parameters, which means that these fonts cannot be used in \s-1NFSS.\s0
In that case, \fBautoinst\fR will split the font family into multiple subfamilies
(based on each font file's \*(L"Subfamily\*(R" value) and try again.
(Since many font vendors misunderstand the \*(L"Subfamily\*(R" concept
and make each font file its own separate subfamily,
this strategy is only used as a last resort.)
.PP
If such a proliferation of font families is unwanted,
either run \fBautoinst\fR on a smaller set of fonts or 
add the missing widths, weights and shapes to the tables \f(CW%FD_WIDTH\fR,
\&\f(CW%FD_WEIGHT\fR and \f(CW%FD_SHAPE\fR, at the top of the source code.
Please also send a bug report (see \s-1AUTHOR\s0 below).
.PP
\&\fBautoinst\fR maps widths, weights and shapes to \s-1NFSS\s0 codes using
the following tables. These are based as much as possible
on the standard \fIFontname\fR scheme and Philipp Lehman's 
\&\fIFont Installation Guide\fR, 
but some changes were made to avoid name clashes in font families 
with many widths and weights.
.PP
.Vb 1
\&    WEIGHT                              WIDTH
\&
\&    Thin           t                    Ultra Compressed    up
\&    Ultra Light    ul                   Extra Compressed    ep
\&    Extra Light    el                   Compressed          p
\&    Light          l                    Compact             p
\&    Book                 [1]            Ultra Condensed     uc
\&    Regular              [1]            Extra Condensed     ec
\&    Medium         mb                   Condensed           c
\&    Demibold       db                   Narrow              n
\&    Semibold       sb                   Semicondensed       sc
\&    Bold           b                    Regular                 [1]
\&    Extra Bold     eb                   Semiextended        sx
\&    Ultra          ub                   Extended            x
\&    Ultra Bold     ub                   Expanded            e
\&    Black          k                    Wide                w
\&    Extra Black    ek
\&    Ultra Black    uk
\&    Heavy          h                    SHAPE
\&    Poster         r
\&                                        Roman, Upright      n   [2]
\&                                        Italic              it
\&                                        Cursive, Kursiv     it
\&                                        Oblique, Slanted    it  [3]
\&                                        Incline(d)          it  [3]
.Ve
.PP
\fINotes:\fR
.IX Subsection "Notes:"
.IP "[1]" 4
.IX Item "[1]"
When \fIboth\fR weight and width are empty, the \*(L"series\*(R" attribute becomes \*(L"m\*(R".
.IP "[2]" 4
.IX Item "[2]"
Adobe Silentium Pro contains two \*(L"Roman\*(R" shapes (\*(L"RomanI\*(R" and \*(L"RomanII\*(R");
the first of these is mapped to \*(L"n\*(R", the second one to \*(L"it\*(R".
.IP "[3]" 4
.IX Item "[3]"
Mapping the \*(L"Slanted\*(R", \*(L"Oblique\*(R" or \*(L"Inclined\*(R" shape to \*(L"it\*(R" instead of \*(L"sl\*(R"
simplifies \fBautoinst\fR. Since font families with both italic and slanted
shapes do \- to the best of my knowledge \- not exist
(apart from Computer Modern), this shouldn't cause problems.
.SS "A note for MiKTeX users"
.IX Subsection "A note for MiKTeX users"
Automatically installing the fonts into a suitable \s-1TEXMF\s0 tree
(as \fBautoinst\fR does by default) requires a TeX-installation that uses
the \fIkpathsea\fR library; with TeX distributions that implement their
own directory searching (such as MiKTeX), \fBautoinst\fR will complain that
it cannot find the \fIkpsewhich\fR program and install all generated files
into subdirectories of the current directory.
If you use such a TeX distribution, you should either move these files
to their correct destinations by hand, or use the \fI\-target\fR option
(see \*(L"COMMAND-LINE \s-1OPTIONS\*(R"\s0 below) to specify a \s-1TEXMF\s0 tree.
.PP
Also, some OpenType fonts lead to \fIpl\fR and \fIvpl\fR files that
are too big for MiKTeX's \fIpltotf\fR and \fIvptovf\fR;
the versions that come with W32TeX (\fIhttp://www.w32tex.org\fR)
and TeXLive (\fIhttp://tug.org/texlive\fR) don't have this problem.
.SH "COMMAND-LINE OPTIONS"
.IX Header "COMMAND-LINE OPTIONS"
\&\fBautoinst\fR tries hard to do The Right Thing (\s-1TM\s0) by default, 
so in many cases you won't need these options;
but many aspects of its operation can be changed if you want to.
.PP
You may use either one or two dashes before options,
and option names may be shortened to a unique prefix
(e.g., \fB\-encoding\fR may be abbreviated to \fB\-enc\fR or even \fB\-en\fR,
but \fB\-e\fR is ambiguous (\fB\-encoding\fR, \fB\-extra\fR).
.IP "\fB\-encoding\fR=\fIencoding[,encoding]\fR" 4
.IX Item "-encoding=encoding[,encoding]"
Generate the specified encoding(s) for the text fonts. The default is \*(L"\s-1OT1,T1,LY1\*(R".\s0
For each encoding, a file \fI<encoding>.enc\fR (\fIlowercase\fR)
should be somewhere where \fIotftotfm\fR can find it. Suitable encoding files
for \s-1OT1, T1/TS1\s0 and \s-1LY1\s0 come with \fBautoinst\fR. (These files are
called \fIfontools_ot1.enc\fR etc. to avoid name clashes with other packages;
the \*(L"fontools_\*(R" prefix may be omitted.)
.Sp
Multiple text encodings can be specified as a comma-separated list:
\&\f(CW\*(C`\-encoding=OT1,T1\*(C'\fR. The encodings are passed to \fIfontenc\fR in the order
specified, so the last one will be the default text encoding.
.IP "\fB\-ts1\fR / \fB\-nots1\fR" 4
.IX Item "-ts1 / -nots1"
Control the creation of TS1\-encoded fonts. The default is \fB\-ts1\fR
if the text encodings (see \fI\-encoding\fR above) include T1,
\&\fB\-nots1\fR otherwise.
.IP "\fB\-sanserif\fR" 4
.IX Item "-sanserif"
Install the font as a sanserif font, accessed via \f(CW\*(C`\esffamily\*(C'\fR and \f(CW\*(C`\etextsf\*(C'\fR.
The generated style file redefines \f(CW\*(C`\efamilydefault\*(C'\fR,
so including it will still make this font the default text font.
.IP "\fB\-typewriter\fR" 4
.IX Item "-typewriter"
Install the font as a typewriter font, accessed via \f(CW\*(C`\ettfamily\*(C'\fR and
\&\f(CW\*(C`\etexttt\*(C'\fR.
The generated style file redefines \f(CW\*(C`\efamilydefault\*(C'\fR,
so including it will still make this font the default text font.
.IP "\fB\-lining\fR / \fB\-oldstyle\fR" 4
.IX Item "-lining / -oldstyle"
.PD 0
.IP "\fB\-tabular\fR / \fB\-proportional\fR" 4
.IX Item "-tabular / -proportional"
.PD
Tell \fBautoinst\fR which figure style is the current font family's default
(i.e., which figures you get when you don't specify anything).
\&\fIThis is only needed for font families that don't provide OpenType
features for the default figure style!\fR 
Even in that case, the default values (\fB\-lining\fR and \fB\-tabular\fR) are usually
correct.
.IP "\fB\-smallcaps\fR / \fB\-nosmallcaps\fR" 4
.IX Item "-smallcaps / -nosmallcaps"
Control the creation of small caps fonts. The default is
\&\fB\-smallcaps\fR.
.IP "\fB\-swash\fR / \fB\-noswash\fR" 4
.IX Item "-swash / -noswash"
Control the creation of swash fonts. The default is \fB\-swash\fR.
.IP "\fB\-titling\fR / \fB\-notitling\fR" 4
.IX Item "-titling / -notitling"
Control the creation of titling fonts. The default is \fB\-titling\fR.
.IP "\fB\-superiors\fR / \fB\-nosuperiors\fR" 4
.IX Item "-superiors / -nosuperiors"
Control the creation of fonts with superior characters.
The default is \fB\-superiors\fR.
.IP "\fB\-inferiors\fR / \fB\-noinferiors\fR" 4
.IX Item "-inferiors / -noinferiors"
Control the creation of fonts with inferior digits.
The default is \fB\-noinferiors\fR.
.IP "\fB\-fractions\fR / \fB\-nofractions\fR" 4
.IX Item "-fractions / -nofractions"
Control the creation of fonts with numerators and denominators.
The default is \fB\-nofractions\fR.
.IP "\fB\-ornaments\fR / \fB\-noornaments\fR" 4
.IX Item "-ornaments / -noornaments"
Control the creation of ornament fonts. The default is \fB\-ornaments\fR.
.IP "\fB\-verbose\fR" 4
.IX Item "-verbose"
Verbose mode; print detailed info about what \fBautoinst\fR thinks it's doing.
.IP "\fB\-figurekern\fR / \fB\-nofigurekern\fR" 4
.IX Item "-figurekern / -nofigurekern"
Some fonts provide kerning pairs for tabular figures.
This is very probably not what you want 
(e.g., numbers in tables won't line up exactly).
The option \fB\-nofigurekern\fR adds extra \fI \-\-ligkern\fR options
to the commands for \fIotftotfm\fR to suppress such kerns
(but of course only for the families with tabular figures).
Since this leads to very long commands (one hundred such options in total!)
and the problem only occurs in very few fonts, 
the default is \fB\-figurekern\fR.
.IP "\fB\-extra\fR=\fItext\fR" 4
.IX Item "-extra=text"
Add \fItext\fR to the command line to \fIotftotfm\fR. To prevent \fItext\fR from 
accidentily being interpreted as options to \fBautoinst\fR, it should be 
properly quoted.
.IP "\fB\-manual\fR" 4
.IX Item "-manual"
Manual mode. By default, \fBautoinst\fR executes all \fIotftotfm\fR
commands it generates; with the \fB\-manual\fR option, these commands are
instead written to a file \fIautoinst.bat\fR.
Also, the generated \fIotftotfm\fR commands specify the \fI \-\-pl\fR option
(which tells \fIotftotfm\fR to generate human readable/editable \fIpl\fR 
and \fIvpl\fR files instead of the default \fItfm\fR and \fIvf\fR files)
and omit the \fI \-\-automatic\fR option (which causes \fIotftotfm\fR to
leave all generated files in the current directory, rather than install
them into your \s-1TEXMF\s0 tree).
.Sp
When using this option, you should run \fIpltotf\fR and \fIvptovf\fR after
executing all commands,
to convert the \fIpl\fR and \fIvf\fR files to \fItfm\fR and \fIvf\fR format.
.PP
The following options are only meaningful in automatic mode,
and hence ignored in manual mode:
.IP "\fB\-target\fR=\fI\s-1DIRECTORY\s0\fR" 4
.IX Item "-target=DIRECTORY"
Install all generated files into the \s-1TEXMF\s0 tree at \fI\s-1DIRECTORY\s0\fR.
.Sp
By default, \fBautoinst\fR searches your \f(CW$TEXMFLOCAL\fR and \f(CW$TEXMFHOME\fR paths
and installs all files into subdirectories of the first writable \s-1TEXMF\s0 tree
it finds (or into subdirectories of the current directory,
if no writable directory is found).
.IP "\fB\-vendor\fR=\fI\s-1VENDOR\s0\fR" 4
.IX Item "-vendor=VENDOR"
.PD 0
.IP "\fB\-typeface\fR=\fI\s-1TYPEFACE\s0\fR" 4
.IX Item "-typeface=TYPEFACE"
.PD
These options are equivalent to \fIotftotfm\fR's \fI \-\-vendor\fR and \fI \-\-typeface\fR
options: they change the \*(L"vendor\*(R" and \*(L"typeface\*(R" parts of the names of the
subdirectories in the \s-1TEXMF\s0 tree where generated files will be stored.
The default values are \*(L"lcdftools\*(R" and the font's FontFamily name.
.Sp
Note that these options change \fIonly\fR directory names,
not the names of any generated files.
.IP "\fB\-updmap\fR / \fB\-noupdmap\fR" 4
.IX Item "-updmap / -noupdmap"
Control whether or not \fIupdmap\fR is called after the last call to \fIotftotfm\fR.
The default is \fB\-updmap\fR.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Eddie Kohler's \fBTypeTools\fR (\fIhttp://www.lcdf.org/type\fR).
.PP
\&\fBPerl\fR can be downloaded from \fIhttp://www.perl.org\fR; it is 
pre-installed on many Linux distributions.
For Windows, try ActivePerl (\fIhttp://www.activestate.com\fR)
or Strawberry Perl (\fIhttp://strawberryperl.com\fR).
.PP
The \fBFontPro\fR project (\fIhttps://github.com/sebschub/FontPro\fR)
offers very complete LaTeX support for Adobe's Minion Pro and Myriad Pro
(including math), and is currently working on Cronos Pro as well.
.PP
\&\fBXeTeX\fR (\fIhttp://www.tug.org/xetex\fR) and \fBLuaTeX\fR (\fIhttp://www.luatex.org\fR)
are TeX engines that can use fonts in many formats 
(including both flavours of OpenType) without TeX-specific support files.
.PP
John Owens' \fBotfinst\fR (available from \s-1CTAN\s0) is another wrapper
around \fIotftotfm\fR.
.SH "AUTHOR"
.IX Header "AUTHOR"
Marc Penninga <marcpenninga@gmail.com>
.PP
When sending a bug report, please give as much relevant information as
possible; this includes at least (but may not be limited to) the output
from running \fBautoinst\fR with the \fI\-verbose\fR option.
Please include all (if any) error messages as well.
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (C) 2005\-2013 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 \s-1GNU\s0 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 text of the \s-1GNU\s0 General Public License is included in 
the \fIfontools\fR distribution; see the file \fIGPLv2.txt\fR.
.SH "DISCLAIMER"
.IX Header "DISCLAIMER"
This program is distributed in the hope that it will be useful,
but \s-1WITHOUT ANY WARRANTY\s0; without even the implied warranty of
\&\s-1MERCHANTABILITY\s0 or \s-1FITNESS FOR A PARTICULAR PURPOSE.\s0 See the
\&\s-1GNU\s0 General Public License for more details.
.SH "RECENT CHANGES"
.IX Header "RECENT CHANGES"
(See the source code for the rest of the story.)
.IP "\fI2013\-10\-01\fR" 12
.IX Item "2013-10-01"
Added the \fI\-lining\fR, \fI\-oldstyle\fR, \fI\-tabular\fR and \fI\-proportional\fR
command line options.
.IP "\fI2013\-07\-25\fR" 12
.IX Item "2013-07-25"
The generated \fIsty\fR files now use the \fImweights\fR package instead of
redefining \f(CW\*(C`\emddefault\*(C'\fR and \f(CW\*(C`\ebfdefault\*(C'\fR. 
Added \f(CW\*(C`scale\*(C'\fR as an alias for the package option \f(CW\*(C`scaled\*(C'\fR.
.IP "\fI2013\-02\-06\fR" 12
.IX Item "2013-02-06"
Bugfix: the directory names for map and encoding files contained 
the \*(L"vendor\*(R" instead of the \*(L"typeface\*(R".
.IP "\fI2013\-01\-03\fR" 12
.IX Item "2013-01-03"
Added extra \*(L"ssub\*(R" rules to the \fIfd\fR files that substitute \*(L"b\*(R" for \*(L"bx\*(R".
Verbose mode now also prints all generated commands before they're executed.
.IP "\fI2012\-10\-25\fR" 12
.IX Item "2012-10-25"
Added extra \*(L"ssub\*(R" rules to the \fIfd\fR files that substitute italic
shapes for slanted ones.
.IP "\fI2012\-09\-25\fR" 12
.IX Item "2012-09-25"
Added the \fI\-vendor\fR, \fI\-typeface\fR and \fI\-(no)updmap\fR command line options.
.IP "\fI2012\-07\-06\fR" 12
.IX Item "2012-07-06"
Documentation update.
.IP "\fI2012\-03\-06\fR" 12
.IX Item "2012-03-06"
Implemented the \*(L"splitting the font family into multiple subfamilies\*(R"
emergency strategy when font info parsing fails.
Added recognition for a number of unusual widths, weights and shapes.
.IP "\fI2012\-02\-29\fR" 12
.IX Item "2012-02-29"
Fixed a bug in the font parsing code,
where possible widths, weights and shapes where tested in the wrong order;
this led to \*(L"ExtraLight\*(R" fonts being recognised as \*(L"Light\*(R".
Added recognition for \*(L"Narrow\*(R" and \*(L"Wide\*(R" widths.
Also added the \fI\-(no)figurekern\fR command-line option.
.IP "\fI2012\-02\-01\fR" 12
.IX Item "2012-02-01"
Reorganised the code, and fixed some bugs in the process.
Added the \fI\-target\fR command-line option.
Made \fBautoinst\fR install the \fIfd\fR and \fIsty\fR files in
the same \s-1TEXMF\s0 tree as the other generated files.
Generate \s-1OT1, T1\s0 and \s-1LY1\s0 encoded text fonts by default.
Made \fI\-titling\fR a default option (instead of \fI\-notitling\fR).
Updated the documentation.