<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>docs/config/lua/wezterm/font_with_fallback.md - fork/wezterm @ termwiz-0.23.1</title>
<meta name="description" content="docs/config/lua/wezterm/font_with_fallback.md in fork/wezterm at termwiz-0.23.1.">
<meta property="og:title" content="docs/config/lua/wezterm/font_with_fallback.md - fork/wezterm @ termwiz-0.23.1">
<meta property="og:description" content="docs/config/lua/wezterm/font_with_fallback.md in fork/wezterm at termwiz-0.23.1.">
<meta property="og:type" content="website">
<meta property="og:site_name" content="git.julia.blue">
<link rel="stylesheet" href="/css/style.css?v=62">
<script type="module" src="/js/main.js?v=62"></script>
</head>
<body>
<main data-ref="termwiz-0.23.1" data-tip="7053748e4d899e7fc5e202d6f903b052fc78e759">
<noscript>
  <div class="callout">
    <p>
      hey! this is a static git repo viewer. commit diffs, file history,
      older commits and other revisions won't load without javascript.
    </p>
    <p>
      you are still able to view source files on branch/tag tips,
      but the experience is degraded.
    </p>
  </div>
</noscript>
<header class="repo"><div>
<h1>fork/wezterm</h1>
</div>
<pre class="clone">git clone https://git.julia.blue/fork/wezterm</pre>
</header>
<p class="snapshot-commit"><span class="commit-author">Wez Furlong</span><span class="commit-message" data-commit="84f7fb9f3b0deb192d45ee36257e5f329584b1fc">docs: add tags to a number of pages</span><span class="snapshot-sha sha" data-commit="84f7fb9f3b0deb192d45ee36257e5f329584b1fc">84f7fb9f3</span><time datetime="2023-04-08T07:48:40-07:00" title="2023-04-08 07:48:40 -0700">2023-04-08</time></p>
<header class="topbar"><details class="switcher"><summary>termwiz-0.23.1</summary><div class="menu"><strong>branches</strong><a href="/fork/wezterm/ref/main/">main</a><strong>tags</strong><a href="/fork/wezterm/ref/termiz-0.23.1/">termiz-0.23.1</a><a href="/fork/wezterm/ref/termiz-0.23.2/">termiz-0.23.2</a><a href="/fork/wezterm/ref/termiz-0.23.3/">termiz-0.23.3</a><a href="/fork/wezterm/ref/termwiz-0.23.0/">termwiz-0.23.0</a><a class="current" href="/fork/wezterm/ref/termwiz-0.23.1/">termwiz-0.23.1</a><a href="/fork/wezterm/ref/termwiz-0.23.2/">termwiz-0.23.2</a><a href="/fork/wezterm/ref/termwiz-0.23.3/">termwiz-0.23.3</a><a href="/fork/wezterm/ref/vtparse-0.7.0/">vtparse-0.7.0</a><a class="all" href="/fork/wezterm/refs">all refs →</a></div></details><nav class="crumbs"><a href="/fork/wezterm/">wezterm</a> / <a href="/fork/wezterm/ref/termwiz-0.23.1/tree/docs/">docs</a> / <a href="/fork/wezterm/ref/termwiz-0.23.1/tree/docs/config/">config</a> / <a href="/fork/wezterm/ref/termwiz-0.23.1/tree/docs/config/lua/">lua</a> / <a href="/fork/wezterm/ref/termwiz-0.23.1/tree/docs/config/lua/wezterm/">wezterm</a> / <span class="cur">font_with_fallback.md</span></nav>
<span class="view-stats"><span>3.7 KiB</span><span>115 lines</span></span><span class="actions"><a class="raw" href="/fork/wezterm/raw/941cc50ed9d92fe95adb3b294c13bcfc34d37e5f/docs/config/lua/wezterm/font_with_fallback.md">raw</a></span></header>
<div class="markdown-view"><input type="radio" name="markdown-view" id="markdown-rendered" checked><label for="markdown-rendered">rendered</label><input type="radio" name="markdown-view" id="markdown-code"><label for="markdown-code">code</label><section class="readme rendered"><hr />
<p>title: wezterm.font_with_fallback
tags:</p>
<ul>
<li>font</li>
</ul>
<hr />
<h1><code>wezterm.font_with_fallback(families [, attributes])</code></h1>
<p>This function constructs a lua table that configures a font with fallback processing.
Glyphs are looked up in the first font in the list but if missing the next font is
checked and so on.</p>
<p>The first parameter is a table listing the fonts in their preferred order:</p>
<pre class="language-lua"><a-k>local</a-k> <a-v>wezterm</a-v> = <a-f>require</a-f> <a-s>&#39;wezterm&#39;</a-s>

