Check for wint_t and attempt to allow compiles even when wint_t isn't
[vte.git] / README
1 * What is VTE?
2 - You could say that VTE is something of a research project of mine, based on
3   the simple question:  "if programs can use a termcap file (through either
4   libtermcap or curses or ncurses) to determine how to drive a terminal, why
5   can't a terminal emulator use a termcap file to determine how to behave?"
6
7 * What does VTE include?
8 - VTE includes a library (libvte) which implements such a terminal emulator
9   widget for GTK+ 2.0, and a sample application (vte) which wraps that widget
10   in a GTK window.  Because I'm more concerned with whether or not it works,
11   all settings are hard-coded to whatever I needed to test the last time I
12   touched it.  If you actually want to use the widget to get work done, you
13   should probably be using profterm.
14
15 * How does it work?
16 - The VTE library inserts terminal capability strings into a tree of tables,
17   and then uses it to determine if data received from a pseudo-terminal is a
18   control sequence or just random data.  The sample program "interpret"
19   illustrates more or less what the widget sees after it filters incoming data.
20
21 * What's missing?
22 - Accessibility isn't completed yet.
23 - Mouse hilite tracking isn't implemented yet.
24 - Extending the selection using shift+click pays attention to whether or not
25   the existing selection was done word-at-a-time or line-at-a-time, but
26   probably shouldn't.
27 - Most control sequences are recognized, but many aren't implemented.  There
28   are enough to run ls, vim, less, emacs and mutt, but more need to be
29   implemented (ff, i1, i3, is, iP, LF, LO, MC, mh, ML, mm, mo, nw, pf,
30   pk, pl, pf, po, pO, ps, px, r1, r2, r3, RA, RF, rp, rs, RX, SA, SX, wi,
31   several more from the XTerm set).
32 - I'm not sure the widget implementation itself is correct.  There are many
33   changes in going from GTK+ 1.2 to 2.0, and examples of the proper way to do
34   things is currently scarce, so some of it's guesswork.
35 - An actual property interface needs to be retrofitted over the various options
36   which are currently hard-coded at startup-time.
37
38 * What's weird?
39 - Relative cursor motion is weird.  When the character to the right of the
40   cursor is a 3-byte UTF-8 sequence for a character which occupies two
41   columns on the screen, three things may happen when the application sends
42   the "cursor left" control sequence:
43   * the cursor moves two columns (one character) to the left
44     This eliminates the possibility of moving the cursor into the middle of
45     a multi-column character.
46   * the cursor moves one column (one half-character) to the left
47     This makes determining where the cursor is easier, but requires the
48     application to emit a control sequence more than once for multi-column
49     characters.
50   * the cursor moves one "byte" to the left
51     This happens to work for a few locales, and is otherwise just broken.
52   Currently VTE follows the second convention.  More on this topic:
53   http://czyborra.com/unicode/terminals.html
54   http://mail.nl.linux.org/linux-utf8/1999-10/msg00014.html
55   http://www.debian.org/doc/manuals/intro-i18n/ch-output.en.html