home *** CD-ROM | disk | FTP | other *** search
/ Geek Gadgets 1 / ADE-1.bin / ade-dist / ncurses-1.9.9e-src.tgz / tar.out / fsf / ncurses / README < prev    next >
Text File  |  1996-09-28  |  6KB  |  156 lines
  1.         README file for the ncurses package
  2.  
  3. See the file ANNOUNCE for a summary of ncurses features and ports.
  4. See the file INSTALL for instructions on how to build and install ncurses.
  5. See the file NEWS for a release history and bug-fix notes.
  6. See the file TO-DO for things that still need doing, including known bugs.
  7.  
  8. Browse the file misc/ncurses-intro.html for narrative descriptions of how
  9. to use ncurses and the panel, menu, and form libraries.
  10.  
  11. Browse the file misc/hackguide.html for a tour of the package internals.
  12.  
  13. ROADMAP AND PACKAGE OVERVIEW:
  14.  
  15. You should be reading this file in a directory called: ncurses-d.d.d, where
  16. d.d.d is the current version number (see the dist.mk file in this
  17. directory for that).  There should be several subdirectories, including `c++',
  18. `form', `man', `menu', `misc', `ncurses', `panel', `progs', and `test'.
  19.  
  20. A full build/install of this package typically installs several libraries, a
  21. handful of utilities, and a database hierarchy.  Here is an inventory of the
  22. pieces:
  23.  
  24. The libraries are:
  25.  
  26.     libncurses.a       (normal)
  27.     libncurses.so      (shared)
  28.     libncurses_g.a     (debug and trace code enabled)
  29.     libncurses_p.a     (profiling enabled)
  30.  
  31.     libpanel.a         (normal)
  32.     libpanel_g.a       (debug and trace code enabled)
  33.  
  34.     libmenu.a          (normal)
  35.     libmenu_g.a        (debug enabled)
  36.  
  37.     libform.a          (normal)
  38.     libform_g.a        (debug enabled)
  39.  
  40. The ncurses libraries implement the curses API.  The panel, menu and forms
  41. libraries implement clones of the SVr4 panel, menu and forms APIs.  The
  42. source code for these lives in the `ncurses', `panel', `menu', and
  43. `form' directories respectively.
  44.  
  45. In the `c++' directory, you'll find code that defines an interface to the
  46. curses and panels library packaged as a C++ class, and a demo program in C++
  47. to test it.  These class definition modules are not installed anywhere by
  48. default; it's up to you what you do with them.
  49.  
  50. In order to do its job, the ncurses code needs your terminal type to be set in
  51. the environment variable TERM (normally set by your OS; under UNIX, getty(1)
  52. typically does this, but you can override it in your .profile); and, it needs a
  53. database of terminal descriptions in which to look up your terminal type's
  54. capabilities.
  55.  
  56. In older (V7/BSD) versions of curses, the database was a flat text file,
  57. /etc/termcap; in newer (USG/USL) versions, the database is a hierarchy of
  58. fast-loading binary description blocks under /usr/lib/terminfo.  These binary
  59. blocks are compiled from an improved editable text representation called
  60. `terminfo' format (documented in man/terminfo.5).  The ncurses library can use
  61. either /etc/termcap or the compiled binary terminfo blocks, but prefers the
  62. second form.
  63.  
  64. In the `misc' directory, there is a text file terminfo.src, in editable
  65. terminfo format, which can be used to generate the terminfo binaries (that's
  66. what make install.data does).  If the package was built with the
  67. --with-termcap option enabled, and the ncurses library can't find a terminfo
  68. description for your terminal, it will fall back to the termcap file supplied
  69. with your system (which the ncurses package installation leaves strictly
  70. alone).
  71.  
  72. The utilities are as follows:
  73.  
  74.     tic             -- terminfo source to binary compiler
  75.     infocmp         -- terminfo binary to source decompiler/comparator
  76.     clear           -- emits clear-screen for current terminal
  77.     tput            -- shell-script access to terminal capabilities.
  78.     tset            -- terminal-initialization utility
  79.     toe        -- table of entries utility
  80.  
  81. The first two are used for manipulating terminfo descriptions; the next two
  82. are for use in shell scripts.  The last is provided for 4.4BSD compatibility.
  83. The source code for all of these lives in the `progs' directory.
  84.  
  85. Detailed documentation for all libraries and utilities can be found in
  86. the `man' directory.  An HTML introduction to ncurses, panels, and
  87. menus programming lives in the `misc' directory.
  88.  
  89. The `test' directory contains programs that can be used to verify the 
  90. functions of the ncurses libraries.  See test/README for descriptions of
  91. these programs.  Notably, the `ncurses' utility is designed to help you
  92. systematically exercise the library functions.
  93.  
  94. RELATED RESOURCES:
  95.  
  96. This distribution now includes (and uses) a copy of the master terminfo
  97. database maintained by Eric Raymond.  This database (which is the 
  98. official descendant of the 4.4BSD termcap file) changes faster than this
  99. code does.
  100.  
  101. You can surf to a WWW page that carries the current terminfo master file,
  102. and news about ncurses, at
  103.  
  104.     http://www.ccil.org/~esr/ncurses.html
  105.  
  106. AUTHORS:
  107.  
  108. Pavel Curtis: 
  109.     wrote the original ncurses
  110.  
  111. Zeyd M. Ben-Halim:
  112.     port of original to Linux and many enhancements.
  113.  
  114. Eric S. Raymond:
  115.     the man pages, infocmp(1), tput(1), clear(1), captoinfo(1), tset(1),
  116.     toe(1), most of tic(1), src/lib_twait.c, trace levels, the HTML intro,
  117.     wgetnstr() and many other entry points,    the cursor-movement
  118.     optimization, the scroll-pack optimizer for vertical motions,
  119.     the mouse interface and xterm mouse support, and the ncurses
  120.     test program.
  121.  
  122. CONTRIBUTORS:
  123.  
  124. Thomas Dickey and David MacKenzie
  125.     for first-class bug-chasing and methodical testing.
  126.  
  127. Ross Ridge
  128.     for the code that hacks termcap parameterized strings into terminfo.
  129.  
  130. Warren Tucker and Gerhard Fuernkranz,
  131.     for writing and sending the panel library.
  132.  
  133. Juergen Pfeifer
  134.     the menu and form code
  135.  
  136. Hellmuth Michaelis,
  137.     for many patches and testing the optimization code.
  138.  
  139. Eric Newton, Ulrich Drepper, and Anatoly Ivasyuk:
  140.     the C++ code.
  141.  
  142. Jonathan Ross,
  143.     for lessons in using sed.
  144.  
  145. Keith Bostic (maintainer of 4.4BSD curses)
  146.     for help, criticism, comments, bug-finding, and being willing to
  147.     deep-six BSD curses for this one when it grew up.
  148.  
  149. Countless other people have contributed by reporting bugs, sending fixes,
  150. suggesting improvements, and generally whining about ncurses :-)
  151.  
  152. BUGS:
  153.     See the INSTALL file for bug and developer-list addresses.
  154.     The Hacker's Guide in the misc directory includes some guidelines
  155.     on how to report bugs in ways that will get them fixed most quickly.
  156.