X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fncurses.3x;h=a8d67af5581a3e89104cbc5f648bda8e4b6b943a;hp=87cfb9afff728d19de08cbb3e8d5a15bda3c96e9;hb=321b81e6b3fa425daddac02420d862100dc3aac8;hpb=ed646e3f683083e787c6ba773364401dc9fa9d40 diff --git a/man/ncurses.3x b/man/ncurses.3x index 87cfb9af..a8d67af5 100644 --- a/man/ncurses.3x +++ b/man/ncurses.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998-2015,2017 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2017,2018 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * .\" copy of this software and associated documentation files (the * @@ -27,7 +27,7 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: ncurses.3x,v 1.133 2017/05/06 14:32:49 tom Exp $ +.\" $Id: ncurses.3x,v 1.140 2018/07/28 23:30:17 tom Exp $ .hy 0 .TH ncurses 3X "" .ie \n(.g .ds `` \(lq @@ -35,12 +35,13 @@ .ie \n(.g .ds '' \(rq .el .ds '' '' .de bP -.IP \(bu 4 +.ie n .IP \(bu 4 +.el .IP \(bu 2 .. .de NS -.ie \n(.sp +.ie n .sp .el .sp .5 -.ie \n(.in +4 +.ie n .in +4 .el .in +2 .nf .ft C \" Courier @@ -48,7 +49,8 @@ .de NE .fi .ft R -.in -4 +.ie n .in -4 +.el .in -2 .. .ds n 5 .ds d @TERMINFO@ @@ -1079,8 +1081,8 @@ If the \fBncurses\fR library has been configured with \fItermcap\fR support, \fBncurses\fR will check for a terminal's description in termcap form if it is not available in the terminfo database. .PP -The \fBTERMCAP\fP environment variable contains either a terminal description (with -newlines stripped out), +The \fBTERMCAP\fP environment variable contains +either a terminal description (with newlines stripped out), or a file name telling where the information denoted by the \fBTERM\fP environment variable exists. In either case, setting it directs \fBncurses\fR to ignore @@ -1088,7 +1090,8 @@ the usual place for this information, e.g., /etc/termcap. .SS TERMINFO .PP \fBncurses\fP can be configured to read from multiple terminal databases. -The \fBTERMINFO\fP variable overrides the location for the default terminal database. +The \fBTERMINFO\fP variable overrides the location for +the default terminal database. Terminal descriptions (in terminal format) are stored in terminal databases: .bP Normally these are stored in a directory tree, @@ -1225,12 +1228,34 @@ you link with \fB\-lncursesw\fR .NE .IP -You must also define \fB_XOPEN_SOURCE_EXTENDED\fP when compiling for the -wide-character library to use the extended (wide-character) functions. +You must also enable the wide-character features in the header file +when compiling for the wide-character library +to use the extended (wide-character) functions. +The symbol which enables these features has changed since XSI Curses, Issue 4: +.RS +.bP +Originally, the wide-character feature required the symbol +\fB_XOPEN_SOURCE_EXTENDED\fP +but that was only valid for XPG4 (1996). +.bP +Later, that was deemed conflicting with \fB_XOPEN_SOURCE\fP defined to 500. +.bP +As of mid-2018, +none of the features in this implementation require a \fB_XOPEN_SOURCE\fP +feature greater than 600. +However, X/Open Curses, Issue 7 (2009) recommends defining it to 700. +.bP +Alternatively, you can enable the feature by defining \fBNCURSES_WIDECHAR\fP +with the caveat that some other header file than \fBcurses.h\fP +may require a specific value for \fB_XOPEN_SOURCE\fP +(or a system-specific symbol). +.RE +.IP The \fBcurses.h\fP file which is installed for the wide-character library is designed to be compatible with the normal library's header. Only the size of the \fBWINDOW\fP structure differs, and very few applications require more than a pointer to \fBWINDOW\fPs. +.IP If the headers are installed allowing overwrite, the wide-character library's headers should be installed last, to allow applications to be built using either library @@ -1275,6 +1300,8 @@ terminal capability database "curs_" for detailed routine descriptions. .br \fBcurs_variables\fR(3X) +.br +\fBuser_caps\fP(5) for user-defined capabilities .SH EXTENSIONS The \fBncurses\fR library can be compiled with an option (\fB\-DUSE_GETCAP\fR) that falls back to the old-style /etc/termcap file if the terminal setup code @@ -1292,7 +1319,7 @@ The \fBncurses\fR library includes facilities for responding to window resizing events, e.g., when running in an xterm. See the \fBresizeterm\fR(3X) and \fBwresize\fR(3X) manual pages for details. -In addition, the library may be configured with a SIGWINCH handler. +In addition, the library may be configured with a \fBSIGWINCH\fP handler. .PP The \fBncurses\fR library extends the fixed set of function key capabilities of terminals by allowing the application designer to define additional