ncurses 6.1 - patch 20190216
[ncurses.git] / man / ncurses.3x
index 796e6c10cefe9599390f4246dfc83635fead0dfc..475046b1ef48552ab0aed5cf6e7ac84a2331d5ba 100644 (file)
@@ -1,6 +1,6 @@
 '\" t
 .\"***************************************************************************
-.\" Copyright (c) 1998-2015,2017 Free Software Foundation, Inc.              *
+.\" Copyright (c) 1998-2018,2019 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.131 2017/03/25 20:45:48 tom Exp $
+.\" $Id: ncurses.3x,v 1.141 2019/02/16 15:07:20 tom Exp $
 .hy 0
 .TH ncurses 3X ""
 .ie \n(.g .ds `` \(lq
 .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@
@@ -100,8 +102,9 @@ and access to low-level terminal-manipulation routines.
 The library uses the locale which the calling program has initialized.
 That is normally done with \fBsetlocale\fP:
 .NS
-      \fBsetlocale(LC_ALL, "");\fP
+\fBsetlocale(LC_ALL, "");\fP
 .NE
+.PP
 If the locale is not initialized,
 the library assumes that characters are printable as in ISO\-8859\-1,
 to work with certain legacy programs.
@@ -118,14 +121,16 @@ To get character-at-a-time input without echoing (most
 interactive, screen oriented programs want this), the following
 sequence should be used:
 .NS
-      \fBinitscr(); cbreak(); noecho();\fR
+\fBinitscr(); cbreak(); noecho();\fR
 .NE
+.PP
 Most programs would additionally use the sequence:
 .NS
-      \fBnonl();\fR
-      \fBintrflush(stdscr, FALSE);\fR
-      \fBkeypad(stdscr, TRUE);\fR
+\fBnonl();\fR
+\fBintrflush(stdscr, FALSE);\fR
+\fBkeypad(stdscr, TRUE);\fR
 .NE
+.PP
 Before a \fBcurses\fR program is run, the tab stops of the terminal
 should be set and its initialization strings, if defined, must be output.
 This can be done by executing the \fB@TPUT@ init\fR command
@@ -197,18 +202,21 @@ standard place.
 For example, if \fBTERM\fR is set to \fBatt4424\fR, then the
 compiled terminal definition is found in
 .NS
-      \fB\*d/a/att4424\fR.
+\fB\*d/a/att4424\fR.
 .NE
+.PP
 (The \fBa\fR is copied from the first letter of \fBatt4424\fR to avoid
 creation of huge directories.)  However, if \fBTERMINFO\fR is set to
 \fB$HOME/myterms\fR, \fBcurses\fR first checks
 .NS
-      \fB$HOME/myterms/a/att4424\fR,
+\fB$HOME/myterms/a/att4424\fR,
 .NE
+.PP
 and if that fails, it then checks
 .NS
-      \fB\*d/a/att4424\fR.
+\fB\*d/a/att4424\fR.
 .NE
+.PP
 This is useful for developing experimental definitions or when write
 permission in \fB\*d\fR is not available.
 .PP
@@ -671,7 +679,7 @@ use_default_colors/\fBdefault_colors\fR(3X)*
 use_env/\fBcurs_util\fR(3X)
 use_extended_names/\fBcurs_extend\fR(3X)*
 use_legacy_coding/\fBlegacy_coding\fR(3X)*
-use_tioctl/\fBcurs_util\fR(3X)
+use_tioctl/\fBcurs_util\fR(3X)*
 vid_attr/\fBcurs_terminfo\fR(3X)
 vid_puts/\fBcurs_terminfo\fR(3X)
 vidattr/\fBcurs_terminfo\fR(3X)
@@ -787,10 +795,12 @@ right-hand side of assignment statements).
 .PP
 Routines that return pointers return \fBNULL\fR on error.
 .SH ENVIRONMENT
+.PP
 The following environment symbols are useful for customizing the
 runtime behavior of the \fBncurses\fR library.
 The most important ones have been already discussed in detail.
-.SS CC
+.SS CC command-character
+.PP
 When set, change occurrences of the command_character
 (i.e., the \fBcmdch\fP capability)
 of the loaded terminfo entries to the value of this variable.
@@ -800,6 +810,7 @@ Because this name is also used in development environments to represent
 the C compiler's name, \fBncurses\fR ignores it if it does not happen to
 be a single character.
 .SS BAUDRATE
+.PP
 The debugging library checks this environment variable when the application
 has redirected output to a file.
 The variable's numeric value is used for the baudrate.
@@ -807,6 +818,7 @@ If no value is found, \fBncurses\fR uses 9600.
 This allows testers to construct repeatable test-cases
 that take into account costs that depend on baudrate.
 .SS COLUMNS
+.PP
 Specify the width of the screen in characters.
 Applications running in a windowing environment usually are able to
 obtain the width of the window in which they are executing.
@@ -832,6 +844,7 @@ Use the \fBuse_env\fR function to disable all use of external environment
 Use the \fBuse_tioctl\fR function to update \fBCOLUMNS\fP or \fBLINES\fP
 to match the screen size obtained from system calls or the terminal database.
 .SS ESCDELAY
+.PP
 Specifies the total time, in milliseconds, for which ncurses will
 await a character sequence, e.g., a function key.
 The default value, 1000 milliseconds, is enough for most uses.
@@ -858,29 +871,33 @@ does not create problems when compiling an application.
 .SS HOME
 Tells \fBncurses\fR where your home directory is.
 That is where it may read and write auxiliary terminal descriptions:
-.PP
+.NS
 $HOME/.termcap
-.br
 $HOME/.terminfo
+.NE
 .SS LINES
+.PP
 Like COLUMNS, specify the height of the screen in characters.
 See COLUMNS for a detailed description.
 .SS MOUSE_BUTTONS_123
+.PP
 This applies only to the OS/2 EMX port.
 It specifies the order of buttons on the mouse.
 OS/2 numbers a 3-button mouse inconsistently from other
 platforms:
-.sp
+.NS
 1 = left
 .br
 2 = right
 .br
 3 = middle.
-.sp
+.NE
+.PP
 This variable lets you customize the mouse.
 The variable must be three numeric digits 1\-3 in any order, e.g., 123 or 321.
 If it is not specified, \fBncurses\fR uses 132.
 .SS NCURSES_ASSUMED_COLORS
+.PP
 Override the compiled-in assumption that the
 terminal's default colors are white-on-black
 (see \fBdefault_colors\fR(3X)).
@@ -901,6 +918,7 @@ mapping coordinates,
 explicitly saving and restoring the original screen contents.
 Setting the environment variable \fBNCGDB\fP has the same effect.
 .SS NCURSES_GPM_TERMS
+.PP
 This applies only to ncurses configured to use the GPM interface.
 .PP
 If present,
@@ -912,17 +930,20 @@ using the built-in support for xterm, etc.
 If the environment variable is absent,
 ncurses will attempt to open GPM if \fBTERM\fP contains "linux".
 .SS NCURSES_NO_HARD_TABS
+.PP
 \fBNcurses\fP may use tabs as part of the cursor movement optimization.
 In some cases,
 your terminal driver may not handle these properly.
 Set this environment variable to disable the feature.
 You can also adjust your \fBstty\fP settings to avoid the problem.
-NCURSES_NO_MAGIC_COOKIE
+.SS NCURSES_NO_MAGIC_COOKIE
+.PP
 Some terminals use a magic-cookie feature which requires special handling
 to make highlighting and other video attributes display properly.
 You can suppress the highlighting entirely for these terminals by
 setting this environment variable.
 .SS NCURSES_NO_PADDING
+.PP
 Most of the terminal descriptions in the terminfo database are written
 for real "hardware" terminals.
 Many people use terminal emulators
@@ -982,6 +1003,7 @@ As a special case, the low-level calls such as \fBputp\fP still use the
 standard output.
 But high-level curses calls do not.
 .SS NCURSES_NO_UTF8_ACS
+.PP
 During initialization, the \fBncurses\fR library
 checks for special cases where VT100 line-drawing (and the corresponding
 alternate character set capabilities) described in the terminfo are known
@@ -1023,6 +1045,7 @@ The name "U8" is chosen to be two characters,
 to permit it to be used by applications that use ncurses'
 termcap interface.
 .SS NCURSES_TRACE
+.PP
 During initialization, the \fBncurses\fR debugging library
 checks the NCURSES_TRACE environment variable.
 If it is defined, to a numeric value, \fBncurses\fR calls the \fBtrace\fR
@@ -1035,6 +1058,7 @@ file \fBtrace\fR to the current directory.
 .PP
 See \fBcurs_trace\fP(3X) for more information.
 .SS TERM
+.PP
 Denotes your terminal type.
 Each terminal type is distinct, though many are similar.
 .PP
@@ -1057,15 +1081,17 @@ 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
 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,
@@ -1134,6 +1160,7 @@ ncurses library, i.e.,
 .RE
 .PP
 .SS TERMINFO_DIRS
+.PP
 Specifies a list of locations to search for terminal descriptions.
 Each location in the list is a terminal database as described in
 the section on the \fBTERMINFO\fP variable.
@@ -1142,6 +1169,7 @@ The list is separated by colons (i.e., ":") on Unix, semicolons on OS/2 EMX.
 There is no corresponding feature in System V terminfo;
 it is an extension developed for \fBncurses\fP.
 .SS TERMPATH
+.PP
 If \fBTERMCAP\fP does not hold a file name then \fBncurses\fR checks
 the \fBTERMPATH\fP environment variable.
 This is a list of filenames separated by spaces or colons (i.e., ":") on Unix,
@@ -1162,6 +1190,7 @@ setgid permissions:
 $TERMINFO, $TERMINFO_DIRS, $TERMPATH, as well as $HOME.
 .NE
 .SH ALTERNATE CONFIGURATIONS
+.PP
 Several different configurations are possible,
 depending on the configure script options used when building \fBncurses\fP.
 There are a few main options whose effects are visible to the applications
@@ -1169,19 +1198,17 @@ developer using \fBncurses\fP:
 .TP 5
 \-\-disable\-overwrite
 The standard include for \fBncurses\fP is as noted in \fBSYNOPSIS\fP:
-.RS 3
-.sp
+.NS
 \fB#include <curses.h>\fR
-.RE
+.NE
 .IP
 This option is used to avoid filename conflicts when \fBncurses\fP
 is not the main implementation of curses of the computer.
 If \fBncurses\fP is installed disabling overwrite, it puts its headers in
 a subdirectory, e.g.,
-.RS 3
-.sp
+.NS
 \fB#include <ncurses/curses.h>\fR
-.RE
+.NE
 .IP
 It also omits a symbolic link which would allow you to use \fB\-lcurses\fP
 to build executables.
@@ -1192,23 +1219,43 @@ The configure script renames the library and
 puts the header files in a different subdirectory.
 All of the library names have a "w" appended to them,
 i.e., instead of
-.RS 3
-.sp
+.NS
 \fB\-lncurses\fR
-.RE
+.NE
 .IP
 you link with
-.RS 3
-.sp
+.NS
 \fB\-lncursesw\fR
+.NE
+.IP
+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
-You must also define \fB_XOPEN_SOURCE_EXTENDED\fP when compiling for the
-wide-character library to use the extended (wide-character) functions.
 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
@@ -1253,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
@@ -1270,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