diff options
Diffstat (limited to 'man/ncurses.3x')
| -rw-r--r-- | man/ncurses.3x | 130 |
1 files changed, 78 insertions, 52 deletions
diff --git a/man/ncurses.3x b/man/ncurses.3x index 703a239abfde..4acfc050101a 100644 --- a/man/ncurses.3x +++ b/man/ncurses.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998-2007,2008 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2010,2011 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,13 +27,16 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: ncurses.3x,v 1.92 2008/10/25 23:31:45 tom Exp $ +.\" $Id: ncurses.3x,v 1.103 2011/02/05 23:21:29 tom Exp $ .hy 0 .TH ncurses 3X "" +.de bP +.IP \(bu 4 +.. .ds n 5 .ds d @TERMINFO@ .SH NAME -\fBncurses\fR - CRT screen handling and optimization package +\fBncurses\fR \- CRT screen handling and optimization package .SH SYNOPSIS \fB#include <curses.h>\fR .br @@ -46,7 +49,7 @@ is the approved replacement for This describes \fBncurses\fR version @NCURSES_MAJOR@.@NCURSES_MINOR@ (patch @NCURSES_PATCH@). .PP -The \fBncurses\fR library emulates the \fBcurses\fR(3X) library of +The \fBncurses\fR library emulates the curses 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. @@ -60,10 +63,10 @@ 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 -A program using these routines must be linked with the \fB-lncurses\fR option, -or (if it has been generated) with the debugging library \fB-lncurses_g\fR. +A program using these routines must be linked with the \fB\-lncurses\fR option, +or (if it has been generated) with the debugging library \fB\-lncurses_g\fR. (Your system integrator may also have installed these libraries under -the names \fB-lcurses\fR and \fB-lcurses_g\fR.) +the names \fB\-lcurses\fR and \fB\-lcurses_g\fR.) The ncurses_g library generates trace logs (in a file called 'trace' in the current directory) that describe curses actions. See also the section on \fBALTERNATE CONFIGURATIONS\fP. @@ -80,7 +83,7 @@ That is normally done with \fBsetlocale\fP: \fBsetlocale(LC_ALL, "");\fP .sp If the locale is not initialized, -the library assumes that characters are printable as in ISO-8859-1, +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. @@ -246,7 +249,7 @@ 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). +(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: @@ -256,7 +259,7 @@ multibyte characters: 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 +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 @@ -267,7 +270,7 @@ 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 +stores a \fBwchar_t\fP or \fBWEOF\fP \- not the same, though both may have the same size. .RE .IP @@ -756,6 +759,10 @@ When set, change occurrences of the command_character (i.e., the \fBcmdch\fP capability) of the loaded terminfo entries to the value of this symbol. Very few terminfo entries provide this feature. +.IP +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. .TP 5 COLUMNS Specify the width of the screen in characters. @@ -831,7 +838,7 @@ platforms: 3 = middle. .sp This symbol lets you customize the mouse. -The symbol must be three numeric digits 1-3 in any order, e.g., 123 or 321. +The symbol must be three numeric digits 1\-3 in any order, e.g., 123 or 321. If it is not specified, \fBncurses\fR uses 132. .TP 5 NCURSES_ASSUMED_COLORS @@ -841,7 +848,7 @@ terminal's default colors are white-on-black You may set the foreground and background color values with this environment variable by proving a 2-element list: foreground,background. For example, to tell ncurses to not assume anything -about the colors, set this to "-1,-1". +about the colors, set this to "\-1,\-1". To make it green-on-black, set it to "2,0". Any positive value from zero to the terminfo \fBmax_colors\fR value is allowed. .TP 5 @@ -911,7 +918,7 @@ 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 to be missing. -Specifically, when running in a UTF-8 locale, +Specifically, when running in a UTF\-8 locale, the Linux console emulator and the GNU screen program ignore these. Ncurses checks the TERM environment variable for these. For other special cases, you should set this environment variable. @@ -922,7 +929,29 @@ and is likely to work for terminal emulators. .IP When setting this variable, you should set it to a nonzero value. Setting it to zero (or to a nonnumber) -disables the special check for Linux and screen. +disables the special check for "linux" and "screen". +.IP +As an alternative to the environment variable, +ncurses checks for an extended terminfo capability \fBU8\fP. +This is a numeric capability which can be compiled using \fBtic\ \-x\fP. +For example +.RS 5 +.sp +.nf +# linux console, if patched to provide working +# VT100 shift-in/shift-out, with corresponding font. +linux-vt100|linux console with VT100 line-graphics, + U8#0, use=linux, +.sp +# uxterm with vt100Graphics resource set to false +xterm-utf8|xterm relying on UTF-8 line-graphics, + U8#1, use=xterm, +.fi +.RE +.IP +The name "U8" is chosen to be two characters, +to permit it to be used by applications that use ncurses' +termcap interface. .TP 5 NCURSES_TRACE During initialization, the \fBncurses\fR debugging library @@ -956,20 +985,15 @@ description. This is the simplest, but not the only way to change the list of directories. The complete list of directories in order follows: .RS -.TP 3 -- +.bP the last directory to which \fBncurses\fR wrote, if any, is searched first -.TP 3 -- +.bP the directory specified by the TERMINFO symbol -.TP 3 -- +.bP $HOME/.terminfo -.TP 3 -- +.bP directories listed in the TERMINFO_DIRS symbol -.TP 3 -- +.bP one or more directories whose names are configured and compiled into the ncurses library, e.g., @TERMINFO@ @@ -998,7 +1022,7 @@ depending on the configure script options used when building \fBncurses\fP. There are a few main options whose effects are visible to the applications developer using \fBncurses\fP: .TP 5 ---disable-overwrite +\-\-disable\-overwrite The standard include for \fBncurses\fP is as noted in \fBSYNOPSIS\fP: .RS .sp @@ -1014,23 +1038,23 @@ a subdirectory, e.g., \fB#include <ncurses/curses.h>\fR .RE .IP -It also omits a symbolic link which would allow you to use \fB-lcurses\fP +It also omits a symbolic link which would allow you to use \fB\-lcurses\fP to build executables. .TP 5 ---enable-widec -The configure script renames the library and (if the \fB--disable-overwrite\fP +\-\-enable\-widec +The configure script renames the library and (if the \fB\-\-disable\-overwrite\fP option is used) puts the header files in a different subdirectory. All of the library names have a "w" appended to them, i.e., instead of .RS .sp -\fB-lncurses\fR +\fB\-lncurses\fR .RE .IP you link with .RS .sp -\fB-lncursesw\fR +\fB\-lncursesw\fR .RE .IP You must also define \fB_XOPEN_SOURCE_EXTENDED\fP when compiling for the @@ -1044,20 +1068,20 @@ the wide-character library's headers should be installed last, to allow applications to be built using either library from the same set of headers. .TP 5 ---with-shared +\-\-with\-shared .TP ---with-normal +\-\-with\-normal .TP ---with-debug +\-\-with\-debug .TP ---with-profile +\-\-with\-profile The shared and normal (static) library names differ by their suffixes, e.g., \fBlibncurses.so\fP and \fBlibncurses.a\fP. The debug and profiling libraries add a "_g" and a "_p" to the root names respectively, e.g., \fBlibncurses_g.a\fP and \fBlibncurses_p.a\fP. .TP 5 ---with-trace +\-\-with\-trace The \fBtrace\fP function normally resides in the debug library, but it is sometimes useful to configure this in the shared library. Configure scripts should check for the function's existence rather @@ -1071,8 +1095,10 @@ terminal capability database .SH SEE ALSO \fBterminfo\fR(\*n) and related pages whose names begin "curs_" for detailed routine descriptions. +.br +\fBcurs_variables\fR(3X) .SH EXTENSIONS -The \fBncurses\fR library can be compiled with an option (\fB-DUSE_GETCAP\fR) +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 cannot find a terminfo entry corresponding to \fBTERM\fR. Use of this feature @@ -1098,7 +1124,7 @@ See the \fBdefine_key\fR(3X) and \fBkeyok\fR(3X) manual pages for details. .PP The \fBncurses\fR library can exploit the capabilities of terminals which -implement the ISO-6429 SGR 39 and SGR 49 controls, which allow an application +implement the ISO\-6429 SGR 39 and SGR 49 controls, which allow an application to reset the terminal to its original foreground and background colors. From the users' perspective, the application is able to draw colored text on a background whose color is set independently, providing better @@ -1119,29 +1145,35 @@ the XSI Curses and \fBncurses\fR calls) are described in \fBPORTABILITY\fR sections of the library man pages. .PP This implementation also contains several extensions: -.RS 5 -.PP +.bP 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. -.PP +.bP 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 +.bP The routines \fBgetmouse\fR, \fBmousemask\fR, \fBungetmouse\fR, \fBmouseinterval\fR, and \fBwenclose\fR relating to mouse interfacing are not part of XPG4, nor are they present in SVr4. See the \fBcurs_mouse\fR(3X) manual page for details. -.PP +.bP The routine \fBmcprint\fR was not present in any previous curses implementation. See the \fBcurs_print\fR(3X) manual page for details. -.PP +.bP The routine \fBwresize\fR is not part of XPG4, nor is it present in SVr4. See the \fBwresize\fR(3X) manual page for details. -.PP +.bP 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 +.bP +This implementation can be configured to provide rudimentary support +for multi-threaded applications. +See \fBcurs_threads\fR(3X) for details. +.bP +This implementation can also be configured to provide a set of functions which +improve the ability to manage multiple screens. +See \fBcurs_sp_funcs\fR(3X) for details. .PP In historic curses versions, delays embedded in the capabilities \fBcr\fR, \fBind\fR, \fBcub1\fR, \fBff\fR and \fBtab\fR activated corresponding delay @@ -1160,9 +1192,3 @@ This was an undocumented feature of AT&T System V Release 3 curses. .SH AUTHORS Zeyd M. Ben-Halim, Eric S. Raymond, Thomas E. Dickey. Based on pcurses by Pavel Curtis. -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: |