<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>docs/config/lua/window-events/bell.md - fork/wezterm @ termwiz-0.23.2</title>
<meta name="description" content="docs/config/lua/window-events/bell.md in fork/wezterm at termwiz-0.23.2.">
<meta property="og:title" content="docs/config/lua/window-events/bell.md - fork/wezterm @ termwiz-0.23.2">
<meta property="og:description" content="docs/config/lua/window-events/bell.md in fork/wezterm at termwiz-0.23.2.">
<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.2" data-tip="8b7ca454b5e0a65b69b1b736db54eae3c195384b">
<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="40081cb5737da32058a3c87e14b84d8f2bfefdc4">docs: update a bunch of since lines to new macro</span><span class="snapshot-sha sha" data-commit="40081cb5737da32058a3c87e14b84d8f2bfefdc4">40081cb57</span><time datetime="2023-03-20T22:01:24-07:00" title="2023-03-20 22:01:24 -0700">2023-03-20</time></p>
<header class="topbar"><details class="switcher"><summary>termwiz-0.23.2</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 href="/fork/wezterm/ref/termwiz-0.23.1/">termwiz-0.23.1</a><a class="current" 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.2/tree/docs/">docs</a> / <a href="/fork/wezterm/ref/termwiz-0.23.2/tree/docs/config/">config</a> / <a href="/fork/wezterm/ref/termwiz-0.23.2/tree/docs/config/lua/">lua</a> / <a href="/fork/wezterm/ref/termwiz-0.23.2/tree/docs/config/lua/window-events/">window-events</a> / <span class="cur">bell.md</span></nav>
<span class="view-stats"><span>881 B</span><span>29 lines</span></span><span class="actions"><a class="raw" href="/fork/wezterm/raw/074d308376416f30dede91a920534ac2901d416f/docs/config/lua/window-events/bell.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>bell</code></h1>
<p>{{since('20211204-082213-a66c61ee9')}}</p>
<p>The <code>bell</code> event is emitted when the ASCII BEL sequence is emitted to
a pane in the window.</p>
<p>Defining an event handler doesn't alter wezterm's handling of the bell;
the event supplements it and allows you to take additional action over
the configured behavior.</p>
<p>The first event parameter is a <a href="../window/index.md"><code>window</code> object</a> that
represents the gui window.</p>
<p>The second event parameter is a <a href="../pane/index.md"><code>pane</code> object</a> that
represents the pane in which the bell was rung, which may not be active
pane--it could be in an unfocused pane or tab..</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-v>wezterm</a-v><a-p>.</a-p><a-f>on</a-f><a-p>(</a-p><a-s>&#39;bell&#39;</a-s><a-p>,</a-p> <a-k>function</a-k><a-p>(</a-p><a-v>window</a-v><a-p>,</a-p> <a-v>pane</a-v><a-p>)</a-p>
  <a-v>wezterm</a-v><a-p>.</a-p><a-f>log_info</a-f><a-p>(</a-p><a-s>&#39;the bell was rung in pane &#39;</a-s> <a-o>..</a-o> <a-v>pane</a-v><a-p>:</a-p><a-f>pane_id</a-f><a-p>()</a-p> <a-o>..</a-o> <a-s>&#39;!&#39;</a-s><a-p>)</a-p>
<a-k>end</a-k><a-p>)</a-p>

<a-k>return</a-k> <a-cr>{}</a-cr></pre>
<p>See also <a href="/fork/wezterm/ref/termwiz-0.23.2/blob/docs/config/lua/config/audible_bell.md">audible_bell</a> and <a href="/fork/wezterm/ref/termwiz-0.23.2/blob/docs/config/lua/config/visual_bell.md">visual_bell</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>`bell`</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;20211204-082213-a66c61ee9&#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">The `bell` event is emitted when the ASCII BEL sequence is emitted to</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text">a pane in the window.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text">Defining an event handler doesn&#39;t alter wezterm&#39;s handling of the bell;</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text">the event supplements it and allows you to take additional action over</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 configured behavior.</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">The first event parameter is a [`window` object](../window/index.md) that</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text">represents the gui window.</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">The second event parameter is a [`pane` object](../pane/index.md) that</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text">represents the pane in which the bell was rung, which may not be active</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L17" href="#L17">17</a><span class="code-text">pane--it could be in an unfocused pane or tab..</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L18" href="#L18">18</a><span class="code-text"></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-tl>lua</a-tl></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>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="L21" href="#L21">21</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L22" href="#L22">22</a><span class="code-text"><a-p>wezterm.</a-p><a-f>on</a-f><a-p>(</a-p><a-s>&#39;bell&#39;</a-s><a-p>, </a-p><a-k>function</a-k><a-p>(</a-p><a-v>window</a-v><a-p>, </a-p><a-v>pane</a-v><a-p>)</a-p></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>  </a-p><a-v>wezterm</a-v><a-p>.</a-p><a-f>log_info</a-f><a-p>(</a-p><a-s>&#39;the bell was rung in pane &#39;</a-s><a-p> </a-p><a-o>..</a-o><a-p> </a-p><a-v>pane</a-v><a-p>:</a-p><a-f>pane_id</a-f><a-p>() </a-p><a-o>..</a-o><a-p> </a-p><a-s>&#39;!&#39;</a-s><a-p>)</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>end)</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>return </a-p><a-cr>{}</a-cr></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>```</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">See also [audible_bell](../config/audible_bell.md) and [visual_bell](../config/visual_bell.md).</span></span></pre></div></div>
</main>
</body>
</html>
