<!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/copy_to_clipboard.md - fork/wezterm @ termwiz-0.23.0</title>
<meta name="description" content="docs/config/lua/window/copy_to_clipboard.md in fork/wezterm at termwiz-0.23.0.">
<meta property="og:title" content="docs/config/lua/window/copy_to_clipboard.md - fork/wezterm @ termwiz-0.23.0">
<meta property="og:description" content="docs/config/lua/window/copy_to_clipboard.md in fork/wezterm at termwiz-0.23.0.">
<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.0" data-tip="958804c8ac16b750954b3bcaaf847e7498cd2205">
<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.0</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 class="current" 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 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.0/tree/docs/">docs</a> / <a href="/fork/wezterm/ref/termwiz-0.23.0/tree/docs/config/">config</a> / <a href="/fork/wezterm/ref/termwiz-0.23.0/tree/docs/config/lua/">lua</a> / <a href="/fork/wezterm/ref/termwiz-0.23.0/tree/docs/config/lua/window/">window</a> / <span class="cur">copy_to_clipboard.md</span></nav>
<span class="view-stats"><span>1.1 KiB</span><span>33 lines</span></span><span class="actions"><a class="raw" href="/fork/wezterm/raw/20eb84f2be20a4ac6c915f9e8d2b25b3d531d621/docs/config/lua/window/copy_to_clipboard.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>window:copy_to_clipboard(text [,clipboard])</h1>
<p>{{since('20220807-113146-c2fee766')}}</p>
<p>Puts <code>text</code> into the specified <code>clipboard</code>.</p>
<p>Clipboard can be one of:</p>
<ul>
<li><code>"Clipboard"</code> - the system clipboard</li>
<li><code>"PrimarySelection"</code> - the primary selection buffer (applicable to X11 and some Wayland systems only)</li>
<li><code>"ClipboardAndPrimarySelection"</code> - both the system clipboard and the primary selection.  This is the default if you don't specify the clipboard.</li>
</ul>
<p>Note that updating the clipboard is asynchronous; this method will return
immediately while the clipboard is updated a few moments later in another
thread. If you need to ensure that the published text is visible to other
applications before you trigger some other action in your lua code then you may
need to add a short sleep to allow for that to complete.</p>
<pre class="language-lua"><a-v>window</a-v><a-p>:</a-p><a-f>copy_to_clipboard</a-f> <a-s>&#39;put this text in the clipboard and primary selection!&#39;</a-s></pre>
<pre class="language-lua"><a-v>window</a-v><a-p>:</a-p><a-f>copy_to_clipboard</a-f><a-p>(</a-p><a-s>&#39;put me in the clipboard only&#39;</a-s><a-p>,</a-p> <a-s>&#39;Clipboard&#39;</a-s><a-p>)</a-p></pre>
<pre class="language-lua"><a-v>window</a-v><a-p>:</a-p><a-f>copy_to_clipboard</a-f><a-p>(</a-p>
  <a-s>&#39;put me in the primary selection&#39;</a-s><a-p>,</a-p>
  <a-s>&#39;PrimarySelection&#39;</a-s>
<a-p>)</a-p></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> <a-tt>window:copy_to_clipboard(text \[,clipboard\])</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;20220807-113146-c2fee766&#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">Puts `text` into the specified `clipboard`.</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">Clipboard can be one of:</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"><a-p>* </a-p>`&quot;Clipboard&quot;` - the system clipboard</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>`&quot;PrimarySelection&quot;` - the primary selection buffer (applicable to X11 and some Wayland systems only)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text"><a-p>* </a-p>`&quot;ClipboardAndPrimarySelection&quot;` - both the system clipboard and the primary selection.  This is the default if you don&#39;t specify the clipboard.</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"><a-p>Note that updating the clipboard is asynchronous; this method will return</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>immediately while the clipboard is updated a few moments later in another</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>thread. If you need to ensure that the published text is visible to other</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>applications before you trigger some other action in your lua code then you may</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>need to add a short sleep to allow for that to complete.</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"></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>window:</a-p><a-f>copy_to_clipboard</a-f><a-p> </a-p><a-s>&#39;put this text in the clipboard and primary selection!&#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"><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>```</a-p><a-tl>lua</a-tl></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>window:</a-p><a-f>copy_to_clipboard</a-f><a-p>(</a-p><a-s>&#39;put me in the clipboard only&#39;</a-s><a-p>, </a-p><a-s>&#39;Clipboard&#39;</a-s><a-p>)</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"><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"></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><a-tl>lua</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L28" href="#L28">28</a><span class="code-text"><a-p>window:</a-p><a-f>copy_to_clipboard</a-f><a-p>(</a-p></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>  </a-p><a-s>&#39;put me in the primary selection&#39;</a-s><a-p>,</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"><a-p>  </a-p><a-s>&#39;PrimarySelection&#39;</a-s></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>)</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>```</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></pre></div></div>
</main>
</body>
</html>
