lib/libmytinfo/README

   1 Mytinfo is Public Domain and comes with no guarantees.
   2 By Ross Ridge (ross@zooid.guild.org).
   3
   4 Mytinfo is a single library that combines the functionality of the
   5 standard Unix termcap and terminfo libraries.  It has the special
   6 ability of being able to fetch terminal descriptions from both
   7 termcap and terminfo databases regardless of which set of functions,
   8 termcap or terminfo, are used.  It can even read terminal descriptions
   9 from terminfo source files.
  10
  11 You should be able to compile this library on almost all versions of Unix.
  12 Much of it's development was done on '386 Xenix, but I've sucessfuly built
  13 mytinfo under BSD 4.3, HP-UX 2.1 (System III), SunOS 3.5, and Amix
  14 (System V R4).  There hasn't been a large amount of testing of the support
  15 programmes that come with the library, but the library itself has been in
  16 use on a couple of public access Unix sites for over two years.  It has
  17 successfully linked and run with many programmes such as rn, vi and nethack.
  18
  19 Included in the package is tconv, an "all-in-one" programme that will
  20 compile terminfo sources to binary format and also translate termcap to
  21 either terminfo source or binary.  tic and cap2info are just links
  22 to the tconv programme.  I've also written replacement for tset,
  23 that uses the mytinfo library, in case tset doesn't come with your
  24 system or if you aren't too pleased with the one that did.  Since this
  25 is the newest part of the package it probably still has a few bugs.
  26 You'll also find tput, as well two versions of clear, one that uses
  27 termcap and the other that uses terminfo.
  28
  29 The environment variables TERMCAP and TERMINFO can have multiple
  30 filenames separated by a space, a feature not in terminfo and not in
  31 most termcaps.  This is very handy for users that maintain their own
  32 private databases, as they don't have to have a copy the entire
  33 database.  Eg:
  34         TERMCAP="$HOME/.termcap /etc/termcap"
  35         TERMINFO="$HOME/terminfo /usr/lib/terminfo"
  36         export TERMCAP TERMINFO
  37 The library will also check compiled-in default locations for terminal
  38 descriptions.  Like most termcaps, the TERMCAP variable can also
  39 contain the complete termcap terminal description, usually supplied
  40 from tset at login.  The TERMINFO variable can also contain a complete
  41 terminfo description, but there is no programme like tset to supply it.
  42
  43 Unlike termcap, this library can only use capabilities that it knows about.
  44 However it does knows about all the standard ones, and you can easily
  45 add your own to it's list.  Included in the list are all terminfo
  46 capabilities to Release 4 of System V, obsolete termcap capabilities, a
  47 few caps used from the University of Waterloo (UW), a couple from GNU Emacs,
  48 and a few I made up myself. Two extensions to the standard termcap % codes
  49 are supported, GNU's %a, %m, %b, and %f, and UW's %-, %a, and %s.
  50
  51 Termcap and terminfo source descriptions can be mixed in one file, but
  52 because of this termcap databases must be in a certain style.  All
  53 continuation lines of a termcap entry must be indented from the left
  54 margin by white space.  This shouldn't be a problem with most sites
  55 since this is the style that most termcap files are distributed, but local
  56 additions may not adhere to this style.  Another possible problem is
  57 that termcap entries should end with a colon (:), but in most
  58 distributed termcaps there are entries that don't.  If a one line
  59 termcap entry doesn't end with a colon, it will be ignored.  A quick
  60 way to find these is "tconv -c /etc/termcap > /dev/null".
  61
  62 See the file INSTALL for instructions on configuring and installing
  63 this library. The file README.doc lists the functions supported by the
  64 library, and gives short description of the tconv programme.  tconv.1 is
  65 a simple man page for tconv.  terminfo.src contains a few sample
  66 terminal descriptions in terminfo source format.  TODO is a list of
  67 possible enhancements too the library, your comments and additions
  68 are welcome.
  69
  70 Please let me know of any bugs you find, as well as any ideas you have
  71 for improvement.
  72
  73 Ross Ridge
  74
  75 ross@zooid.guild.org