Debian Codegraph @

texmf-dist/doc/luatex/luaotfload/README.md

raw
1 # The Luaotfload Package
2
3 VERSION: 3.29
4
5 DATE: 2024-12-03
6
7
8 ## Description
9
10 Luaotfload is an adaptation of the ConTeXt font loading system for the Plain
11 and LaTeX formats. It allows OpenType fonts to be loaded with font features
12 accessible using an extended font request syntax while providing compatibility
13 with XeTeX. By indexing metadata in a database it facilitates loading fonts by
14 their proper names instead of file names.
15
16 Luaotfload may be loaded in Plain LuaTeX with "\input luaotfload.sty" and in
17 LuaLaTeX with "\usepackage{luaotfload}". LuaLaTeX users may be interested in
18 the fontspec package which provides a high-level interface to the functionality
19 provided by this package.
20
21 Please see the documentation luaotfload.pdf for more information.
22
23 ## Maintenance
24
25 This package is currently maintained at
26 <https://github.com/latex3/luaotfload>.
27
28 Issues can be reported at the issue tracker.
29
30 The development for LuaLaTeX is discussed on the lualatex-dev mailing list. See
31 <http://www.tug.org/mailman/listinfo/lualatex-dev> for details.
32
33
34 ## Responsible Persons
35
36 The following people have contributed to this package.
37
38 - Khaled Hosny <[email protected]>
39 - Elie Roux <[email protected]>
40 - Will Robertson <[email protected]>
41 - Philipp Gesang <[email protected]>
42 - Dohyun Kim <[email protected]>
43 - Reuben Thomas <https://github.com/rrthomas>
44 - Joseph Wright <[email protected]>
45 - Manuel Pégourié-Gonnard <[email protected]>
46 - Olof-Joachim Frahm <[email protected]>
47 - Patrick Gundlach <[email protected]>
48 - Philipp Stephani <[email protected]>
49 - David Carlisle <[email protected]>
50 - Yan Zhou @zhouyan
51 - Ulrike Fischer <[email protected]>
52 - Marcel Krüger <https://github.com/zauguin>
53
54 ## Installation
55
56 1. Install the current version with the package management tools of your TeX system.
57 If you want to install manually: there is a tds-zip file which can be unpacked in a texmf tree.
58
59 2. If you want to try the development version download the texmf folder in the development branch.
60 at <https://github.com/latex3/luaotfload>
61
62 3. Manual installation:
63 * luaotfload-tool.lua belongs in scripts/luatex/luaotfload
64 * fontloader-reference-load-order.tex and fontloader-reference-load-order.lua are source files and can got in source or doc
65 * the other lua-files and the sty belong in tex/luatex/luaotfload
66 * luaotfload.conf.5 and luaotfload-tool.1 belong in doc/man
67 * the rest in doc/luatex/luaotfload
68
69 ## Documentation
70
71 * The main documentation is luaotfload-latex.pdf.
72 * luaotfload.conf.5 and luaotfload-tool.1 are man-files, their sources are the rst-files.
73 * README.md, NEWS and COPYING contain what their name says.
74 * The rest are input files.
75
76
77
78
79 ## License
80
81 The luaotfload bundle, as a derived work of ConTeXt, is distributed under the
82 GNU GPLv2 license:
83
84 <http://www.gnu.org/licenses/old-licenses/gpl-2.0.html>
85
86 This license requires the license itself to be distributed with the work. For
87 its full text see the documentation in luaotfload.pdf.
88
89
90 ## DISCLAIMER
91
92 This program is free software; you can redistribute it and/or
93 modify it under the terms of the GNU General Public License
94 as published by the Free Software Foundation; version 2.
95
96 This program is distributed in the hope that it will be useful,
97 but WITHOUT ANY WARRANTY; without even the implied warranty of
98 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
99 GNU General Public License for more details.
100
101 See headers of each source file for copyright details.
102