README

   1 = TSM - Terminal Emulator State Machine =
   2
   3 TSM is a state machine for DEC VT100-VT520 compatible terminal emulators. It
   4 tries to support all common standards while keeping compatibility to existing
   5 emulators like xterm, gnome-terminal, konsole, ..
   6
   7 TSM itself does not provide any rendering nor window management. It is a simple
   8 plain state machine without any external dependencies. It can be used to
   9 implement terminal emulators, but also to implement other applications that need
  10 to interpret terminal escape sequences.
  11
  12 This library is very similar to libvte of the gnome project. However, libvte is
  13 highly bound to GTK+, which makes it unsuitable for non-graphics projects that
  14 need to parse escape sequences. Instead, TSM tries to restrict its API to
  15 terminal emulation only. Furthermore, TSM does not try to establish a new
  16 terminal emulation standard, but instead keeps compatibility as close to xterm
  17 as possible. This is why the TERM variable can be set to xterm-color256 with any
  18 TSM based terminal emulator.
  19
  20 Website:
  21   http://www.freedesktop.org/wiki/Software/kmscon/libtsm
  22
  23 == Requirements ==
  24
  25   libtsm has no runtime requirements other than a ISO-C compatible C library.
  26   For keyboard key-symbols, the headers of libxkbcommon are needed during
  27   compile-time only. libtsm ships a copy of these headers if they are not
  28   available at compile-time.
  29
  30 == Download ==
  31
  32 Released tarballs can be found at:
  33   http://www.freedesktop.org/software/kmscon/releases
  34
  35 == Install ==
  36
  37   To compile libtsm, run the standard autotools commands:
  38     $ test -f ./configure || NOCONFIGURE=1 ./autogen.sh
  39     $ ./configure
  40     $ make
  41     $ make install
  42   To compile the test applications, run:
  43     $ make check
  44
  45 == Documentation ==
  46
  47   There is currently no API documentation available. You can have a look at the
  48   example terminal-emulator "wlterm" available at:
  49     http://www.freedesktop.org/wiki/Software/kmscon/wlterm
  50
  51 == License ==
  52
  53   This software is licensed under the terms of an MIT-like license. Please see
  54   ./COPYING for further information.
  55
  56 == Contact ==
  57
  58   This software is maintained by:
  59     David Herrmann <dh.herrmann@gmail.com>
  60   If you have any questions, do not hesitate to contact one of the maintainers.