mirror of
https://github.com/ghostty-org/ghostty.git
synced 2026-04-14 03:25:50 +00:00
4128e6a38c
Add a comprehensive "Effects" section to the terminal module documentation in terminal.h explaining the callback system that lets embedding applications react to terminal-initiated events (bell, title changes, pty writes, device queries, etc.). The section includes a reference table of all available effects and their triggers, plus @snippet references to the new example. Add c-vt-effects example project demonstrating how to register write_pty, bell, and title_changed callbacks, attach userdata, and feed VT data that triggers each effect.
19 lines
482 B
Markdown
19 lines
482 B
Markdown
# Example: `ghostty-vt` Terminal Effects
|
|
|
|
This contains a simple example of how to register and use terminal
|
|
effect callbacks (`write_pty`, `bell`, `title_changed`) with the
|
|
`ghostty-vt` C library.
|
|
|
|
This uses a `build.zig` and `Zig` to build the C program so that we
|
|
can reuse a lot of our build logic and depend directly on our source
|
|
tree, but Ghostty emits a standard C library that can be used with any
|
|
C tooling.
|
|
|
|
## Usage
|
|
|
|
Run the program:
|
|
|
|
```shell-session
|
|
zig build run
|
|
```
|