mirrors/ghostty
1
0
Fork 0
mirror of https://github.com/ghostty-org/ghostty.git synced 2026-04-20 22:35:20 +00: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
Download Patch File Download Diff File Expand all files Collapse all files

20
docs/sequences/bel.md
View File

@@ -1,24 +1,24 @@
# Bell
| | |
| --- | --- |
| | |
| ---- | ------ |
| Text | |
| Hex | `0x07` |
| Hex | `0x07` |
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 --
to flash the border.
* Mark the window as requesting attention, most operating systems support
this. For example, Windows windows will flash in the toolbar.
* Support an audible bell.
- Add a configurable visual bell -- common in most terminal emulators --
to flash the border.
- Mark the window as requesting attention, most operating systems support
this. For example, Windows windows will flash in the toolbar.
- Support an audible bell.
## References
* https://vt100.net/docs/vt100-ug/chapter3.html
- https://vt100.net/docs/vt100-ug/chapter3.html

12
docs/sequences/bs.md
View File

@@ -1,9 +1,9 @@
# Backspace
| | |
| --- | --- |
| | |
| ---- | ------ |
| Text | |
| Hex | `0x08` |
| Hex | `0x08` |
Move the cursor left one cell.
@@ -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
saturating subtraction).
- ghostty implements this naively as `cursor.x -|= 1` (`-|=` being a
saturating subtraction).
## TODO
* Soft wrap integration
- Soft wrap integration

8
docs/sequences/can.md
View File

@@ -1,9 +1,9 @@
# Cancel Parsing
| | |
| --- | --- |
| Text | |
| Hex | `0x18` or `0x1A` |
| | |
| ---- | ---------------- |
| Text | |
| Hex | `0x18` or `0x1A` |
Cancels sequence parsing. Any partially completed sequence such as `ESC`
can send `0x18` and revert back to an unparsed state. The sequence characters

10
docs/sequences/cr.md
View File

@@ -1,13 +1,13 @@
# Carriage Return
| | |
| --- | --- |
| | |
| ---- | ------ |
| Text | |
| Hex | `0x0D` |
| Hex | `0x0D` |
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

12
docs/sequences/enq.md
View File

@@ -1,21 +1,21 @@
# Enquiry (Answerback)
| | |
| --- | --- |
| | |
| ---- | ------ |
| Text | |
| Hex | `0x05` |
| Hex | `0x05` |
Sends an answerback string. In the VT100, this was configurable by the
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

6
docs/sequences/ff.md
View File

@@ -1,8 +1,8 @@
# Form Feed
| | |
| --- | --- |
| | |
| ---- | ------ |
| Text | |
| Hex | `0x0C` |
| Hex | `0x0C` |
Equivalent to [linefeed](lf.md).

4
docs/sequences/hts.md
View File

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

12
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
[scroll up](su.md) with the value `1`.
* Else: move the cursor one line down.
- 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.

8
docs/sequences/lf.md
View File

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

4
docs/sequences/nel.md
View File

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

12
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

10
docs/sequences/tab.md
View File

@@ -1,9 +1,9 @@
# Tab
| | |
| --- | --- |
| | |
| ---- | ------ |
| Text | |
| Hex | `0x09` |
| Hex | `0x09` |
Move the cursor right to the next tab stop.
@@ -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?

6
docs/sequences/vt.md
View File

@@ -1,8 +1,8 @@
# Vertical Tab
| | |
| --- | --- |
| | |
| ---- | ------ |
| Text | |
| Hex | `0x0B` |
| Hex | `0x0B` |
Equivalent to [linefeed](lf.md).