README
1PDCurses for X11
2================
3
4This is a port of PDCurses for X11, aka XCurses. It is designed to
5allow existing curses programs to be re-compiled with PDCurses,
6resulting in native X11 programs.
7
8
9Building
10--------
11
12. Run "./configure" in the top-level directory.
13
14 To build the wide-character version of the library, specify
15 "--enable-widec" as a parameter. To use X Input Methods, add
16 "--enable-xim". I recommend these options, but I haven't yet made
17 them the defaults, for the sake of backwards compatibility and due to
18 their new and relatively untested status.
19
20 If your system is lacking in UTF-8 support, you can force the use of
21 UTF-8 instead of the system locale via "--enable-force-utf8". This is
22 generally more useful in Windows.
23
24 If configure can't find your X include files or X libraries, you can
25 specify the paths with the arguments "--x-includes=inc_path" and/or
26 "--x-libraries=lib_path".
27
28 By default, the library and demo programs are built with the optimizer
29 switch -O2. You can turn this off, and turn on debugging (-g), by
30 adding "--with-debug" to the configure command.
31
32. Run "make". This should build libXCurses and all the demo programs.
33
34. Optionally, run "make install". curses.h and panel.h will be renamed
35 when installed (to xcurses.h and xpanel.h), to avoid conflicts with
36 any existing curses installations. Unrenamed copies of curses.h and
37 panel.h are installed in (by default) /usr/local/include/xcurses.
38
39 libXpanel is just a symlink to libXCurses. Both curses and panel
40 functions are in the main library.
41
42
43Distribution Status
44-------------------
45
46As of April 13, 2006, the files in this directory are released to the
47Public Domain, except for ScrollBox*, which are under essentially the
48MIT X License.
49
50
51To be Done
52----------
53
54- have newterm() create a new X window
55
56- provide a command line parsing function to enable X command line
57 arguments to be parsed and stripped from the arguments passed back
58 to the calling procedure.
59
60
61Acknowledgements
62----------------
63
64X11 port was provided by Mark Hessling <mark@rexx.org>
65