norohind/kmscon
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

vte: improve docs

Browse Source 
Add parser-links to the docs and add summary comment to the vte.c source file.

Signed-off-by: David Herrmann <dh.herrmann@googlemail.com>
This commit is contained in:
David Herrmann 2012-03-01 11:37:27 +01:00
parent c343e6cef2
commit 32cb165e40
2 changed files with 21 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/vte.txt
View File

@ -1,8 +1,8 @@
= KMSCON Virtual Terminal Emulator = = KMSCON Virtual Terminal Emulator =
The KMSCON Virtual Terminal Emulator (VTE) tries to be linux-console and xterm The KMSCON Virtual Terminal Emulator (VTE) tries to be linux-console, xterm and
compatible. This documentations contains links to several resources related to vt102 compatible. This documentations contains links to several resources
VT100-like terminals. related to VT100-like terminals.
Resources: Resources:
Terminfo database: Terminfo database:
@ -23,6 +23,8 @@ Resources:
http://en.wikipedia.org/wiki/Control_Sequence_Introducer http://en.wikipedia.org/wiki/Control_Sequence_Introducer
vttest Terminal Tests: vttest Terminal Tests:
http://invisible-island.net/vttest/ http://invisible-island.net/vttest/
vt100-vt520 docs:
http://vt100.net/
Implementations: Implementations:
XTerm: XTerm:

17
src/vte.c
View File

@ -30,7 +30,22 @@
* console subsystem as output and is tightly bound to it. It supports * console subsystem as output and is tightly bound to it. It supports
* functionality from vt100 up to vt500 series. It doesn't implement an * functionality from vt100 up to vt500 series. It doesn't implement an
* explicitly selected terminal but tries to support the most important commands * explicitly selected terminal but tries to support the most important commands
* to be compatible with existing implementations. * to be compatible with existing implementations. However, full vt102
* compatibility is the least that is provided.
*
* The main parser in this file controls the parser-state and dispatches the
* actions to the related handlers. The parser is based on the state-diagram
* from Paul Williams: http://vt100.net/emu/
* It is written from scratch, though.
* This parser is fully compatible up to the vt500 series. It requires UTF-8 and
* does not support any other input encoding. The G0 and G1 sets are therefore
* defined as subsets of UTF-8. You may still map G0-G3 into GL, though.
*
* However, the CSI/DCS/etc handlers are not designed after a specific VT
* series. We try to support all vt102 commands but implement several other
* often used sequences, too. Feel free to add further.
*
* See ./doc/vte.txt for more information on this VT-emulator.
*/ */
#include <errno.h> #include <errno.h>