<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>termwiz/README.md - fork/wezterm @ termwiz-0.23.1</title>
<meta name="description" content="termwiz/README.md in fork/wezterm at termwiz-0.23.1.">
<meta property="og:title" content="termwiz/README.md - fork/wezterm @ termwiz-0.23.1">
<meta property="og:description" content="termwiz/README.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="1ad6f00696ea7d4588ee7eeb93f4189f155871fa">termwiz: cut 0.9.0 release</span><span class="snapshot-sha sha" data-commit="1ad6f00696ea7d4588ee7eeb93f4189f155871fa">1ad6f0069</span><time datetime="2020-05-17T12:03:15-07:00" title="2020-05-17 12:03:15 -0700">2020-05-17</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/termwiz/">termwiz</a> / <span class="cur">README.md</span></nav>
<span class="view-stats"><span>1.9 KiB</span><span>46 lines</span></span><span class="actions"><a class="raw" href="/fork/wezterm/raw/edfd4726a8646f0f1f22c719efd24ee86ce3c035/termwiz/README.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>Terminal Wizardry</h1>
<p>This is a rust crate that provides a number of support functions for
applications interested in either displaying data to a terminal or in building
a terminal emulator.</p>
<p>It is currently in active development and subject to fairly wild sweeping
changes.</p>
<p>Included functionality:</p>
<ul>
<li><code>Surface</code> models a terminal display and its component <code>Cell</code>s</li>
<li>Terminal attributes are aware of modern features such as
True Color, <a href="https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda">Hyperlinks</a>
and will also support sixel and iterm style terminal graphics display.</li>
<li><code>Surface</code>s include a log of <code>Change</code>s and an API for consuming
and applying deltas.  This is a powerful building block for
synchronizing screen instances.</li>
<li>Escape sequence parser decodes inscrutable escape sequences
and gives them semantic meaning, making the code that uses
them clearer.  The decoded escapes can be re-encoded, allowing
applications to start with the semantic meaning and emit
the appropriate escape sequence without embedding obscure
binary bytes.</li>
<li><code>Capabilities</code> allows probing for terminal capabilities
that may not be included in the system terminfo database,
and overriding them in an embedding application.</li>
<li><code>Terminal</code> trait provides an abstraction over unix style ttys
and Windows style console APIs.  <code>Change</code>s from <code>Surface</code>
can be rendered to <code>Terminal</code>s.  <code>Terminal</code>s allow decoding
mouse and keyboard inputs in both blocking or non-blocking
mode.</li>
<li><code>Widget</code> trait allows composition of UI elements at a higher level.</li>
<li><code>LineEditor</code> implements shell-like line editing functionality.</li>
</ul>
<h1>Windows Support</h1>
<p>Termwiz understands how to work with both the legacy console APIs and
the new PTY and virtual terminal features available in Windows 10,
allowing for true color terminal applications on Windows 10.</p>
<h1>Documentation</h1>
<p>https://docs.rs/termwiz</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>Terminal Wizardry</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">This is a rust crate that provides a number of support functions for</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text">applications interested in either displaying data to a terminal or in building</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 terminal emulator.</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">It is currently in active development and subject to fairly wild sweeping</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text">changes.</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">Included functionality:</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>`Surface` models a terminal display and its component `Cell`s</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>* </a-p>Terminal attributes are aware of modern features such as</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>True Color, [Hyperlinks](https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda)</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>and will also support sixel and iterm style terminal graphics display.</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>`Surface`s include a log of `Change`s and an API for consuming</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>and applying deltas.  This is a powerful building block for</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>synchronizing screen instances.</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>Escape sequence parser decodes inscrutable escape sequences</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>and gives them semantic meaning, making the code that uses</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>them clearer.  The decoded escapes can be re-encoded, allowing</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>applications to start with the semantic meaning and emit</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>the appropriate escape sequence without embedding obscure</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>binary bytes.</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>`Capabilities` allows probing for terminal capabilities</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>that may not be included in the system terminfo database,</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>and overriding them in an embedding application.</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>* </a-p>`Terminal` trait provides an abstraction over unix style ttys</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>and Windows style console APIs.  `Change`s from `Surface`</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>can be rendered to `Terminal`s.  `Terminal`s allow decoding</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>mouse and keyboard inputs in both blocking or non-blocking</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>mode.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L33" href="#L33">33</a><span class="code-text"><a-p>* </a-p>`Widget` trait allows composition of UI elements at a higher level.</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>`LineEditor` implements shell-like line editing functionality.</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"><a-p># </a-p><a-tt>Windows Support</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L37" href="#L37">37</a><span class="code-text"></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>Termwiz understands how to work with both the legacy console APIs and</a-p></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>the new PTY and virtual terminal features available in Windows 10,</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>allowing for true color terminal applications on Windows 10.</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"></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-tt>Documentation</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L43" href="#L43">43</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L44" href="#L44">44</a><span class="code-text">https://docs.rs/termwiz</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"></span></span></pre></div></div>
</main>
</body>
</html>
