managarm / libtsm-mirror Goto Github PK

= TSM - Terminal Emulator State Machine =

TSM is a state machine for DEC VT100-VT520 compatible terminal emulators. It
tries to support all common standards while keeping compatibility to existing
emulators like xterm, gnome-terminal, konsole, ..

TSM itself does not provide any rendering nor window management. It is a simple
plain state machine without any external dependencies. It can be used to
implement terminal emulators, but also to implement other applications that need
to interpret terminal escape sequences.

This library is very similar to libvte of the gnome project. However, libvte is
highly bound to GTK+, which makes it unsuitable for non-graphics projects that
need to parse escape sequences. Instead, TSM tries to restrict its API to
terminal emulation only. Furthermore, TSM does not try to establish a new
terminal emulation standard, but instead keeps compatibility as close to xterm
as possible. This is why the TERM variable can be set to xterm-color256 with any
TSM based terminal emulator.

Website:
  http://www.freedesktop.org/wiki/Software/libtsm

== Requirements ==

  libtsm has no runtime requirements other than a ISO-C compatible C library.
  For keyboard key-symbols, the headers of libxkbcommon are needed during
  compile-time only. libtsm ships a copy of these headers if they are not
  available at compile-time.

== Download ==

Released tarballs can be found at:
  http://www.freedesktop.org/software/kmscon/releases

== Install ==

  To compile libtsm, run the standard autotools commands:
    $ test -f ./configure || NOCONFIGURE=1 ./autogen.sh
    $ ./configure
    $ make
    $ make install
  To compile the test applications, run:
    $ make check

== Documentation ==

  There is currently no API documentation available. You can have a look at the
  example terminal-emulator "wlterm" available at:
    http://www.freedesktop.org/wiki/Software/kmscon/wlterm

== License ==

  This software is licensed under the terms of an MIT-like license. Please see
  ./COPYING for further information.

== Contact ==

  This software is maintained by:
    David Herrmann <[email protected]>
  If you have any questions, do not hesitate to contact one of the maintainers.