Applied-Software/ghostty
5
0
Fork 0
mirror of https://github.com/ghostty-org/ghostty.git synced 2025-04-12 10:48:39 +03:00
Code Issues Packages Projects Releases Wiki Activity

lint all Md files

Browse Source
This commit is contained in:
Patrick Fong
2023-09-28 10:27:15 -07:00
parent 28b7782bbe
commit 8be80558c7
18 changed files with 141 additions and 143 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@ -45,7 +45,7 @@ things, but I've been using it full time since April 2022.
## Download
| Platform / Package | Links | Notes |
| ----------| ----- | ----- |
| ------------------ | ------------------------------------------------------------------------ | -------------------------- |
| macOS | [Tip ("Nightly")](https://github.com/mitchellh/ghostty/releases/tag/tip) | MacOS 12+ Universal Binary |
| Linux | [Build from Source](#developing-ghostty) | |
| Windows | n/a | Not supported yet |
@ -134,11 +134,11 @@ to support many of the features that
The currently support shell integration features in Ghostty:
* We do not confirm close for windows where the cursor is at a prompt.
* New terminals start in the working directory of the previously focused terminal.
* Complex prompts resize correctly by allowing the shell to redraw the prompt line.
* The cursor at the prompt is turned into a bar.
* The `jump_to_prompt` keybinding can be used to scroll the terminal window
- We do not confirm close for windows where the cursor is at a prompt.
- New terminals start in the working directory of the previously focused terminal.
- Complex prompts resize correctly by allowing the shell to redraw the prompt line.
- The cursor at the prompt is turned into a bar.
- The `jump_to_prompt` keybinding can be used to scroll the terminal window
forward and back through prompts.
#### Shell Integration Installation and Verification
@ -209,7 +209,7 @@ goes for any other shell.
The high-level ambitious plan for the project, in order:
| # | Step | Status |
|:---:|------|:------:|
| :-: | ----------------------------------------------------------- | :----: |
| 1 | [Standards-compliant terminal emulation](docs/sequences.md) | ⚠️ |
| 2 | Competitive performance | ✅ |
| 3 | Basic customizability -- fonts, bg colors, etc. | ✅ |
@ -261,10 +261,10 @@ Ghostty is a cross-platform terminal emulator but we don't aim for a
least-common-denominator experience. There is a large, shared core written
in Zig but we do a lot of platform-native things:
* The macOS app is a true SwiftUI-based application with all the things you
- The macOS app is a true SwiftUI-based application with all the things you
would expect such as real windowing, menu bars, a settings GUI, etc.
* macOS uses a true Metal renderer with CoreText for font discovery.
* The Linux app is built with GTK.
- macOS uses a true Metal renderer with CoreText for font discovery.
- The Linux app is built with GTK.
There are more improvements to be made. The macOS settings window is still
a work-in-progress. Similar improvements will follow with Linux.
@ -310,8 +310,8 @@ tasks.
Other useful commands:
* `zig build test` for running unit tests.
* `zig build run -Dconformance=<name>` runs a conformance test case from
- `zig build test` for running unit tests.
- `zig build run -Dconformance=<name>` runs a conformance test case from
the `conformance` directory. The `name` is the name of the file. This runs
in the current running terminal emulator so if you want to check the
behavior of this project, you must run this command in ghostty.

18
TODO.md
View File

@ -1,15 +1,15 @@
Performance:
* for scrollback, investigate using segmented list for sufficiently large
- for scrollback, investigate using segmented list for sufficiently large
scrollback scenarios.
* Loading fonts on startups should probably happen in multiple threads
* `deleteLines` is very, very slow which makes scroll region benchmarks terrible
- Loading fonts on startups should probably happen in multiple threads
- `deleteLines` is very, very slow which makes scroll region benchmarks terrible
Correctness:
* test wrap against wraptest: https://github.com/mattiase/wraptest
- test wrap against wraptest: https://github.com/mattiase/wraptest
- automate this in some way
* Charsets: UTF-8 vs. ASCII mode
- Charsets: UTF-8 vs. ASCII mode
- we only support UTF-8 input right now
- need fallback glyphs if they're not supported
- can effect a crash using `vttest` menu `3 10` since it tries to parse
@ -17,13 +17,13 @@ Correctness:
Improvements:
* scrollback: configurable
- scrollback: configurable
Mac:
* Preferences window
- Preferences window
Major Features:
* Bell
* Sixels: https://saitoha.github.io/libsixel/
- Bell
- Sixels: https://saitoha.github.io/libsixel/

11
docs/sequences.md
View File

@ -3,7 +3,6 @@
⚠️ **This is super out of date. Ghostty's support is much better
than this document seems. TODO to update this.** ⚠️
This is the list of control and escape sequences known in the ecosystem
of terminal emulators and their implementation status in ghostty. Note that
some control sequences may never be implemented in ghostty. In these scenarios,
@ -11,18 +10,18 @@ it is noted why.
Status meanings:
* ✅ - Implementation is complete and considered 100% accurate.
* ⚠️ - Implementation works, but may be missing some functionality. The
- ✅ - Implementation is complete and considered 100% accurate.
- ⚠️ - Implementation works, but may be missing some functionality. The
details of how well it works or doesn't are in the linked page. In many
cases, the missing functionality is very specific or esoteric. Regardless,
we don't consider a sequence a green checkmark until all known feature
interactions are complete.
* ❌ - Implementation is effectively non-functional, but ghostty continues
- ❌ - Implementation is effectively non-functional, but ghostty continues
in the face of it (probably in some broken state).
* 💥 - Ghostty crashes if this control sequence is sent.
- 💥 - Ghostty crashes if this control sequence is sent.
| ID | ASCII | Name | Status |
|:---:|:-----:|:-----|:------:|
| :---: | :-----: | :----------------------------------------- | :----: |
| `ENQ` | `0x05` | [Enquiry](sequences/enq.md) | ✅ |
| `BEL` | `0x07` | [Bell](sequences/bel.md) | ❌ |
| `BS` | `0x08` | [Backspace](sequences/bs.md) | ⚠️ |

12
docs/sequences/bel.md
View File

@ -1,7 +1,7 @@
# Bell
| | |
| --- | --- |
| ---- | ------ |
| Text | |
| Hex | `0x07` |
@ -9,16 +9,16 @@ Rings a "bell" to alert the operator to some condition.
## Implementation Details
* ghostty logs "BELL"
- ghostty logs "BELL"
## TODO
* Add a configurable visual bell -- common in most terminal emulators --
- Add a configurable visual bell -- common in most terminal emulators --
to flash the border.
* Mark the window as requesting attention, most operating systems support
- Mark the window as requesting attention, most operating systems support
this. For example, Windows windows will flash in the toolbar.
* Support an audible bell.
- Support an audible bell.
## References
* https://vt100.net/docs/vt100-ug/chapter3.html
- https://vt100.net/docs/vt100-ug/chapter3.html

6
docs/sequences/bs.md
View File

@ -1,7 +1,7 @@
# Backspace
| | |
| --- | --- |
| ---- | ------ |
| Text | |
| Hex | `0x08` |
@ -11,9 +11,9 @@ TODO: Details about how this interacts with soft wrapping.
## Implementation Details
* ghostty implements this naively as `cursor.x -|= 1` (`-|=` being a
- ghostty implements this naively as `cursor.x -|= 1` (`-|=` being a
saturating subtraction).
## TODO
* Soft wrap integration
- Soft wrap integration

2
docs/sequences/can.md
View File

@ -1,7 +1,7 @@
# Cancel Parsing
| | |
| --- | --- |
| ---- | ---------------- |
| Text | |
| Hex | `0x18` or `0x1A` |

6
docs/sequences/cr.md
View File

@ -1,7 +1,7 @@
# Carriage Return
| | |
| --- | --- |
| ---- | ------ |
| Text | |
| Hex | `0x0D` |
@ -9,5 +9,5 @@ Moves the cursor to the left-most column and resets any pending wrap flags.
## TODO
* Integration with left/right scrolling margins
* Integration with origin mode
- Integration with left/right scrolling margins
- Integration with origin mode

8
docs/sequences/enq.md
View File

@ -1,7 +1,7 @@
# Enquiry (Answerback)
| | |
| --- | --- |
| ---- | ------ |
| Text | |
| Hex | `0x05` |
@ -10,12 +10,12 @@ operator.
## Implementation Details
* ghostty always sends `""`
- ghostty always sends `""`
## TODO
* Make the answerback configurable
- Make the answerback configurable
## References
* https://vt100.net/docs/vt100-ug/chapter3.html
- https://vt100.net/docs/vt100-ug/chapter3.html

2
docs/sequences/ff.md
View File

@ -1,7 +1,7 @@
# Form Feed
| | |
| --- | --- |
| ---- | ------ |
| Text | |
| Hex | `0x0C` |

2
docs/sequences/hts.md
View File

@ -1,7 +1,7 @@
# Horizontal Tab Set
| | |
| --- | --- |
| ---- | ----------- |
| Text | `ESC H` |
| Hex | `0x18 0x48` |

8
docs/sequences/ind.md
View File

@ -1,7 +1,7 @@
# Index
| | |
| --- | --- |
| ---- | ----------- |
| Text | `ESC D` |
| Hex | `0x18 0x44` |
@ -10,10 +10,10 @@ if necessary. This always unsets the pending wrap state.
If the cursor is currently outside the scrolling region:
* move the cursor down one line if it is not on bottom line of the screen.
- move the cursor down one line if it is not on bottom line of the screen.
If the cursor is inside the scrolling region:
* If the cursor is on the bottom-most line of the screen: invoke
- If the cursor is on the bottom-most line of the screen: invoke
[scroll up](su.md) with the value `1`.
* Else: move the cursor one line down.
- Else: move the cursor one line down.

4
docs/sequences/lf.md
View File

@ -1,7 +1,7 @@
# Linefeed
| | |
| --- | --- |
| ---- | ------ |
| Text | |
| Hex | `0x0A` |
@ -9,4 +9,4 @@ Invoke [Index](ind.md).
## TODO
* Linefeed mode (mode 20)
- Linefeed mode (mode 20)

2
docs/sequences/nel.md
View File

@ -1,7 +1,7 @@
# Index
| | |
| --- | --- |
| ---- | ----------- |
| Text | `ESC E` |
| Hex | `0x18 0x45` |

10
docs/sequences/ri.md
View File

@ -1,7 +1,7 @@
# Reverse Index
| | |
| --- | --- |
| ---- | ----------- |
| Text | `ESC M` |
| Hex | `0x18 0x4D` |
@ -9,13 +9,13 @@ Reverse [index](ind.md). This unsets the pending wrap state.
If the cursor is outside of the scrolling region:
* move the cursor one line up unless it is the top-most line of the screen.
- move the cursor one line up unless it is the top-most line of the screen.
If the cursor is inside the scrolling region:
* If the cursor is on the top-most line: invoke [scroll down](#) with value `1`
* Else: move the cursor one line up.
- If the cursor is on the top-most line: invoke [scroll down](#) with value `1`
- Else: move the cursor one line up.
## TODO
* Scroll region edge cases
- Scroll region edge cases

6
docs/sequences/tab.md
View File

@ -1,7 +1,7 @@
# Tab
| | |
| --- | --- |
| ---- | ------ |
| Text | |
| Hex | `0x09` |
@ -17,5 +17,5 @@ Initially, tab stops are set on every 8th column.
## TODO
* Integration with left/right margins of the scrolling region.
* How does horizontal tab interact with the pending wrap state?
- Integration with left/right margins of the scrolling region.
- How does horizontal tab interact with the pending wrap state?

2
docs/sequences/vt.md
View File

@ -1,7 +1,7 @@
# Vertical Tab
| | |
| --- | --- |
| ---- | ------ |
| Text | |
| Hex | `0x0B` |

1
test/README.md
View File

@ -38,4 +38,3 @@ the full test suite against only a single terminal emulator.
This test suite expects the `ghostty` binary to be in _this directory_.
You can manually copy it into place. Each time you modify the binary, you
must rebuild the Docker image.