diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-06-17 10:51:52 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-06-17 10:51:52 +0000 |
commit | 4ad94864781f48b1a4b77f9cfb934622bf756ba1 (patch) | |
tree | 3900955c1886e6d2570fea7125ee1f01bafe876d /upstream/mageia-cauldron/man3/ncurses.3x | |
parent | Adding upstream version 4.22.0. (diff) | |
download | manpages-l10n-4ad94864781f48b1a4b77f9cfb934622bf756ba1.tar.xz manpages-l10n-4ad94864781f48b1a4b77f9cfb934622bf756ba1.zip |
Adding upstream version 4.23.0.upstream/4.23.0
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'upstream/mageia-cauldron/man3/ncurses.3x')
-rw-r--r-- | upstream/mageia-cauldron/man3/ncurses.3x | 106 |
1 files changed, 65 insertions, 41 deletions
diff --git a/upstream/mageia-cauldron/man3/ncurses.3x b/upstream/mageia-cauldron/man3/ncurses.3x index be4ca538..114eb7ca 100644 --- a/upstream/mageia-cauldron/man3/ncurses.3x +++ b/upstream/mageia-cauldron/man3/ncurses.3x @@ -28,8 +28,8 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: ncurses.3x,v 1.197 2024/01/13 20:30:39 tom Exp $ -.TH ncurses 3X 2024-01-13 "ncurses 6.4" "Library calls" +.\" $Id: ncurses.3x,v 1.204 2024/03/23 20:42:29 tom Exp $ +.TH ncurses 3X 2024-03-23 "ncurses 6.4" "Library calls" .ie \n(.g \{\ .ds `` \(lq .ds '' \(rq @@ -55,20 +55,49 @@ character-cell terminal interface with optimized output \fB#include <curses.h> .fi .SH DESCRIPTION -The \fI\%ncurses\fP library routines give the user a -terminal-independent method of updating character screens with -reasonable optimization. -This implementation is \*(``new curses\*('' (\fI\%ncurses\fP) and -is the approved replacement for -4.4BSD classic curses, which has been discontinued. +The \*(``new curses\*('' library offers the programmer a +terminal-independent means of reading keyboard and mouse input and +updating character-cell terminals with output optimized to minimize +screen updates. +.I \%ncurses +replaces the +.I curses +libraries from +System V Release 4 Unix (\*(``SVr4\*('') +and +4.4BSD Unix, +the development of which ceased in the 1990s. This describes \fI\%ncurses\fP -version 6.4 (patch 20240217). +version 6.4 (patch 20240323). +.PP +.I \%ncurses +permits control of the terminal screen's contents; +abstraction and subdivision thereof with +.I windows +and +.IR pads ; +the reading of terminal input; +control of terminal input and output options; +environment query routines; +color manipulation; +the definition and use of +.I "soft label" +keys; +.I \%term\%info +capabilities; +a +.I \%term\%cap +compatibility interface; +and access to low-level terminal-manipulation routines. .PP -The \fI\%ncurses\fP library emulates the curses library of -System V Release 4 Unix (\*(``SVr4\*(''), -and XPG4 (X/Open Portability Guide) curses (also known as XSI curses). -XSI stands for X/Open System Interfaces Extension. -The \fI\%ncurses\fP library is freely redistributable in source form. +.I \%ncurses +implements the standard interface described by +X/Open Curses Issue\ 7. +In many behavioral details not standardized by X/Open, +.I \%ncurses +emulates the +.I curses +library of SVr4 and provides numerous useful extensions. .PP \fI\%ncurses\fP man pages employ several sections to clarify matters of usage and interoperability with other \fIcurses\fP implementations. @@ -107,12 +136,6 @@ The ncurses_g library generates trace logs (in a file called \*(``trace\*('' in the current directory) that describe curses actions. See section \*(``ALTERNATE CONFIGURATIONS\*('' below. -.PP -The \fI\%ncurses\fP package supports: overall screen, window and pad -manipulation; output to windows and pads; reading terminal input; control over -terminal and \fBcurses\fP input and output options; environment query -routines; color manipulation; use of soft label keys; terminfo capabilities; -and access to low-level terminal-manipulation routines. .SS Initialization The library uses the locale which the calling program has initialized. That is normally done with \fBsetlocale\fP(3): @@ -127,7 +150,7 @@ If the locale is not initialized, the library assumes that characters are printable as in ISO\-8859\-1, to work with certain legacy programs. You should initialize the locale and not rely on specific details of -the library when the locale has not been setup. +the library when the locale has not been set up. .PP The function \fBinitscr\fP or \fBnewterm\fP must be called to initialize the library @@ -205,7 +228,7 @@ window-addressing functions feature names prefixed see below) with \*(``w\*(''; these allow the user to specify a pointer to a -.I \%WINDOW. +.IR \%WINDOW . Counterparts not thus prefixed (or infixed) affect \fB\%stdscr\fP. @@ -360,7 +383,7 @@ It stores a character combined with attributes in a .I \%chtype datum, which is often an alias of -.I int. +.IR int . .IP Attributes alone (with no corresponding character) @@ -375,7 +398,7 @@ they are represented as an integral bit mask. Each cell of a .I \%WINDOW is stored as a -.I \%chtype. +.IR \%chtype . .TP 10 .I \%ncursesw is the library in its \*(``wide\*('' configuration, @@ -391,27 +414,27 @@ characters. .TP 9 \" "cchar_t" + 2n .I \%cchar_t corresponds to the non-wide configuration's -.I \%chtype. +.IR \%chtype . It always a structure type, because it stores more data than fits into an integral type. A character code may not be representable as a -.I \%char, +.IR \%char , and moreover more than one character may occupy a cell (as with accent marks and other diacritics). Each character is of type -.I \%wchar_t; +.IR \%wchar_t ; a complex character contains one spacing character and zero or more non-spacing characters (see below). Attributes and color data are stored in separate fields of the structure, not combined as in -.I \%chtype. +.IR \%chtype . .PP Each cell of a .I \%WINDOW is stored as a -.I \%cchar_t. +.IR \%cchar_t . .PP The \fB\%setcchar\fP(3X) and \fB\%getcchar\fP(3X) functions store and retrieve the data from a @@ -424,16 +447,16 @@ depends on two data types standardized by ISO C95. .I \%wchar_t stores a wide character. Like -.I \%chtype, +.IR \%chtype , it may be an alias of -.I int. +.IR int . Depending on the character encoding, a wide character may be -.I spacing, +.IR spacing , meaning that it occupies a character cell by itself and typically accompanies cursor advancement, or -.I non-spacing, +.IR non-spacing , meaning that it occupies the same cell as a spacing character, is often regarded as a \*(``modifier\*('' of the base glyph with which it combines, @@ -986,15 +1009,16 @@ character. .SS "\fIBAUDRATE\fP" 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. +The variable's numeric value is used for the baud rate. If no value is found, \fI\%ncurses\fP uses 9600. This allows testers to construct repeatable test-cases -that take into account costs that depend on baudrate. +that take into account costs that depend on baud rate. .SS "\fICOLUMNS\fP" 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. -If neither the \fI\%COLUMNS\fP value nor the terminal's screen size is available, +If neither the \fI\%COLUMNS\fP value +nor the terminal's screen size is available, \fI\%ncurses\fP uses the size which may be specified in the terminfo database (i.e., the \fBcols\fP capability). @@ -1210,7 +1234,7 @@ For example # VT100 shift\-in/shift\-out, with corresponding font. linux\-vt100|linux console with VT100 line\-graphics, U8#0, use=linux, - +\& # uxterm with vt100Graphics resource set to false xterm\-utf8|xterm relying on UTF\-8 line\-graphics, U8#1, use=xterm, @@ -1394,7 +1418,7 @@ Run the script with the option to peruse them all. A few are of particular significance to the application developer employing -.I \%ncurses. +.IR \%ncurses . .TP 5 \-\-disable\-overwrite The standard include for \fI\%ncurses\fP is as noted in \fBSYNOPSIS\fP: @@ -1568,13 +1592,13 @@ inclusion of \fI\%curses.h\fP. .I \%ncurses enables an application to capture mouse events on certain terminals, including -.I \%xterm; +.IR \%xterm ; see \fB\%curs_mouse\fP(3X). .PP .I \%ncurses provides a means of responding to window resizing events, as when running in a GUI terminal emulator application such as -.I \%xterm; +.IR \%xterm ; see \fB\%resizeterm\fP(3X) and \fB\%wresize\fP(3X). .PP .I \%ncurses @@ -1641,7 +1665,7 @@ causes the library to fall back to reading if the terminal setup code cannot find a .I \%term\%info entry corresponding to -.I TERM. +.IR TERM . Use of this feature is not recommended, as it essentially includes an entire .I termcap |