summaryrefslogtreecommitdiff
path: root/support/luafindfont/doc/luafindfont-doc.tex
diff options
context:
space:
mode:
authorNorbert Preining <norbert@preining.info>2021-12-06 03:03:03 +0000
committerNorbert Preining <norbert@preining.info>2021-12-06 03:03:03 +0000
commit51bc8dcf794519b64c5c4a92dd3c09097025167f (patch)
tree978c38c7c08fa0feb97be15cd5a248a44a8398a5 /support/luafindfont/doc/luafindfont-doc.tex
parente26711a638906ed9b27bd3c210f4f75da6064a58 (diff)
CTAN sync 202112060303
Diffstat (limited to 'support/luafindfont/doc/luafindfont-doc.tex')
-rw-r--r--support/luafindfont/doc/luafindfont-doc.tex134
1 files changed, 117 insertions, 17 deletions
diff --git a/support/luafindfont/doc/luafindfont-doc.tex b/support/luafindfont/doc/luafindfont-doc.tex
index b051447e54..0e1b4360f1 100644
--- a/support/luafindfont/doc/luafindfont-doc.tex
+++ b/support/luafindfont/doc/luafindfont-doc.tex
@@ -1,4 +1,4 @@
- %% $Id: findfont-doc.tex 16 2021-11-07 19:42:57Z hvoss $
+ %% $Id: luafindfont-doc.tex 341 2021-12-05 10:38:08Z herbert $
%
\listfiles\setcounter{errorcontextlines}{100}
\documentclass[paper=a4,fontsize=11pt,DIV=14,parskip=half-,
@@ -77,7 +77,7 @@
\def\setVersion#1{\setVVersion#1!!}
\def\setVVersion#1=#2!!{\def\luafindfontVersion{#2}}
-\setVersion{version = 0.04}% can be automatically changed by perl
+\setVersion{version = 0.05}% can be automatically changed by perl
\setkeys{dtk}{cleanup=true,force}
@@ -92,6 +92,7 @@
\vfill
Thanks to: \\
+Gerhard Bachmaier;
Rolf Niepraschk;
\clearpage
@@ -100,9 +101,9 @@ The Lua program
\FF is a program for searching installed fonts which are usable for \LuaLaTeX\ and \XeLaTeX.
The already existing Lua program \Lprog{luaotfload-tool} can also be used for searching, but
the search-interface is somewhat cryptic and too complex for a user, who wants only to know
-if a font is present or not. And if present, wher can it be found. For example:
+if a font is present or not. And if present, where can it be found. For example:
-\begin{verbatim}
+\begin{Verbatim}[frame=lines,label=luaotfload-tool]
H-MacBook:~ voss$
H-MacBook:~ voss$ luaotfload-tool --find=times
luaotfload | resolve : Font "times" found!
@@ -112,13 +113,13 @@ H-MacBook:~ voss$ luaotfload-tool --fuzzy --find="times new roman"
luaotfload | resolve : Font "times new roman" found!
luaotfload | resolve : Resolved file name "/System/Library/Fonts/Supplemental/Times New Roman.ttf"
H-MacBook:~ voss$
-\end{verbatim}
+\end{Verbatim}
-But this are not \emph{all} Times fonts. Compare it with the output of \Lprog{luafindfont},
+But that are not \emph{all} Times fonts. Compare it with the output of \Lprog{luafindfont},
where the searchname \emph{times} must only be a part of a longer name:
-\begin{verbatim}
-bash-3.2$ ./luafindfont.lua times
+\begin{Verbatim}[frame=lines,label=luafindfont times]
+bash-3.2$ luafindfont times
We are using Lua 5.3
Check for file /usr/local/texlive/texmf-var/luatex-cache/generic/names/luaotfload-names
Nr. Fontname Symbolic Name Path
@@ -146,7 +147,9 @@ Check for file /usr/local/texlive/texmf-var/luatex-cache/generic/names/luaotfloa
22. TimesNewRomanPSStd-BoldIt.otf timesnewromanpsstd /Users/voss/Library/Fonts/Times/
23. TimesNewRomanPSStd-Italic.otf timesnewromanpsstd /Users/voss/Library/Fonts/Times/
24. TimesNewRomanPSStd-Regular.otf timesnewromanpsstd /Users/voss/Library/Fonts/Times/
-\end{verbatim}
+\end{Verbatim}
+
+%$
\subsection{Syntax}
@@ -158,9 +161,8 @@ The \Index{syntax} is
where \verb|[...]| are optional \Index{argument}s, either in short or
long form which, of course, can be mixed:
-\begin{verbatim}
+\begin{Verbatim}[frame=lines,label=Parameter]
parameter handling
- -q,--quiet
-h,--help
-o,--otfinfo (default 0)
-i,--info (default 0)
@@ -168,7 +170,7 @@ long form which, of course, can be mixed:
-v... Verbosity output
-m,--max_string (default 90)
<font> (string)
-\end{verbatim}
+\end{Verbatim}
For example:
@@ -179,12 +181,12 @@ luafindfont -i 3 -m 50 arial
\end{verbatim}
\begin{enumerate}
-\item \texttt{-q}: quiet;
\item \texttt{-m <columns>}: How many columns are used for the font with full path. This can be really long, but with e.g. \verb|-m 50|
-the length is limited to 50 characters.
-\item \texttt{-o <number>}: For the font with the given number from the font list the program \Lprog{otfinfo} is called
- for some generell font informations.
-\item \texttt{-i <number>}: For the font with the given number from the font list the existing font styles are listed.
+the length is limited to 50 characters and in the middle of the long name there will be \ldots, representing the missing characters.
+\item \texttt{-o <number[character]>}: For the font with the given number from the font list the program \Lprog{otfinfo} is called
+ for some generell font informations. An additional optional argument for \Lprog{otfinfo} (only one character) must follow directly the fontnumber
+ (see also section~\ref{otfinfo})
+\item \texttt{-i <number>}: For the font with the given number from the font list the existing other corresponding font styles are listed.
\end{enumerate}
\section{How it works}
@@ -193,6 +195,104 @@ missing it will be created by \FF itself. The name of the font should be in lowe
characters and must not be the complete name. A \verb|time| for finding all fonts with
time in its names is sufficiant.
+
+\subsection{Fontname}
+The fontname can only be a substring of the complete filename. It is not case sensitive, \texttt{Myriad} and \texttt{myriad}
+are the same. It is possible to combine two search strings which will act like a boolean \texttt{and}. A search with
+\texttt{"Myriad \& bold"} (in quotes) will list all files which have \texttt{myriad} \emph{and} \texttt{bold} in its name.
+
+
+\subsection{Option \texttt{-o}}\label{otfinfo}
+This needs an installed program \Lprog{otfinfo}, which should be the default for all \TeX\ distributions.
+This program lists some useful informations of a given fontnumber. The fontnumber can be combined by an
+additional character for different outputs. For example \texttt{-o 2f} lists the features of the font number 2
+in the list. The order makes no difference: \texttt{-o f2} prints the same. If there is no output then the font has no such
+informations defined!
+
+The possible options are (i is the default):
+
+\begin{Verbatim}[frame=lines,label=otfinfo]
+ s Report font’s supported scripts.
+ f Report font’s GSUB/GPOS features.
+ z Report font’s optical size information.
+ p Report font’s PostScript name.
+ a Report font’s family name.
+ v Report font’s version information.
+ i Report font’s names and designer/vendor info.
+ g Report font’s glyph names.
+ t Report font’s OpenType tables.
+\end{Verbatim}
+
+
+\begin{Verbatim}[frame=lines,label=luafindfont -o 2f "myriad \& semibold"]
+bash-3.2$ luafindfont -o 2f "myriad & semibold"
+We are using Lua 5.3
+Looking for font "myriad & semibold"
+Check for file /usr/local/texlive/2021/texmf-var/luatex-cache/generic/names/luaotfload-names
+ No. Fontname Symbolic Name Path
+ 1. MyriadPro-Semibold.otf myriadpro /Users/voss/Library/Fonts/MyriadPro/
+ 2. MyriadPro-SemiboldCond.otf myriadpro /Users/voss/Library/Fonts/MyriadPro/
+ 3. MyriadPro-SemiboldCondIt.otf myriadpro /Users/voss/Library/Fonts/MyriadPro/
+ 4. MyriadPro-SemiboldIt.otf myriadpro /Users/voss/Library/Fonts/MyriadPro/
+ 5. MyriadPro-SemiboldSemiCn.otf myriadpro /Users/voss/Library/Fonts/MyriadPro/
+ 6. MyriadPro-SemiboldSemiCnIt.otf myriadpro /Users/voss/Library/Fonts/MyriadPro/
+ 7. MyriadPro-SemiboldSemiExt.otf myriadpro /Users/voss/Library/Fonts/MyriadPro/
+ 8. MyriadPro-SemiboldSemiExtIt.otf myriadpro /Users/voss/Library/Fonts/MyriadPro/
+
+Run otfinfo -f: 2
+otfinfo -f "/Users/voss/Library/Fonts/MyriadPro/MyriadPro-SemiboldCond.otf"
+aalt Access All Alternates
+case Case-Sensitive Forms
+cpsp Capital Spacing
+dnom Denominators
+fina Terminal Forms
+frac Fractions
+kern Kerning
+liga Standard Ligatures
+lnum Lining Figures
+numr Numerators
+onum Oldstyle Figures
+ordn Ordinals
+pnum Proportional Figures
+sinf Scientific Inferiors
+sups Superscript
+tnum Tabular Figures
+zero Slashed Zero
+\end{Verbatim}
+
+if no parameter is given, then \texttt{-i} is assumed.
+
+
+\subsection{Option \texttt{-i}}
+For a given font number \texttt{luafindfont} will list the font styles which were found by the font search
+and which correspond to the font number. This is useful if a fontname doesn't has the style in its name or
+only in short form.
+
+\begin{Verbatim}[frame=lines,label=luafindfont -i 4 "myriad \& semibold"]
+bash-3.2$ luafindfont -i 4 "myriad & semibold"
+We are using Lua 5.3
+Looking for font "myriad & semibold"
+Check for file /usr/local/texlive/2021/texmf-var/luatex-cache/generic/names/luaotfload-names
+ No. Fontname Symbolic Name Path
+ 1. MyriadPro-Semibold.otf myriadpro /Users/voss/Library/Fonts/MyriadPro/
+ 2. MyriadPro-SemiboldCond.otf myriadpro /Users/voss/Library/Fonts/MyriadPro/
+ 3. MyriadPro-SemiboldCondIt.otf myriadpro /Users/voss/Library/Fonts/MyriadPro/
+ 4. MyriadPro-SemiboldIt.otf myriadpro /Users/voss/Library/Fonts/MyriadPro/
+ 5. MyriadPro-SemiboldSemiCn.otf myriadpro /Users/voss/Library/Fonts/MyriadPro/
+ 6. MyriadPro-SemiboldSemiCnIt.otf myriadpro /Users/voss/Library/Fonts/MyriadPro/
+ 7. MyriadPro-SemiboldSemiExt.otf myriadpro /Users/voss/Library/Fonts/MyriadPro/
+ 8. MyriadPro-SemiboldSemiExtIt.otf myriadpro /Users/voss/Library/Fonts/MyriadPro/
+
+Font: myriadpro
+
+Fonttype otf(system) --> | Regular | Bold | Italic | BoldItalic |
+\end{Verbatim}
+
+For the font number 4 there also exists a Regular, Bold, and a Italic font. The font no 4 itself
+is a BoldItalic version.
+
+
+
\section{Examples}
\begin{Verbatim}