diff options
author | Karl Berry <karl@freefriends.org> | 2014-07-15 22:56:45 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2014-07-15 22:56:45 +0000 |
commit | 6caf348b43edcfc1dce127bf0895a5fb9bd77f2d (patch) | |
tree | 7b4b79f90596e69716ad87e3293743756b2a1954 /Master/texmf-dist/doc | |
parent | d71cd04a4c07d1cdaf85a7b7c2398022cc39beab (diff) |
luaotfload (15jul14)
git-svn-id: svn://tug.org/texlive/trunk@34622 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc')
-rw-r--r-- | Master/texmf-dist/doc/luatex/luaotfload/COPYING | 350 | ||||
-rw-r--r-- | Master/texmf-dist/doc/luatex/luaotfload/NEWS | 29 | ||||
-rw-r--r-- | Master/texmf-dist/doc/luatex/luaotfload/README | 1 | ||||
-rw-r--r-- | Master/texmf-dist/doc/luatex/luaotfload/filegraph.pdf | bin | 45545 -> 45642 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/luatex/luaotfload/luaotfload.conf.example | 30 | ||||
-rw-r--r-- | Master/texmf-dist/doc/luatex/luaotfload/luaotfload.pdf | bin | 222144 -> 170441 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/luatex/luaotfload/valgrind-kpse-suppression.sup | 140 | ||||
-rw-r--r-- | Master/texmf-dist/doc/man/man1/luaotfload-tool.1 | 122 | ||||
-rw-r--r-- | Master/texmf-dist/doc/man/man1/luaotfload-tool.man1.pdf | bin | 15440 -> 18400 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/man/man5/luaotfload.conf.5 | 545 |
10 files changed, 1183 insertions, 34 deletions
diff --git a/Master/texmf-dist/doc/luatex/luaotfload/COPYING b/Master/texmf-dist/doc/luatex/luaotfload/COPYING new file mode 100644 index 00000000000..d769b3faa1a --- /dev/null +++ b/Master/texmf-dist/doc/luatex/luaotfload/COPYING @@ -0,0 +1,350 @@ +Context, where the fontloader Luaotfload is built around originates, is +licensed under the GPL version 2.0 (exactly). As a derived work, anything +Luaotflaod adds to that is also subject to the same license at the same +version. The “any later version” clause as used by the FSF in the license text +*does not apply* to either Context or Luaotfload, despite being kept around in +the license text given below. + +------------------------------------------------------------------------------- + LICENSE TEXT BELOW +------------------------------------------------------------------------------- + + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Lesser General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + <one line to give the program's name and a brief idea of what it does.> + Copyright (C) <year> <name of author> + + 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; either version 2 of the License, or + (at your option) any later version. + + 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. + + You should have received a copy of the GNU General Public License along + with this program; if not, write to the Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + <signature of Ty Coon>, 1 April 1989 + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. diff --git a/Master/texmf-dist/doc/luatex/luaotfload/NEWS b/Master/texmf-dist/doc/luatex/luaotfload/NEWS index a87417fa268..c460f620675 100644 --- a/Master/texmf-dist/doc/luatex/luaotfload/NEWS +++ b/Master/texmf-dist/doc/luatex/luaotfload/NEWS @@ -1,14 +1,27 @@ Change History -------------- -2014/05/18, luaotfload v2.4-4 - * Fix incorrect handling of font file formats (backport of commit - 828a69ef... to the 2.5 branch). - -2014/02/05, luaotfload v2.4-3 - * Add contact info to --version output of luaotfload-tool (backport from - 2.5). - * Fix bug with broken font names (backport from 2.5). +2014/07/13, luaotfload v2.5 + * Remove legacy code. + * Remove compatibility with the old mkluatexfontdb script. + * Remove test directory. Use https://bitbucket.org/phg/lua-la-tex-tests + instead. + * Remove luaotfload.lua from luaotfload.dtx; it is now a separate file + luaotfload-main.lua. + * Standard source tree structure: the code is now located in the ./doc, + ./scripts, ./src, ./build, and ./misc directories. + * Move the heavier LPEG parsers from luaotfload-features (syntax) and + luaotfload-database (fontconfig) into the new file + luaotfload-parsers.lua. + * Move logging routines from luaotfload-override in to luaotfload-log. + * Scan local font files (``--local`` flag to luaotfload-tool, flag + ``scan_local`` during TeX run). + * Add bisection mode (``--bisect``) to luaotfload-tool. + * Add functions for accessing the database: ``aux.font_index()`` and + ``aux.read_font_index()``. + * Distinguish XDG configuration paths (Reuben Thomas) + * Optional configuration via rc files. + * Configure default features via configuration file. 2013/12/31, luaotfload v2.4 * Additional self-tests, now in separate file (luaotfload-diagnostics.lua) diff --git a/Master/texmf-dist/doc/luatex/luaotfload/README b/Master/texmf-dist/doc/luatex/luaotfload/README index 903551f70c3..75575d2ddc6 100644 --- a/Master/texmf-dist/doc/luatex/luaotfload/README +++ b/Master/texmf-dist/doc/luatex/luaotfload/README @@ -32,6 +32,7 @@ Elie Roux <elie.roux@telecom-bretagne.eu> Will Robertson <will.robertson@latex-project.org> Philipp Gesang <philipp.gesang@alumni.uni-heidelberg.de> Dohyun Kim <nomosnomos@gmail.com> +Reuben Thomas <https://github.com/rrthomas> Installation diff --git a/Master/texmf-dist/doc/luatex/luaotfload/filegraph.pdf b/Master/texmf-dist/doc/luatex/luaotfload/filegraph.pdf Binary files differindex bd2d0a6039b..50d4160abf2 100644 --- a/Master/texmf-dist/doc/luatex/luaotfload/filegraph.pdf +++ b/Master/texmf-dist/doc/luatex/luaotfload/filegraph.pdf diff --git a/Master/texmf-dist/doc/luatex/luaotfload/luaotfload.conf.example b/Master/texmf-dist/doc/luatex/luaotfload/luaotfload.conf.example new file mode 100644 index 00000000000..2756d62126a --- /dev/null +++ b/Master/texmf-dist/doc/luatex/luaotfload/luaotfload.conf.example @@ -0,0 +1,30 @@ +;; Example configuration file for Luaotfload. This file contains the +;; defaults only, see luaotfload.conf(5) for more information. + +[db] + compress = true + formats = otf, ttf, ttc, dfont + max-fonts = 2.2517998136852e15 + scan-local = false + skip-read = false + strip = true + update-live = true + +[misc] + statistics = false + termwidth = nil + +[paths] + cache-dir = fonts + names-dir = names + index-file = luaotfload-names.lua + lookups-file = luaotfload-lookup-cache.lua + +[run] + color-callback = pre_linebreak_filter + definer = patch + log-level = 0 + resolver = cached + +;; vim:ft=dosini:et:sw=4:ts=8 + diff --git a/Master/texmf-dist/doc/luatex/luaotfload/luaotfload.pdf b/Master/texmf-dist/doc/luatex/luaotfload/luaotfload.pdf Binary files differindex 4e5f71ebe60..6572c7b121f 100644 --- a/Master/texmf-dist/doc/luatex/luaotfload/luaotfload.pdf +++ b/Master/texmf-dist/doc/luatex/luaotfload/luaotfload.pdf diff --git a/Master/texmf-dist/doc/luatex/luaotfload/valgrind-kpse-suppression.sup b/Master/texmf-dist/doc/luatex/luaotfload/valgrind-kpse-suppression.sup new file mode 100644 index 00000000000..dc325869fa1 --- /dev/null +++ b/Master/texmf-dist/doc/luatex/luaotfload/valgrind-kpse-suppression.sup @@ -0,0 +1,140 @@ +{ + kpathsea-garbage-1 + Memcheck:Leak + match-leak-kinds: all + ... + fun:kpathsea_cnf_get +} + +{ + kpathsea-garbage-2 + Memcheck:Leak + match-leak-kinds: all + ... + fun:kpse_program_basename +} + + +{ + kpathsea-garbage-3 + Memcheck:Leak + match-leak-kinds: all + ... + fun:kpse_find_file +} + + +{ + kpathsea-garbage-4 + Memcheck:Leak + match-leak-kinds: all + ... + fun:find_file +} + +{ + kpathsea-garbage-5 + Memcheck:Leak + match-leak-kinds: all + ... + fun:lua_kpse_lookup +} + +{ + kpathsea-garbage-6 + Memcheck:Leak + match-leak-kinds: all + ... + fun:find_file +} + + +{ + kpathsea-garbage-7 + Memcheck:Leak + match-leak-kinds: all + ... + fun:expand_path +} + +{ + kpathsea-garbage-8 + Memcheck:Leak + match-leak-kinds: all + ... + fun:do_lua_kpathsea_lookup +} + + +{ + kpathsea-garbage-9 + Memcheck:Leak + match-leak-kinds: all + ... + fun:kpathsea_find_file +} + + +{ + kpathsea-garbage-10 + Memcheck:Leak + match-leak-kinds: all + ... + fun:kpathsea_init_db +} + + +{ + kpathsea-garbage-11 + Memcheck:Leak + match-leak-kinds: all + ... + fun:kpathsea_find_file_generic +} + + +{ + kpathsea-garbage-12 + Memcheck:Leak + match-leak-kinds: all + ... + fun:expand_var +} + + +{ + kpathsea-garbage-13 + Memcheck:Leak + match-leak-kinds: all + ... + fun:init_path +} + + +{ + kpathsea-garbage-14 + Memcheck:Leak + match-leak-kinds: all + ... + fun:kpse_in_name_ok +} + + +{ + kpathsea-garbage-15 + Memcheck:Leak + match-leak-kinds: all + ... + fun:kpathsea_var_value +} + + +{ + kpathsea-garbage-16 + Memcheck:Leak + match-leak-kinds: all + ... + fun:kpse_set_program_name +} + + diff --git a/Master/texmf-dist/doc/man/man1/luaotfload-tool.1 b/Master/texmf-dist/doc/man/man1/luaotfload-tool.1 index d368e35f84a..dd8abe2999f 100644 --- a/Master/texmf-dist/doc/man/man1/luaotfload-tool.1 +++ b/Master/texmf-dist/doc/man/man1/luaotfload-tool.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH LUAOTFLOAD-TOOL 1 "2014-05-18" "2.4-4" "text processing" +.TH LUAOTFLOAD-TOOL 1 "2014-03-30" "2.5" "text processing" .SH NAME luaotfload-tool \- generate and query the Luaotfload font names database . @@ -32,13 +32,14 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .. .SH SYNOPSIS .sp -\fBluaotfload\-tool\fP [ \-bDfFiIlnpquvVhw ] +\fBluaotfload\-tool\fP [ \-bcDfFiIlLnpqRSuvVhw ] .INDENT 0.0 .TP .B \fBluaotfload\-tool\fP \-\-update [ \-\-force ] [ \-\-quiet ] [ \-\-verbose ] [ \-\-prefer\-texmf ] [ \-\-dry\-run ] [ \-\-formats=[+|\-]EXTENSIONS ] [ \-\-no\-compress ] [ \-\-no\-strip ] +[ \-\-local ] [ \-\-max\-fonts=N ] .TP .B \fBluaotfload\-tool\fP \-\-find=FONTNAME [ \-\-fuzzy ] [ \-\-info ] [ \-\-inspect ] [ \-\-no\-reload ] @@ -50,6 +51,8 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .sp \fBluaotfload\-tool\fP \-\-list=CRITERION[:VALUE] [ \-\-fields=F1,F2,...,Fn ] .sp +\fBluaotfload\-tool\fP \-\-bisect=DIRECTIVE +.sp \fBluaotfload\-tool\fP \-\-help .sp \fBluaotfload\-tool\fP \-\-version @@ -68,10 +71,6 @@ the \fILuaotfload\fP package. There are two general modes: \fBupdate\fP and .IP \(bu 2 \fBquery\fP: resolve a font name or display close matches. .UNINDENT -.sp -Note that if the script is named \fBmkluatexfontdb\fP it will behave like -earlier versions (<=1.3) and always update the database first. Also, -the verbosity level will be set to 2. .SH OPTIONS .SS update mode .INDENT 0.0 @@ -83,16 +82,19 @@ Update the database; indexes new fonts. Force rebuilding of the database; re\-indexes all fonts. .TP +.B \-\-local\fP,\fB \-L +Include font files in \fB$PWD\fP\&. This option +will cause large parts of the database to be +rebuilt. Thus it is quite inefficient. +Additionally, if local font files are found, +the database is prevented from being saved +to disk, so the local fonts need to be parsed +with every invocation of \fBluaotfload\-tool\fP\&. +.TP .B \-\-no\-reload\fP,\fB \-n Suppress auto\-updates to the database (e.g. when \fB\-\-find\fP is passed an unknown name). .TP -.B \-\-no\-strip -Do not strip redundant information after -building the database. Warning: this will -inflate the index to about two to three times -the normal size. -.TP .B \-\-no\-compress\fP,\fB \-c Do not filter the plain text version of the font index through gzip. Useful for debugging @@ -103,10 +105,6 @@ Organize the file name database in a way so that it prefer fonts in the \fITEXMF\fP tree over system fonts if they are installed in both. .TP -.BI \-\-max\-fonts\fB= N -Process at most \fIN\fP font files, including fonts -already indexed in the count. -.TP .BI \-\-formats\fB= EXTENSIONS Extensions of the font files to index. Where \fIEXTENSIONS\fP is a comma\-separated list of @@ -130,10 +128,6 @@ standard TeX Live installation this will grow the database considerably and slow down font indexing. .UNINDENT -.TP -.B \-\-dry\-run\fP,\fB \-D -Don’t load fonts, scan directories only. -(For debugging file system related issues.) .UNINDENT .SS query mode .INDENT 0.0 @@ -167,9 +161,6 @@ Print the warnings generated by the fontloader library (assumes \fB\-I\fP). Automatically enabled if the verbosity level exceeds 2. .TP -.B \-\-show\-blacklist\fP,\fB \-b -Show blacklisted files (not directories). -.TP .BI \-\-list\fB= CRITERION Show entries, where \fICRITERION\fP is one of the following: @@ -260,6 +251,84 @@ cache; \fBshow\fP \-> print stats. .UNINDENT .UNINDENT +.SS debugging methods +.INDENT 0.0 +.TP +.B \-\-show\-blacklist\fP,\fB \-b +Show blacklisted files (not directories). +.TP +.B \-\-dry\-run\fP,\fB \-D +Don’t load fonts when updating the database; +scan directories only. +(For debugging file system related issues.) +.TP +.B \-\-no\-strip +Do not strip redundant information after +building the database. Warning: this will +inflate the index to about two to three times +the normal size. +.TP +.BI \-\-max\-fonts\fB= N +Process at most \fIN\fP font files, including fonts +already indexed in the count. +.TP +.BI \-\-bisect\fB= DIRECTIVE +Bisection of the font database. +This mode is intended as assistance in +debugging the Luatex engine, especially when +tracking memleaks or buggy fonts. +.sp +\fIDIRECTIVE\fP can be one of the following: +.INDENT 7.0 +.IP 1. 3 +\fBrun\fP \-> Make \fBluaotfload\-tool\fP respect +the bisection progress when running. +Combined with \fB\-\-update\fP and possibly +\fB\-\-force\fP this will only process the files +from the start up until the pivot and ignore +the rest. +.IP 2. 3 +\fBstart\fP \-> Start bisection: create a +bisection state file and initialize the low, +high, and pivot indices. +.IP 3. 3 +\fBstop\fP \-> Terminate the current bisection +session by deleting the state file. +.IP 4. 3 +\fBgood\fP | \fBbad\fP \-> Mark the section +processed last as “good” or “bad”, +respectively. The next bisection step will +continue with the bad section. +.IP 5. 3 +\fBstatus\fP \-> Print status information about +the current bisection session. Hint: Use +with higher verbosity settings for more +output. +.UNINDENT +.sp +A bisection session is initiated by issuing the +\fBstart\fP directive. This sets the pivot to the +middle of the list of available font files. +Now run \fIluaotfload\-tool\fP with the \fB\-\-update\fP +flag set as well as \fB\-\-bisect=run\fP: only the +fonts up to the pivot will be considered. If +that task exhibited the issue you are tracking, +then tell Luaotfload using \fB\-\-bisect=bad\fP\&. +The next step of \fB\-\-bisect=run\fP will continue +bisection with the part of the files below the +pivot. +Likewise, issue \fB\-\-bisect=good\fP in order to +continue with the fonts above the pivot, +assuming the tested part of the list did not +trigger the bug. +.sp +Once the culprit font is tracked down, \fBgood\fP +or \fBbad\fP will have no effect anymore. \fBrun\fP +will always end up processing the single font +file that was left. +Use \fB\-\-bisect=stop\fP to clear the bisection +state. +.UNINDENT .SS miscellaneous .INDENT 0.0 .TP @@ -276,15 +345,16 @@ troubleshooting), where \fICHANNEL\fP can be .INDENT 7.0 .IP 1. 3 \fBstdout\fP \-> all output will be -dumped to the terminal; or +dumped to the terminal (default); or .IP 2. 3 \fBfile\fP \-> write to a file to the temporary directory (the name will be chosen -automatically (\fBexperimental!\fP). +automatically. .UNINDENT .TP .B \-\-version\fP,\fB \-V -Show version info of components and exit. +Show version numbers of components as well as +some basic information and exit. .TP .B \-\-help\fP,\fB \-h Show help message and exit. diff --git a/Master/texmf-dist/doc/man/man1/luaotfload-tool.man1.pdf b/Master/texmf-dist/doc/man/man1/luaotfload-tool.man1.pdf Binary files differindex ee830d8378d..39103c39cd8 100644 --- a/Master/texmf-dist/doc/man/man1/luaotfload-tool.man1.pdf +++ b/Master/texmf-dist/doc/man/man1/luaotfload-tool.man1.pdf diff --git a/Master/texmf-dist/doc/man/man5/luaotfload.conf.5 b/Master/texmf-dist/doc/man/man5/luaotfload.conf.5 new file mode 100644 index 00000000000..68d40eba01f --- /dev/null +++ b/Master/texmf-dist/doc/man/man5/luaotfload.conf.5 @@ -0,0 +1,545 @@ +.\" Man page generated from reStructuredText. +. +.TH LUAOTFLOAD.CONF 5 "2014-06-09" "2.5" "text processing" +.SH NAME +luaotfload.conf \- Luaotfload configuration file +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.SH SYNOPSIS +.INDENT 0.0 +.IP \(bu 2 +\fB\&./luaotfload{.conf,rc}\fP +.IP \(bu 2 +\fBXDG_CONFIG_HOME/luaotfload/luaotfload{.conf,rc}\fP +.IP \(bu 2 +\fB~/.luaotfloadrc\fP +.UNINDENT +.SH DESCRIPTION +.sp +The file \fBluaotfload.conf\fP contains configuration options for +\fILuaotfload\fP, a font loading and font management component for LuaTeX. +.SH EXAMPLE +.sp +A small Luaotfload configuration file with few customizations could +look as follows: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +[db] + formats = afm, pfa, pfb + compress = false + +[misc] + termwidth = 60 + +[run] + log\-level = 6 +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +This will make Luaotfload ignore all font files except for PostScript +formats. NB: With a default Tex Live install the PS fonts will take +much longer to index than OpenType or TrueType ones. Also, an +uncompressed index file will be dumped which is going to be much larger +due to the huge amount of PostScript fonts indexed. The terminal width +is truncated to 60 characters which influences the verbose output +during indexing. Finally, the verbosity is increased greatly: each font +file being processed will be printed to the stdout on a separate line, +along with lots of other information. +.sp +To observe the difference in behavior, save above snippet to +\fB\&./luaotfload.conf\fP and update the font index: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +luaotfload \-\-update \-\-force +.ft P +.fi +.UNINDENT +.UNINDENT +.SH SYNTAX +.sp +The configuration file syntax follows the common INI format. For a more +detailed description please refer to the section “CONFIGURATION FILE” +of \fBgit\-config\fP(1). A brief list of rules is given below: +.INDENT 0.0 +.INDENT 3.5 +.INDENT 0.0 +.IP \(bu 2 +Blank lines and lines starting with a semicolon (\fB;\fP) are ignored. +.IP \(bu 2 +A configuration file is partitioned into sections that are declared +by specifying the section title in brackets on a separate line: +.INDENT 2.0 +.INDENT 3.5 +.sp +.nf +.ft C +[some\-section] +\&... section content ... +.ft P +.fi +.UNINDENT +.UNINDENT +.IP \(bu 2 +Sections consist of one or more variable assignments of the form +\fBvariable\-name = value\fP E. g.: +.INDENT 2.0 +.INDENT 3.5 +.sp +.nf +.ft C +[foo] + bar = baz + quux = xyzzy + ... +.ft P +.fi +.UNINDENT +.UNINDENT +.IP \(bu 2 +Section and variable names may contain only uppercase and lowercase +letters as well as dashes (\fB\-\fP). +.UNINDENT +.UNINDENT +.UNINDENT +.SH VARIABLES +.sp +Variables in belong into a configuration section and their values must +be of a certain type. Some of them have further constraints. For +example, the “color callback” must be a string of one of the values +\fBpre_linebreak_filter\fP or \fBpre_output_filter\fP, defined in the +section \fIrun\fP\&. +.sp +Currently, the configuration is organized into four sections: +.INDENT 0.0 +.TP +.B db +Options relating to the font index. +.TP +.B misc +Options without a clearly defined category. +.TP +.B paths +Path and file name settings. +.TP +.B run +Options controlling runtime behavior of Luaotfload. +.UNINDENT +.sp +The list of valid variables, the sections they are part of and their +type is given below. Types represent Lua types that the values must be +convertible to; they are abbreviated as follows: \fBs\fP for the \fIstring\fP +type, \fBn\fP for \fInumber\fP, \fBb\fP for \fIboolean\fP\&. A value of \fBnil\fP means +the variable is unset. +.SS Section \fBdb\fP +.TS +center; +|l|l|l|. +_ +T{ +variable +T} T{ +type +T} T{ +default +T} +_ +T{ +compress +T} T{ +b +T} T{ +\fBtrue\fP +T} +_ +T{ +formats +T} T{ +s +T} T{ +\fB"otf,ttf,ttc,dfont"\fP +T} +_ +T{ +max\-fonts +T} T{ +n +T} T{ +\fB2^51\fP +T} +_ +T{ +scan\-local +T} T{ +b +T} T{ +\fBfalse\fP +T} +_ +T{ +skip\-read +T} T{ +b +T} T{ +\fBfalse\fP +T} +_ +T{ +strip +T} T{ +b +T} T{ +\fBtrue\fP +T} +_ +T{ +update\-live +T} T{ +b +T} T{ +\fBtrue\fP +T} +_ +.TE +.sp +The flag \fBcompress\fP determines whether the font index (usually +\fBluaotfload\-names.lua[.gz]\fP will be stored in compressed forms. +If unset it is equivalent of passing \fB\-\-no\-compress\fP to +\fBluaotfload\-tool\fP\&. Since the file is only created for convenience +and has no effect on the runtime behavior of Luaotfload, the flag +should remain set. Most editors come with zlib support anyways. +.sp +The list of \fBformats\fP must be a comma separated sequence of strings +containing one or more of these elements: +.INDENT 0.0 +.IP \(bu 2 +\fBotf\fP (OpenType format), +.IP \(bu 2 +\fBttf\fP and \fBttc\fP (TrueType format), +.IP \(bu 2 +\fBdfont\fP (Macintosh TrueType format), +.IP \(bu 2 +\fBafm\fP (Adobe Font Metrics), +.IP \(bu 2 +\fBpfb\fP and \fBpfa\fP (PostScript format). +.UNINDENT +.sp +It corresponds loosely to the \fB\-\-formats\fP option to +\fBluaotfload\-tool\fP\&. Invalid or duplicate members are ignored; if the +list does not contain any useful identifiers, the default list +\fB"otf,ttf,ttc,dfont"\fP will be used. +.sp +The variable \fBmax\-fonts\fP determines after processing how many font +files the font scanner will terminate the search. This is useful for +debugging issues with the font index and has the same effect as the +option \fB\-\-max\-fonts\fP to \fBluaotfload\-tools\fP\&. +.sp +The \fBscan\-local\fP flag, if set, will incorporate the current working +directory as a font search location. NB: This will potentially slow +down document processing because a font index with local fonts will not +be saved to disk, so these fonts will have to be re\-indexed whenever +the document is built. +.sp +The \fBskip\-read\fP flag is only useful for debugging: It makes +Luaotfload skip reading fonts. The font information for rebuilding the +index is taken from the presently existing one. +.sp +Unsetting the \fBstrip\fP flag prevents Luaotfload from removing data +from the index that is only useful when processing font files. NB: this +can increase the size of the index files significantly and has no +effect on the runtime behavior. +.sp +If \fBupdate\-live\fP is set, Luaotfload will reload the database if it +cannot find a requested font. Those who prefer to update manually using +\fBluaotfload\-tool\fP should unset this flag. +.SS Section \fBdefault\-features\fP +.sp +By default Luaotfload enables \fBnode\fP mode and picks the default font +features that are prescribed in the OpenType standard. This behavior +may be overridden in the \fBdefault\-features\fP section. Global defaults +that will be applied for all scripts can be set via the \fBglobal\fP +option, others by the script they are to be applied to. For example, +a setting of +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +[default\-features] + global = mode=base,color=0000FF + dflt = smcp,onum +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +would force \fIbase\fP mode, tint all fonts blue and activate small +capitals and text figures globally. Features are specified as a comma +separated list of variables or variable\-value pairs. Variables without +an explicit value are set to \fBtrue\fP\&. +.SS Section \fBmisc\fP +.TS +center; +|l|l|l|. +_ +T{ +variable +T} T{ +type +T} T{ +default +T} +_ +T{ +statistics +T} T{ +b +T} T{ +\fBfalse\fP +T} +_ +T{ +termwidth +T} T{ +n +T} T{ +\fBnil\fP +T} +_ +T{ +version +T} T{ +s +T} T{ +<Luaotfload version> +T} +_ +.TE +.sp +With \fBstatistics\fP enabled, extra statistics will be collected during +index creation and appended to the index file. It may then be queried +at the Lua end or inspected by reading the file itself. +.sp +The value of \fBtermwidth\fP, if set, overrides the value retrieved by +querying the properties of the terminal in which Luatex runs. This is +useful if the engine runs with \fBshell_escape\fP disabled and the actual +terminal dimensions cannot be retrieved. +.sp +The value of \fBversion\fP is derived from the version string hard\-coded +in the Luaotfload source. Override at your own risk. +.SS Section \fBpaths\fP +.TS +center; +|l|l|l|. +_ +T{ +variable +T} T{ +type +T} T{ +default +T} +_ +T{ +cache\-dir +T} T{ +s +T} T{ +\fB"fonts"\fP +T} +_ +T{ +names\-dir +T} T{ +s +T} T{ +\fB"names"\fP +T} +_ +T{ +index\-file +T} T{ +s +T} T{ +\fB"luaotfload\-names.lua"\fP +T} +_ +T{ +lookups\-file +T} T{ +s +T} T{ +\fB"luaotfload\-lookup\-cache.lua"\fP +T} +_ +.TE +.sp +The paths \fBcache\-dir\fP and \fBnames\-dir\fP determine the subdirectory +inside the Luaotfload subtree of the \fBluatex\-cache\fP directory where +the font cache and the font index will be stored, respectively. +.sp +Inside the index directory, the names of the index file and the font +lookup cache will be derived from the respective values of +\fBindex\-file\fP and \fBlookups\-file\fP\&. This is the filename base for the +bytecode compiled version as well as \-\- for the index \-\- the gzipped +version. +.SS Section \fBrun\fP +.TS +center; +|l|l|l|. +_ +T{ +variable +T} T{ +type +T} T{ +default +T} +_ +T{ +color\-callback +T} T{ +s +T} T{ +\fB"pre_linebreak_filter"\fP +T} +_ +T{ +definer +T} T{ +s +T} T{ +\fB"patch"\fP +T} +_ +T{ +log\-level +T} T{ +n +T} T{ +\fB0\fP +T} +_ +T{ +resolver +T} T{ +s +T} T{ +\fB"cached"\fP +T} +_ +.TE +.sp +The \fBcolor\-callback\fP option determines the stage at which fonts that +defined with a \fBcolor=xxyyzz\fP feature will be colorized. By default +this happens in a \fBpre_linebreak_filter\fP but alternatively the +\fBpre_output_filter\fP may be chosen, which is faster but might produce +inconsistent output. The latter also was the default in the 1.x series +of Luaotfload. +.sp +The \fBdefiner\fP allows for switching the \fBdefine_font\fP callback. +Apart from the default \fBpatch\fP one may also choose the \fBgeneric\fP +one that comes with the vanilla fontloader. Beware that this might +break tools like Fontspect that rely on the \fBpatch_font\fP callback +provided by Luaotfload to perform important corrections on font data. +.sp +The value of \fBlog\-level\fP sets the default verbosity of messages +printed by Luaotfload. Only messages defined with a verbosity of less +than or equal to the supplied value will be output on the terminal. +At a log level of five Luaotfload can be very noisy. Also, printing too +many messages will slow down the interpreter due to line buffering +being disabled (see \fBsetbuf\fP(3)). +.sp +The \fBresolver\fP setting allows choosing the font name resolution +function: With the default value \fBcached\fP Luaotfload saves the result +of a successful font name request to a cache file to speed up +subsequent lookups. The alternative, \fBnormal\fP circumvents the cache +and resolves every request individually. (Since to the restructuring of +the font name index in Luaotfload 2.4 the performance difference +between the cached and uncached lookups should be marginal.) +.SH FILES +.sp +Luaotfload only processes the first configuration file it encounters at +one of the search locations. The file name may be either +\fBluaotfload.conf\fP or \fBluaotfloadrc\fP, except for the dotfile in the +user’s home directory which is expected at \fB~/.luaotfloadrc\fP\&. +.sp +Configuration files are located following a series of steps. The search +terminates as soon as a suitable file is encountered. The sequence of +locations that Luaotfload looks at is +.INDENT 0.0 +.IP i. 5 +The current working directory of the LuaTeX process. +.IP ii. 5 +The subdirectory \fBluaotfload/\fP inside the XDG configuration +tree, e. g. \fB/home/oenothea/config/luaotfload/\fP\&. +.IP iii. 5 +The dotfile. +.IP iv. 5 +The \fITEXMF\fP (using kpathsea). +.UNINDENT +.SH SEE ALSO +.sp +\fBluaotfload\-tool\fP(1), \fBluatex\fP(1), \fBlua\fP(1) +.INDENT 0.0 +.IP \(bu 2 +\fBtexdoc luaotfload\fP to display the PDF manual for the \fILuaotfload\fP +package +.IP \(bu 2 +Luaotfload development \fI\%https://github.com/lualatex/luaotfload\fP +.IP \(bu 2 +LuaLaTeX mailing list \fI\%http://tug.org/pipermail/lualatex\-dev/\fP +.IP \(bu 2 +LuaTeX \fI\%http://luatex.org/\fP +.IP \(bu 2 +Luaotfload on CTAN \fI\%http://ctan.org/pkg/luaotfload\fP +.UNINDENT +.SH REFERENCES +.INDENT 0.0 +.IP \(bu 2 +The XDG base specification +\fI\%http://standards.freedesktop.org/basedir\-spec/basedir\-spec\-latest.html\fP\&. +.UNINDENT +.SH AUTHORS +.sp +\fILuaotfload\fP is maintained by the LuaLaTeX dev team +(\fI\%https://github.com/lualatex/\fP). +.sp +This manual page was written by Philipp Gesang +<\fI\%philipp.gesang@alumni.uni\-heidelberg.de\fP>. +.SH COPYRIGHT +GPL v2.0 +.\" Generated by docutils manpage writer. +. |