<a-k>return</a-k> <a-cr>{</a-cr>
  <a-v>font</a-v> = <a-v>wezterm</a-v><a-p>.</a-p><a-f>font_with_fallback</a-f> <a-cr>{</a-cr> <a-s>&#39;JetBrains Mono&#39;</a-s><a-p>,</a-p> <a-s>&#39;Noto Color Emoji&#39;</a-s> <a-cr>}</a-cr><a-p>,</a-p>
<a-cr>}</a-cr></pre>
<p>WezTerm implicitly adds its default fallback to the list that you specify.</p>
<p>The <em>attributes</em> parameter behaves the same as that of <a href="/fork/wezterm/ref/termwiz-0.23.1/blob/docs/config/lua/wezterm/font.md">wezterm.font</a>
in that it allows you to specify font weight and style attributes that you
want to match.</p>
<p>{{since('20210502-130208-bff6815d')}}</p>
<p>The attributes can now be specified per fallback font using this alternative
form where the family and attributes are specified as part of the same lua table:</p>
<pre class="language-lua"><a-k>local</a-k> <a-v>wezterm</a-v> = <a-f>require</a-f> <a-s>&#39;wezterm&#39;</a-s>

<a-k>return</a-k> <a-cr>{</a-cr>
  <a-v>font</a-v> = <a-v>wezterm</a-v><a-p>.</a-p><a-f>font_with_fallback</a-f> <a-cr>{</a-cr>
    <a-cr>{</a-cr> <a-v>family</a-v> = <a-s>&#39;JetBrains Mono&#39;</a-s><a-p>,</a-p> <a-v>weight</a-v> = <a-s>&#39;Medium&#39;</a-s> <a-cr>}</a-cr><a-p>,</a-p>
    <a-cr>{</a-cr> <a-v>family</a-v> = <a-s>&#39;Terminus&#39;</a-s><a-p>,</a-p> <a-v>weight</a-v> = <a-s>&#39;Bold&#39;</a-s> <a-cr>}</a-cr><a-p>,</a-p>
    <a-s>&#39;Noto Color Emoji&#39;</a-s><a-p>,</a-p>
  <a-cr>}</a-cr><a-p>,</a-p>
<a-cr>}</a-cr></pre>
<p>{{since('20220101-133340-7edc5b5a')}}</p>
<p>You can use the expanded form mentioned above to override freetype and harfbuzz
settings just for the specified font; this examples shows how to disable the
default ligature feature just for JetBrains Mono, but leave it on for the
other fonts in the fallback:</p>
<pre class="language-lua"><a-k>local</a-k> <a-v>wezterm</a-v> = <a-f>require</a-f> <a-s>&#39;wezterm&#39;</a-s>

<a-k>return</a-k> <a-cr>{</a-cr>
  <a-v>font</a-v> = <a-v>wezterm</a-v><a-p>.</a-p><a-f>font_with_fallback</a-f> <a-cr>{</a-cr>
    <a-cr>{</a-cr>
      <a-v>family</a-v> = <a-s>&#39;JetBrains Mono&#39;</a-s><a-p>,</a-p>
      <a-v>harfbuzz_features</a-v> = <a-cr>{</a-cr> <a-s>&#39;calt=0&#39;</a-s><a-p>,</a-p> <a-s>&#39;clig=0&#39;</a-s><a-p>,</a-p> <a-s>&#39;liga=0&#39;</a-s> <a-cr>}</a-cr><a-p>,</a-p>
    <a-cr>}</a-cr><a-p>,</a-p>
    <a-cr>{</a-cr> <a-v>family</a-v> = <a-s>&#39;Terminus&#39;</a-s><a-p>,</a-p> <a-v>weight</a-v> = <a-s>&#39;Bold&#39;</a-s> <a-cr>}</a-cr><a-p>,</a-p>
    <a-s>&#39;Noto Color Emoji&#39;</a-s><a-p>,</a-p>
  <a-cr>}</a-cr><a-p>,</a-p>
<a-cr>}</a-cr></pre>
<p>The following options can be specified in the same way:</p>
<ul>
<li><a href="/fork/wezterm/ref/termwiz-0.23.1/blob/docs/config/font-shaping.md">harfbuzz_features</a></li>
<li><a href="/fork/wezterm/ref/termwiz-0.23.1/blob/docs/config/lua/config/freetype_load_target.md">freetype_load_target</a></li>
<li><a href="/fork/wezterm/ref/termwiz-0.23.1/blob/docs/config/lua/config/freetype_render_target.md">freetype_render_target</a></li>
<li><a href="/fork/wezterm/ref/termwiz-0.23.1/blob/docs/config/lua/config/freetype_load_flags.md">freetype_load_flags</a></li>
<li><code>assume_emoji_presentation = true</code> or <code>assume_emoji_presentation = false</code> to control whether a font is considered to have emoji (rather than text) presentation glyphs for emoji. {{since('20220807-113146-c2fee766', inline=True)}}</li>
</ul>
<h2>Dealing with different fallback font heights</h2>
<p>When mixing different font families there is a chance that glyphs from one font
don't appear to be the same height as the glyphs from your primary font.</p>
<p>For "Roman" fonts there exists a font metric known as <em>cap-height</em> which
indicates the nominal size of a capital (uppercase) letter that can be used to
compute a scaling factor that can be used to make the fallback font appear to
have the same size.</p>
<p>Setting
<a href="/fork/wezterm/ref/termwiz-0.23.1/blob/docs/config/lua/config/use_cap_height_to_scale_fallback_fonts.md">use_cap_height_to_scale_fallback_fonts</a>
= <code>true</code> will cause wezterm to try to automatically scale using the
<em>cap-height</em> metric (or to compute its own idea of the <em>cap-height</em> based on the size of
glyph(s)).</p>
<h3>Manual fallback scaling</h3>
<p>{{since('20220408-101518-b908e2dd')}}</p>
<p>CJK fonts typically won't have a useful <em>cap-height</em> metric so it may be
desirable to manually configure the fallback scaling factor to boost the size
of the CJK font so that the glyphs are more readable.</p>
<p>The example below shows how to boost the effective size of the <code>"Microsoft YaHei"</code> fallback font to <code>1.5</code> times the normal size.  The boost cannot
influence font metrics so it may be desirable to also specify
<a href="/fork/wezterm/ref/termwiz-0.23.1/blob/docs/config/lua/config/line_height.md">line_height</a> to produce a more pleasing display.</p>
<pre class="language-lua"><a-k>local</a-k> <a-v>wezterm</a-v> = <a-f>require</a-f> <a-s>&#39;wezterm&#39;</a-s>

<a-k>return</a-k> <a-cr>{</a-cr>
  <a-v>line_height</a-v> = <a-n>1.2</a-n><a-p>,</a-p>
  <a-v>font</a-v> = <a-v>wezterm</a-v><a-p>.</a-p><a-f>font_with_fallback</a-f> <a-cr>{</a-cr>
    <a-s>&#39;JetBrains Mono&#39;</a-s><a-p>,</a-p>
    <a-cr>{</a-cr> <a-v>family</a-v> = <a-s>&#39;Microsoft YaHei&#39;</a-s><a-p>,</a-p> <a-v>scale</a-v> = <a-n>1.5</a-n> <a-cr>}</a-cr><a-p>,</a-p>
  <a-cr>}</a-cr><a-p>,</a-p>
<a-cr>}</a-cr></pre>
</section><div class="code-panel"><pre class="code src language-markdown"><span class="code-line"><a class="ln" id="L1" href="#L1">1</a><span class="code-text"><a-p>---</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L2" href="#L2">2</a><span class="code-text"><a-pr>title</a-pr><a-p>:</a-p> <a-s>wezterm.font_with_fallback</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L3" href="#L3">3</a><span class="code-text"><a-pr>tags</a-pr><a-p>:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text"> <a-p>-</a-p> <a-s>font</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text"><a-p>---</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text"><a-p>#</a-p> <a-tt>`wezterm.font_with_fallback(families [, attributes])`</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text">This function constructs a lua table that configures a font with fallback processing.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text">Glyphs are looked up in the first font in the list but if missing the next font is</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text">checked and so on.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text">The first parameter is a table listing the fonts in their preferred order:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L14" href="#L14">14</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L15" href="#L15">15</a><span class="code-text"><a-p>```</a-p><a-tl>lua</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text"><a-p>local </a-p><a-v>wezterm</a-v><a-p> = </a-p><a-f>require</a-f><a-p> </a-p><a-s>&#39;wezterm&#39;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L17" href="#L17">17</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L18" href="#L18">18</a><span class="code-text"><a-p>return </a-p><a-cr>{</a-cr></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L19" href="#L19">19</a><span class="code-text"><a-p>  </a-p><a-v>font</a-v><a-p> = </a-p><a-v>wezterm</a-v><a-p>.</a-p><a-f>font_with_fallback</a-f><a-p> </a-p><a-cr>{</a-cr><a-p> </a-p><a-s>&#39;JetBrains Mono&#39;</a-s><a-p>, </a-p><a-s>&#39;Noto Color Emoji&#39;</a-s><a-p> </a-p><a-cr>}</a-cr><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L20" href="#L20">20</a><span class="code-text"><a-p>}</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L21" href="#L21">21</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L22" href="#L22">22</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L23" href="#L23">23</a><span class="code-text"><a-p>WezTerm implicitly adds its default fallback to the list that you specify.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L24" href="#L24">24</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L25" href="#L25">25</a><span class="code-text"><a-p>The *attributes* parameter behaves the same as that of [wezterm.font](font.md)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L26" href="#L26">26</a><span class="code-text"><a-p>in that it allows you to specify font weight and style attributes that you</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L27" href="#L27">27</a><span class="code-text"><a-p>want to match.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L28" href="#L28">28</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L29" href="#L29">29</a><span class="code-text"><a-p>{{since(&#39;20210502-130208-bff6815d&#39;)}}</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L30" href="#L30">30</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L31" href="#L31">31</a><span class="code-text"><a-p>The attributes can now be specified per fallback font using this alternative</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L32" href="#L32">32</a><span class="code-text"><a-p>form where the family and attributes are specified as part of the same lua table:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L33" href="#L33">33</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L34" href="#L34">34</a><span class="code-text"><a-p>```</a-p><a-tl>lua</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L35" href="#L35">35</a><span class="code-text"><a-p>local </a-p><a-v>wezterm</a-v><a-p> = </a-p><a-f>require</a-f><a-p> </a-p><a-s>&#39;wezterm&#39;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L36" href="#L36">36</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L37" href="#L37">37</a><span class="code-text"><a-p>return </a-p><a-cr>{</a-cr></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L38" href="#L38">38</a><span class="code-text"><a-p>  </a-p><a-v>font</a-v><a-p> = </a-p><a-v>wezterm</a-v><a-p>.</a-p><a-f>font_with_fallback</a-f><a-p> </a-p><a-cr>{</a-cr></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L39" href="#L39">39</a><span class="code-text"><a-p>    </a-p><a-cr>{</a-cr><a-p> </a-p><a-v>family</a-v><a-p> = </a-p><a-s>&#39;JetBrains Mono&#39;</a-s><a-p>, </a-p><a-v>weight</a-v><a-p> = </a-p><a-s>&#39;Medium&#39;</a-s><a-p> </a-p><a-cr>}</a-cr><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L40" href="#L40">40</a><span class="code-text"><a-p>    </a-p><a-cr>{</a-cr><a-p> </a-p><a-v>family</a-v><a-p> = </a-p><a-s>&#39;Terminus&#39;</a-s><a-p>, </a-p><a-v>weight</a-v><a-p> = </a-p><a-s>&#39;Bold&#39;</a-s><a-p> </a-p><a-cr>}</a-cr><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L41" href="#L41">41</a><span class="code-text"><a-p>    </a-p><a-s>&#39;Noto Color Emoji&#39;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L42" href="#L42">42</a><span class="code-text"><a-p>  </a-p><a-cr>}</a-cr><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L43" href="#L43">43</a><span class="code-text"><a-p>}</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L44" href="#L44">44</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L45" href="#L45">45</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L46" href="#L46">46</a><span class="code-text"><a-p>{{since(&#39;20220101-133340-7edc5b5a&#39;)}}</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L47" href="#L47">47</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L48" href="#L48">48</a><span class="code-text"><a-p>You can use the expanded form mentioned above to override freetype and harfbuzz</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L49" href="#L49">49</a><span class="code-text"><a-p>settings just for the specified font; this examples shows how to disable the</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L50" href="#L50">50</a><span class="code-text"><a-p>default ligature feature just for JetBrains Mono, but leave it on for the</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L51" href="#L51">51</a><span class="code-text"><a-p>other fonts in the fallback:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L52" href="#L52">52</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L53" href="#L53">53</a><span class="code-text"><a-p>```</a-p><a-tl>lua</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L54" href="#L54">54</a><span class="code-text"><a-p>local </a-p><a-v>wezterm</a-v><a-p> = </a-p><a-f>require</a-f><a-p> </a-p><a-s>&#39;wezterm&#39;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L55" href="#L55">55</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L56" href="#L56">56</a><span class="code-text"><a-p>return </a-p><a-cr>{</a-cr></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L57" href="#L57">57</a><span class="code-text"><a-p>  </a-p><a-v>font</a-v><a-p> = </a-p><a-v>wezterm</a-v><a-p>.</a-p><a-f>font_with_fallback</a-f><a-p> </a-p><a-cr>{</a-cr></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L58" href="#L58">58</a><span class="code-text"><a-p>    </a-p><a-cr>{</a-cr></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L59" href="#L59">59</a><span class="code-text"><a-p>      </a-p><a-v>family</a-v><a-p> = </a-p><a-s>&#39;JetBrains Mono&#39;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L60" href="#L60">60</a><span class="code-text"><a-p>      </a-p><a-v>harfbuzz_features</a-v><a-p> = </a-p><a-cr>{</a-cr><a-p> </a-p><a-s>&#39;calt=0&#39;</a-s><a-p>, </a-p><a-s>&#39;clig=0&#39;</a-s><a-p>, </a-p><a-s>&#39;liga=0&#39;</a-s><a-p> </a-p><a-cr>}</a-cr><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L61" href="#L61">61</a><span class="code-text"><a-p>    </a-p><a-cr>}</a-cr><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L62" href="#L62">62</a><span class="code-text"><a-p>    </a-p><a-cr>{</a-cr><a-p> </a-p><a-v>family</a-v><a-p> = </a-p><a-s>&#39;Terminus&#39;</a-s><a-p>, </a-p><a-v>weight</a-v><a-p> = </a-p><a-s>&#39;Bold&#39;</a-s><a-p> </a-p><a-cr>}</a-cr><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L63" href="#L63">63</a><span class="code-text"><a-p>    </a-p><a-s>&#39;Noto Color Emoji&#39;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L64" href="#L64">64</a><span class="code-text"><a-p>  </a-p><a-cr>}</a-cr><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L65" href="#L65">65</a><span class="code-text"><a-p>}</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L66" href="#L66">66</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L67" href="#L67">67</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L68" href="#L68">68</a><span class="code-text"><a-p>The following options can be specified in the same way:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L69" href="#L69">69</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L70" href="#L70">70</a><span class="code-text"><a-p>* [harfbuzz_features](../../font-shaping.md)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L71" href="#L71">71</a><span class="code-text"><a-p>* [freetype_load_target](../config/freetype_load_target.md)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L72" href="#L72">72</a><span class="code-text"><a-p>* [freetype_render_target](../config/freetype_render_target.md)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L73" href="#L73">73</a><span class="code-text"><a-p>* [freetype_load_flags](../config/freetype_load_flags.md)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L74" href="#L74">74</a><span class="code-text"><a-p>* `assume_emoji_presentation = true` or `assume_emoji_presentation = false` to control whether a font is considered to have emoji (rather than text) presentation glyphs for emoji. {{since(&#39;20220807-113146-c2fee766&#39;, inline=True)}}</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L75" href="#L75">75</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L76" href="#L76">76</a><span class="code-text"><a-p>## </a-p><a-tt>Dealing with different fallback font heights</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L77" href="#L77">77</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L78" href="#L78">78</a><span class="code-text"><a-p>When mixing different font families there is a chance that glyphs from one font</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L79" href="#L79">79</a><span class="code-text"><a-p>don&#39;t appear to be the same height as the glyphs from your primary font.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L80" href="#L80">80</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L81" href="#L81">81</a><span class="code-text"><a-p>For &quot;Roman&quot; fonts there exists a font metric known as *cap-height* which</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L82" href="#L82">82</a><span class="code-text"><a-p>indicates the nominal size of a capital (uppercase) letter that can be used to</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L83" href="#L83">83</a><span class="code-text"><a-p>compute a scaling factor that can be used to make the fallback font appear to</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L84" href="#L84">84</a><span class="code-text"><a-p>have the same size.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L85" href="#L85">85</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L86" href="#L86">86</a><span class="code-text"><a-p>Setting</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L87" href="#L87">87</a><span class="code-text"><a-p>[use_cap_height_to_scale_fallback_fonts](../config/use_cap_height_to_scale_fallback_fonts.md)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L88" href="#L88">88</a><span class="code-text"><a-p>= `true` will cause wezterm to try to automatically scale using the</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L89" href="#L89">89</a><span class="code-text"><a-p>*cap-height* metric (or to compute its own idea of the *cap-height* based on the size of</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L90" href="#L90">90</a><span class="code-text"><a-p>glyph(s)).</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L91" href="#L91">91</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L92" href="#L92">92</a><span class="code-text"><a-p>### </a-p><a-tt>Manual fallback scaling</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L93" href="#L93">93</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L94" href="#L94">94</a><span class="code-text"><a-p>{{since(&#39;20220408-101518-b908e2dd&#39;)}}</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L95" href="#L95">95</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L96" href="#L96">96</a><span class="code-text"><a-p>CJK fonts typically won&#39;t have a useful *cap-height* metric so it may be</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L97" href="#L97">97</a><span class="code-text"><a-p>desirable to manually configure the fallback scaling factor to boost the size</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L98" href="#L98">98</a><span class="code-text"><a-p>of the CJK font so that the glyphs are more readable.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L99" href="#L99">99</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L100" href="#L100">100</a><span class="code-text"><a-p>The example below shows how to boost the effective size of the `&quot;Microsoft</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L101" href="#L101">101</a><span class="code-text"><a-p>YaHei&quot;` fallback font to `1.5` times the normal size.  The boost cannot</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L102" href="#L102">102</a><span class="code-text"><a-p>influence font metrics so it may be desirable to also specify</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L103" href="#L103">103</a><span class="code-text"><a-p>[line_height](../config/line_height.md) to produce a more pleasing display.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L104" href="#L104">104</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L105" href="#L105">105</a><span class="code-text"><a-p>```</a-p><a-tl>lua</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L106" href="#L106">106</a><span class="code-text"><a-p>local </a-p><a-v>wezterm</a-v><a-p> = </a-p><a-f>require</a-f><a-p> </a-p><a-s>&#39;wezterm&#39;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L107" href="#L107">107</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L108" href="#L108">108</a><span class="code-text"><a-p>return </a-p><a-cr>{</a-cr></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L109" href="#L109">109</a><span class="code-text"><a-p>  </a-p><a-v>line_height</a-v><a-p> = </a-p><a-n>1.2</a-n><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L110" href="#L110">110</a><span class="code-text"><a-p>  </a-p><a-v>font</a-v><a-p> = </a-p><a-v>wezterm</a-v><a-p>.</a-p><a-f>font_with_fallback</a-f><a-p> </a-p><a-cr>{</a-cr></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L111" href="#L111">111</a><span class="code-text"><a-p>    </a-p><a-s>&#39;JetBrains Mono&#39;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L112" href="#L112">112</a><span class="code-text"><a-p>    </a-p><a-cr>{</a-cr><a-p> </a-p><a-v>family</a-v><a-p> = </a-p><a-s>&#39;Microsoft YaHei&#39;</a-s><a-p>, </a-p><a-v>scale</a-v><a-p> = </a-p><a-n>1.5</a-n><a-p> </a-p><a-cr>}</a-cr><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L113" href="#L113">113</a><span class="code-text"><a-p>  </a-p><a-cr>}</a-cr><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L114" href="#L114">114</a><span class="code-text"><a-p>}</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L115" href="#L115">115</a><span class="code-text"><a-p>```</a-p></span></span></pre></div></div>
</main>
</body>
</html>
