Deleted Added
full compact
3c3
< .\" Copyright (c) 1998-2005,2006 Free Software Foundation, Inc. *
---
> .\" Copyright (c) 1998-2006,2007 Free Software Foundation, Inc. *
30c30
< .\" $Id: ncurses.3x,v 1.81 2006/12/02 19:23:11 tom Exp $
---
> .\" $Id: ncurses.3x,v 1.89 2007/09/01 18:57:29 tom Exp $
42,43c42,44
< of updating character screens with reasonable optimization. This
< implementation is ``new curses'' (ncurses) and is the approved replacement for
---
> of updating character screens with reasonable optimization.
> This implementation is ``new curses'' (ncurses) and
> is the approved replacement for
48,50c49,54
< The \fBncurses\fR routines emulate the \fBcurses\fR(3X) library of System V
< Release 4 UNIX, and the XPG4 curses standard (XSI curses) but the \fBncurses\fR
< library is freely redistributable in source form. Differences from the SVr4
---
> The \fBncurses\fR library emulates the \fBcurses\fR(3X) library of
> System V Release 4 UNIX,
> and XPG4 (X/Open Portability Guide) curses (also known as XSI curses).
> XSI stands for X/Open System Interfaces Extension.
> The \fBncurses\fR library is freely redistributable in source form.
> Differences from the SVr4
54a59,62
> The \fBncurses\fR library also provides many useful extensions,
> i.e., features which cannot be implemented by a simple add-on library
> but which require access to the internals of the library.
> .PP
71,72c79,81
< and screens are used. The routine \fBendwin\fR must be called before
< exiting. To get character-at-a-time input without echoing (most
---
> and screens are used.
> The routine \fBendwin\fR must be called before exiting.
> To get character-at-a-time input without echoing (most
85,86c94,95
< should be set and its initialization strings, if defined, must be
< output. This can be done by executing the \fBtput init\fR command
---
> should be set and its initialization strings, if defined, must be output.
> This can be done by executing the \fBtput init\fR command
93,95c102,105
< arrays of characters representing all or part of a CRT screen. A
< default window called \fBstdscr\fR, which is the size of the terminal
< screen, is supplied. Others may be created with \fBnewwin\fR.
---
> arrays of characters representing all or part of a CRT screen.
> A default window called \fBstdscr\fR, which is the size of the terminal
> screen, is supplied.
> Others may be created with \fBnewwin\fR.
98c108,109
< the \fBpanel\fR(3X) library. This means that you can either use
---
> the \fBpanel\fR(3X) library.
> This means that you can either use
100,101c111,112
< \fBstdscr\fR at all. Mixing the two will result in unpredictable, and
< undesired, effects.
---
> \fBstdscr\fR at all.
> Mixing the two will result in unpredictable, and undesired, effects.
105,106c116,119
< elsewhere in the \fBncurses\fR manual pages. Among those, the most basic
< routines are \fBmove\fR and \fBaddch\fR. More general versions of
---
> elsewhere in the \fBncurses\fR manual pages.
> Among those, the most basic
> routines are \fBmove\fR and \fBaddch\fR.
> More general versions of
108c121,122
< allowing the user to specify a window. The routines not beginning
---
> allowing the user to specify a window.
> The routines not beginning
113c127,128
< \fBstdscr\fR. The characters in a window are actually of type
---
> \fBstdscr\fR.
> The characters in a window are actually of type
117c132,133
< Special windows called \fIpads\fR may also be manipulated. These are windows
---
> Special windows called \fIpads\fR may also be manipulated.
> These are windows
119c135,136
< be completely displayed. See \fBcurs_pad\fR(3X) for more information.
---
> be completely displayed.
> See \fBcurs_pad\fR(3X) for more information.
124c141,142
< display enhancements. Line drawing characters may be specified to be output.
---
> display enhancements.
> Line drawing characters may be specified to be output.
126c144,145
< transmit escape sequences into single values. The video attributes, line
---
> transmit escape sequences into single values.
> The video attributes, line
132,133c151,153
< the environment will override information read by \fIterminfo\fR. This would
< effect a program running in an AT&T 630 layer, for example, where the size of a
---
> the environment will override information read by \fIterminfo\fR.
> This would affect a program running in an AT&T 630 layer,
> for example, where the size of a
138c158,159
< standard place. For example, if \fBTERM\fR is set to \fBatt4424\fR, then the
---
> standard place.
> For example, if \fBTERM\fR is set to \fBatt4424\fR, then the
158c179,180
< screen. The constants \fBTRUE\fR and \fBFALSE\fR have the values \fB1\fR and
---
> screen.
> The constants \fBTRUE\fR and \fBFALSE\fR have the values \fB1\fR and
163,165c185,187
< screen containing garbage. The \fBcurscr\fR can be used in only a few
< routines.
< .
---
> screen containing garbage.
> The \fBcurscr\fR can be used in only a few routines.
> .\"
167,169c189,192
< Many \fBcurses\fR routines have two or more versions. The routines prefixed
< with \fBw\fR require a window argument. The routines prefixed with \fBp\fR
< require a pad argument. Those without a prefix generally use \fBstdscr\fR.
---
> Many \fBcurses\fR routines have two or more versions.
> The routines prefixed with \fBw\fR require a window argument.
> The routines prefixed with \fBp\fR require a pad argument.
> Those without a prefix generally use \fBstdscr\fR.
172,176c195,200
< coordinate to move to before performing the appropriate action. The
< \fBmv\fR routines imply a call to \fBmove\fR before the call to the
< other routine. The coordinate \fIy\fR always refers to the row (of
< the window), and \fIx\fR always refers to the column. The upper
< left-hand corner is always (0,0), not (1,1).
---
> coordinate to move to before performing the appropriate action.
> The \fBmv\fR routines imply a call to \fBmove\fR before the call to the
> other routine.
> The coordinate \fIy\fR always refers to the row (of
> the window), and \fIx\fR always refers to the column.
> The upper left-hand corner is always (0,0), not (1,1).
179,180c203,204
< \fIx\fR and \fIy\fR coordinates. The window argument is always
< specified before the coordinates.
---
> \fIx\fR and \fIy\fR coordinates.
> The window argument is always specified before the coordinates.
187,191c211,268
< \fBTRUE\fR or \fBFALSE\fR; \fIbf\fR is always of type \fBbool\fR. The
< variables \fIch\fR and \fIattrs\fR below are always of type
< \fBchtype\fR. The types \fBWINDOW\fR, \fBSCREEN\fR, \fBbool\fR, and
< \fBchtype\fR are defined in \fB<curses.h>\fR. The type \fBTERMINAL\fR
< is defined in \fB<term.h>\fR. All other arguments are integers.
---
> \fBTRUE\fR or \fBFALSE\fR; \fIbf\fR is always of type \fBbool\fR.
> Most of the data types used in the library routines,
> such as \fBWINDOW\fR, \fBSCREEN\fR, \fBbool\fR, and \fBchtype\fR
> are defined in \fB<curses.h>\fR.
> Types used for the terminfo routines such as
> \fBTERMINAL\fR are defined in \fB<term.h>\fR.
> .PP
> This manual page describes functions which may appear in any configuration
> of the library.
> There are two common configurations of the library:
> .RS
> .TP 5
> ncurses
> the "normal" library, which handles 8-bit characters.
> The normal (8-bit) library stores characters combined with attributes
> in \fBchtype\fP data.
> .IP
> Attributes alone (no corresponding character) may be stored in \fBchtype\fP
> or the equivalent \fBattr_t\fP data.
> In either case, the data is stored in something like an integer.
> .IP
> Each cell (row and column) in a \fBWINDOW\fP is stored as a \fBchtype\fP.
> .TP 5
> ncursesw
> the so-called "wide" library, which handles multibyte characters
> (See the section on \fBALTERNATE CONFIGURATIONS\fP).
> The "wide" library includes all of the calls from the "normal" library.
> It adds about one third more calls using data types which store
> multibyte characters:
> .RS
> .TP 5
> .B cchar_t
> corresponds to \fBchtype\fP.
> However it is a structure, because more data is stored than can fit into
> an integer.
> The characters are large enough to require a full integer value - and there
> may be more than one character per cell.
> The video attributes and color are stored in separate fields of the structure.
> .IP
> Each cell (row and column) in a \fBWINDOW\fP is stored as a \fBcchar_t\fP.
> .TP 5
> .B wchar_t
> stores a "wide" character.
> Like \fBchtype\fP, this may be an integer.
> .TP 5
> .B wint_t
> stores a \fBwchar_t\fP or \fBWEOF\fP - not the same, though both may have
> the same size.
> .RE
> .IP
> The "wide" library provides new functions which are analogous to
> functions in the "normal" library.
> There is a naming convention which relates many of the normal/wide variants:
> a "_w" is inserted into the name.
> For example, \fBwaddch\fP becomes \fBwadd_wch\fP.
> .RE
> .PP
> .\"
194c271,272
< the manual page on which it is described. Routines flagged with `*'
---
> the manual page on which it is described.
> Routines flagged with `*'
277a356,358
> getattrs/\fBcurs_attr\fR(3X)
> getbegx/\fBcurs_legacy\fR(3X)*
> getbegy/\fBcurs_legacy\fR(3X)*
282a364,367
> getcurx/\fBcurs_legacy\fR(3X)*
> getcury/\fBcurs_legacy\fR(3X)*
> getmaxx/\fBcurs_legacy\fR(3X)*
> getmaxy/\fBcurs_legacy\fR(3X)*
286a372,373
> getparx/\fBcurs_legacy\fR(3X)*
> getpary/\fBcurs_legacy\fR(3X)*
323a411,416
> is_cleared/\fBcurs_opaque\fR(3X)*
> is_idcok/\fBcurs_opaque\fR(3X)*
> is_idlok/\fBcurs_opaque\fR(3X)*
> is_immedok/\fBcurs_opaque\fR(3X)*
> is_keypad/\fBcurs_opaque\fR(3X)*
> is_leaveok/\fBcurs_opaque\fR(3X)*
324a418,422
> is_nodelay/\fBcurs_opaque\fR(3X)*
> is_notimeout/\fBcurs_opaque\fR(3X)*
> is_scrollok/\fBcurs_opaque\fR(3X)*
> is_syncok/\fBcurs_opaque\fR(3X)*
> is_term_resized/\fBresizeterm\fR(3X)*
433a532
> nofilter/\fBcurs_util\fR(3X)*
521a621
> use_legacy_coding/\fBlegacy_coding\fR(3X)*
620,621c720,721
< \fBwsetscrreg\fR, \fBgetyx\fR, \fBgetbegyx\fR, and \fBgetmaxyx\fR. The return
< values of \fBsetscrreg\fR, \fBwsetscrreg\fR, \fBgetyx\fR, \fBgetbegyx\fR, and
---
> \fBwsetscrreg\fR, \fBgetyx\fR, \fBgetbegyx\fR, and \fBgetmaxyx\fR.
> The return values of \fBsetscrreg\fR, \fBwsetscrreg\fR, \fBgetyx\fR, \fBgetbegyx\fR, and
628,629c728,729
< runtime behavior of the \fBncurses\fR library. The most important
< ones have been already discussed in detail.
---
> runtime behavior of the \fBncurses\fR library.
> The most important ones have been already discussed in detail.
725c825
< (see \fBassume_default_colors\fR(3X)).
---
> (see \fBdefault_colors\fR(3X)).
742c842
< to make highlighting and other video attributes display properly.
---
> to make highlighting and other video attributes display properly.
764c864,865
< have delay times embedded. You may wish to use these descriptions,
---
> have delay times embedded.
> You may wish to use these descriptions,
768c869,870
< padding. Mandatory padding is used as a part of special control
---
> padding.
> Mandatory padding is used as a part of special control
775c877,878
< this feature is made optional. Setting the NCURSES_NO_SETBUF variable
---
> this feature is made optional.
> Setting the NCURSES_NO_SETBUF variable
947c1050,1051
< cannot find a terminfo entry corresponding to \fBTERM\fR. Use of this feature
---
> cannot find a terminfo entry corresponding to \fBTERM\fR.
> Use of this feature
952c1056,1057
< certain terminals (including xterm). See the \fBcurs_mouse\fR(3X)
---
> certain terminals (including xterm).
> See the \fBcurs_mouse\fR(3X)
977,978c1082,1083
< to a printer attached to the terminal device. See the \fBcurs_print\fR(3X)
< manual page for details.
---
> to a printer attached to the terminal device.
> See the \fBcurs_print\fR(3X) manual page for details.
980,981c1085,1087
< The \fBncurses\fR library is intended to be BASE-level conformant with the XSI
< Curses standard. The EXTENDED XSI Curses functionality
---
> The \fBncurses\fR library is intended to be BASE-level conformant with XSI
> Curses.
> The EXTENDED XSI Curses functionality
988,989c1094,1095
< The routine \fBhas_key\fR is not part of XPG4, nor is it present in SVr4. See
< the \fBcurs_getch\fR(3X) manual page for details.
---
> This implementation also contains several extensions:
> .RS 5
991,992c1097,1098
< The routine \fBslk_attr\fR is not part of XPG4, nor is it present in SVr4. See
< the \fBcurs_slk\fR(3X) manual page for details.
---
> The routine \fBhas_key\fR is not part of XPG4, nor is it present in SVr4.
> See the \fBcurs_getch\fR(3X) manual page for details.
993a1100,1102
> The routine \fBslk_attr\fR is not part of XPG4, nor is it present in SVr4.
> See the \fBcurs_slk\fR(3X) manual page for details.
> .PP
996,997c1105,1106
< part of XPG4, nor are they present in SVr4. See the \fBcurs_mouse\fR(3X)
< manual page for details.
---
> part of XPG4, nor are they present in SVr4.
> See the \fBcurs_mouse\fR(3X) manual page for details.
999,1000c1108,1109
< The routine \fBmcprint\fR was not present in any previous curses
< implementation. See the \fBcurs_print\fR(3X) manual page for details.
---
> The routine \fBmcprint\fR was not present in any previous curses implementation.
> See the \fBcurs_print\fR(3X) manual page for details.
1002,1003c1111,1112
< The routine \fBwresize\fR is not part of XPG4, nor is it present in SVr4. See
< the \fBwresize\fR(3X) manual page for details.
---
> The routine \fBwresize\fR is not part of XPG4, nor is it present in SVr4.
> See the \fBwresize\fR(3X) manual page for details.
1004a1114,1118
> The WINDOW structure's internal details can be hidden from application
> programs.
> See \fBcurs_opaque\fR(3X) for the discussion of \fBis_scrollok\fR, etc.
> .RE
> .PP
1007,1008c1121,1123
< bits in the UNIX tty driver. In this implementation, all padding is done by
< NUL sends. This method is slightly more expensive, but narrows the interface
---
> bits in the UNIX tty driver.
> In this implementation, all padding is done by sending NUL bytes.
> This method is slightly more expensive, but narrows the interface
1016,1017c1131,1132
< which is not a tty, screen updates will be directed to standard error. This
< was an undocumented feature of AT&T System V Release 3 curses.
---
> which is not a tty, screen updates will be directed to standard error.
> This was an undocumented feature of AT&T System V Release 3 curses.