<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>docs/config/lua/keyassignment/SendString.md - fork/wezterm @ termwiz-0.23.2</title>
<meta name="description" content="docs/config/lua/keyassignment/SendString.md in fork/wezterm at termwiz-0.23.2.">
<meta property="og:title" content="docs/config/lua/keyassignment/SendString.md - fork/wezterm @ termwiz-0.23.2">
<meta property="og:description" content="docs/config/lua/keyassignment/SendString.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">Benoit de Chezelles</span><span class="commit-message" data-commit="f37c3ae5daaff27ecb885f4eed86ddb5784fdb59">Fix some documentation pages (#3321)</span><span class="snapshot-sha sha" data-commit="f37c3ae5daaff27ecb885f4eed86ddb5784fdb59">f37c3ae5d</span><time datetime="2023-03-22T14:36:03+01:00" title="2023-03-22 14:36:03 +0100">2023-03-22</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/keyassignment/">keyassignment</a> / <span class="cur">SendString.md</span></nav>
<span class="view-stats"><span>1016 B</span><span>30 lines</span></span><span class="actions"><a class="raw" href="/fork/wezterm/raw/96eb6d317b6696cca6cb40932191ccc6474e3ebd/docs/config/lua/keyassignment/SendString.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>SendString</code></h1>
<p>Sends the string specified argument to the terminal in the current tab, as
though that text were literally typed into the terminal.</p>
<pre class="language-lua"><a-v>config</a-v><a-p>.</a-p><a-v>keys</a-v> = <a-cr>{</a-cr>
  <a-cr>{</a-cr> <a-v>key</a-v> = <a-s>&#39;m&#39;</a-s><a-p>,</a-p> <a-v>mods</a-v> = <a-s>&#39;CMD&#39;</a-s><a-p>,</a-p> <a-v>action</a-v> = <a-v>wezterm</a-v><a-p>.</a-p><a-v>action</a-v><a-p>.</a-p><a-f>SendString</a-f> <a-s>&#39;Hello&#39;</a-s> <a-cr>}</a-cr><a-p>,</a-p>
<a-cr>}</a-cr></pre>
<p>You can also emit escape sequences using <code>SendString</code>.  This example shows
how to bind Alt-LeftArrow/RightArrow to the Alt-b/f, an emacs style
keybinding for moving backwards/forwards through a word in a line editor.</p>
<p><code>\x1b</code> is the ESC character:</p>
<pre class="language-lua"><a-k>local</a-k> <a-v>act</a-v> = <a-v>wezterm</a-v><a-p>.</a-p><a-v>action</a-v>

<a-v>config</a-v><a-p>.</a-p><a-v>keys</a-v> = <a-cr>{</a-cr>
  <a-c>-- Make Option-Left equivalent to Alt-b which many line editors interpret as backward-word</a-c>
  <a-cr>{</a-cr> <a-v>key</a-v> = <a-s>&#39;LeftArrow&#39;</a-s><a-p>,</a-p> <a-v>mods</a-v> = <a-s>&#39;OPT&#39;</a-s><a-p>,</a-p> <a-v>action</a-v> = <a-v>act</a-v><a-p>.</a-p><a-f>SendString</a-f> <a-s>&#39;\x1bb&#39;</a-s> <a-cr>}</a-cr><a-p>,</a-p>
  <a-c>-- Make Option-Right equivalent to Alt-f; forward-word</a-c>
  <a-cr>{</a-cr> <a-v>key</a-v> = <a-s>&#39;RightArrow&#39;</a-s><a-p>,</a-p> <a-v>mods</a-v> = <a-s>&#39;OPT&#39;</a-s><a-p>,</a-p> <a-v>action</a-v> = <a-v>act</a-v><a-p>.</a-p><a-f>SendString</a-f> <a-s>&#39;\x1bf&#39;</a-s> <a-cr>}</a-cr><a-p>,</a-p>
<a-cr>}</a-cr></pre>
<p>See also <a href="/fork/wezterm/ref/termwiz-0.23.2/blob/docs/config/lua/keyassignment/SendKey.md">SendKey</a> which makes the example above much more convenient,
and <a href="/fork/wezterm/ref/termwiz-0.23.2/blob/docs/config/lua/keyassignment/Multiple.md">Multiple</a> for combining multiple actions in a single press.</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>`SendString`</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">Sends the string specified argument to the terminal in the current tab, as</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text">though that text were literally typed into the terminal.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text"></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-p>```</a-p><a-tl>lua</a-tl></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>config.</a-p><a-v>keys</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="L8" href="#L8">8</a><span class="code-text"><a-p>  </a-p><a-cr>{</a-cr><a-p> </a-p><a-v>key</a-v><a-p> = </a-p><a-s>&#39;m&#39;</a-s><a-p>, </a-p><a-v>mods</a-v><a-p> = </a-p><a-s>&#39;CMD&#39;</a-s><a-p>, </a-p><a-v>action</a-v><a-p> = </a-p><a-v>wezterm</a-v><a-p>.</a-p><a-v>action</a-v><a-p>.</a-p><a-f>SendString</a-f><a-p> </a-p><a-s>&#39;Hello&#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="L9" href="#L9">9</a><span class="code-text"><a-p>}</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text"><a-p>```</a-p></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>You can also emit escape sequences using `SendString`.  This example shows</a-p></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>how to bind Alt-LeftArrow/RightArrow to the Alt-b/f, an emacs style</a-p></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>keybinding for moving backwards/forwards through a word in a line editor.</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"></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>`\x1b` is the ESC character:</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"></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><a-tl>lua</a-tl></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>local </a-p><a-v>act</a-v><a-p> = </a-p><a-v>wezterm</a-v><a-p>.</a-p><a-v>action</a-v></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>config.</a-p><a-v>keys</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="L22" href="#L22">22</a><span class="code-text"><a-p>  </a-p><a-c>-- Make Option-Left equivalent to Alt-b which many line editors interpret as backward-word</a-c></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-cr>{</a-cr><a-p> </a-p><a-v>key</a-v><a-p> = </a-p><a-s>&#39;LeftArrow&#39;</a-s><a-p>, </a-p><a-v>mods</a-v><a-p> = </a-p><a-s>&#39;OPT&#39;</a-s><a-p>, </a-p><a-v>action</a-v><a-p> = </a-p><a-v>act</a-v><a-p>.</a-p><a-f>SendString</a-f><a-p> </a-p><a-s>&#39;\x1bb&#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="L24" href="#L24">24</a><span class="code-text"><a-p>  </a-p><a-c>-- Make Option-Right equivalent to Alt-f; forward-word</a-c></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>  </a-p><a-cr>{</a-cr><a-p> </a-p><a-v>key</a-v><a-p> = </a-p><a-s>&#39;RightArrow&#39;</a-s><a-p>, </a-p><a-v>mods</a-v><a-p> = </a-p><a-s>&#39;OPT&#39;</a-s><a-p>, </a-p><a-v>action</a-v><a-p> = </a-p><a-v>act</a-v><a-p>.</a-p><a-f>SendString</a-f><a-p> </a-p><a-s>&#39;\x1bf&#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="L26" href="#L26">26</a><span class="code-text"><a-p>}</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>```</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 [SendKey](SendKey.md) which makes the example above much more convenient,</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L30" href="#L30">30</a><span class="code-text">and [Multiple](Multiple.md) for combining multiple actions in a single press.</span></span></pre></div></div>
</main>
</body>
</html>
