<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>docs/config/lua/config/tiling_desktop_environments.md - fork/wezterm @ termwiz-0.23.1</title>
<meta name="description" content="docs/config/lua/config/tiling_desktop_environments.md in fork/wezterm at termwiz-0.23.1.">
<meta property="og:title" content="docs/config/lua/config/tiling_desktop_environments.md - fork/wezterm @ termwiz-0.23.1">
<meta property="og:description" content="docs/config/lua/config/tiling_desktop_environments.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">UserIsntAvailable</span><span class="commit-message" data-commit="fd9afa18c62f1d4b4281aabebf5dea826f958024">add `awesome` to default `tiling_desktop_environments`.</span><span class="snapshot-sha sha" data-commit="fd9afa18c62f1d4b4281aabebf5dea826f958024">fd9afa18c</span><time datetime="2023-08-18T19:08:38-04:00" title="2023-08-18 19:08:38 -0400">2023-08-18</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/config/">config</a> / <span class="cur">tiling_desktop_environments.md</span></nav>
<span class="view-stats"><span>1.3 KiB</span><span>42 lines</span></span><span class="actions"><a class="raw" href="/fork/wezterm/raw/b7f8d8cb1ead1dc8a1c41c526eb0757f1512ed81/docs/config/lua/config/tiling_desktop_environments.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"><h1><code>tiling_desktop_environments = {}</code></h1>
<p>{{since('20230712-072601-f4abf8fd')}}</p>
<p>Contains a list of Window Environments that are known to be tiling
window managers. A tiling window manager is one that automatically
resizes windows according to some layout policy, rather than respecting
the window size set by an application.</p>
<p>The default value for this option is:</p>
<pre class="language-lua"><a-v>config</a-v><a-p>.</a-p><a-v>tiling_desktop_environments</a-v> = <a-cr>{</a-cr>
  <a-s>&#39;X11 LG3D&#39;</a-s><a-p>,</a-p>
  <a-s>&#39;X11 bspwm&#39;</a-s><a-p>,</a-p>
  <a-s>&#39;X11 i3&#39;</a-s><a-p>,</a-p>
  <a-s>&#39;X11 dwm&#39;</a-s><a-p>,</a-p>
<a-cr>}</a-cr></pre>
<p>{{since('dev')}}</p>
<p>The following additional entries are now part of the default value of
<code>tiling_desktop_environments</code>:</p>
<ul>
<li>'"X11 awesome"'</li>
</ul>
<p>The environment name can be found in the debug overlay which you can show via
the <a href="/fork/wezterm/ref/termwiz-0.23.1/blob/docs/config/lua/keyassignment/ShowDebugOverlay.md">ShowDebugOverlay</a> key assignment.
The default key binding for it is &lt;kbd&gt;Ctrl&lt;/kbd&gt; + &lt;kbd&gt;Shift&lt;/kbd&gt; +
&lt;kbd&gt;L&lt;/kbd&gt;.</p>
<p>Look for the line beginning with <code>Window Environment:</code>. The text after the
colon is the name to add to <code>tiling_desktop_environments</code>.</p>
<p>If your window environment is a tiling environment and is not listed
here, please file an issue (or even a PR!) to add it to the default
list.</p>
<p>This contents of this list are used to determine a reasonable default for
<a href="/fork/wezterm/ref/termwiz-0.23.1/blob/docs/config/lua/config/adjust_window_size_when_changing_font_size.md">adjust_window_size_when_changing_font_size</a>.</p>
</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> <a-tt>`tiling_desktop_environments = {}`</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L2" href="#L2">2</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L3" href="#L3">3</a><span class="code-text">{{since(&#39;20230712-072601-f4abf8fd&#39;)}}</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text">Contains a list of Window Environments that are known to be tiling</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text">window managers. A tiling window manager is one that automatically</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text">resizes windows according to some layout policy, rather than respecting</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text">the window size set by an application.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text">The default value for this option 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"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</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="L13" href="#L13">13</a><span class="code-text"><a-p>config.</a-p><a-v>tiling_desktop_environments</a-v><a-p> = </a-p><a-cr>{</a-cr></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L14" href="#L14">14</a><span class="code-text"><a-p>  </a-p><a-s>&#39;X11 LG3D&#39;</a-s><a-p>,</a-p></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-s>&#39;X11 bspwm&#39;</a-s><a-p>,</a-p></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>  </a-p><a-s>&#39;X11 i3&#39;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L17" href="#L17">17</a><span class="code-text"><a-p>  </a-p><a-s>&#39;X11 dwm&#39;</a-s><a-p>,</a-p></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>}</a-p></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></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L20" href="#L20">20</a><span class="code-text"></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>{{since(&#39;dev&#39;)}}</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>The following additional entries are now part of the default value of</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"><a-p>`tiling_desktop_environments`:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L25" href="#L25">25</a><span class="code-text"></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> *  &#39;&quot;X11 awesome&quot;&#39;</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"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L28" href="#L28">28</a><span class="code-text">The environment name can be found in the debug overlay which you can show via</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L29" href="#L29">29</a><span class="code-text">the [ShowDebugOverlay](../keyassignment/ShowDebugOverlay.md) key assignment.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L30" href="#L30">30</a><span class="code-text">The default key binding for it is &lt;kbd&gt;Ctrl&lt;/kbd&gt; + &lt;kbd&gt;Shift&lt;/kbd&gt; +</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L31" href="#L31">31</a><span class="code-text">&lt;kbd&gt;L&lt;/kbd&gt;.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L32" href="#L32">32</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L33" href="#L33">33</a><span class="code-text">Look for the line beginning with `Window Environment:`. The text after the</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L34" href="#L34">34</a><span class="code-text">colon is the name to add to `tiling_desktop_environments`.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L35" href="#L35">35</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L36" href="#L36">36</a><span class="code-text">If your window environment is a tiling environment and is not listed</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L37" href="#L37">37</a><span class="code-text">here, please file an issue (or even a PR!) to add it to the default</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L38" href="#L38">38</a><span class="code-text">list.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L39" href="#L39">39</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L40" href="#L40">40</a><span class="code-text">This contents of this list are used to determine a reasonable default for</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L41" href="#L41">41</a><span class="code-text">[adjust_window_size_when_changing_font_size](adjust_window_size_when_changing_font_size.md).</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L42" href="#L42">42</a><span class="code-text"></span></span></pre></div></div>
</main>
</body>
</html>
