summaryrefslogtreecommitdiff
path: root/macros/luatex/generic/luaotfload/README.md
blob: c325c4171e66ea29f56527616baf06865dc876e4 (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
# The Luaotfload Package

VERSION: 3.23

DATE: 2022-10-03


## Description

Luaotfload is an adaptation of the ConTeXt font loading system for the Plain
and LaTeX formats. It allows OpenType fonts to be loaded with font features
accessible using an extended font request syntax while providing compatibility
with XeTeX. By indexing metadata in a database it facilitates loading fonts by
their proper names instead of file names.

Luaotfload may be loaded in Plain LuaTeX with "\input luaotfload.sty" and in
LuaLaTeX with "\usepackage{luaotfload}". LuaLaTeX users may be interested in
the fontspec package which provides a high-level interface to the functionality
provided by this package.

Please see the documentation luaotfload.pdf for more information.

## Maintenance

This package is currently maintained at 
<https://github.com/latex3/luaotfload>. 
 
Issues can be reported at the issue tracker.

The development for LuaLaTeX is discussed on the lualatex-dev mailing list. See
<http://www.tug.org/mailman/listinfo/lualatex-dev> for details.


## Responsible Persons

The following people have contributed to this package.

- Khaled Hosny             <khaledhosny@eglug.org>
- Elie Roux                <elie.roux@telecom-bretagne.eu>
- Will Robertson           <will.robertson@latex-project.org>
- Philipp Gesang           <phg@phi-gamma.net>
- Dohyun Kim               <nomosnomos@gmail.com>
- Reuben Thomas            <https://github.com/rrthomas>
- Joseph Wright            <joseph.wright@morningstar2.co.uk>
- Manuel Pégourié-Gonnard  <mpg@elzevir.fr>
- Olof-Joachim Frahm       <olof@macrolet.net>
- Patrick Gundlach         <gundlach@speedata.de>
- Philipp Stephani         <st_philipp@yahoo.de>
- David Carlisle           <d.p.carlisle@gmail.com>
- Yan Zhou                 @zhouyan
- Ulrike Fischer           <fischer@troubleshooting-tex.de>
- Marcel Krüger            <https://github.com/zauguin> 

## Installation

1.  Install the current version with the package management tools of your TeX system.
    If you want to install manually: there is a tds-zip file which can be unpacked in a texmf tree. 

2.  If you want to try the development version download the texmf folder in the development branch. 
    at <https://github.com/latex3/luaotfload>
    
3.  Manual installation:
    * luaotfload-tool.lua belongs in scripts/luatex/luaotfload
    * fontloader-reference-load-order.tex and fontloader-reference-load-order.lua are source files and can got in source or doc
    * the other lua-files and the sty belong in tex/luatex/luaotfload
    * luaotfload.conf.5 and luaotfload-tool.1 belong in doc/man
    * the rest in doc/luatex/luaotfload  
    
## Documentation

* The main documentation is luaotfload-latex.pdf. 
* luaotfload.conf.5 and luaotfload-tool.1 are man-files, their sources are the rst-files. 
* README.md, NEWS and COPYING contain what their name says.
* The rest are input files. 


    

## License

The luaotfload bundle, as a derived work of ConTeXt, is distributed under the
GNU GPLv2 license:

   <http://www.gnu.org/licenses/old-licenses/gpl-2.0.html>

This license requires the license itself to be distributed with the work. For
its full text see the documentation in luaotfload.pdf.


##  DISCLAIMER

        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; version 2.

        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.

        See headers of each source file for copyright details.