ncurses 5.9 - patch 20110820
[ncurses.git] / INSTALL
1 -------------------------------------------------------------------------------
2 -- Copyright (c) 1998-2010,2011 Free Software Foundation, Inc.               --
3 --                                                                           --
4 -- Permission is hereby granted, free of charge, to any person obtaining a   --
5 -- copy of this software and associated documentation files (the             --
6 -- "Software"), to deal in the Software without restriction, including       --
7 -- without limitation the rights to use, copy, modify, merge, publish,       --
8 -- distribute, distribute with modifications, sublicense, and/or sell copies --
9 -- of the Software, and to permit persons to whom the Software is furnished  --
10 -- to do so, subject to the following conditions:                            --
11 --                                                                           --
12 -- The above copyright notice and this permission notice shall be included   --
13 -- in all copies or substantial portions of the Software.                    --
14 --                                                                           --
15 -- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS   --
16 -- OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF                --
17 -- MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN --
18 -- NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,       --
19 -- DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR     --
20 -- OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE --
21 -- USE OR OTHER DEALINGS IN THE SOFTWARE.                                    --
22 --                                                                           --
23 -- Except as contained in this notice, the name(s) of the above copyright    --
24 -- holders shall not be used in advertising or otherwise to promote the      --
25 -- sale, use or other dealings in this Software without prior written        --
26 -- authorization.                                                            --
27 -------------------------------------------------------------------------------
28 -- $Id: INSTALL,v 1.157 2011/07/24 13:43:43 tom Exp $
29 ---------------------------------------------------------------------
30              How to install Ncurses/Terminfo on your system
31 ---------------------------------------------------------------------
32
33     ************************************************************
34     * READ ALL OF THIS FILE BEFORE YOU TRY TO INSTALL NCURSES. *
35     ************************************************************
36
37 You should be reading the file INSTALL in a directory called ncurses-d.d, where
38 d.d is the current version number.  There should be several subdirectories,
39 including `c++', `form', `man', `menu', 'misc', `ncurses', `panel', `progs',
40 and `test'.  See the README file for a roadmap to the package.
41
42 If you are a distribution integrator or packager, please read and act on the
43 section titled IF YOU ARE A SYSTEM INTEGRATOR below.
44
45 If you are converting from BSD curses and do not have root access, be sure
46 to read the BSD CONVERSION NOTES section below.
47
48 If you are trying to build applications using gpm with ncurses,
49 read the USING NCURSES WITH GPM section below.
50
51 If you are running over the Andrew File System see the note below on
52 USING NCURSES WITH AFS.
53
54 If you are cross-compiling, see the note below on BUILDING NCURSES WITH A
55 CROSS-COMPILER.
56
57 If you want to build the Ada95 binding, go to the Ada95 directory and
58 follow the instructions there.  The Ada95 binding is not covered below.
59
60
61 REQUIREMENTS:
62 ------------
63
64 You will need the following to build and install ncurses under UNIX:
65
66         * ANSI C compiler  (gcc, for instance)
67         * sh               (bash will do)
68         * awk              (mawk or gawk will do)
69         * sed
70         * BSD or System V style install (a script is enclosed)
71
72 Ncurses has been also built in the OS/2 EMX environment.
73
74
75 INSTALLATION PROCEDURE:
76 ----------------------
77
78 1.  First, decide whether you want ncurses to replace your existing library (in
79     which case you'll need super-user privileges) or be installed in parallel
80     with it.
81
82     The --prefix option to configure changes the root directory for installing
83     ncurses.  The default is normally in subdirectories of /usr/local, except
84     for systems where ncurses is normally installed as a system library (see
85     "IF YOU ARE A SYSTEM INTEGRATOR").  Use --prefix=/usr to replace your
86     default curses distribution.
87
88     The package gets installed beneath the --prefix directory as follows:
89
90     In $(prefix)/bin:          tic, infocmp, captoinfo, tset,
91                                 reset, clear, tput, toe, tabs
92     In $(prefix)/lib:          libncurses*.* libcurses.a
93     In $(prefix)/share/terminfo: compiled terminal descriptions
94     In $(prefix)/include:      C header files
95     Under $(prefix)/man:       the manual pages
96
97     Note that the configure script attempts to locate previous installation of
98     ncurses, and will set the default prefix according to where it finds the
99     ncurses headers.
100
101     Do not use commands such as
102
103         make install prefix=XXX
104
105     to change the prefix after configuration, since the prefix value is used
106     for some absolute pathnames such as TERMINFO.  Instead do this
107
108         make install DESTDIR=XXX
109
110     See also the discussion of --with-install-prefix.
111
112 2.  Type `./configure' in the top-level directory of the distribution to
113     configure ncurses for your operating system and create the Makefiles.
114     Besides --prefix, various configuration options are available to customize
115     the installation; use `./configure --help' to list the available options.
116
117     If your operating system is not supported, read the PORTABILITY section in
118     the file ncurses/README for information on how to create a configuration
119     file for your system.
120
121     The `configure' script generates makefile rules for one or more object
122     models and their associated libraries:
123
124         libncurses.a (normal)
125
126         libcurses.a (normal, a link to libncurses.a)
127                 This gets left out if you configure with --disable-overwrite.
128
129         libncurses.so (shared)
130
131         libncurses_g.a (debug)
132
133         libncurses_p.a (profile)
134
135         libncurses.la (libtool)
136
137     If you configure using the --enable-widec option, a "w" is appended to the
138     library names (e.g., libncursesw.a), and the resulting libraries support
139     wide-characters, e.g., via a UTF-8 locale.  The corresponding header files
140     are compatible with the non-wide-character configuration; wide-character
141     features are provided by ifdef's in the header files.  The wide-character
142     library interfaces are not binary-compatible with the non-wide-character
143     version.  Building and running the wide-character code relies on a fairly
144     recent implementation of libiconv.  We have built this configuration on
145     various systems using libiconv, sometimes requiring libutf8.
146
147     If you configure using the --with-pthread option, a "t" is appended to
148     the library names (e.g., libncursest.a, libncursestw.a).
149
150     If you do not specify any models, the normal and debug libraries will be
151     configured.  Typing `configure' with no arguments is equivalent to:
152
153         ./configure --with-normal --with-debug --enable-overwrite
154
155     Typing
156
157         ./configure --with-shared
158
159     makes the shared libraries the default, resulting in
160
161         ./configure --with-shared --with-normal --with-debug --enable-overwrite
162
163     If you want only shared libraries, type
164
165         ./configure --with-shared --without-normal --without-debug
166
167     Rules for generating shared libraries are highly dependent upon the choice
168     of host system and compiler.  We've been testing shared libraries on
169     several systems, but more work needs to be done to make shared libraries
170     work on other systems.
171
172     If you have libtool installed, you can type
173
174         ./configure --with-libtool
175
176     to generate the appropriate static and/or shared libraries for your
177     platform using libtool.
178
179     You can make curses and terminfo fall back to an existing file of termcap
180     definitions by configuring with --enable-termcap.  If you do this, the
181     library will search /etc/termcap before the terminfo database, and will
182     also interpret the contents of the TERM environment variable.  See the
183     section BSD CONVERSION NOTES below.
184
185 3.  Type `make'.  Ignore any warnings, no error messages should be produced.
186     This should compile the ncurses library, the terminfo compiler tic(1),
187     captoinfo(1), infocmp(1), toe(1), clear(1) tset(1), reset(1), and tput(1)
188     programs (see the manual pages for explanation of what they do), some test
189     programs, and the panels, menus, and forms libraries.
190
191 4.  Run ncurses and several other test programs in the test directory to
192     verify that ncurses functions correctly before doing an install that
193     may overwrite system files.  Read the file test/README for details on
194     the test programs.
195
196     NOTE: You must have installed the terminfo database, or set the
197     environment variable $TERMINFO to point to a SVr4-compatible terminfo
198     database before running the test programs.  Not all vendors' terminfo
199     databases are SVr4-compatible, but most seem to be.  Exceptions include
200     DEC's Digital Unix (formerly known as OSF/1).
201
202     If you run the test programs WITHOUT installing terminfo, ncurses may
203     read the termcap file and cache that in $HOME/.terminfo, which will
204     thereafter be used instead of the terminfo database.  See the comments
205     on "--enable-getcap-cache", to see why this is a Bad Thing.
206
207     It is possible to configure ncurses to use other terminfo database formats.
208     A few are provided as examples in the include-directory (see --with-caps).
209
210     The ncurses program is designed specifically to test the ncurses library.
211     You can use it to verify that the screen highlights work correctly, that
212     cursor addressing and window scrolling works OK, etc.
213
214 5.  Once you've tested, you can type `make install' to install libraries,
215     the programs, the terminfo database and the manual pages.  Alternately, you
216     can type `make install' in each directory you want to install.  In the
217     top-level directory, you can do a partial install using these commands:
218
219         'make install.progs'    installs tic, infocmp, etc...
220         'make install.includes' installs the headers.
221         'make install.libs'     installs the libraries (and the headers).
222         'make install.data'     installs the terminfo data. (Note: `tic' must
223                                 be installed before the terminfo data can be
224                                 compiled).
225         'make install.man'      installs the manual pages.
226
227   ############################################################################
228   #     CAVEAT EMPTOR: `install.data' run as root will NUKE any existing     #
229   #  terminfo database. If you have any custom or unusual entries SAVE them  #
230   #  before you install ncurses.  I have a file called terminfo.custom for   #
231   #  this purpose.  Don't forget to run tic on the file once you're done.    #
232   ############################################################################
233
234     The terminfo(5) manual page must be preprocessed with tbl(1) before
235     being formatted by nroff(1).  Modern man(1) implementations tend to do
236     this by default, but you may want to look at your version's manual page
237     to be sure.  You may also install the manual pages after preprocessing
238     with tbl(1) by specifying the configure option --with-manpage-tbl.
239
240     If the system already has a curses library that you need to keep using
241     you'll need to distinguish between it and ncurses.  See the discussion of
242     --disable-overwrite.  If ncurses is installed outside the standard
243     directories (/usr/include and /usr/lib) then all your users will need to
244     use the -I option to compile programs and -L to link them.
245
246     If you have another curses installed in your system and you accidentally
247     compile using its curses.h you'll end up with a large number of
248     undefined symbols at link time.
249
250     IF YOU DO NOT HAVE ROOT: Change directory to the `progs' subdirectory
251     and run the `capconvert' script.  This script will deduce various things
252     about your environment and use them to build you a private terminfo tree,
253     so you can use ncurses applications.
254
255     If more than one user at your site does this, the space for the duplicate
256     trees is wasted.  Try to get your site administrators to install a system-
257     wide terminfo tree instead.
258
259     See the BSD CONVERSION NOTES section below for a few more details.
260
261 6.  The c++ directory has C++ classes that are built on top of ncurses and
262     panels.  You must have c++ (and its libraries) installed before you can
263     compile and run the demo.
264
265     Use --without-cxx-binding to tell configure to not build the C++ bindings
266     and demo.
267
268     If you do not have C++, you must use the --without-cxx option to tell
269     the configure script to not attempt to determine the type of 'bool'
270     which may be supported by C++.  IF YOU USE THIS OPTION, BE ADVISED THAT
271     YOU MAY NOT BE ABLE TO COMPILE (OR RUN) NCURSES APPLICATIONS WITH C++.
272
273
274 SUMMARY OF CONFIGURE OPTIONS:
275 ----------------------------
276
277     The configure script provides a short list of its options when you type
278
279         ./configure --help
280
281     The --help and several options are common to all configure scripts that are
282     generated with autoconf.  Those are all listed before the line
283
284         --enable and --with options recognized:
285
286     The other options are specific to this package.  We list them in alphabetic
287     order.
288
289     --disable-assumed-color
290         With ncurses 5.1, we introduced a new function, assume_default_colors()
291         which allows applications to specify what the default foreground and
292         background color are assumed to be.  Most color applications use
293         full-screen color; but a few do not color the background.  While the
294         assumed values can be overridden by invoking assume_default_colors(),
295         you may find it useful to set the assumed values to the pre-5.1
296         convention, using this configure option.
297
298     --disable-big-core
299         Assume machine has little memory.  The configure script attempts to
300         determine if your machine has enough memory (about 6Mb) to compile the
301         terminfo database without writing portions to disk.  Some allocators
302         return deceptive results, so you may have to override the configure
303         script.  Or you may be building tic for a smaller machine.
304
305     --disable-big-strings
306         Disable compile-time optimization of predefined tables which puts
307         all of their strings into a very long string, to reduce relocation
308         overhead.
309
310     --disable-database
311         Use only built-in data.  The ncurses libraries normally read terminfo
312         and termcap data from disk.  You can configure ncurses to have a
313         built-in database, aka "fallback" entries.  Embedded applications may
314         have no need for an external database.  Some, but not all of the
315         programs are useful in this configuration, e.g., reset and tput versus
316         infocmp and tic.
317
318     --disable-ext-funcs
319         Disable function-extensions.  Configure ncurses without the functions
320         that are not specified by XSI.  See ncurses/modules for the exact
321         list of library modules that would be suppressed.
322
323     --disable-hashmap
324         Compile without hashmap scrolling-optimization code.  This algorithm is
325         the default.
326
327     --disable-home-terminfo
328         The $HOME/.terminfo directory is normally added to ncurses' search
329         list for reading/writing terminfo entries, since that directory is
330         more likely writable than the system terminfo database.  Use this
331         option to disable the feature altogether.
332
333     --disable-largefile
334         Disable compiler flags needed to use large-file interfaces.
335
336     --disable-libtool-version
337         when using --with-libtool, control how the major/minor version numbers
338         are used for constructing the library name.
339
340         The default uses the -version-number feature of libtool, which makes
341         the library names compatible (though not identical) with the standard
342         build using --with-shared.
343
344         Use --disable-libtool-version to use the libtool -version-info feature.
345         This corresponds to the setting used before patch 20100515.
346
347     --disable-leaks
348         For testing, compile-in code that frees memory that normally would not
349         be freed, to simplify analysis of memory-leaks.
350
351         Any implementation of curses must not free the memory associated with
352         a screen, since (even after calling endwin()), it must be available
353         for use in the next call to refresh().  There are also chunks of
354         memory held for performance reasons.  That makes it hard to analyze
355         curses applications for memory leaks.  To work around this, build
356         a debugging version of the ncurses library which frees those chunks
357         which it can, and provides the _nc_free_and_exit() function to free
358         the remainder on exit.  The ncurses utility and test programs use this
359         feature, e.g., via the ExitProgram() macro.
360
361     --disable-lp64
362         The header files will ignore use of the _LP64 symbol to make chtype
363         and mmask_t types 32 bits (they may be long on 64-bit hosts, for
364         compatibility with older releases).
365
366         NOTE: this is potentially an ABI change, depending on existing
367         packages.  The default for this option is "disabled" for ncurses
368         ABI 5, and "enabled" for ABI 6.
369
370     --disable-macros
371         For testing, use functions rather than macros.  The program will run
372         more slowly, but it is simpler to debug.  This defines NCURSES_NOMACROS
373         at build time.  See also the --enable-expanded option.
374
375     --disable-overwrite
376         If you are installing ncurses on a system which contains another
377         development version of curses, or which could be confused by the loader
378         for another version, we recommend that you leave out the link to
379         -lcurses.  The ncurses library is always available as -lncurses.
380         Disabling overwrite also causes the ncurses header files to be
381         installed into a subdirectory, e.g., /usr/local/include/ncurses,
382         rather than the include directory.  This makes it simpler to avoid
383         compile-time conflicts with other versions of curses.h
384
385     --disable-relink
386         If --enable-rpath is given, the generated makefiles normally will
387         rebuild the libraries during install.  Use this option to simply
388         copy whatever the linked produced.
389
390         This option is ignored if --enable-rpath is not given.
391
392     --disable-root-environ
393         Compile with environment restriction, so certain environment variables
394         are not available when running as root, or via a setuid/setgid
395         application.  These are (for example $TERMINFO) those that allow the
396         search path for the terminfo or termcap entry to be customized.
397
398     --disable-rpath-hack
399         Normally the configure script helps link libraries found in unusual
400         places by adding an rpath option to the link command.  If you are
401         building packages, this feature may be redundant.  Use this option
402         to suppress the feature.
403
404     --disable-scroll-hints
405         Compile without scroll-hints code.  This option is ignored when
406         hashmap scrolling is configured, which is the default.
407
408     --disable-tic-depends
409         When building shared libraries, normally the tic library is linked to
410         depend upon the ncurses library (and in turn, on the term-library if
411         the --with-termlib option was given).  The tic- and term-libraries
412         ABI does not depend on the --enable-widec option. Some packagers have
413         used this to reduce the number of library files which are packaged
414         by using only one copy of those libraries.  To make this work properly,
415         the tic library must be built without an explicit dependency on the
416         ncurses (or ncursesw) library.  Use this configure option to do that.
417         For example
418                 configure --with-ticlib --with-shared --disable-tic-depends
419
420     --disable-tparm-varargs
421         Portable programs should call tparm() using the fixed-length parameter
422         list documented in X/Open.  ncurses provides varargs support for this
423         function.  Use --disable-tparm-varargs to disable this support.
424
425     --enable-assertions
426         For testing, compile-in assertion code.  This is used only for a few
427         places where ncurses cannot easily recover by returning an error code.
428
429     --enable-broken_linker
430         A few platforms have what we consider a broken linker:  it cannot link
431         objects from an archive solely by referring to data objects in those
432         files, but requires a function reference.  This configure option
433         changes several data references to functions to work around this
434         problem.
435
436         NOTE: With ncurses 5.1, this may not be necessary, since we are
437         told that some linkers interpret uninitialized global data as a
438         different type of reference which behaves as described above.  We have
439         explicitly initialized all of the global data to work around the
440         problem.
441
442     --enable-bsdpad
443         Recognize BSD-style prefix padding.  Some ancient BSD programs (such as
444         nethack) call tputs("50") to implement delays.
445
446     --enable-colorfgbg
447         Compile with experimental $COLORFGBG code.  That environment variable
448         is set by some terminal emulators as a hint to applications, by
449         advertising the default foreground and background colors.  During
450         initialization, ncurses sets color pair 0 to match this.
451
452     --enable-const
453         The curses interface as documented in XSI is rather old, in fact
454         including features that precede ANSI C.  The prototypes generally do
455         not make effective use of "const".  When using stricter compilers (or
456         gcc with appropriate warnings), you may see warnings about the mismatch
457         between const and non-const data.  We provide a configure option which
458         changes the interfaces to use const - quieting these warnings and
459         reflecting the actual use of the parameters more closely.  The ncurses
460         library uses the symbol NCURSES_CONST for these instances of const,
461         and if you have asked for compiler warnings, will add gcc's const-qual
462         warning.  There will still be warnings due to subtle inconsistencies
463         in the interface, but at a lower level.
464
465         NOTE: configuring ncurses with this option may detract from the
466         portability of your applications by encouraging you to use const in
467         places where the XSI curses interface would not allow them.  Similar
468         issues arise when porting to SVr4 curses, which uses const in even
469         fewer places.
470
471     --enable-echo
472         Use the option --disable-echo to make the build-log less verbose by
473         suppressing the display of the compile and link commands.  This makes
474         it easier to see the compiler warnings.  (You can always use "make -n"
475         to see the options that are used).
476
477     --enable-expanded
478         For testing, generate functions for certain macros to make them visible
479         as such to the debugger.  See also the --disable-macros option.
480
481     --enable-ext-colors
482         Extend the cchar_t structure to allow more than 16 colors to be
483         encoded.  This applies only to the wide-character (--enable-widec)
484         configuration.
485
486         NOTE: using this option will make libraries which are not binary-
487         compatible with libncursesw 5.4.  None of the interfaces change, but
488         applications which have an array of cchar_t's must be recompiled.
489
490     --enable-ext-mouse
491         Modify the encoding of mouse state to make room for a 5th mouse button.
492         That allows one to use ncurses with a wheel mouse with xterm or
493         similar X terminal emulators.
494
495         NOTE: using this option will make libraries which are not binary-
496         compatible with libncursesw 5.4.  None of the interfaces change, but
497         applications which have mouse mask mmask_t's must be recompiled.
498
499     --enable-getcap
500         Use the 4.4BSD getcap code if available, or a bundled version of it to
501         fetch termcap entries.  Entries read in this way cannot use (make
502         cross-references to) the terminfo tree, but it is faster than reading
503         /etc/termcap.
504
505         If configured for one of the *BSD systems, this automatically uses
506         the hashed database system produced using cap_mkdb or similar tools.
507         In that case, there is no advantage in using the --enable-getcap-cache
508         option.
509
510         See also the --with-hashed-db option.
511
512     --enable-getcap-cache
513         Cache translated termcaps under the directory $HOME/.terminfo
514
515         NOTE: this sounds good - it makes ncurses run faster the second time.
516         But look where the data comes from - an /etc/termcap containing lots of
517         entries that are not up to date.  If you configure with this option and
518         forget to install the terminfo database before running an ncurses
519         application, you will end up with a hidden terminfo database that
520         generally does not support color and will miss some function keys.
521
522     --enable-hard-tabs
523         Compile-in cursor-optimization code that uses hard-tabs.  We would make
524         this a standard feature except for the concern that the terminfo entry
525         may not be accurate, or that your stty settings have disabled the use
526         of tabs.
527
528     --enable-interop
529         Compile-in experimental interop bindings.  These provide generic types
530         for the form-library.
531
532     --enable-mixed-case
533         Controls whether the filesystem on which the terminfo database resides
534         supports mixed-case filenames (normal for UNIX, but not on other
535         systems).  If you do not specify this option, the configure script
536         checks the current filesystem.
537
538     --enable-no-padding
539         Compile-in support for the $NCURSES_NO_PADDING environment variable,
540         which allows you to suppress the effect of non-mandatory padding in
541         terminfo entries.  This is the default, unless you have disabled the
542         extended functions.
543
544     --enable-pc-files
545         If pkg-config is found (see --with-pkg-config), generate ".pc" files
546         for each of the libraries, and install them in pkg-config's library
547         directory.
548
549     --enable-pthreads-eintr
550         add logic in threaded configuration to ensure that a read(2) system
551         call can be interrupted for SIGWINCH.
552
553     --enable-reentrant
554         Compile experimental configuration which improves reentrant use of the
555         library by reducing global and static variables.  This option is also
556         set if --with-pthread is used.
557
558     --enable-rpath
559         Use rpath option when generating shared libraries, and (with some
560         restrictions) when linking the corresponding programs.  This originally
561         (in 1997) applied mainly to systems using the GNU linker (read the
562         manpage).
563
564         More recently it is useful for systems that require special treatment
565         shared libraries in "unusual" locations.  The "system" libraries reside
566         in directories which are on the loader's default search-path.  While
567         you may be able to use workarounds such as the $LD_LIBRARY_PATH
568         environment variable, they do not work with setuid applications since
569         the LD_LIBRARY_PATH variable would be unset in that situation.
570
571         This option does not apply to --with-libtool, since libtool makes
572         extra assumptions about rpath.
573
574     --enable-safe-sprintf
575         Compile with experimental safe-sprintf code.  You may consider using
576         this if you are building ncurses for a system that has neither
577         vsnprintf() or vsprintf().  It is slow, however.
578
579     --enable-sigwinch
580         Compile support for ncurses' SIGWINCH handler.  If your application has
581         its own SIGWINCH handler, ncurses will not use its own.  The ncurses
582         handler causes wgetch() to return KEY_RESIZE when the screen-size
583         changes.  This option is the default, unless you have disabled the
584         extended functions.
585
586     --enable-signed-char
587         The term.h header declares a Booleans[] array typed "char".  But it
588         stores signed values there and "char" is not necessarily signed.
589         Some packagers choose to alter the type of Booleans[] though this
590         is not strictly compatible.  This option allows one to implement this
591         alteration without patching the source code.
592
593     --enable-sp-funcs
594         Compile-in support for extended functions which accept a SCREEN pointer,
595         reducing the need for juggling the global SP value with set_term() and
596         delscreen().
597
598     --enable-symlinks
599         If your system supports symbolic links, make tic use symbolic links
600         rather than hard links to save diskspace when writing aliases in the
601         terminfo database.
602
603     --enable-tcap-names
604         Compile-in support for user-definable terminal capabilities.  Use the
605         -x option of tic and infocmp to treat unrecognized terminal
606         capabilities as user-defined strings.  This option is the default,
607         unless you have disabled the extended functions.
608
609     --enable-term-driver
610         Enable experimental terminal-driver.  This is currently used for the
611         MinGW port, by providing a way to substitute the low-level terminfo
612         library with different terminal drivers.
613
614     --enable-termcap
615         Compile in support for reading terminal descriptions from termcap if no
616         match is found in the terminfo database.  See also the --enable-getcap
617         and --enable-getcap-cache options.
618
619         Termcap support requires run-time parsing rather than loading
620         predigested data.  If you have specified --with-ticlib, then you
621         cannot have termcap support since run-time parsing is done in the
622         tic library, which is intentionally not part of normal linkage
623         dependencies.
624
625     --enable-warnings
626         Turn on GCC compiler warnings.  There should be only a few.
627
628     --enable-weak-symbols
629         If the --with-pthread option is set, check if the compiler supports
630         weak-symbols.  If it does, then name the thread-capable library without
631         the "t" (libncurses rather than libncursest), and provide for
632         dynamically loading the pthreads entrypoints at runtime.  This allows
633         one to reduce the number of library files for ncurses.
634
635     --enable-wgetch-events
636         Compile with experimental wgetch-events code.  See ncurses/README.IZ
637
638     --enable-widec
639         Compile with wide-character code.  This makes a different version of
640         the libraries (e.g., libncursesw.so), which stores characters as
641         wide-characters,
642
643         NOTE: applications compiled with this configuration are not compatible
644         with those built for 8-bit characters.  You cannot simply make a
645         symbolic link to equate libncurses.so with libncursesw.so
646
647         NOTE: the Ada95 binding may be built against either version of the the
648         ncurses library, but you must decide which:  the binding installs the
649         same set of files for either version.  Currently (2002/6/22) it does
650         not use the extended features from the wide-character code, so it is
651         probably better to not install the binding for that configuration.
652
653     --enable-xmc-glitch
654         Compile-in support experimental xmc (magic cookie) code.
655
656     --with-abi-version=NUM
657         Override the ABI version, which is used in shared library filenames.
658         Normally this is the same as the release version; some ports have
659         special requirements for compatibility.
660
661         This option does not affect linking with libtool, which uses the
662         release major/minor numbers.
663
664     --with-ada-compiler=CMD
665         Specify the Ada95 compiler command (default "gnatmake")
666
667     --with-ada-include=DIR
668         Tell where to install the Ada includes (default:
669         PREFIX/lib/ada/adainclude)
670
671     --with-ada-objects=DIR
672         Tell where to install the Ada objects (default:  PREFIX/lib/ada/adalib)
673
674     --with-ada-sharedlib
675         Build a shared library for Ada95 binding, if the compiler permits.
676
677         NOTE: You must also set the --with-shared option on some platforms
678         for a successful build.  You need not use this option when you set
679         --with-shared, unless you want to use the Ada shared library.
680
681     --with-bool=TYPE
682         If --without-cxx is specified, override the type used for the "bool"
683         declared in curses.h (normally the type is automatically chosen to
684         correspond with that in <stdbool.h>, or defaults to platform-specific
685         sizes).
686
687     --with-build-cpp=XXX
688         This option is provided by the same macro used for $BUILD_CC, etc.,
689         but is not directly used by ncurses.
690
691     --with-build-cc=XXX
692         If cross-compiling, specify a host C compiler, which is needed to
693         compile a few utilities which generate source modules for ncurses.
694         If you do not give this option, the configure script checks if the
695         $BUILD_CC variable is set, and otherwise defaults to gcc or cc.
696
697     --with-build-cflags=XXX
698         If cross-compiling, specify the host C compiler-flags.  You might need
699         to do this if the target compiler has unusual flags which confuse the
700         host compiler.
701
702         You can also set the environment variable $BUILD_CFLAGS rather than
703         use this option.
704
705     --with-build-cppflags=XXX
706         If cross-compiling, specify the host C preprocessor-flags.  You might
707         need to do this if the target compiler has unusual flags which confuse
708         the host compiler.
709
710         You can also set the environment variable $BUILD_CPPFLAGS rather than
711         use this option.
712
713     --with-build-ldflags=XXX
714         If cross-compiling, specify the host linker-flags.  You might need to
715         do this if the target linker has unusual flags which confuse the host
716         compiler.
717
718         You can also set the environment variable $BUILD_LDFLAGS rather than
719         use this option.
720
721     --with-build-libs=XXX
722         If cross-compiling, the host libraries.  You might need to do this if
723         the target environment requires unusual libraries.
724
725         You can also set the environment variable $BUILD_LIBS rather than
726         use this option.
727
728     --with-caps=XXX
729         Specify an alternate terminfo capabilities file, which makes the
730         configure script look for "include/Caps.XXX".  A few systems, e.g.,
731         AIX 4.x use the same overall file-format as ncurses for terminfo
732         data, but use different alignments within the tables to support
733         legacy applications.  For those systems, you can configure ncurses
734         to use a terminfo database which is compatible with the native
735         applications.
736
737     --with-ccharw-max=XXX
738         Override the size of the wide-character array in cchar_t structures.
739         Changing this will alter the binary interface.  This defaults to 5.
740
741     --with-chtype=TYPE
742         Override type of chtype, which stores the video attributes and (if
743         --enable-widec is not given) a character.  Prior to ncurses 5.5, this
744         was always unsigned long, but with ncurses 5.5, it may be unsigned.
745         Use this option if you need to preserve compatibility with 64-bit
746         executables, e.g., by setting "--with-chtype=long" (the configure
747         script supplies "unsigned").
748
749     --with-database=XXX
750         Specify the terminfo source file to install.  Usually you will wish
751         to install ncurses' default (misc/terminfo.src).  Certain systems
752         have special requirements, e.g, OS/2 EMX has a customized terminfo
753         source file.
754
755     --with-dbmalloc
756         For testing, compile and link with Conor Cahill's dbmalloc library.
757         This also sets the --disable-leaks option.
758
759     --with-debug
760         Generate debug-libraries (default).  These are named by adding "_g"
761         to the root, e.g., libncurses_g.a
762
763     --with-default-terminfo-dir=XXX
764         Specify the default terminfo database directory.  This is normally
765         DATADIR/terminfo, e.g., /usr/share/terminfo.
766
767     --with-dmalloc
768         For testing, compile and link with Gray Watson's dmalloc library.
769         This also sets the --disable-leaks option.
770
771     --with-fallbacks=XXX
772         Specify a list of fallback terminal descriptions which will be
773         compiled into the ncurses library.  See CONFIGURING FALLBACK ENTRIES.
774
775     --with-gpm
776         use Alessandro Rubini's GPM library to provide mouse support on the
777         Linux console.  Prior to ncurses 5.5, this introduced a dependency on
778         the GPM library.
779
780         Currently ncurses uses the dlsym() function to bind to the library at
781         runtime, so it is only necessary that the library be present when
782         ncurses is built, to obtain the filename (or soname) used in the
783         corresponding dlopen() call.  If you give a value for this option,
784         e.g.,
785
786                 --with-gpm=$HOME/tmp/test-gpm.so
787
788         that overrides the configure check for the soname.
789
790         See also --without-dlsym
791
792     --with-hashed-db[=XXX]
793         Use a hashed database for storing terminfo data rather than storing
794         each compiled entry in a separate binary file within a directory
795         tree.
796
797         In particular, this uses the Berkeley database 1.8.5 interface, as
798         provided by that and its successors db 2, 3, and 4.  The actual
799         interface is slightly different in the successor versions of the
800         Berkeley database.  The database should have been configured using
801         "--enable-compat185".
802
803         If you use this option for configuring ncurses, tic will only be able
804         to write entries in the hashed database.  infocmp can still read
805         entries from a directory tree as well as reading entries from the
806         hashed database.  To do this, infocmp determines whether the $TERMINFO
807         variable points to a directory or a file, and reads the directory-tree
808         or hashed database respectively.
809
810         You cannot have a directory containing both hashed-database and
811         filesystem-based terminfo entries.
812
813         Use the parameter value to give the install-prefix used for the
814         datbase, e.g.,
815                 --with-hashed-db=/usr/local/BigBase
816         to find the corresponding include- and lib-directories under the
817         given directory.
818
819         See also the --enable-getcap option.
820
821     --with-install-prefix=XXX
822         Allows you to specify an alternate location for installing ncurses
823         after building it.  The value you specify is prepended to the "real"
824         install location.  This simplifies making binary packages.  The
825         makefile variable DESTDIR is set by this option.  It is also possible
826         to use
827                 make install DESTDIR=XXX
828         since the makefiles pass that variable to subordinate makes.
829
830         NOTE: a few systems build shared libraries with fixed pathnames; this
831         option probably will not work for those configurations.
832
833      --with-libtool[=XXX]
834         Generate libraries with libtool.  If this option is selected, then it
835         overrides all other library model specifications.  Note that libtool
836         must already be installed, uses makefile rules dependent on GNU make,
837         and does not promise to follow the version numbering convention of
838         other shared libraries on your system.  However, if the --with-shared
839         option does not succeed, you may get better results with this option.
840
841         If a parameter value is given, it must be the full pathname of the
842         particular version of libtool, e.g.,
843                 /usr/bin/libtool-1.2.3
844
845         It is possible to rebuild the configure script to use the automake
846         macros for libtool, e.g., AC_PROG_LIBTOOL.  See the comments in
847         aclocal.m4 for CF_PROG_LIBTOOL, and ensure that you build configure
848         using the appropriate patch for autoconf from
849                 http://invisible-island.net/autoconf/
850
851     --with-manpage-aliases
852         Tell the configure script you wish to create entries in the
853         man-directory for aliases to manpages which list them, e.g., the
854         functions in the panel manpage.  This is the default.  You can disable
855         it if your man program does this.  You can also disable
856         --with-manpage-symlinks to install files containing a ".so" command
857         rather than symbolic links.
858
859     --with-manpage-format=XXX
860         Tell the configure script how you would like to install man-pages.  The
861         option value must be one of these:  gzip, compress, BSDI, normal,
862         formatted.  If you do not give this option, the configure script
863         attempts to determine which is the case.
864
865     --with-manpage-renames=XXX
866         Tell the configure script that you wish to rename the manpages while
867         installing.  Currently the only distribution which does this is Debian.
868         The option value specifies the name of a file that lists the renamed
869         files, e.g., $srcdir/man/man_db.renames
870
871     --with-manpage-symlinks
872         Tell the configure script that you wish to make symbolic links in the
873         man-directory for aliases to the man-pages.  This is the default, but
874         can be disabled for systems that provide this automatically.  Doing
875         this on systems that do not support symbolic links will result in
876         copying the man-page for each alias.
877
878     --with-manpage-tbl
879         Tell the configure script that you with to preprocess the manpages
880         by running them through tbl to generate tables understandable by
881         nroff.
882
883     --with-mmask-t=TYPE
884         Override type of mmask_t, which stores the mouse mask.  Prior to
885         ncurses 5.5, this was always unsigned long, but with ncurses 5.5, it
886         may be unsigned.  Use this option if you need to preserve compatibility
887         with 64-bit executables.
888
889     --with-normal
890         Generate normal (i.e., static) libraries (default).
891
892         Note:  on Linux, the configure script will attempt to use the GPM
893         library via the dlsym() function call.  Use --without-dlsym to disable
894         this feature, or --without-gpm, depending on whether you wish to use
895         GPM.
896
897     --with-ospeed=TYPE
898         Override type of ospeed variable, which is part of the termcap
899         compatibility interface.  In termcap, this is a 'short', which works
900         for a wide range of baudrates because ospeed is not the actual speed
901         but the encoded value, e.g., B9600 would be a small number such as 13.
902         However the encoding scheme originally allowed for values "only" up to
903         38400bd.  A newer set of definitions past 38400bd is not encoded as
904         compactly, and is not guaranteed to fit into a short (see the function
905         cfgetospeed(), which returns a speed_t for this reason).  In practice,
906         applications that required knowledge of the ospeed variable, i.e.,
907         those using termcap, do not use the higher speeds.  Your application
908         (or system, in general) may or may not.
909
910     --with-pkg-config=[DIR]
911         Check for pkg-config, optionally specifying its path.
912
913     --with-profile
914         Generate profile-libraries These are named by adding "_p" to the root,
915         e.g., libncurses_p.a
916
917     --with-pthread
918         Link with POSIX threads, set --enable-reentrant.  The use_window() and
919         use_screen() functions will use mutex's, allowing rudimentary support
920         for multithreaded applications.
921
922     --with-rcs-ids
923         Compile-in RCS identifiers.  Most of the C files have an identifier.
924
925     --with-rel-version=NUM
926         Override the release version, which may be used in shared library
927         filenames.  This consists of a major and minor version number separated
928         by ".".  Normally the major version number is the same as the ABI
929         version; some ports have special requirements for compatibility.
930
931     --with-shared
932         Generate shared-libraries.  The names given depend on the system for
933         which you are building, typically using a ".so" suffix, along with
934         symbolic links that refer to the release version.
935
936         NOTE: Unless you override the configure script by setting the $CFLAGS
937         environment variable, these will not be built with the -g debugging
938         option.
939
940         NOTE: For some configurations, e.g., installing a new version of
941         ncurses shared libraries on a machine which already has ncurses
942         shared libraries, you may encounter problems with the linker.
943         For example, it may prevent you from running  the build tree's
944         copy of tic (for installing the terminfo database) because it
945         loads the system's copy of the ncurses shared libraries.  In that
946         case, using the misc/shlib script may be helpful, since it sets
947         $LD_LIBRARY_PATH to point to the build tree, e.g.,
948                 ./misc/shlib make install
949
950         NOTE: If you use the --with-ada-sharedlib option, you should also
951         set this option, to ensure that C-language modules needed for the
952         Ada binding use appropriate compiler options.
953
954     --with-shlib-version=XXX
955         Specify whether to use the release or ABI version for shared libraries.
956         This is normally chosen automatically based on the type of system
957         which you are building on.  We use it for testing the configure script.
958
959     --with-sysmouse
960         use FreeBSD sysmouse interface provide mouse support on the console.
961
962     --with-system-type=XXX
963         For testing, override the derived host system-type which is used to
964         decide things such as the linker commands used to build shared
965         libraries.  This is normally chosen automatically based on the type of
966         system which you are building on.  We use it for testing the configure
967         script.
968
969     --with-terminfo-dirs=XXX
970         Specify a search-list of terminfo directories which will be compiled
971         into the ncurses library (default: DATADIR/terminfo)
972
973     --with-termlib[=XXX]
974         When building the ncurses library, organize this as two parts:  the
975         curses library (libncurses) and the low-level terminfo library
976         (libtinfo).  This is done to accommodate applications that use only
977         the latter.  The terminfo library is about half the size of the total.
978
979         If an option value is given, that overrides the name of the terminfo
980         library.  For instance, if the wide-character version is built, the
981         terminfo library would be named libtinfow.  But the libtinfow interface
982         is upward compatible from libtinfo, so it would be possible to overlay
983         libtinfo.so with a "wide" version of libtinfow.so by renaming it with
984         this option.
985
986     --with-termpath=XXX
987         Specify a search-list of termcap files which will be compiled into the
988         ncurses library (default:  /etc/termcap:/usr/share/misc/termcap)
989
990     --with-ticlib[=XXX]
991         When building the ncurses library, build a separate library for
992         the modules that are used only by the utility programs.  Normally
993         those would be bundled with the termlib or ncurses libraries.
994
995         If an option value is given, that overrides the name of the tic
996         library.  As in termlib, there is no ABI difference between the
997         "wide" libticw.so and libtic.so
998
999         NOTE: Overriding the name of the tic library may be useful if you are
1000         also using the --with-termlib option to rename libtinfo.  If you are
1001         not doing that, renaming the tic library can result in conflicting
1002         library dependencies for tic and other programs built with the tic
1003         library.
1004
1005     --with-trace
1006         Configure the trace() function as part of the all models of the ncurses
1007         library.  Normally it is part of the debug (libncurses_g) library only.
1008
1009     --with-valgrind
1010         For testing, compile with debug option.
1011         This also sets the --disable-leaks option.
1012
1013     --with-wrap-prefix=XXX
1014         When using the --enable-reentrant option, ncurses redefines variables
1015         that would be global in curses, e.g., LINES, as a macro that calls a
1016         "wrapping" function which fetches the data from the current SCREEN
1017         structure.  Normally that function is named by prepending "_nc_" to the
1018         variable's name.  The function is technically private (since portable
1019         applications would not refer directly to it).  But according to one
1020         line of reasoning, it is not the same type of "private" as functions
1021         which applications should not call even via a macro.  This configure
1022         option lets you choose the prefix for these wrapped variables.
1023
1024     --without-ada
1025         Suppress the configure script's check for Ada95, do not build the
1026         Ada95 binding and related demo.
1027
1028     --without-curses-h
1029         Don't install the ncurses header with the name "curses.h".  Rather,
1030         install as "ncurses.h" and modify the installed headers and manpages
1031         accordingly.
1032
1033     --without-cxx
1034         XSI curses declares "bool" as part of the interface.  C++ also declares
1035         "bool".  Neither specifies the size and type of booleans, but both
1036         insist on the same name.  We chose to accommodate this by making the
1037         configure script check for the size and type (e.g., unsigned or signed)
1038         that your C++ compiler uses for booleans.  If you do not wish to use
1039         ncurses with C++, use this option to tell the configure script to not
1040         adjust ncurses bool to match C++.
1041
1042     --without-cxx-binding
1043         Suppress the configure script's check for C++, do not build the
1044         C++ binding and related demo.
1045
1046     --without-develop
1047         Disable development options.  This does not include those that change
1048         the interface, such as --enable-widec.
1049
1050     --without-dlsym
1051         Do not use dlsym() to load GPM dynamically.
1052
1053     --without-manpages
1054         Tell the configure script to suppress the install of ncurses' manpages.
1055
1056     --without-progs
1057         Tell the configure script to suppress the build of ncurses' application
1058         programs (e.g., tic).  The test applications will still be built if you
1059         type "make", though not if you simply do "make install".
1060
1061     --without-tests
1062         Tell the configure script to suppress the build of ncurses' test
1063         programs.
1064
1065     --without-xterm-new
1066         Tell the configure script to use "xterm-old" for the entry used in
1067         the terminfo database.  This will work with variations such as
1068         X11R5 and X11R6 xterm.
1069
1070
1071 COMPATIBILITY WITH OLDER VERSIONS OF NCURSES:
1072 --------------------------------------------
1073
1074     Because ncurses implements the X/Open Curses Specification, its interface
1075     is fairly stable.  That does not mean the interface does not change.
1076     Changes are made to the documented interfaces when we find differences
1077     between ncurses and X/Open or implementations which they certify (such as
1078     Solaris).  We add extensions to those interfaces to solve problems not
1079     addressed by the original curses design, but those must not conflict with
1080     the X/Open documentation.
1081
1082     Here are some of the major interface changes, and related problems which
1083     you may encounter when building a system with different versions of
1084     ncurses:
1085
1086     5.8 (Feb 26, 2011)
1087         Interface changes:
1088
1089         + add an alternate library configuration, i.e., "terminal driver" to
1090           support port to Windows, built with MinGW.  There are two drivers
1091           (terminfo and Windows console).  The terminfo driver works on other
1092           platforms.
1093
1094         + add a new set of functions which accept a SCREEN* parameter, in
1095           contrast with the original set which use the global value "sp".
1096           By default, these names end with "_sp", and are otherwise
1097           functionally identical with the originals.
1098
1099           In addition to the "_sp" functions, there are a few new functions
1100           associated with this feature:  ceiling_panel, ground_panel,
1101           new_prescr.
1102
1103           If the library is not built with the sp-funcs extension, there
1104           are no related interface changes.
1105
1106         + add tiparm function based on review of X/Open Curses Issue 7.
1107
1108         + change internal _nc_has_mouse function to public has_mouse function
1109
1110         Added extensions:
1111
1112         + add a few more functions to support the NCURSES_OPAQUE feature:
1113           get_escdelay, is_pad, is_subwin
1114
1115         Added internal functions (other than "_sp" variants):
1116                 _nc_curscr_of
1117                 _nc_format_slks
1118                 _nc_get_alias_table
1119                 _nc_get_hash_info
1120                 _nc_insert_wch
1121                 _nc_newscr_of
1122                 _nc_outc_wrapper
1123                 _nc_retrace_char
1124                 _nc_retrace_int_attr_t
1125                 _nc_retrace_mmask_t
1126                 _nc_setup_tinfo
1127                 _nc_stdscr_of
1128                 _nc_tinfo_cmdch
1129
1130         Removed internal functions:
1131                 _nc_makenew (some configurations replace by _nc_makenew_sp)
1132
1133         Modified internal functions:
1134                 _nc_UpdateAttrs
1135                 _nc_get_hash_table
1136                 _nc_has_mouse
1137                 _nc_insert_ch
1138                 _nc_wgetch
1139
1140     5.7 (November 2, 2008)
1141         Interface changes:
1142
1143         + generate linkable stubs for some macros:
1144                 getattrs
1145
1146         + Add new library configuration for tic-library (the non-curses portion
1147           of the ncurses library used for the tic program as well as some
1148           others such as tack.  There is no API change, but makefiles would be
1149           changed to use the tic-library built separately.
1150
1151           tack, distributed separately from ncurses, uses some of the internal
1152           _nc_XXX functions, which are declared in the tic.h header file.
1153
1154           The reason for providing this separate library is that none of the
1155           functions in it are suitable for threaded applications.
1156
1157         + Add new library configuration (ncursest, ncurseswt) which provides
1158           rudimentary support for POSIX threads.  This introduces opaque
1159           access functions to the WINDOW structure and adds a parameter to
1160           several internal functions.
1161
1162         + move most internal variables (except tic-library) into data blocks
1163           _nc_globals and _nc_prescreen to simplify analysis.  Those were
1164           globally accessible, but since they were not part of the documented
1165           API, there is no ABI change.
1166
1167         + changed static tables of strings to be indices into long strings, to
1168           improve startup performance.  This changes parameter lists for some
1169           of the internal functions.
1170
1171         Added extensions:
1172
1173         + add NCURSES_OPAQUE definition in curses.h to control whether internal
1174           details of the WINDOW structure are visible to an application.  This
1175           is always defined when the threaded library is built, and is optional
1176           otherwise.  New functions for this:  is_cleared, is_idcok, is_idlok,
1177           is_immedok, is_keypad, is_leaveok, is_nodelay, is_notimeout,
1178           is_scrollok, is_syncok, wgetparent and wgetscrreg.
1179
1180         + the threaded library (ncursest) also disallows direct updating of
1181           global curses-level variables, providing functions (via macros) for
1182           obtaining their value.  A few of those variables can be modified by
1183           the application, using new functions:  set_escdelay, set_tabsize
1184
1185         + added functions use_window() and use_screen() which wrap a mutex
1186           (if threading is configured) around a call to a user-supplied
1187           function.
1188
1189         Added internal functions:
1190                 _nc_get_alias_table
1191                 _nc_get_screensize
1192                 _nc_keyname
1193                 _nc_screen_of
1194                 _nc_set_no_padding
1195                 _nc_tracechar
1196                 _nc_tracemouse
1197                 _nc_unctrl
1198                 _nc_ungetch
1199
1200                 These are used for leak-testing, and are stubs for
1201                 ABI compatibility when ncurses is not configured for that
1202                 using the --disable-leaks configure script option:
1203
1204                 _nc_free_and_exit
1205                 _nc_leaks_tinfo
1206
1207         Removed internal functions:
1208                 none
1209
1210         Modified internal functions:
1211                 _nc_fifo_dump
1212                 _nc_find_entry
1213                 _nc_handle_sigwinch
1214                 _nc_init_keytry
1215                 _nc_keypad
1216                 _nc_locale_breaks_acs
1217                 _nc_timed_wait
1218                 _nc_update_screensize
1219
1220                 Use new typedef TRIES to replace "struct tries":
1221
1222                 _nc_add_to_try
1223                 _nc_expand_try
1224                 _nc_remove_key
1225                 _nc_remove_string
1226                 _nc_trace_tries
1227
1228     5.6 (December 17, 2006)
1229         Interface changes:
1230
1231         + generate linkable stubs for some macros:
1232
1233           getbegx, getbegy, getcurx, getcury, getmaxx, getmaxy, getparx,
1234           getpary, getpary,
1235
1236           and (for libncursesw)
1237
1238           wgetbkgrnd
1239
1240         Added extensions:
1241                 nofilter()
1242                 use_legacy_coding()
1243
1244         Added internal functions:
1245                 _nc_first_db
1246                 _nc_get_source
1247                 _nc_handle_sigwinch
1248                 _nc_is_abs_path
1249                 _nc_is_dir_path
1250                 _nc_is_file_path
1251                 _nc_keep_tic_dir
1252                 _nc_keep_tic_dir
1253                 _nc_last_db
1254                 _nc_next_db
1255                 _nc_read_termtype
1256                 _nc_tic_dir
1257
1258                 Also (if using the hashed database configuration):
1259
1260                 _nc_db_close
1261                 _nc_db_first
1262                 _nc_db_get
1263                 _nc_db_have_data
1264                 _nc_db_have_index
1265                 _nc_db_next
1266                 _nc_db_open
1267                 _nc_db_put
1268
1269                 otherwise
1270
1271                 _nc_hashed_db
1272
1273         Removed internal functions:
1274                 none
1275
1276         Modified internal functions:
1277                 _nc_add_to_try
1278                 _nc_do_color
1279                 _nc_expand_try
1280                 _nc_remove_key
1281                 _nc_setupscreen
1282
1283     5.5 (October 10, 2005)
1284         Interface changes:
1285
1286         + terminfo installs "xterm-new" as "xterm" entry rather than
1287           "xterm-old" (aka xterm-r6).
1288
1289         + terminfo data is installed using the tic -x option (few systems
1290           still use ncurses 4.2).
1291
1292         + modify C++ binding to work with newer C++ compilers by providing
1293           initializers and using modern casts.  Old-style header names are
1294           still used in this release to allow compiling with not-so-old
1295           compilers.
1296
1297         + form and menu libraries now work with wide-character data.
1298           Applications which bypassed the form library and manipulated the
1299           FIELD.buf data directly will not work properly with libformw, since
1300           that no longer points to an array of char.  The set_field_buffer()
1301           and field_buffer() functions translate to/from the actual field
1302           data.
1303
1304         + change SP->_current_attr to a pointer, adjust ifdef's to ensure that
1305           libtinfo.so and libtinfow.so have the same ABI.  The reason for this
1306           is that the corresponding data which belongs to the upper-level
1307           ncurses library has a different size in each model.
1308
1309         + winnstr() now returns multibyte character strings for the
1310           wide-character configuration.
1311
1312         + assume_default_colors() no longer requires that use_default_colors()
1313           be called first.
1314
1315         + data_ahead() now works with wide-characters.
1316
1317         + slk_set() and slk_wset() now accept and store multibyte or
1318           multicolumn characters.
1319
1320         + start_color() now returns OK if colors have already been started.
1321           start_color() also returns ERR if it cannot allocate memory.
1322
1323         + pair_content() now returns -1 for consistency with init_pair() if it
1324           corresponds to the default-color.
1325
1326         + unctrl() now returns null if its parameter does not correspond
1327           to an unsigned char.
1328
1329         Added extensions:
1330                 Experimental mouse version 2 supports wheel mice with buttons
1331                 4 and 5.  This requires ABI 6 because it modifies the encoding
1332                 of mouse events.
1333
1334                 Experimental extended colors allows encoding of 256 foreground
1335                 and background colors, e.g., with the xterm-256color or
1336                 xterm-88color terminfo entries.  This requires ABI 6 because
1337                 it changes the size of cchar_t.
1338
1339         Added internal functions:
1340                 _nc_check_termtype2
1341                 _nc_resolve_uses2
1342                 _nc_retrace_cptr
1343                 _nc_retrace_cvoid_ptr
1344                 _nc_retrace_void_ptr
1345                 _nc_setup_term
1346
1347         Removed internal functions:
1348                 none
1349
1350         Modified internal functions:
1351                 _nc_insert_ch
1352                 _nc_save_str
1353                 _nc_trans_string
1354
1355     5.4 (February 8, 2004)
1356         Interface changes:
1357
1358         + add the remaining functions for X/Open curses wide-character support.
1359           These are only available if the library is configured using the
1360           --enable-widec option.
1361                 pecho_wchar()
1362                 slk_wset()
1363
1364         + write getyx() and related 2-return macros in terms of getcury(),
1365           getcurx(), etc.
1366
1367         + simplify ifdef for bool declaration in curses.h
1368
1369         + modify ifdef's in curses.h that disabled use of __attribute__() for
1370           g++, since recent versions implement the cases which ncurses uses.
1371
1372         + change some interfaces to use const:
1373                 define_key()
1374                 mvprintw()
1375                 mvwprintw()
1376                 printw()
1377                 vw_printw()
1378                 winsnstr()
1379                 wprintw()
1380
1381         Added extensions:
1382                 key_defined()
1383
1384         Added internal functions:
1385                 _nc_get_locale()
1386                 _nc_insert_ch()
1387                 _nc_is_charable()       wide
1388                 _nc_locale_breaks_acs()
1389                 _nc_pathlast()
1390                 _nc_to_char()           wide
1391                 _nc_to_widechar()       wide
1392                 _nc_tparm_analyze()
1393                 _nc_trace_bufcat()      debug
1394                 _nc_unicode_locale()
1395
1396         Removed internal functions:
1397                 _nc_outstr()
1398                 _nc_sigaction()
1399
1400         Modified internal functions:
1401                 _nc_remove_string()
1402                 _nc_retrace_chtype()
1403
1404     5.3 (October 12, 2002)
1405         Interface changes:
1406
1407         + change type for bool used in headers to NCURSES_BOOL, which usually
1408           is the same as the compiler's definition for 'bool'.
1409
1410         + add all but two functions for X/Open curses wide-character support.
1411           These are only available if the library is configured using the
1412           --enable-widec option.  Missing functions are
1413                 pecho_wchar()
1414                 slk_wset()
1415
1416         + add environment variable $NCURSES_ASSUMED_COLORS to modify the
1417           assume_default_colors() extension.
1418
1419         Added extensions:
1420                 is_term_resized()
1421                 resize_term()
1422
1423         Added internal functions:
1424                 _nc_altcharset_name()   debug
1425                 _nc_reset_colors()
1426                 _nc_retrace_bool()      debug
1427                 _nc_retrace_unsigned()  debug
1428                 _nc_rootname()
1429                 _nc_trace_ttymode()     debug
1430                 _nc_varargs()           debug
1431                 _nc_visbufn()           debug
1432                 _nc_wgetch()
1433
1434         Removed internal functions:
1435                 _nc_background()
1436
1437         Modified internal functions:
1438                 _nc_freeall()           debug
1439
1440     5.2 (October 21, 2000)
1441         Interface changes:
1442
1443         + revert termcap ospeed variable to 'short' (see discussion of the
1444           --with-ospeed configure option).
1445
1446     5.1 (July 8, 2000)
1447         Interface changes:
1448
1449         + made the extended terminal capabilities
1450           (configure --enable-tcap-names) a standard feature.  This should
1451           be transparent to applications that do not require it.
1452
1453         + removed the trace() function and related trace support from the
1454           production library.
1455
1456         + modified curses.h.in, undef'ing some symbols to avoid conflict
1457           with C++ STL.
1458
1459         Added extensions:  assume_default_colors().
1460
1461     5.0 (October 23, 1999)
1462         Interface changes:
1463
1464         + implemented the wcolor_set() and slk_color() functions.
1465
1466         + move macro winch to a function, to hide details of struct ldat
1467
1468         + corrected prototypes for slk_* functions, using chtype rather than
1469           attr_t.
1470
1471         + the slk_attr_{set,off,on} functions need an additional void*
1472           parameter according to XSI.
1473
1474         + modified several prototypes to correspond with 1997 version of X/Open
1475           Curses:  [w]attr_get(), [w]attr_set(), border_set() have different
1476           parameters.  Some functions were renamed or misspelled:
1477           erase_wchar(), in_wchntr(), mvin_wchntr().  Some developers have used
1478           attr_get().
1479
1480         Added extensions:  keybound(), curses_version().
1481
1482         Terminfo database changes:
1483
1484         + change translation for termcap 'rs' to terminfo 'rs2', which is
1485           the documented equivalent, rather than 'rs1'.
1486
1487         The problems are subtler in recent releases.
1488
1489         a) This release provides users with the ability to define their own
1490            terminal capability extensions, like termcap.  To accomplish this,
1491            we redesigned the TERMTYPE struct (in term.h).  Very few
1492            applications use this struct.  They must be recompiled to work with
1493            the 5.0 library.
1494
1495         a) If you use the extended terminfo names (i.e., you used configure
1496            --enable-tcap-names), the resulting terminfo database can have some
1497            entries which are not readable by older versions of ncurses.  This
1498            is a bug in the older versions:
1499
1500            + the terminfo database stores booleans, numbers and strings in
1501              arrays.  The capabilities that are listed in the arrays are
1502              specified by X/Open.  ncurses recognizes a number of obsolete and
1503              extended names which are stored past the end of the specified
1504              entries.
1505
1506            + a change to read_entry.c in 951001 made the library do an lseek()
1507              call incorrectly skipping data which is already read from the
1508              string array.  This happens when the number of strings in the
1509              terminfo data file is greater than STRCOUNT, the number of
1510              specified and obsolete or extended strings.
1511
1512            + as part of alignment with the X/Open final specification, in the
1513              990109 patch we added two new terminfo capabilities:
1514              set_a_attributes and set_pglen_inch).  This makes the indices for
1515              the obsolete and extended capabilities shift up by 2.
1516
1517            + the last two capabilities in the obsolete/extended list are memu
1518              and meml, which are found in most terminfo descriptions for xterm.
1519
1520              When trying to read this terminfo entry, the spurious lseek()
1521              causes the library to attempt to read the final portion of the
1522              terminfo data (the text of the string capabilities) 4 characters
1523              past its starting point, and reads 4 characters too few.  The
1524              library rejects the data, and applications are unable to
1525              initialize that terminal type.
1526
1527            FIX: remove memu and meml from the xterm description.  They are
1528            obsolete, not used by ncurses.  (It appears that the feature was
1529            added to xterm to make it more like hpterm).
1530
1531            This is not a problem if you do not use the -x option of tic to
1532            create a terminfo database with extended names.  Note that the
1533            user-defined terminal capabilities are not affected by this bug,
1534            since they are stored in a table after the older terminfo data ends,
1535            and are invisible to the older libraries.
1536
1537         c) Some developers did not wish to use the C++ binding, and used the
1538            configure --without-cxx option.  This causes problems if someone
1539            uses the ncurses library from C++ because that configure test
1540            determines the type for C++'s bool and makes ncurses match it, since
1541            both C++ and curses are specified to declare bool.  Calling ncurses
1542            functions with the incorrect type for bool will cause execution
1543            errors.  In 5.0 we added a configure option "--without-cxx-binding"
1544            which controls whether the binding itself is built and installed.
1545
1546     4.2 (March 2, 1998)
1547         Interface changes:
1548
1549         + correct prototype for termattrs() as per XPG4 version 2.
1550
1551         + add placeholder prototypes for color_set(), erasewchar(),
1552           term_attrs(), wcolor_set() as per XPG4 version 2.
1553
1554         + add macros getcur[xy] getbeg[xy] getpar[xy], which are defined in
1555           SVr4 headers.
1556
1557         New extensions: keyok() and define_key().
1558
1559         Terminfo database changes:
1560
1561         + corrected definition in curses.h for ACS_LANTERN, which was 'I'
1562           rather than 'i'.
1563
1564     4.1 (May 15, 1997)
1565
1566         We added these extensions:  use_default_colors().  Also added
1567         configure option --enable-const, to support the use of const where
1568         X/Open should have, but did not, specify.
1569
1570         The terminfo database content changed the representation of color for
1571         most entries that use ANSI colors.  SVr4 curses treats the setaf/setab
1572         and setf/setb capabilities differently, interchanging the red/blue
1573         colors in the latter.
1574
1575     4.0 (December 24, 1996)
1576
1577         We bumped to version 4.0 because the newly released Linux dynamic
1578         loader (ld.so.1.8.5) did not load shared libraries whose ABI and REL
1579         versions were inconsistent.  At that point, ncurses ABI was 3.4 and the
1580         REL was 1.9.9g, so we made them consistent.
1581
1582     1.9.9g (December 1, 1996)
1583
1584         This fixed most of the problems with 1.9.9e, and made these interface
1585         changes:
1586
1587         + remove tparam(), which had been provided for compatibility with
1588           some termcap.  tparm() is standard, and does not conflict with
1589           application's fallback for missing tparam().
1590
1591         + turn off hardware echo in initscr().  This changes the sense of the
1592           echo() function, which was initialized to echoing rather than
1593           nonechoing (the latter is specified).  There were several other
1594           corrections to the terminal I/O settings which cause applications to
1595           behave differently.
1596
1597         + implemented several functions (such as attr_on()) which were
1598           available only as macros.
1599
1600         + corrected several typos in curses.h.in (i.e., the mvXXXX macros).
1601
1602         + corrected prototypes for delay_output(),
1603           has_color, immedok() and idcok().
1604
1605         + corrected misspelled getbkgd().  Some applications used the
1606           misspelled name.
1607
1608         + added _yoffset to WINDOW.  The size of WINDOW does not impact
1609           applications, since they use only pointers to WINDOW structs.
1610
1611         These changes were made to the terminfo database:
1612
1613         + removed boolean 'getm' which was available as an extended name.
1614
1615         We added these extensions: wresize(), resizeterm(), has_key() and
1616         mcprint().
1617
1618     1.9.9e (March 24, 1996)
1619
1620         not recommended (a last-minute/untested change left the forms and
1621         menus libraries unusable since they do not repaint the screen).
1622         Foreground/background colors are combined incorrectly, working properly
1623         only on a black background.  When this was released, the X/Open
1624         specification was available only in draft form.
1625
1626         Some applications (such as lxdialog) were "fixed" to work with the
1627         incorrect color scheme.
1628
1629
1630 IF YOU ARE A SYSTEM INTEGRATOR:
1631 ------------------------------
1632
1633     Configuration and Installation:
1634
1635         On platforms where ncurses is assumed to be installed in /usr/lib,
1636         the configure script uses "/usr" as a default:
1637
1638                 GNU/Linux, FreeBSD, NetBSD, OpenBSD, Cygwin
1639
1640         For other platforms, the default is "/usr/local".  See the discussion
1641         of the "--disable-overwrite" option.
1642
1643         The location of the terminfo is set indirectly by the "--datadir"
1644         configure option, e.g., /usr/share/terminfo, given a datadir of
1645         /usr/share.  You may want to override this if you are installing
1646         ncurses libraries in nonstandard locations, but wish to share the
1647         terminfo database.
1648
1649         Normally the ncurses library is configured in a pure-terminfo mode;
1650         that is, with the --disable-termcap option.  This makes the ncurses
1651         library smaller and faster.  The ncurses library includes a termcap
1652         emulation that queries the terminfo database, so even applications that
1653         use raw termcap to query terminal characteristics will win (providing
1654         you recompile and relink them!).
1655
1656         If you must configure with termcap fallback enabled, you may also wish
1657         to use the --enable-getcap option.  This speeds up termcap-based
1658         startups, at the expense of not allowing personal termcap entries to
1659         reference the terminfo tree.  See comments in
1660         ncurses/tinfo/read_termcap.c for further details.
1661
1662         Note that if you have $TERMCAP set, ncurses will use that value
1663         to locate termcap data.  In particular, running from xterm will
1664         set $TERMCAP to the contents of the xterm's termcap entry.
1665         If ncurses sees that, it will not examine /etc/termcap.
1666
1667     Keyboard Mapping:
1668
1669         The terminfo file assumes that Shift-Tab generates \E[Z (the ECMA-48
1670         reverse-tabulation sequence) rather than ^I.  Here are the loadkeys -d
1671         mappings that will set this up:
1672
1673                 keycode  15 = Tab             Tab
1674                         alt     keycode  15 = Meta_Tab
1675                         shift   keycode  15 = F26
1676                 string F26 ="\033[Z"
1677
1678     Naming the Console Terminal
1679
1680         In various systems there has been a practice of designating the system
1681         console driver type as `console'.  Please do not do this!  It
1682         complicates peoples' lives, because it can mean that several different
1683         terminfo entries from different operating systems all logically want to
1684         be called `console'.
1685
1686         Please pick a name unique to your console driver and set that up
1687         in the /etc/inittab table or local equivalent.  Send the entry to the
1688         terminfo maintainer (listed in the misc/terminfo file) to be included
1689         in the terminfo file, if it's not already there.  See the
1690         term(7) manual page included with this distribution for more on
1691         conventions for choosing type names.
1692
1693         Here are some recommended primary console names:
1694
1695                 linux   -- Linux console driver
1696                 freebsd -- FreeBSD
1697                 netbsd  -- NetBSD
1698                 bsdos   -- BSD/OS
1699
1700         If you are responsible for integrating ncurses for one of these
1701         distributions, please either use the recommended name or get back
1702         to us explaining why you don't want to, so we can work out nomenclature
1703         that will make users' lives easier rather than harder.
1704
1705
1706 RECENT XTERM VERSIONS:
1707 ---------------------
1708
1709         The terminfo database file included with this distribution assumes you
1710         are running a modern xterm based on XFree86 (i.e., xterm-new).  The
1711         earlier X11R6 entry (xterm-r6) and X11R5 entry (xterm-r5) is provided
1712         as well.  See the --without-xterm-new configure script option if you
1713         are unable to update your system.
1714
1715
1716 CONFIGURING FALLBACK ENTRIES:
1717 ----------------------------
1718
1719         In order to support operation of ncurses programs before the terminfo
1720         tree is accessible (that is, in single-user mode or at OS installation
1721         time) the ncurses library can be compiled to include an array of
1722         pre-fetched fallback entries.  This must be done on a machine which
1723         has ncurses' infocmp and terminfo database installed (as well as
1724         ncurses' tic and infocmp programs).
1725
1726         These entries are checked by setupterm() only when the conventional
1727         fetches from the terminfo tree and the termcap fallback (if configured)
1728         have been tried and failed.  Thus, the presence of a fallback will not
1729         shadow modifications to the on-disk entry for the same type, when that
1730         entry is accessible.
1731
1732         By default, there are no entries on the fallback list.  After you have
1733         built the ncurses suite for the first time, you can change the list
1734         (the process needs infocmp(1)).  To do so, use the script
1735         ncurses/tinfo/MKfallback.sh.  The configure script option
1736         --with-fallbacks does this (it accepts a comma-separated list of the
1737         names you wish, and does not require a rebuild).
1738
1739         If you wanted (say) to have linux, vt100, and xterm fallbacks, you
1740         might use the commands
1741
1742                 cd ncurses;
1743                 tinfo/MKfallback.sh \
1744                         $TERMINFO \
1745                         ../misc/terminfo.src \
1746                         `which tic` \
1747                         linux vt100 xterm >fallback.c
1748
1749         The first three parameters of the script are normally supplied by
1750         the configured makefiles via the "--with-fallbacks" option.  They
1751         are
1752
1753                 1) the location of the terminfo database
1754                 2) the source for the terminfo entries
1755                 3) the location of the tic program, used to create a terminfo
1756                    database.
1757
1758         Then just rebuild and reinstall the library as you would normally.
1759         You can restore the default empty fallback list with
1760
1761                 tinfo/MKfallback.sh \
1762                         $TERMINFO \
1763                         ../misc/terminfo.src \
1764                         `which tic` \
1765                         >fallback.c
1766
1767         The overhead for an empty fallback list is one trivial stub function.
1768         Any non-empty fallback list is const-ed and therefore lives in sharable
1769         text space.  You can look at the comment trailing each initializer in
1770         the generated ncurses/fallback.c file to see the core cost of the
1771         fallbacks.  A good rule of thumb for modern vt100-like entries is that
1772         each one will cost about 2.5K of text space.
1773
1774
1775 BSD CONVERSION NOTES:
1776 --------------------
1777
1778         If you need to support really ancient BSD programs, you probably
1779         want to configure with the --enable-bsdpad option.  What this does
1780         is enable code in tputs() that recognizes a numeric prefix on a
1781         capability as a request for that much trailing padding in milliseconds.
1782         There are old BSD programs that do things like tputs("50").
1783
1784         (If you are distributing ncurses as a support-library component of
1785         an application you probably want to put the remainder of this section
1786         in the package README file.)
1787
1788         The following note applies only if you have configured ncurses with
1789         --enable-termcap.
1790
1791 ------------------------------- CUT HERE --------------------------------
1792
1793 If you are installing this application privately (either because you
1794 have no root access or want to experiment with it before doing a root
1795 installation), there are a couple of details you need to be aware of.
1796 They have to do with the ncurses library, which uses terminfo rather
1797 than termcap for describing terminal characteristics.
1798
1799 Though the ncurses library is terminfo-based, it will interpret your
1800 TERMCAP variable (if present), any local termcap files you reference
1801 through it, and the system termcap file.  However, in order to avoid
1802 slowing down your application startup, it will only do this once per
1803 terminal type!
1804
1805 The first time you load a given terminal type from your termcap
1806 database, the library initialization code will automatically write it
1807 in terminfo format to a subdirectory under $HOME/.terminfo.  After
1808 that, the initialization code will find it there and do a (much
1809 faster) terminfo fetch.
1810
1811 Usually, all this means is that your home directory will silently grow
1812 an invisible .terminfo subdirectory which will get filled in with
1813 terminfo descriptions of terminal types as you invoke them.  If anyone
1814 ever installs a global terminfo tree on your system, this will quietly
1815 stop happening and your $HOME/.terminfo will become redundant.
1816
1817 The objective of all this logic is to make converting from BSD termcap
1818 as painless as possible without slowing down your application (termcap
1819 compilation is expensive).
1820
1821 If you don't have a TERMCAP variable or custom personal termcap file,
1822 you can skip the rest of this dissertation.
1823
1824 If you *do* have a TERMCAP variable and/or a custom personal termcap file
1825 that defines a terminal type, that definition will stop being visible
1826 to this application after the first time you run it, because it will
1827 instead see the terminfo entry that it wrote to $HOME/terminfo the
1828 first time around.
1829
1830 Subsequently, editing the TERMCAP variable or personal TERMCAP file
1831 will have no effect unless you explicitly remove the terminfo entry
1832 under $HOME/terminfo.  If you do that, the entry will be recompiled
1833 from your termcap resources the next time it is invoked.
1834
1835 To avoid these complications, use infocmp(1) and tic(1) to edit the
1836 terminfo directory directly.
1837
1838 ------------------------------- CUT HERE --------------------------------
1839
1840 USING NCURSES WITH AFS:
1841         AFS treats each directory as a separate logical filesystem, you
1842         can't hard-link across them.  The --enable-symlinks option copes
1843         with this by making tic use symbolic links.
1844
1845 USING NCURSES WITH GPM:
1846         Ncurses 4.1 and up can be configured to use GPM (General Purpose Mouse)
1847         which is used with Linux console.  Be aware that GPM is commonly
1848         installed as a shared library which contains a wrapper for the curses
1849         wgetch() function (libcurses.o).  Some integrators have simplified
1850         linking applications by combining all or part of libcurses.so into the
1851         libgpm.so file, producing symbol conflicts with ncurses (specifically
1852         the wgetch function).  This was originally the BSD curses, but
1853         generally whatever curses library exists on the system.
1854
1855         You may be able to work around this problem by linking as follows:
1856
1857                 cc -o foo foo.o -lncurses -lgpm -lncurses
1858
1859         but the linker may not cooperate, producing mysterious errors.
1860         See the FAQ, as well as the discussion under the --with-gpm option:
1861
1862         http://invisible-island.net/ncurses/ncurses.faq.html#using_gpm_lib
1863
1864 BUILDING NCURSES WITH A CROSS-COMPILER
1865         Ncurses can be built with a cross-compiler.  Some parts must be built
1866         with the host's compiler since they are used for building programs
1867         (e.g., ncurses/make_hash and ncurses/make_keys) that generate tables
1868         that are compiled into the ncurses library.  The essential thing to do
1869         is set the BUILD_CC environment variable to your host's compiler, and
1870         run the configure script configuring for the cross-compiler.
1871
1872         The configure options --with-build-cc, etc., are provided to make this
1873         simpler.  Since make_hash and make_keys use only ANSI C features, it
1874         is normally not necessary to provide the other options such as
1875         --with-build-libs, but they are provided for completeness.
1876
1877         Note that all of the generated source-files which are part of ncurses
1878         will be made if you use
1879
1880                 make sources
1881
1882         This would be useful in porting to an environment which has little
1883         support for the tools used to generate the sources, e.g., sed, awk and
1884         Bourne-shell.
1885
1886         When ncurses has been successfully cross-compiled, you may want to use
1887         "make install" (with a suitable target directory) to construct an
1888         install tree.  Note that in this case (as with the --with-fallbacks
1889         option), ncurses uses the development platform's tic to do the
1890         "make install.data" portion.
1891
1892         The system's tic program is used to install the terminal database,
1893         even for cross-compiles.  For best results, the tic program should
1894         be from the most current version of ncurses.
1895
1896 BUGS:
1897         Send any feedback to the ncurses mailing list at
1898         bug-ncurses@gnu.org. To subscribe send mail to
1899         bug-ncurses-request@gnu.org with body that reads:
1900         subscribe ncurses <your-email-address-here>
1901
1902         The Hacker's Guide in the doc directory includes some guidelines
1903         on how to report bugs in ways that will get them fixed most quickly.
1904
1905 -- vile:txtmode