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