ncurses 5.4
[ncurses.git] / doc / html / announce.html
1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 3.0//EN">
2 <!--
3   $Id: announce.html,v 1.46 2004/01/18 01:28:19 tom Exp $
4 -->
5 <HTML>
6 <HEAD>
7 <TITLE>Announcing ncurses 5.4</TITLE>
8 <link rev=made href="mailto:bug-ncurses@gnu.org">
9 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
10 </HEAD>
11 <BODY>
12
13 <H1>Announcing ncurses 5.4</H1>
14
15 The ncurses (new curses) library is a free software emulation of
16 curses in System V Release 4.0, and more.  It uses terminfo format,
17 supports pads and color
18 and multiple highlights and forms characters and function-key mapping,
19 and has all the other SYSV-curses enhancements over BSD curses.<P>
20
21 In mid-June 1995, the maintainer of 4.4BSD curses declared that he
22 considered 4.4BSD curses obsolete, and is encouraging the keepers of
23 Unix releases such as BSD/OS, freeBSD and netBSD to switch over to
24 ncurses.<P>
25
26 The ncurses code was developed under GNU/Linux.
27 It has been in use for some time with OpenBSD as the system curses library,
28 and on FreeBSD and NetBSD as an external package.
29 It should port easily to any ANSI/POSIX-conforming UNIX.
30 It has even been ported to OS/2 Warp!<P>
31
32 The distribution includes the library and support utilities, including a
33 terminfo compiler tic(1), a decompiler infocmp(1), clear(1), tput(1), tset(1),
34 and a termcap conversion tool captoinfo(1).  Full manual pages are provided for
35 the library and tools.<P>
36
37 The ncurses distribution is available via anonymous FTP at
38 the GNU distribution site
39 <A HREF="ftp://ftp.gnu.org/gnu/ncurses/">ftp://ftp.gnu.org/gnu/ncurses/</A>&nbsp;.
40 <br>It is also available at
41 <A HREF="ftp://invisible-island.net/ncurses/">ftp://invisible-island.net/ncurses/</A>&nbsp;.
42
43 <H1>Release Notes</H1>
44
45 This release is designed to be upward compatible from ncurses 5.0 and 5.3;
46 very few applications will require recompilation, depending on the platform.
47 These are the highlights from the change-log since ncurses 5.3 release.
48 <p>
49 Interface changes:
50 <ul>
51         <li>add the remaining functions for X/Open curses wide-character
52             support.
53                 <ul>
54                 <li>pecho_wchar()
55                 <li>slk_wset()
56                 </ul>
57             These are only available if the library is configured using the
58             <kbd>--enable-widec</kbd> option.
59
60         <li>write <code>getyx()</code> and related 2-return macros in terms of
61             <code>getcury()</code>,
62             <code>getcurx()</code>, etc.
63
64         <li>simplify ifdef for <code>bool</code> declaration in curses.h
65
66         <li>modify ifdef's in curses.h that disabled use of
67             <code>__attribute__()</code> for g++, since recent versions
68             implement the cases which ncurses uses.
69
70         <li>add <code>key_defined()</code> function, to tell which keycode a
71             string is bound to.
72 </ul>
73 New features and improvements:
74 <ul>
75         <li>library
76           <ul>
77             <li>implement logic in lib_mouse.c to handle position reports which
78               are generated when XFree86 xterm is initialized with private
79               modes 1002 or 1003. These are returned to the application as the
80               REPORT_MOUSE_POSITION mask, which was not implemented.
81             <li>modify soft-key initialization to use A_REVERSE if A_STANDOUT
82               would not be shown when colors are used, i.e., if ncv#1 is set in
83               the terminfo as is done in "screen".
84             <li>add configure option for FreeBSD sysmouse, --with-sysmouse, and
85               implement library support for that.
86           </ul>
87
88         <li>programs:
89
90           <ul>
91           <li>tack:
92
93             <ul>
94             <li>allow it to run from fallback terminfo data.
95             <li>reset colors after each color test, correct a place
96                 where <code>exit_standout_mode</code> was used instead of
97                 <code>exit_attribute_mode</code>.
98             <li>improve <code>bce</code> test by making it set colors other
99                 than black on white.
100             </ul>
101
102           <li>tic:
103
104             <ul>
105             <li>handle a case where an entry has no
106                 description, and capabilities begin on the same line as the entry
107                 name.
108             <li>allow a terminfo entry with a leading 2-character name.
109             <li>improved warnings when suppressing items to fit in termcap's
110                 1023-byte limit.
111             <li>add check for multiple "tc=" clauses in a termcap.
112             <li>correct logic for resolving "use=" clauses
113                 allow infocmp and tic to show cancelled capabilities.
114             <li>check for incomplete line-drawing character mapping.
115             <li>check for missing/empty/illegal terminfo name.
116             </ul>
117
118           <li>tput:
119             <ul>
120             <li>modify tput to use the same parameter analysis as tparm() does,
121               to provide for user-defined strings, e.g., for xterm title, a
122               corresponding capability might be
123                 title=\E]2;%p1%s^G,
124             </ul>
125
126           <li>tset:
127
128             <ul>
129             <li>use the system's default values for CKILL and other default
130                 control characters.
131             <li>correct interchanged defaults for kill and interrupt
132                 characters, which caused it to report unnecessarily.
133             </ul>
134
135           </ul>
136 </ul>
137 Major bug fixes:
138 <ul>
139         <li>prevent recursion in wgetch() via wgetnstr() if the connection
140           cannot be switched between cooked/raw modes because it is not a TTY.
141
142         <li>correct a case in _nc_remove_string(), used by
143           <code>define_key()</code>, to avoid infinite loop if the given string
144           happens to be a substring of other strings which are assigned to keys.
145
146         <li>modify logic of acsc to use the original character if no mapping is
147           defined, rather than a null.
148
149         <li>several improvements for handling multi-cell display of wide
150             characters.
151           <ul>
152           <li>modify setcchar() to allow converting control characters to complex
153             characters.
154           <li>correct handling of multibyte characters in waddch_literal() which
155             force wrapping because they are started too late on the line.
156           <li>modify setcchar() to allow for wchar_t input strings that have
157             more than one spacing character.
158           </ul>
159
160         <li>other fixes for wide-character support:
161           <ul>
162           <li>rewrote lib_acs.c to allow PutAttrChar() to decide how to render
163             alternate-characters, i.e., to work with Linux console and UTF-8
164             locale.
165           <li>implement a workaround so that line-drawing works with screen's
166             crippled UTF-8 support (tested with 3.9.13).  This only works with
167             the wide-character support (--enable-widec); the normal library
168             will simply suppress line-drawing when running in a UTF-8 locale in
169             screen.
170           <li>corrections to lib_get_wstr.c:
171             <ul>
172             <li>null-terminate buffer passed to setcchar(), which occasionally
173               failed.
174             <li>map special characters such as erase- and kill-characters into
175               key-codes so those will work as expected even if they are not
176               mentioned in the terminfo.
177             </ul>
178           </ul>
179
180         <li>modify <code>setupterm()</code> to check if the terminfo and
181           terminal-modes have already been read.  This ensures that it does not
182           reinvoke <code>def_prog_mode()</code> when an application calls more
183           than one function, such as <code>tgetent()</code> and
184           <code>initscr()</code>.
185
186         <li>fix form_driver() cases for REQ_CLR_EOF, REQ_CLR_EOL, REQ_DEL_CHAR,
187           REQ_DEL_PREV and REQ_NEW_LINE, which did not ensure the cursor was at
188           the editing position before making modifications.
189
190         <li>correct <code>keybound()</code>, which reported definitions in the
191           wrong table, i.e., the list of definitions which are disabled by
192           <code>keyok()</code>.
193
194         <li>fixes related to safe_sprintf.c:
195           <ul>
196           <li>correct an allocation size in safe_sprintf.c for the "*" format
197           code.
198           <li>correct safe_sprintf.c to not return a null pointer if the format
199             happens to be an empty string.
200           <li>make return value from _nc_printf_string() consistent. Before,
201             depending on whether --enable-safe-sprintf was used, it might not
202             be cached for reallocating.
203           </ul>
204
205         <li>other low-level improvements to the optimization code include:
206           <ul>
207           <li>if the output is a socket or other non-tty device, use 1
208             millisecond
209             for the cost in mvcur; previously it was 9 milliseconds because the
210             baudrate was not known.
211           <li>modify lib_getch.c to avoid recursion via wgetnstr() when the
212             input
213             is not a tty and consequently mode-changes do not work.
214           <li>fix several places in tack/pad.c which tested and used the
215             parameter- and parameterless strings inconsistently.
216           <li>change several tputs() calls in scrolling code to use putp(), to
217             enable padding which may be needed for some terminals.
218           <li>improve mvcur() by checking if it is safe to move when video
219             attributes are set (msgr), and if not, reset/restore attributes
220             within that function rather than doing it separately in the GoTo()
221             function in tty_update.c.
222           <li>use tputs() rather than putp() in a few cases in tty_update.c
223             since the corresponding delays are proportional to the number of
224             lines affected: repeat_char, clr_eos, change_scroll_region.
225           </ul>
226
227         <li>correct line/column reference in adjust_window(), needed to make
228           special windows such as curscr track properly when resizing.
229
230         <li>fix a potential recursion between napms() and _nc_timed_wait()
231
232         <li>rewrote lib_insch.c, combining it with lib_insstr.c so both handle
233           tab and other control characters consistently.
234
235         <li>do not try to open gpm mouse driver if standard output is not a
236           tty; the gpm library does not make this check.
237 </ul>
238
239 Portability:
240 <ul>
241         <li>configure script:
242           <ul>
243           <li>new options:
244             <dl>
245             <dt>--with-abi-version option.
246               <dd>addresses platforms where packagers have diverged from
247                   ncurses ABI numbering.
248             <dt>--with-manpage-format=catonly
249               <dd>addresses
250                   behavior of BSDI, allow install of man+cat files on NetBSD,
251                   whose behavior has diverged by requiring both to be present.
252             <dt>--with-manpage-aliases
253               <dd>extends
254                   "--with-manpage-aliases" to provide the option of generating
255                   ".so" files rather than symbolic links for manpage aliases.
256             <dt>--with-rel-version
257               <dd>workaround to force
258                   libtool on Darwin generate the "same" library names as with
259                   the "--with-shared" option.  The Darwin ld program does not
260                   work well with a zero as the minor-version value.
261             <dt>--with-trace
262               <dd>simplifies defining TRACE to incorporate trace() in libraries.
263             </dl>
264   
265           <li>fixes/improvements for cross-compiling:
266   
267             <ul>
268             <li>allow BUILD_CC and related configure script variables to be
269               overridden from the environment.
270             <li>use AC_CHECK_TOOL to get proper values for AR and LD for cross
271               compiling.
272             <li>use <code>$cross_compiling</code> variable in configure script
273               rather than comparing <code>$host_alias</code> and
274               <code>$target</code> alias, since "host" is traditionally misused
275               in autoconf to refer to the target platform.
276             <li>modify run_tic.in to avoid using wrong shared libraries when
277               cross-compiling.
278             </ul>
279   
280           <li>fixes for Mac OS X:
281             <ul>
282             <li>fix a redefinition of <code>$RANLIB</code> in the configure
283               script when libtool is used.
284             <li>modify MKlib_gen.sh to avoid passing "#" tokens through the C
285               preprocessor.  This works around Mac OS X's preprocessor, which
286               insists on adding a blank on each side of the token.
287             </ul>
288   
289           <li>workarounds for broken tools:
290             <ul>
291             <li>add configure check for wchar_t and wint_t types, rather than
292               rely on preprocessor definitions.  Also work around for gcc
293               <code>fixinclude</code> bug which creates a shadow copy of
294               curses.h if it sees these symbols apparently typedef'd.
295             <li>modify configure script to omit -Winline for gcc 3.3, since
296               that feature is broken.
297             <li>several script fixes to work around the ironically named
298               <em>POSIXLY_CORRECT</em> feature of GNU sed 4.0.
299             <li>modify configure script to avoid using "head -1", which does
300               not work if POSIXLY_CORRECT (sic) is set.
301             <li>update configure script to reflect fix for
302               AC_PROG_GCC_TRADITIONAL, which is broken in autoconf 2.5x for Mac
303               OS X 10.2.3.
304             <li>repair check for missing C++ compiler, which is broken in
305               autoconf 2.5x by hardcoding it to g++.
306             </ul>
307   
308           <li>corrected ifdef's relating to configure check for wchar_t, etc.
309           <li>remove configure script check to allow -Wconversion for older
310             versions of gcc
311           <li>modify configure script to accommodate libtool 1.5, as well as
312             add an parameter to the "--with-libtool" option which can specify
313             the pathname of libtool.
314           <li>change several sed scripts to avoid using "\+" since it is not a
315             BRE (basic regular expression).  One instance caused terminfo.5 to
316             be misformatted on FreeBSD.
317           <li>use '%' as sed substitute delimiter in run_tic script to avoid
318             problems with pathname delimiters such as ':' and '@'.
319           <li>add -D_XOPEN_SOURCE=500 if needed when configuring with
320             "--enable-widec", to get <code>mbstate_t</code> declaration on HPUX
321             11.11.
322           </ul>
323
324         <li>library:
325           <ul>
326           <li>adjust include-options in CF_ETIP_DEFINES to avoid missing
327             ncurses_dll.h, fixing special definitions that may be needed for
328             etip.h.
329           <li>modify CF_LIB_SUFFIX for Itanium releases of HP-UX, which use a
330             ".so" suffix.
331           <li>improve ifdef's to guard against redefinition of wchar_t and wint_t
332             in curses.h.
333           <li>remove an #undef for KEY_EVENT from curses.tail used in the
334             experimental NCURSES_WGETCH_EVENTS feature.  The #undef confuses
335             Debian <code>dpkg</code>'s build script.
336           </ul>
337 </ul>
338
339 <H1>Features of Ncurses</H1>
340
341 The ncurses package is fully compatible with SVr4 (System V Release 4) curses:
342
343 <UL>
344 <LI>All 257 of the SVr4 calls have been implemented (and are documented).
345 <LI>Full support for SVr4 curses features including keyboard mapping, color,
346 forms-drawing with ACS characters, and automatic recognition of keypad
347 and function keys.
348 <LI>An emulation of the SVr4 panels library, supporting
349 a stack of windows with backing store, is included.
350 <LI>An emulation of the SVr4 menus library, supporting
351 a uniform but flexible interface for menu programming, is included.
352 <LI>An emulation of the SVr4 form library, supporting
353 data collection through on-screen forms, is included.
354 <LI>Binary terminfo entries generated by the ncurses tic(1) implementation
355 are bit-for-bit-compatible with the entry format SVr4 curses uses.
356 <LI>The utilities have options to allow you to filter terminfo
357 entries for use with less capable <STRONG>curses</STRONG>/<STRONG>terminfo</STRONG>
358 versions such as the HP/UX and AIX ports.</UL>
359
360 The ncurses package also has many useful extensions over SVr4:
361
362 <UL>
363 <LI>The API is 8-bit clean and base-level conformant with the X/OPEN curses
364 specification, XSI curses (that is, it implements all BASE level features,
365 but not all EXTENDED features).  Most EXTENDED-level features not directly
366 concerned with wide-character support are implemented, including many
367 function calls not supported under SVr4 curses (but portability of all
368 calls is documented so you can use the SVr4 subset only).
369 <LI>Unlike SVr3 curses, ncurses can write to the rightmost-bottommost corner
370 of the screen if your terminal has an insert-character capability.
371 <LI>Ada95 and C++ bindings.
372 <LI>Support for mouse event reporting with X Window xterm and OS/2 console windows.
373 <LI>Extended mouse support via Alessandro Rubini's gpm package.
374 <LI>The function <CODE>wresize()</CODE> allows you to resize windows, preserving
375 their data.
376 <LI>The function <CODE>use_default_colors()</CODE> allows you to
377 use the terminal's default colors for the default color pair,
378 achieving the effect of transparent colors.
379 <LI>The functions <CODE>keyok()</CODE>
380 and <CODE>define_key()</CODE> allow
381 you to better control the use of function keys,
382 e.g., disabling the ncurses KEY_MOUSE,
383 or by defining more than one control sequence to map to a given key code.
384 <LI>Support for 16-color terminals, such as aixterm and XFree86 xterm.
385 <LI>Better cursor-movement optimization.  The package now features a
386 cursor-local-movement computation more efficient than either BSD's
387 or System V's.
388 <LI>Super hardware scrolling support.  The screen-update code incorporates
389 a novel, simple, and cheap algorithm that enables it to make optimal
390 use of hardware scrolling, line-insertion, and line-deletion
391 for screen-line movements.  This algorithm is more powerful than
392 the 4.4BSD curses quickch() routine.
393 <LI>Real support for terminals with the magic-cookie glitch.  The
394 screen-update code will refrain from drawing a highlight if the magic-
395 cookie unattributed spaces required just before the beginning and
396 after the end would step on a non-space character.  It will
397 automatically shift highlight boundaries when doing so would make it
398 possible to draw the highlight without changing the visual appearance
399 of the screen.
400 <LI>It is possible to generate the library with a list of pre-loaded
401 fallback entries linked to it so that it can serve those terminal types even
402 when no terminfo tree or termcap file is accessible (this may be useful
403 for support of screen-oriented programs that must run in single-user mode).
404 <LI>The tic(1)/captoinfo utility provided with ncurses has the
405 ability to translate many termcaps from the XENIX, IBM and
406 AT&amp;T extension sets.
407 <LI>A BSD-like tset(1) utility is provided.
408 <LI>The ncurses library and utilities will automatically read terminfo
409 entries from $HOME/.terminfo if it exists, and compile to that directory
410 if it exists and the user has no write access to the system directory.
411 This feature makes it easier for users to have personal terminfo entries
412 without giving up access to the system terminfo directory.
413 <LI>You may specify a path of directories to search for compiled
414 descriptions with the environment variable TERMINFO_DIRS (this
415 generalizes the feature provided by TERMINFO under stock System V.)
416 <LI>In terminfo source files, use capabilities may refer not just to
417 other entries in the same source file (as in System V) but also to
418 compiled entries in either the system terminfo directory or the user's
419 $HOME/.terminfo directory.
420 <LI>A script (<STRONG>capconvert</STRONG>) is provided to help BSD users
421 transition from termcap to terminfo.  It gathers the information in a
422 TERMCAP environment variable and/or a ~/.termcap local entries file
423 and converts it to an equivalent local terminfo tree under $HOME/.terminfo.
424 <LI>Automatic fallback to the /etc/termcap file can be compiled in
425 when it is not possible to build a terminfo tree.  This feature is neither
426 fast nor cheap, you don't want to use it unless you have to,
427 but it's there.
428 <LI>The table-of-entries utility <STRONG>toe</STRONG> makes it easy for users to
429 see exactly what terminal types are available on the system.
430 <LI>The library meets the XSI requirement that every macro entry
431 point have a corresponding function which may be linked (and will be
432 prototype-checked) if the macro definition is disabled with
433 <CODE>#undef</CODE>.
434 <LI>An HTML "Introduction to Programming with NCURSES" document provides
435 a narrative introduction to the curses programming interface.
436 </UL>
437
438 <H1>State of the Package</H1>
439
440 Numerous bugs present in earlier versions have been fixed; the
441 library is far more reliable than it used to be.  Bounds checking in many
442 `dangerous' entry points has been improved.  The code is now type-safe
443 according to gcc -Wall.  The library has been checked for malloc leaks and
444 arena corruption by the Purify memory-allocation tester.<P>
445
446 The ncurses code has been tested with a wide variety of applications
447 including (versions starting with those noted):
448 <DL>
449 <DT> cdk
450 <DD> Curses Development Kit
451 <br>
452 <A HREF="http://invisible-island.net/cdk/">http://invisible-island.net/cdk/</A>
453 <br>
454 <A HREF="http://www.vexus.ca/products/CDK/">http://www.vexus.ca/products/CDK/</a>
455 <DT> ded
456 <DD> directory-editor
457 <br>
458 <A HREF="http://invisible-island.net/ded/">http://invisible-island.net/ded/</A>
459 <DT> dialog
460 <DD> the underlying application used in Slackware's setup, and the basis
461 for similar applications on GNU/Linux.
462 <br>
463 <A HREF="http://invisible-island.net/dialog/">http://invisible-island.net/dialog/</A>
464 <DT> lynx
465 <DD> the character-screen WWW browser
466 <br>
467 <A HREF="http://lynx.isc.org/release/">http://lynx.isc.org/release/</A>
468 <DT> Midnight Commander
469 <DD> file manager
470 <br>
471 <A HREF="http://www.ibiblio.org/mc/">http://www.ibiblio.org/mc/</A>
472 <DT> mutt
473 <DD> mail utility
474 <br>
475 <A HREF="http://www.mutt.org/">http://www.mutt.org/</A>
476 <DT> ncftp
477 <DD> file-transfer utility
478 <br>
479 <A HREF="http://www.ncftp.com/">http://www.ncftp.com/</A>
480 <DT> nvi
481 <DD> New vi versions 1.50 are able to use ncurses versions 1.9.7 and later.
482 <br>
483 <A HREF="http://www.bostic.com/vi/">http://www.bostic.com/vi/</A>
484 <br>
485 <DT> pinfo
486 <DD> Lynx-like info browser.
487 <A HREF="http://dione.ids.pl/~pborys/software/pinfo/">http://dione.ids.pl/~pborys/software/pinfo/</A>
488 <DT> tin
489 <DD> newsreader, supporting color, MIME
490 <A HREF="http://www.tin.org/">http://www.tin.org/</A>
491 <DT> vh-1.6
492 <DD> Volks-Hypertext browser for the Jargon File
493 <br>
494 <A HREF="http://www.debian.org/Packages/unstable/text/vh.html">http://www.debian.org/Packages/unstable/text/vh.html</A>
495 </DL>
496 as well as some that use ncurses for the terminfo support alone:
497 <DL>
498 <DT> minicom
499 <DD> terminal emulator
500 <br>
501 <A HREF="http://www.netsonic.fi/~walker/minicom.html">http://www.netsonic.fi/~walker/minicom.html</A>
502 <DT> vile
503 <DD> vi-like-emacs
504 <br>
505 <A HREF="http://invisible-island.net/vile/">http://invisible-island.net/vile/</A>
506 </DL>
507 <P>
508
509 The ncurses distribution includes a selection of test programs (including
510 a few games).
511
512 <H2>Who's Who and What's What</H2>
513
514 Zeyd Ben-Halim
515 started it from a previous package pcurses, written by Pavel Curtis.
516 Eric S. Raymond
517 continued development.
518 J&uuml;rgen Pfeifer wrote most of the form and menu libraries.
519 Ongoing work is being done by
520 <A HREF="mailto:dickey@invisible-island.net">Thomas Dickey</A>.
521 Thomas Dickey
522 acts as the maintainer for the Free Software Foundation,
523 which holds the copyright on ncurses.
524 Contact the current maintainers at
525 <A HREF="mailto:bug-ncurses@gnu.org">bug-ncurses@gnu.org</A>.
526 <P>
527
528 To join the ncurses mailing list, please write email to
529 <CODE>bug-ncurses-request@gnu.org</CODE> containing the line:
530 <PRE>
531              subscribe &lt;name&gt;@&lt;host.domain&gt;
532 </PRE>
533
534 This list is open to anyone interested in helping with the development and
535 testing of this package.<P>
536
537 Beta versions of ncurses and patches to the current release are made available at
538 <A HREF="ftp://invisible-island.net/ncurses/">ftp://invisible-island.net/ncurses/</A>&nbsp;.
539
540 <H2>Future Plans</H2>
541 <UL>
542 <LI>Extended-level XPG4 conformance, with internationalization support.
543 <LI>Ports to more systems, including DOS and Windows.
544 </UL>
545 We need people to help with these projects.  If you are interested in working
546 on them, please join the ncurses list.
547
548 <H2>Other Related Resources</H2>
549
550 The distribution provides a newer version of the terminfo-format
551 terminal description file maintained by
552 <A HREF="http://www.catb.org/~esr/terminfo/">Eric Raymond</A>&nbsp;.
553 Unlike the older version, the termcap and terminfo data are provided
554 in the same file.<P>
555
556 You can find lots of information on terminal-related topics
557 not covered in the terminfo file at
558 <A HREF="http://www.cs.utk.edu/~shuford/terminal_index.html">Richard Shuford's
559 archive</A>&nbsp;.
560 </BODY>
561 </HTML>
562 <!--
563 # The following sets edit modes for GNU EMACS
564 # Local Variables:
565 # mode:html
566 # case-fold-search:nil
567 # fill-column:70
568 # End:
569 -->