| [2621] | 1 | -- $Id: README,v 1.22 2004/08/07 23:42:43 tom Exp $
|
|---|
| 2 | -------------------------------------------------------------------------------
|
|---|
| 3 | README file for the ncurses package
|
|---|
| 4 |
|
|---|
| 5 | See the file ANNOUNCE for a summary of ncurses features and ports.
|
|---|
| 6 | See the file INSTALL for instructions on how to build and install ncurses.
|
|---|
| 7 | See the file NEWS for a release history and bug-fix notes.
|
|---|
| 8 | See the file TO-DO for things that still need doing, including known bugs.
|
|---|
| 9 |
|
|---|
| 10 | Browse the file misc/ncurses-intro.html for narrative descriptions of how
|
|---|
| 11 | to use ncurses and the panel, menu, and form libraries.
|
|---|
| 12 |
|
|---|
| 13 | Browse the file doc/html/hackguide.html for a tour of the package internals.
|
|---|
| 14 |
|
|---|
| 15 | ROADMAP AND PACKAGE OVERVIEW:
|
|---|
| 16 |
|
|---|
| 17 | You should be reading this file in a directory called: ncurses-d.d, where d.d
|
|---|
| 18 | is the current version number (see the dist.mk file in this directory for
|
|---|
| 19 | that). There should be a number of subdirectories, including `c++', `form',
|
|---|
| 20 | `man', `menu', `misc', `ncurses', `panel', `progs', `test', 'tack' and `Ada95'.
|
|---|
| 21 | (The 'tack' program may be distributed separately).
|
|---|
| 22 |
|
|---|
| 23 | A full build/install of this package typically installs several libraries, a
|
|---|
| 24 | handful of utilities, and a database hierarchy. Here is an inventory of the
|
|---|
| 25 | pieces:
|
|---|
| 26 |
|
|---|
| 27 | The libraries are:
|
|---|
| 28 |
|
|---|
| 29 | libncurses.a (normal)
|
|---|
| 30 | libncurses.so (shared)
|
|---|
| 31 | libncurses_g.a (debug and trace code enabled)
|
|---|
| 32 | libncurses_p.a (profiling enabled)
|
|---|
| 33 |
|
|---|
| 34 | libpanel.a (normal)
|
|---|
| 35 | libpanel.so (shared)
|
|---|
| 36 | libpanel_g.a (debug and trace code enabled)
|
|---|
| 37 |
|
|---|
| 38 | libmenu.a (normal)
|
|---|
| 39 | libmenu.so (shared)
|
|---|
| 40 | libmenu_g.a (debug enabled)
|
|---|
| 41 |
|
|---|
| 42 | libform.a (normal)
|
|---|
| 43 | libform.so (shared)
|
|---|
| 44 | libform_g.a (debug enabled)
|
|---|
| 45 |
|
|---|
| 46 | If you configure using the --enable-widec option, a "w" is appended to the
|
|---|
| 47 | library names (e.g., libncursesw.a), and the resulting libraries support
|
|---|
| 48 | wide-characters, e.g., via a UTF-8 locale. The corresponding header files
|
|---|
| 49 | are compatible with the non-wide-character configuration; wide-character
|
|---|
| 50 | features are provided by ifdef's in the header files. The wide-character
|
|---|
| 51 | library interfaces are not binary-compatible with the non-wide-character
|
|---|
| 52 | version.
|
|---|
| 53 |
|
|---|
| 54 | The ncurses libraries implement the curses API. The panel, menu and forms
|
|---|
| 55 | libraries implement clones of the SVr4 panel, menu and forms APIs. The source
|
|---|
| 56 | code for these lives in the `ncurses', `panel', `menu', and `form' directories
|
|---|
| 57 | respectively.
|
|---|
| 58 |
|
|---|
| 59 | In the `c++' directory, you'll find code that defines an interface to the
|
|---|
| 60 | curses, forms, menus and panels library packaged as C++ classes, and a demo program in C++
|
|---|
| 61 | to test it. These class definition modules are not installed by the 'make
|
|---|
| 62 | install.libs' rule as libncurses++.
|
|---|
| 63 |
|
|---|
| 64 | In the `Ada95' directory, you'll find code and documentation for an
|
|---|
| 65 | Ada95 binding of the curses API, to be used with the GNAT compiler.
|
|---|
| 66 | This binding is built by a normal top-level `make' if configure detects
|
|---|
| 67 | an usable version of GNAT (3.11 or above). It is not installed automatically.
|
|---|
| 68 | See the Ada95 directory for more build and installation instructions and
|
|---|
| 69 | for documentation of the binding.
|
|---|
| 70 |
|
|---|
| 71 | To do its job, the ncurses code needs your terminal type to be set in the
|
|---|
| 72 | environment variable TERM (normally set by your OS; under UNIX, getty(1)
|
|---|
| 73 | typically does this, but you can override it in your .profile); and, it needs a
|
|---|
| 74 | database of terminal descriptions in which to look up your terminal type's
|
|---|
| |
|---|
