wez/wezterm
1
1
Fork 0
mirror of https://github.com/wez/wezterm.git synced 2024-11-13 07:22:52 +03:00
Code Issues Projects Releases Wiki Activity
51d7b28fb5
wezterm/termwiz
History
Wez Furlong 0f8146b212
docs: shift from return {} style to config.something style 
Nudge new users towards using this style:

```lua
local config = {}
config.color_scheme = 'Batman'
return config
```

and surface how to write lua modules closer to the main section
on config files. In that lua modules section, nudge towards using
a convention similar to that of the plugin spec described in
this commit: e4ae8a844d
2023-03-19 18:26:21 -07:00
..
benches termwiz: add bench for Cell creation/drop 2022-07-22 19:23:53 -07:00
codegen termwiz: update nerdfont symbol data 2022-09-17 07:36:24 -07:00
data wezterm.terminfo: add statusline entries 2022-11-06 20:57:58 -07:00
examples docs: shift from return {} style to config.something style 2023-03-19 18:26:21 -07:00
fuzz Add fuzzer for termwiz::escape::parser 2022-05-14 08:18:08 -07:00
src fix non-serde termwiz build 2023-03-18 22:21:42 -07:00
Cargo.toml ImageDataType::File -> EncodedLease 2023-03-18 20:32:49 -07:00
CHANGELOG.md termwiz: bump version ready for publish 2023-02-12 06:57:31 -07:00
LICENSE.md restructure termwiz tree prior to merging into wezterm repo 2018-08-05 07:55:30 -07:00
README.md termwiz: cut 0.9.0 release 2020-05-17 12:05:46 -07:00

README.md

Terminal Wizardry

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.

It is currently in active development and subject to fairly wild sweeping changes.

Included functionality:

  • Surface models a terminal display and its component Cells
  • Terminal attributes are aware of modern features such as True Color, Hyperlinks and will also support sixel and iterm style terminal graphics display.
  • Surfaces include a log of Changes and an API for consuming and applying deltas. This is a powerful building block for synchronizing screen instances.
  • 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.
  • Capabilities allows probing for terminal capabilities that may not be included in the system terminfo database, and overriding them in an embedding application.
  • Terminal trait provides an abstraction over unix style ttys and Windows style console APIs. Changes from Surface can be rendered to Terminals. Terminals allow decoding mouse and keyboard inputs in both blocking or non-blocking mode.
  • Widget trait allows composition of UI elements at a higher level.
  • LineEditor implements shell-like line editing functionality.

Windows Support

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.

Documentation

https://docs.rs/termwiz