diff options
Diffstat (limited to 'contrib/ncurses/man')
50 files changed, 890 insertions, 385 deletions
diff --git a/contrib/ncurses/man/Makefile.in b/contrib/ncurses/man/Makefile.in index 8a24d843a242..c04f7c9eea57 100644 --- a/contrib/ncurses/man/Makefile.in +++ b/contrib/ncurses/man/Makefile.in @@ -1,6 +1,6 @@ -# $Id: Makefile.in,v 1.39 2005/07/16 17:26:45 tom Exp $ +# $Id: Makefile.in,v 1.41 2007/03/31 15:54:06 tom Exp $ ############################################################################## -# Copyright (c) 1998-2003,2005 Free Software Foundation, Inc. # +# Copyright (c) 1998-2006,2007 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 "Software"), # @@ -52,7 +52,7 @@ depend : tags : $(DESTDIR)$(mandir) : - sh $(srcdir)/../mkinstalldirs $@ + sh $(srcdir)/../mkdirs.sh $@ EDITARGS = $(DESTDIR)$(mandir) $(srcdir) terminfo.5 $(srcdir)/*.[0-9]* @@ -77,4 +77,4 @@ clean: mostlyclean sh $(srcdir)/make_sed.sh @MANPAGE_RENAMES@ >../edit_man.sed distclean realclean: clean - rm -f Makefile ../edit_man.* + rm -f Makefile ../edit_man.* ../man_alias.* diff --git a/contrib/ncurses/man/captoinfo.1m b/contrib/ncurses/man/captoinfo.1m index 1bb6dec82fbf..de57a27cf0f4 100644 --- a/contrib/ncurses/man/captoinfo.1m +++ b/contrib/ncurses/man/captoinfo.1m @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998-2004,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2006,2007 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,16 +27,16 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: captoinfo.1m,v 1.20 2006/05/13 15:14:01 tom Exp $ -.TH captoinfo 1M "" +.\" $Id: captoinfo.1m,v 1.22 2007/06/02 20:40:07 tom Exp $ +.TH @CAPTOINFO@ 1M "" .ds n 5 .ds d @TERMINFO@ .SH NAME -\fBcaptoinfo\fR - convert a \fItermcap\fR description into a \fIterminfo\fR description +\fB@CAPTOINFO@\fR - convert a \fItermcap\fR description into a \fIterminfo\fR description .SH SYNOPSIS -\fBcaptoinfo\fR [\fB-v\fR\fIn\fR \fIwidth\fR] [\fB-V\fR] [\fB-1\fR] [\fB-w\fR \fIwidth\fR] \fIfile\fR . . . +\fB@CAPTOINFO@\fR [\fB-v\fR\fIn\fR \fIwidth\fR] [\fB-V\fR] [\fB-1\fR] [\fB-w\fR \fIwidth\fR] \fIfile\fR . . . .SH DESCRIPTION -\fBcaptoinfo\fR looks in \fIfile\fR for \fBtermcap\fR descriptions. For each +\fB@CAPTOINFO@\fR looks in \fIfile\fR for \fBtermcap\fR descriptions. For each one found, an equivalent \fBterminfo\fR description is written to standard output. Termcap \fBtc\fR capabilities are translated directly to terminfo \fBuse\fR capabilities. @@ -67,7 +67,7 @@ Compiled terminal description database. .SH TRANSLATIONS FROM NONSTANDARD CAPABILITIES .PP Some obsolete nonstandard capabilities will automatically be translated -into standard (SVr4/XSI Curses) terminfo capabilities by \fBcaptoinfo\fR. +into standard (SVr4/XSI Curses) terminfo capabilities by \fB@CAPTOINFO@\fR. Whenever one of these automatic translations is done, the program will issue an notification to stderr, inviting the user to check that it has not mistakenly translated a completely unknown and random @@ -145,7 +145,7 @@ GG acs magic cookie count .TE .PP If the single-line capabilities occur in an entry, they will automatically -be composed into an \fBacsc\fR string. The double-line capabilities and +be composed into an \fIacsc\fR string. The double-line capabilities and \fBGG\fR are discarded with a warning message. .PP IBM's AIX has a terminfo facility descended from SVr1 terminfo but incompatible @@ -164,17 +164,17 @@ font2 s2ds font3 s3ds .TE .PP -Additionally, the AIX \fBbox1\fR capability will be automatically translated to -an \fBacsc\fR string. +Additionally, the AIX \fIbox1\fR capability will be automatically translated to +an \fIacsc\fR string. .PP Hewlett-Packard's terminfo library supports two nonstandard terminfo -capabilities \fBmeml\fR (memory lock) and \fBmemu\fR (memory unlock). +capabilities \fImeml\fR (memory lock) and \fImemu\fR (memory unlock). These will be discarded with a warning message. .SH NOTES -This utility is actually a link to \fItic\fR(1M), running in \fI-I\fR mode. -You can use other \fItic\fR options such as \fB-f\fR and \fB-x\fR. +This utility is actually a link to \fB@TIC@\fR(1M), running in \fI-I\fR mode. +You can use other \fB@TIC@\fR options such as \fB-f\fR and \fB-x\fR. .PP -The trace option isn't identical to SVr4's. Under SVr4, instead of following +The trace option is not identical to SVr4's. Under SVr4, instead of following the \fB-v\fR with a trace level n, you repeat it n times. .SH SEE ALSO \fB@INFOCMP@\fR(1M), diff --git a/contrib/ncurses/man/clear.1 b/contrib/ncurses/man/clear.1 index 41c4cadc7796..31d0f93e05b9 100644 --- a/contrib/ncurses/man/clear.1 +++ b/contrib/ncurses/man/clear.1 @@ -26,20 +26,20 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: clear.1,v 1.5 2006/07/01 21:55:09 tom Exp $ -.TH clear 1 "" +.\" $Id: clear.1,v 1.6 2006/12/24 18:07:53 tom Exp $ +.TH @CLEAR@ 1 "" .ds n 5 .SH NAME -\fBclear\fR - clear the terminal screen +\fB@CLEAR@\fR - clear the terminal screen .SH SYNOPSIS -\fBclear\fR +\fB@CLEAR@\fR .br .SH DESCRIPTION -\fBclear\fR clears your screen if this is possible. It looks in the +\fB@CLEAR@\fR clears your screen if this is possible. It looks in the environment for the terminal type and then in the \fBterminfo\fR database to figure out how to clear the screen. .PP -\fBclear\fR ignores any command-line parameters that may be present. +\fB@CLEAR@\fR ignores any command-line parameters that may be present. .SH SEE ALSO \fB@TPUT@\fR(1), \fBterminfo\fR(\*n) .PP diff --git a/contrib/ncurses/man/curs_add_wch.3x b/contrib/ncurses/man/curs_add_wch.3x index 91228d450b20..51ac1a4b5c35 100644 --- a/contrib/ncurses/man/curs_add_wch.3x +++ b/contrib/ncurses/man/curs_add_wch.3x @@ -26,7 +26,7 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_add_wch.3x,v 1.5 2006/12/02 17:02:35 tom Exp $ +.\" $Id: curs_add_wch.3x,v 1.6 2006/12/24 15:22:22 tom Exp $ .TH curs_add_wch 3X "" .SH NAME \fBadd_wch\fP, @@ -82,7 +82,7 @@ and the rendition specified by \fIwch\fP is ignored. - If the character part of \fIwch\fP is a tab, newline, backspace or other control character, -the window is updated and the cursor moves as if \fBaddch\fR(3X) were called. +the window is updated and the cursor moves as if \fBaddch\fR were called. .PP The \fBecho_wchar\fP function is functionally equivalent to a call to @@ -122,7 +122,7 @@ Those are not currently implemented in \fBncurses\fP. .PP \fBcurses\fR(3X), \fBcurs_addch\fR(3X), -\fBcurs_attr_get\fR(3X), +\fBcurs_attr\fR(3X), \fBcurs_clear\fR(3X), \fBcurs_outopts\fR(3X), \fBcurs_refresh\fR(3X), diff --git a/contrib/ncurses/man/curs_addch.3x b/contrib/ncurses/man/curs_addch.3x index d8b645d7c359..73918b88b954 100644 --- a/contrib/ncurses/man/curs_addch.3x +++ b/contrib/ncurses/man/curs_addch.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998-2005,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2006,2007 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: curs_addch.3x,v 1.25 2006/12/02 17:02:22 tom Exp $ +.\" $Id: curs_addch.3x,v 1.27 2007/06/02 20:40:07 tom Exp $ .TH curs_addch 3X "" .SH NAME \fBaddch\fR, \fBwaddch\fR, \fBmvaddch\fR, \fBmvwaddch\fR, @@ -87,7 +87,7 @@ their equivalents. .SS Line Graphics The following variables may be used to add line drawing characters to the screen with routines of the \fBaddch\fR family. The default character listed -below is used if the \fBacsc\fR capability doesn't define a terminal-specific +below is used if the \fBacsc\fR capability does not define a terminal-specific replacement for it. The names are taken from VT100 nomenclature. .PP @@ -168,7 +168,7 @@ This is true of other implementations, but is not documented. \fBcurs_inch\fR(3X), \fBcurs_outopts\fR(3X), \fBcurs_refresh\fR(3X), -\fBputc\fR(3S). +\fBputc\fR(3). .PP Comparable functions in the wide-character (ncursesw) library are described in diff --git a/contrib/ncurses/man/curs_attr.3x b/contrib/ncurses/man/curs_attr.3x index 31c5397dad1f..cf58affee13d 100644 --- a/contrib/ncurses/man/curs_attr.3x +++ b/contrib/ncurses/man/curs_attr.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998-2005,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2006,2007 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: curs_attr.3x,v 1.30 2006/07/15 18:39:05 tom Exp $ +.\" $Id: curs_attr.3x,v 1.31 2007/03/17 20:30:33 tom Exp $ .TH curs_attr 3X "" .na .hy 0 @@ -253,6 +253,9 @@ This implementation returns an error if the window pointer is null. The \fBwcolor_set\fP function returns an error if the color pair parameter is outside the range 0..COLOR_PAIRS-1. +This implementation also provides +\fBgetattrs\fR +for compatibility with older versions of curses. .SH SEE ALSO \fBcurses\fR(3X), \fBcurs_addch\fR(3X), diff --git a/contrib/ncurses/man/curs_border.3x b/contrib/ncurses/man/curs_border.3x index 3071d2a603ea..09f9a4c221f9 100644 --- a/contrib/ncurses/man/curs_border.3x +++ b/contrib/ncurses/man/curs_border.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2005,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2006,2007 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 * @@ -26,7 +26,7 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_border.3x,v 1.18 2006/02/25 21:49:19 tom Exp $ +.\" $Id: curs_border.3x,v 1.19 2007/02/24 16:15:38 tom Exp $ .TH curs_border 3X "" .na .hy 0 @@ -64,9 +64,9 @@ .br \fBint wvline(WINDOW *win, chtype ch, int n);\fR .br -\fBmvhline(int y, int x, chtype ch, int n);\fR +\fBint mvhline(int y, int x, chtype ch, int n);\fR .br -\fBmvwhline(WINDOW *, int y, int x, chtype ch, int n);\fR +\fBint mvwhline(WINDOW *, int y, int x, chtype ch, int n);\fR .br \fBint mvvline(int y, int x, chtype ch, int n);\fR .br diff --git a/contrib/ncurses/man/curs_deleteln.3x b/contrib/ncurses/man/curs_deleteln.3x index 25991391840d..fc7b16a96d07 100644 --- a/contrib/ncurses/man/curs_deleteln.3x +++ b/contrib/ncurses/man/curs_deleteln.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2005,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2006,2007 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 * @@ -26,7 +26,7 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_deleteln.3x,v 1.10 2006/02/25 21:49:19 tom Exp $ +.\" $Id: curs_deleteln.3x,v 1.11 2007/06/02 20:40:07 tom Exp $ .TH curs_deleteln 3X "" .SH NAME \fBdeleteln\fR, @@ -79,7 +79,7 @@ error conditions. Note that all but \fBwinsdelln\fR may be macros. .PP These routines do not require a hardware line delete or insert feature in the -terminal. In fact, they won't use hardware line delete/insert unless +terminal. In fact, they will not use hardware line delete/insert unless \fBidlok(..., TRUE)\fR has been set on the current window. .SH SEE ALSO \fBcurses\fR(3X) diff --git a/contrib/ncurses/man/curs_extend.3x b/contrib/ncurses/man/curs_extend.3x index c053864194c3..3092253fff0b 100644 --- a/contrib/ncurses/man/curs_extend.3x +++ b/contrib/ncurses/man/curs_extend.3x @@ -28,7 +28,7 @@ .\" .\" Author: Thomas E. Dickey 1999-on .\" -.\" $Id: curs_extend.3x,v 1.15 2006/02/25 21:04:43 tom Exp $ +.\" $Id: curs_extend.3x,v 1.17 2006/12/24 18:01:48 tom Exp $ .TH curs_extend 3X "" .SH NAME \fBcurses_version\fP, @@ -56,7 +56,7 @@ is able to use user-defined or nonstandard names which may be compiled into the terminfo description, i.e., via the terminfo or termcap interfaces. Normally these names are available for use, since the essential decision -is made by using the \fB-x\fP option of \fItic\fP to compile +is made by using the \fB-x\fP option of \fB@TIC@\fP to compile extended terminal definitions. However you can disable this feature to ensure compatibility with other implementations of curses. @@ -68,11 +68,11 @@ any code depending on them be conditioned using NCURSES_VERSION. \fBcurs_getch\fR(3X), \fBcurs_mouse\fR(3X), \fBcurs_print\fR(3X), +\fBcurs_util\fR(3X), \fBdefault_colors\fR(3X), \fBdefine_key\fR(3X), \fBkeybound\fR(3X), \fBkeyok\fR(3X), -\fBnofilter\fR(3X), \fBresizeterm\fR(3X), \fBwresize\fR(3X). .SH AUTHOR diff --git a/contrib/ncurses/man/curs_getcchar.3x b/contrib/ncurses/man/curs_getcchar.3x index 91b996197c58..b811a37db8f7 100644 --- a/contrib/ncurses/man/curs_getcchar.3x +++ b/contrib/ncurses/man/curs_getcchar.3x @@ -26,7 +26,7 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_getcchar.3x,v 1.8 2006/07/15 22:51:07 wcmbrine Exp $ +.\" $Id: curs_getcchar.3x,v 1.10 2006/12/24 16:00:02 tom Exp $ .TH curs_getcchar 3X "" .SH NAME \fBgetcchar\fP, @@ -132,10 +132,10 @@ Otherwise, it returns \fBERR\fP. .SH SEE ALSO .PP Functions: +\fBcurs_attr\fR(3X), +\fBcurs_color\fR(3X), \fBcurses\fR(3X), -\fBwcwidth\fR(3X), -\fBcurs_attr_get\fR(3X), -\fBcan_change_color\fR(3X). +\fBwcwidth\fR(3). .\"# .\"# The following sets edit modes for GNU EMACS .\"# Local Variables: diff --git a/contrib/ncurses/man/curs_getyx.3x b/contrib/ncurses/man/curs_getyx.3x index 8fe53dc71972..2581253d7c78 100644 --- a/contrib/ncurses/man/curs_getyx.3x +++ b/contrib/ncurses/man/curs_getyx.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2003,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2006,2007 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 * @@ -26,7 +26,7 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_getyx.3x,v 1.13 2006/05/27 20:28:05 tom Exp $ +.\" $Id: curs_getyx.3x,v 1.16 2007/05/12 16:34:49 tom Exp $ .TH curs_getyx 3X "" .SH NAME \fBgetyx\fR, @@ -69,7 +69,7 @@ The \fBgetmaxyx\fR macros are described in the XSI Curses standard, Issue 4. .PP -This implementation also provides +This implementation also provides functions \fBgetbegx\fR, \fBgetbegy\fR, \fBgetcurx\fR, @@ -79,10 +79,25 @@ This implementation also provides \fBgetparx\fR and \fBgetpary\fR for compatibility with older versions of curses. -X/Open does not define a corresponding \fBgetcuryx\fP function, -though that would be needed to make references to the WINDOW structure opaque. +.PP +Although X/Open Curses does not address this, +many implementations provide members of the WINDOW structure +containing values corresponding to these macros. +For best portability, do not rely on using the data in WINDOW, +since some implementations make WINDOW opaque (do not allow +direct use of its members). +.PP +Besides the problem of opaque structures, +the data stored in like-named members may not have like-values in +different implementations. +For example, the WINDOW._maxx and WINDOW._maxy values in ncurses +have (at least since release 1.8.1) differed by one from some +other implementations. +The difference is hidden by means of the macro \fBgetmaxyx\fP. .SH SEE ALSO -\fBcurses\fR(3X) +\fBcurses\fR(3X), +\fBcurs_legacy\fR(3X), +\fBcurs_opaque\fR(3X) .\"# .\"# The following sets edit modes for GNU EMACS .\"# Local Variables: diff --git a/contrib/ncurses/man/curs_insstr.3x b/contrib/ncurses/man/curs_insstr.3x index 6a5d312970f6..1536ea293a5a 100644 --- a/contrib/ncurses/man/curs_insstr.3x +++ b/contrib/ncurses/man/curs_insstr.3x @@ -26,7 +26,7 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_insstr.3x,v 1.17 2006/02/25 21:49:19 tom Exp $ +.\" $Id: curs_insstr.3x,v 1.18 2006/12/24 14:59:30 tom Exp $ .TH curs_insstr 3X "" .SH NAME \fBinsstr\fR, @@ -90,7 +90,7 @@ This is probably an error, since it makes this group of functions inconsistent. Also, no implementation of curses documents this inconsistency. .SH SEE ALSO \fBcurses\fR(3X), -\fBunctrl\fR(3X), +\fBcurs_util\fR(3X), \fBcurs_clear\fR(3X), \fBcurs_inch\fR(3X). .\"# diff --git a/contrib/ncurses/man/curs_legacy.3x b/contrib/ncurses/man/curs_legacy.3x new file mode 100644 index 000000000000..251ae496b851 --- /dev/null +++ b/contrib/ncurses/man/curs_legacy.3x @@ -0,0 +1,93 @@ +.\"*************************************************************************** +.\" Copyright (c) 2007 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 * +.\" "Software"), to deal in the Software without restriction, including * +.\" without limitation the rights to use, copy, modify, merge, publish, * +.\" distribute, distribute with modifications, sublicense, and/or sell * +.\" copies of the Software, and to permit persons to whom the Software is * +.\" furnished to do so, subject to the following conditions: * +.\" * +.\" The above copyright notice and this permission notice shall be included * +.\" in all copies or substantial portions of the Software. * +.\" * +.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * +.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * +.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * +.\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * +.\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * +.\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * +.\" THE USE OR OTHER DEALINGS IN THE SOFTWARE. * +.\" * +.\" Except as contained in this notice, the name(s) of the above copyright * +.\" holders shall not be used in advertising or otherwise to promote the * +.\" sale, use or other dealings in this Software without prior written * +.\" authorization. * +.\"*************************************************************************** +.\" +.\" $Id: curs_legacy.3x,v 1.1 2007/04/07 23:54:29 tom Exp $ +.TH curs_legacy 3X "" +.SH NAME +\fBgetbegx\fR, +\fBgetbegy\fR, +\fBgetcurx\fR, +\fBgetcury\fR, +\fBgetmaxx\fR, +\fBgetmaxy\fR, +\fBgetparx\fR, +\fBgetpary\fR - get \fBcurses\fR cursor and window coordinates +.SH SYNOPSIS +\fB#include <curses.h>\fR +.sp +\fBint getbegx(WINDOW *win);\fR +.br +\fBint getbegy(WINDOW *win);\fR +.br +\fBint getcurx(WINDOW *win);\fR +.br +\fBint getcury(WINDOW *win);\fR +.br +\fBint getmaxx(WINDOW *win);\fR +.br +\fBint getmaxy(WINDOW *win);\fR +.br +\fBint getparx(WINDOW *win);\fR +.br +\fBint getpary(WINDOW *win);\fR +.br +.SH DESCRIPTION +The \fBgetbegy\fR and \fBgetbegx\fR functions return the same +data as \fBgetbegyx\fR. +.PP +The \fBgetcury\fR and \fBgetcurx\fR functions return the same +data as \fBgetyx\fR. +.PP +The \fBgetmaxy\fR and \fBgetmaxx\fR functions return the same +data as \fBgetmaxyx\fR. +.PP +The \fBgetpary\fR and \fBgetparx\fR functions return the same +data as \fBgetparyx\fR. +.SH RETURN VALUE +These functions return an integer, +or ERR if the window parameter is null. +.SH NOTES +All of these interfaces are provided as macros and functions. +The macros are suppressed (and only the functions provided) +when \fBNCURSES_OPAQUE\fR is defined. +The standard forms such as \fBgetyx\fP must be implemented as macros, +and (in this implementation) are defined in terms of the functions +described here, +to avoid reliance on internal details of the WINDOW structure. +.SH PORTABILITY +These functions were supported on Version 7, BSD or System V implementations. +.SH SEE ALSO +\fBcurses\fR(3X), +\fBcurs_getyx\fR(3X), +\fBcurs_opaque\fR(3X) +.\"# +.\"# The following sets edit modes for GNU EMACS +.\"# Local Variables: +.\"# mode:nroff +.\"# fill-column:79 +.\"# End: diff --git a/contrib/ncurses/man/curs_mouse.3x b/contrib/ncurses/man/curs_mouse.3x index 865fab1ad88f..23f9f9c6d7d0 100644 --- a/contrib/ncurses/man/curs_mouse.3x +++ b/contrib/ncurses/man/curs_mouse.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998-2003,2005 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2005,2006 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: curs_mouse.3x,v 1.28 2005/05/15 16:18:19 tom Exp $ +.\" $Id: curs_mouse.3x,v 1.30 2006/12/30 23:43:34 tom Exp $ .TH curs_mouse 3X "" .na .hy 0 @@ -158,22 +158,23 @@ if it is and FALSE otherwise. It is useful for determining what subset of the screen windows enclose the location of a mouse event. .PP -The \fBwmouse_trafo\fR function transforms a given pair of coordinates from -stdscr-relative coordinates to screen-relative coordinates or vice versa. +The \fBwmouse_trafo\fR function transforms a given pair of coordinates +from stdscr-relative coordinates +to coordinates relative to the given window or vice versa. Please remember, that stdscr-relative coordinates are not always identical -to screen-relative coordinates due to the mechanism to reserve lines on top -or bottom of the screen for other purposes (ripoff() call, see also slk_... -functions). +to window-relative coordinates due to the mechanism to reserve lines on top +or bottom of the screen for other purposes +(see the \fBripoffline()\fP and \fBslk_init\fR calls, for example). If the parameter \fBto_screen\fR is \fBTRUE\fR, the pointers -\fBpY, pX\fR must reference the coordinates of a location inside the window -\fBwin\fR. -They are converted to screen-relative coordinates and returned +\fBpY, pX\fR must reference the coordinates of a location +inside the window \fBwin\fR. +They are converted to window-relative coordinates and returned through the pointers. If the conversion was successful, the function returns \fBTRUE\fR. If one of the parameters was NULL or the location is not inside the window, \fBFALSE\fR is returned. If \fBto_screen\fR is -\fBFALSE\fR, the pointers \fBpY, pX\fR must reference screen-relative +\fBFALSE\fR, the pointers \fBpY, pX\fR must reference window-relative coordinates. They are converted to stdscr-relative coordinates if the window \fBwin\fR encloses this point. @@ -184,6 +185,10 @@ Please notice, that the referenced coordinates are only replaced by the converted coordinates if the transformation was successful. .PP +The \fBmouse_trafo\fR function performs the same translation +as \fBwmouse_trafo\fR, +using stdscr for \fBwin\fR. +.PP The \fBmouseinterval\fR function sets the maximum time (in thousands of a second) that can elapse between press and release events for them to be recognized as a click. @@ -259,7 +264,7 @@ OS/2 EMX .RE If you are using an unsupported configuration, mouse events will not be visible to -\fBncurses\fR(3X) (and the \fBwmousemask\fR function will always +\fBncurses\fR(3X) (and the \fBmousemask\fR function will always return \fB0\fR). .PP If the terminfo entry contains a \fBXM\fR string, @@ -276,14 +281,17 @@ for use with touch screens (which may be pressure-sensitive) or with 3D-mice/trackballs/power gloves. .SH BUGS Mouse events under xterm will not in fact be ignored during cooked mode, -if they have been enabled by \fBwmousemask\fR. +if they have been enabled by \fBmousemask\fR. Instead, the xterm mouse report sequence will appear in the string read. .PP Mouse events under xterm will not be detected correctly in a window with its keypad bit off, since they are interpreted as a variety of function key. -Your terminfo description must have \fBkmous\fR set to "\\E[M" (the beginning -of the response from xterm for mouse clicks). +Your terminfo description should have \fBkmous\fR set to "\\E[M" +(the beginning of the response from xterm for mouse clicks). +Other values for \fBkmous\fR are permitted, +but under the same assumption, +i.e., it is the beginning of the response. .PP Because there are no standard terminal responses that would serve to identify terminals which support the xterm mouse protocol, \fBncurses\fR assumes that @@ -291,7 +299,9 @@ if your $TERM environment variable contains "xterm", or \fBkmous\fR is defined in the terminal description, then the terminal may send mouse events. .SH SEE ALSO -\fBcurses\fR(3X). +\fBcurses\fR(3X), +\fBcurs_kernel\fR(3X), +\fBcurs_slk\fR(3X). .\"# .\"# The following sets edit modes for GNU EMACS .\"# Local Variables: diff --git a/contrib/ncurses/man/curs_opaque.3x b/contrib/ncurses/man/curs_opaque.3x new file mode 100644 index 000000000000..6c9cfaa18a35 --- /dev/null +++ b/contrib/ncurses/man/curs_opaque.3x @@ -0,0 +1,133 @@ +.\"*************************************************************************** +.\" Copyright (c) 2007 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 * +.\" "Software"), to deal in the Software without restriction, including * +.\" without limitation the rights to use, copy, modify, merge, publish, * +.\" distribute, distribute with modifications, sublicense, and/or sell * +.\" copies of the Software, and to permit persons to whom the Software is * +.\" furnished to do so, subject to the following conditions: * +.\" * +.\" The above copyright notice and this permission notice shall be included * +.\" in all copies or substantial portions of the Software. * +.\" * +.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * +.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * +.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * +.\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * +.\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * +.\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * +.\" THE USE OR OTHER DEALINGS IN THE SOFTWARE. * +.\" * +.\" Except as contained in this notice, the name(s) of the above copyright * +.\" holders shall not be used in advertising or otherwise to promote the * +.\" sale, use or other dealings in this Software without prior written * +.\" authorization. * +.\"*************************************************************************** +.\" +.\" $Id: curs_opaque.3x,v 1.6 2007/09/08 18:49:13 tom Exp $ +.TH curs_opaque 3X "" +.na +.hy 0 +.SH NAME +\fBis_cleared\fR, +\fBis_idlok\fR, +\fBis_idcok\fR, +\fBis_immedok\fR, +\fBis_keypad\fR, +\fBis_leaveok\fR, +\fBis_nodelay\fR, +\fBis_timeout\fR, +\fBis_scrollok\fR, +\fBis_syncok\fR - \fBcurses\fR window properties +.ad +.hy +.SH SYNOPSIS +\fB#include <curses.h>\fR +.sp +\fBbool is_cleared(const WINDOW *win);\fR +.br +\fBbool is_idcok(const WINDOW *win);\fR +.br +\fBbool is_idlok(const WINDOW *win);\fR +.br +\fBbool is_immedok(const WINDOW *win);\fR +.br +\fBbool is_keypad(const WINDOW *win);\fR +.br +\fBbool is_leaveok(const WINDOW *win);\fR +.br +\fBbool is_nodelay(const WINDOW *win);\fR +.br +\fBbool is_notimeout(const WINDOW *win);\fR +.br +\fBbool is_scrollok(const WINDOW *win);\fR +.br +\fBbool is_syncok(const WINDOW *win);\fR +.br +\fBWINDOW * wgetparent(const WINDOW *win);\fR +.br +\fBint wgetscrreg(const WINDOW *win, int *top, int *bottom);\fR +.br +.SH DESCRIPTION +This implementation provides functions which return properties +set in the WINDOW structure, allowing it to be ``opaque'' if +the symbol \fBNCURSES_OPAQUE\fR is defined: +.TP 5 +\fBis_cleared\fR +returns the value set in \fBclearok\fR +.TP 5 +\fBis_idcok\fR +returns the value set in \fBidcok\fR +.TP 5 +\fBis_idlok\fR +returns the value set in \fBidlok\fR +.TP 5 +\fBis_immedok\fR +returns the value set in \fBimmedok\fR +.TP 5 +\fBis_keypad\fR +returns the value set in \fBkeypad\fR +.TP 5 +\fBis_leaveok\fR +returns the value set in \fBleaveok\fR +.TP 5 +\fBis_nodelay\fR +returns the value set in \fBnodelay\fR +.TP 5 +\fBis_notimeout\fR +returns the value set in \fBnotimeout\fR +.TP 5 +\fBis_scrollok\fR +returns the value set in \fBscrollok\fR +.TP 5 +\fBis_syncok\fR +returns the value set in \fBsyncok\fR +.TP 5 +\fBwgetparent\fR +returns the parent WINDOW pointer for subwindows, +or NULL for windows having no parent. +.TP 5 +\fBwgetscrreg\fR +returns the top and bottom rows for the scrolling margin as set in \fBwsetscrreg\fP. +.SH RETURN VALUE +These functions all return TRUE or FALSE, except as noted. +.SH NOTES +Both a macro and a function are provided for each name. +.SH PORTABILITY +These routines are specific to ncurses. +They were not supported on Version 7, BSD or System V implementations. +It is recommended that any code depending on ncurses extensions +be conditioned using NCURSES_VERSION. +.SH SEE ALSO +\fBcurses\fR(3X), +\fBcurs_inopts\fR(3X), +\fBcurs_outopts\fR(3X), +\fBcurs_window\fR(3X) +.\"# +.\"# The following sets edit modes for GNU EMACS +.\"# Local Variables: +.\"# mode:nroff +.\"# fill-column:79 +.\"# End: diff --git a/contrib/ncurses/man/curs_outopts.3x b/contrib/ncurses/man/curs_outopts.3x index 5b986bbd67bf..3fd437a312bb 100644 --- a/contrib/ncurses/man/curs_outopts.3x +++ b/contrib/ncurses/man/curs_outopts.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2003,2005 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2005,2007 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 * @@ -26,7 +26,7 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_outopts.3x,v 1.20 2005/05/15 16:18:32 tom Exp $ +.\" $Id: curs_outopts.3x,v 1.21 2007/06/02 20:40:07 tom Exp $ .TH curs_outopts 3X "" .na .hy 0 @@ -91,7 +91,7 @@ This option should be enabled only if the application needs insert/delete line, for example, for a screen editor. It is disabled by default because insert/delete line tends to be visually annoying -when used in applications where it isn't really needed. +when used in applications where it is not really needed. If insert/delete line cannot be used, \fBcurses\fR redraws the changed portions of all lines. .PP diff --git a/contrib/ncurses/man/curs_printw.3x b/contrib/ncurses/man/curs_printw.3x index 7c1a41b5b96f..ead0f183dc09 100644 --- a/contrib/ncurses/man/curs_printw.3x +++ b/contrib/ncurses/man/curs_printw.3x @@ -26,7 +26,7 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_printw.3x,v 1.16 2006/02/25 21:49:19 tom Exp $ +.\" $Id: curs_printw.3x,v 1.17 2006/12/24 16:05:17 tom Exp $ .TH curs_printw 3X "" .na .hy 0 @@ -55,12 +55,12 @@ .br .SH DESCRIPTION The \fBprintw\fR, \fBwprintw\fR, \fBmvprintw\fR and \fBmvwprintw\fR -routines are analogous to \fBprintf\fR [see \fBprintf\fR(3S)]. In +routines are analogous to \fBprintf\fR [see \fBprintf\fR(3)]. In effect, the string that would be output by \fBprintf\fR is output instead as though \fBwaddstr\fR were used on the given window. .PP The \fBvwprintw\fR and \fBwv_printw\fR routines are analogous -to \fBvprintf\fR [see \fBprintf\fR(3S)] +to \fBvprintf\fR [see \fBprintf\fR(3)] and perform a \fBwprintw\fR using a variable argument list. The third argument is a \fBva_list\fR, a pointer to a list of arguments, as defined in \fB<stdarg.h>\fR. @@ -85,7 +85,7 @@ cannot be used in the same file as \fB<stdarg.h>\fR. This implementation uses \fB<stdarg.h>\fR for both, because that header is included in \fB<curses.h\fR>. .SH SEE ALSO -\fBcurses\fR(3X), \fBprintf\fR(3S), \fBvprintf(3S)\fR +\fBcurses\fR(3X), \fBprintf\fR(3), \fBvprintf(3)\fR .\"# .\"# The following sets edit modes for GNU EMACS .\"# Local Variables: diff --git a/contrib/ncurses/man/curs_scanw.3x b/contrib/ncurses/man/curs_scanw.3x index 9f25b57089bb..71ba9eeb4ddf 100644 --- a/contrib/ncurses/man/curs_scanw.3x +++ b/contrib/ncurses/man/curs_scanw.3x @@ -26,7 +26,7 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_scanw.3x,v 1.13 2006/02/25 21:42:22 tom Exp $ +.\" $Id: curs_scanw.3x,v 1.14 2006/12/24 16:05:49 tom Exp $ .TH curs_scanw 3X "" .SH NAME \fBscanw\fR, @@ -50,7 +50,7 @@ \fBint vwscanw(WINDOW *win, char *fmt, va_list varglist);\fR .SH DESCRIPTION The \fBscanw\fR, \fBwscanw\fR and \fBmvscanw\fR routines are analogous to -\fBscanf\fR [see \fBscanf\fR(3S)]. The effect of these routines is as though +\fBscanf\fR [see \fBscanf\fR(3)]. The effect of these routines is as though \fBwgetstr\fR were called on the window, and the resulting line used as input for \fBsscanf\fR(3). Fields which do not map to a variable in the \fIfmt\fR field are lost. @@ -88,7 +88,7 @@ since the OK value (zero) is likely to be misleading. One possible way to get useful results would be to use a "%n" conversion at the end of the format string to ensure that something was processed. .SH SEE ALSO -\fBcurses\fR(3X), \fBcurs_getstr\fR(3X), \fBcurs_printw\fR(3X), \fBscanf\fR(3S) +\fBcurses\fR(3X), \fBcurs_getstr\fR(3X), \fBcurs_printw\fR(3X), \fBscanf\fR(3) .\"# .\"# The following sets edit modes for GNU EMACS .\"# Local Variables: diff --git a/contrib/ncurses/man/curs_scr_dump.3x b/contrib/ncurses/man/curs_scr_dump.3x index d432c0dbdb6a..7884f6aa0648 100644 --- a/contrib/ncurses/man/curs_scr_dump.3x +++ b/contrib/ncurses/man/curs_scr_dump.3x @@ -26,7 +26,7 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_scr_dump.3x,v 1.6 2006/02/25 21:49:19 tom Exp $ +.\" $Id: curs_scr_dump.3x,v 1.7 2006/12/24 16:05:49 tom Exp $ .TH curs_scr_dump 3X "" .na .hy 0 @@ -93,7 +93,7 @@ considered invalid "if the time-stamp of the tty is old" but do not define "old". .SH SEE ALSO \fBcurses\fR(3X), \fBcurs_initscr\fR(3X), \fBcurs_refresh\fR(3X), -\fBcurs_util\fR(3X), \fBsystem\fR(3S) +\fBcurs_util\fR(3X), \fBsystem\fR(3) .\"# .\"# The following sets edit modes for GNU EMACS .\"# Local Variables: diff --git a/contrib/ncurses/man/curs_slk.3x b/contrib/ncurses/man/curs_slk.3x index b946ff21f2de..6361268b19d9 100644 --- a/contrib/ncurses/man/curs_slk.3x +++ b/contrib/ncurses/man/curs_slk.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2005,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2006,2007 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 * @@ -26,7 +26,7 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_slk.3x,v 1.15 2006/02/25 21:49:19 tom Exp $ +.\" $Id: curs_slk.3x,v 1.16 2007/06/02 20:40:07 tom Exp $ .TH curs_slk 3X "" .na .hy 0 @@ -95,7 +95,7 @@ labels of up to eight characters each. In addition to this, the ncurses implementation supports a mode where it simulates 12 labels of up to five characters each. This is most common for todays PC like enduser devices. Please note that ncurses simulates this mode by taking over up to two lines at -the bottom of the screen, it doesn't try to use any hardware support for this +the bottom of the screen, it does not try to use any hardware support for this mode. .PP The \fBslk_init\fR routine must be called before \fBinitscr\fR or \fBnewterm\fR diff --git a/contrib/ncurses/man/curs_termattrs.3x b/contrib/ncurses/man/curs_termattrs.3x index 48ff21ced68c..1e07307d19c0 100644 --- a/contrib/ncurses/man/curs_termattrs.3x +++ b/contrib/ncurses/man/curs_termattrs.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2002,2003 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2003,2007 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 * @@ -26,7 +26,7 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_termattrs.3x,v 1.9 2003/12/27 18:37:47 tom Exp $ +.\" $Id: curs_termattrs.3x,v 1.10 2007/06/02 20:40:07 tom Exp $ .TH curs_termattrs 3X "" .SH NAME \fBbaudrate\fR, @@ -101,7 +101,7 @@ overwritten by each call to \fBnewterm\fR and is not restored by \fBnewterm\fR if \fBlongname\fR is going to be used with multiple terminals. .PP -If a given terminal doesn't support a video attribute that an +If a given terminal does not support a video attribute that an application program is trying to use, \fBcurses\fR may substitute a different video attribute for it. The \fBtermattrs\fR and \fBterm_attrs\fR functions diff --git a/contrib/ncurses/man/curs_termcap.3x b/contrib/ncurses/man/curs_termcap.3x index e8072dc95bcf..93ac2fb146d1 100644 --- a/contrib/ncurses/man/curs_termcap.3x +++ b/contrib/ncurses/man/curs_termcap.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2005,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2006,2007 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 * @@ -26,7 +26,7 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_termcap.3x,v 1.20 2006/02/25 21:50:01 tom Exp $ +.\" $Id: curs_termcap.3x,v 1.22 2007/06/02 20:40:07 tom Exp $ .TH curs_termcap 3X "" .ds n 5 .SH NAME @@ -122,7 +122,7 @@ Routines that return pointers return \fBNULL\fR on error. .SH BUGS If you call \fBtgetstr\fR to fetch \fBca\fR or any other parameterized string, be aware that it will be returned in terminfo notation, not the older and -not-quite-compatible termcap notation. This won't cause problems if all +not-quite-compatible termcap notation. This will not cause problems if all you do with it is call \fBtgoto\fR or \fBtparm\fR, which both expand terminfo-style strings as terminfo. (The \fBtgoto\fR function, if configured to support termcap, will check @@ -158,7 +158,7 @@ e.g., not distinguishing between input and output. In particular, some applications are reported to declare and/or modify \fBospeed\fR. .SH SEE ALSO -\fBcurses\fR(3X), \fBterminfo\fR(\*n), \fBputc\fR(3S). +\fBcurses\fR(3X), \fBterminfo\fR(\*n), \fBputc\fR(3). .\"# .\"# The following sets edit modes for GNU EMACS .\"# Local Variables: diff --git a/contrib/ncurses/man/curs_terminfo.3x b/contrib/ncurses/man/curs_terminfo.3x index 435ac35b7c3e..5af0b8fbe27c 100644 --- a/contrib/ncurses/man/curs_terminfo.3x +++ b/contrib/ncurses/man/curs_terminfo.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1999-2005,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 1999-2006,2007 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 * @@ -26,7 +26,7 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_terminfo.3x,v 1.24 2006/11/04 21:50:03 tom Exp $ +.\" $Id: curs_terminfo.3x,v 1.28 2007/05/26 20:09:06 tom Exp $ .TH curs_terminfo 3X "" .ds n 5 .na @@ -64,7 +64,7 @@ .br \fBint del_curterm(TERMINAL *\fR\fIoterm\fR\fB);\fR .br -\fBint restartterm(const char *\fR\fIterm\fR\fB, int \fR\fIfildes\fR\fB, int *\fR\fIerrret\fR\fB);\fR +\fBint restartterm(char *\fR\fIterm\fR\fB, int \fR\fIfildes\fR\fB, int *\fR\fIerrret\fR\fB);\fR .br \fBchar *tparm(char *\fR\fIstr\fR\fB, ...);\fR .br @@ -99,16 +99,22 @@ recommended. Initially, \fBsetupterm\fR should be called. Note that \fBsetupterm\fR is automatically called by \fBinitscr\fR and \fBnewterm\fR. This defines the set of terminal-dependent variables -[listed in \fBterminfo\fR(\*n)]. The \fBterminfo\fR variables +[listed in \fBterminfo\fR(\*n)]. +The \fBterminfo\fR variables \fBlines\fR and \fBcolumns\fR are initialized by \fBsetupterm\fR as -follows: If \fBuse_env(FALSE)\fR has been called, values for +follows: +.RS +.PP +If \fBuse_env(FALSE)\fR has been called, values for \fBlines\fR and \fBcolumns\fR specified in \fBterminfo\fR are used. +.PP Otherwise, if the environment variables \fBLINES\fR and \fBCOLUMNS\fR exist, their values are used. If these environment variables do not exist and the program is running in a window, the current window size is used. Otherwise, if the environment variables do not exist, the values for \fBlines\fR and \fBcolumns\fR specified in the \fBterminfo\fR database are used. +.RE .PP The header files \fBcurses.h\fR and \fBterm.h\fR should be included (in this order) to get the definitions for these strings, numbers, and flags. @@ -183,7 +189,8 @@ except that it is called after restoring memory to a previous state (for example, when reloading a game saved as a core image dump). It assumes that the windows and the input and output options are the same as when memory was saved, but the terminal type and baud rate may be different. Accordingly, -it saves various tty state bits, does a setupterm, and then restores the bits. +it saves various tty state bits, calls \fBsetupterm\fP, +and then restores the bits. .PP The \fBtparm\fR routine instantiates the string \fIstr\fR with parameters \fIpi\fR. A pointer is returned to the result of \fIstr\fR @@ -288,6 +295,9 @@ The function \fBsetterm\fR is not described in the XSI Curses standard and must be considered non-portable. All other functions are as described in the XSI curses standard. .PP +\fBsetupterm\fP copies the terminal name to the array \fBttytype\fP. +This is not part of X/Open Curses, but is assumed by some applications. +.PP In System V Release 4, \fBset_curterm\fR has an \fBint\fR return type and returns \fBOK\fR or \fBERR\fR. We have chosen to implement the XSI Curses semantics. @@ -309,7 +319,7 @@ the SCREEN data allocated in either \fBinitscr\fR or \fBnewterm\fR. So though it is documented as a terminfo function, \fBmvcur\fR is really a curses function which is not well specified. .PP -XSI states that the old location must be given. +XSI states that the old location must be given for \fBmvcur\fP. This implementation allows the caller to use -1's for the old ordinates. In that case, the old location is unknown. .PP @@ -317,7 +327,7 @@ Extended terminal capability names, e.g., as defined by \fBtic\ -x\fP, are not stored in the arrays described in this section. .SH SEE ALSO \fBcurses\fR(3X), \fBcurs_initscr\fR(3X), \fBcurs_kernel\fR(3X), \fBcurs_termcap\fR(3X), -\fBputc\fR(3S), \fBterminfo\fR(\*n) +\fBputc\fR(3), \fBterminfo\fR(\*n) .\"# .\"# The following sets edit modes for GNU EMACS .\"# Local Variables: diff --git a/contrib/ncurses/man/curs_trace.3x b/contrib/ncurses/man/curs_trace.3x index 560302c42cc7..ca7495272d33 100644 --- a/contrib/ncurses/man/curs_trace.3x +++ b/contrib/ncurses/man/curs_trace.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 2000-2002,2005 Free Software Foundation, Inc. * +.\" Copyright (c) 2000-2005,2007 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 * @@ -26,7 +26,7 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_trace.3x,v 1.7 2005/05/15 17:02:54 tom Exp $ +.\" $Id: curs_trace.3x,v 1.8 2007/02/24 17:33:49 tom Exp $ .TH curs_trace 3X "" .na .hy 0 @@ -56,7 +56,7 @@ .br \fBchar *_nc_tracebits(void);\fR .br -\fBchar *_tracechar(const unsigned char ch);\fR +\fBchar *_tracechar(int);\fR .br \fBchar *_tracechtype(chtype ch);\fR .br diff --git a/contrib/ncurses/man/curs_util.3x b/contrib/ncurses/man/curs_util.3x index e78f99935326..4c8929abfce7 100644 --- a/contrib/ncurses/man/curs_util.3x +++ b/contrib/ncurses/man/curs_util.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2005,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2006,2007 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 * @@ -26,7 +26,7 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_util.3x,v 1.21 2006/08/26 14:17:48 tom Exp $ +.\" $Id: curs_util.3x,v 1.25 2007/05/26 21:44:42 tom Exp $ .TH curs_util 3X "" .na .hy 0 @@ -49,7 +49,7 @@ .sp \fBchar *unctrl(chtype c);\fR .br -\fBchar *wunctrl(cchar_t *c);\fR +\fBwchar_t *wunctrl(cchar_t *c);\fR .br \fBchar *keyname(int c);\fR .br @@ -146,6 +146,29 @@ returns an error if the associated \fBfwrite\fP calls return an error. The XSI Curses standard, Issue 4 describes these functions. It states that \fBunctrl\fR and \fBwunctrl\fR will return a null pointer if unsuccessful, but does not define any error conditions. +This implementation checks for three cases: +.RS +.TP 5 +- +the parameter is a 7-bit US-ASCII code. +This is the case that X/Open Curses documented. +.TP 5 +- +the parameter is in the range 128-159, i.e., a C1 control code. +If \fBuse_legacy_coding\fP has been called with a \fB2\fP parameter, +\fBunctrl\fP returns the parameter, i.e., a one-character string with +the parameter as the first character. +Otherwise, it returns ``~@'', ``~A'', etc., analogous to ``^@'', ``^A'', C0 controls. +.IP +X/Open Curses does not document whether \fBunctrl\fP can be called before +initializing curses. +This implementation permits that, +and returns the ``~@'', etc., values in that case. +.TP 5 +- +parameter values outside the 0 to 255 range. +\fBunctrl\fP returns a null pointer. +.RE .PP The SVr4 documentation describes the action of \fBfilter\fR only in the vaguest terms. The description here is adapted from the XSI Curses standard (which @@ -157,13 +180,24 @@ showing C1 controls from the upper-128 codes with a `~' prefix rather than `^'. Other implementations have different conventions. For example, they may show both sets of control characters with `^', and strip the parameter to 7 bits. -Or they may ignore C1 controls and treat all of the upper-1280 codes as +Or they may ignore C1 controls and treat all of the upper-128 codes as printable. This implementation uses 8 bits but does not modify the string to reflect locale. The \fBuse_legacy_coding\fP function allows the caller to change the output of \fBunctrl\fP. .PP +Likewise, the \fBmeta\fP function allows the caller to change the +output of \fBkeyname\fP, i.e., +it determines whether to use the `M-' prefix +for ``meta'' keys (codes in the range 128 to 255). +Both \fBuse_legacy_coding\fP and \fBmeta\fP succeed only after +curses is initialized. +X/Open Curses does not document the treatment of codes 128 to 159. +When treating them as ``meta'' keys +(or if \fBkeyname\fP is called before initializing curses), +this implementation returns strings ``M-^@'', ``M-^A'', etc. +.PP The \fBkeyname\fP function may return the names of user-defined string capabilities which are defined in the terminfo entry via the \fB-x\fP option of \fBtic\fP. @@ -178,11 +212,12 @@ It was not supported on Version 7, BSD or System V implementations. It is recommended that any code depending on ncurses extensions be conditioned using NCURSES_VERSION. .SH SEE ALSO -\fBuse_legacy_coding\fR(3), +\fBlegacy_coding\fR(3X), \fBcurses\fR(3X), \fBcurs_initscr\fR(3X), \fBcurs_kernel\fR(3X), -\fBcurs_scr_dump\fR(3X). +\fBcurs_scr_dump\fR(3X), +\fBlegacy_coding\fR(3X). .\"# .\"# The following sets edit modes for GNU EMACS .\"# Local Variables: diff --git a/contrib/ncurses/man/default_colors.3x b/contrib/ncurses/man/default_colors.3x index ce313e2b51a9..32518ba9d9cf 100644 --- a/contrib/ncurses/man/default_colors.3x +++ b/contrib/ncurses/man/default_colors.3x @@ -28,7 +28,7 @@ .\" .\" Author: Thomas E. Dickey 1997,1999,2000,2005 .\" -.\" $Id: default_colors.3x,v 1.19 2006/02/25 21:49:19 tom Exp $ +.\" $Id: default_colors.3x,v 1.20 2006/12/24 15:02:53 tom Exp $ .TH default_colors 3X "" .SH NAME \fBuse_default_colors\fR, @@ -104,9 +104,8 @@ the \fIorig_pair\fP or \fIorig_colors\fP capability. If the \fIinitialize_pair\fP capability is found, this causes an error as well. .SH NOTES -Associated with this extension, the \fBinit_pair\fR(3X) function accepts -negative arguments to specify default foreground or background -colors. +Associated with this extension, the \fBinit_pair\fR function accepts +negative arguments to specify default foreground or background colors. .PP The \fIuse_default_colors()\fP function was added to support \fIded\fP. This is a full-screen application which uses curses to manage only part diff --git a/contrib/ncurses/man/form_driver.3x b/contrib/ncurses/man/form_driver.3x index c88e3be0ae1c..85b1df8277d6 100644 --- a/contrib/ncurses/man/form_driver.3x +++ b/contrib/ncurses/man/form_driver.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2002,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2006,2007 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 * @@ -26,7 +26,7 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: form_driver.3x,v 1.12 2006/11/04 18:51:00 tom Exp $ +.\" $Id: form_driver.3x,v 1.15 2007/06/02 22:56:49 tom Exp $ .TH form_driver 3X "" .SH NAME \fBform_driver\fR - command-processing loop of the form system @@ -38,7 +38,7 @@ int form_driver(FORM *form, int c); .SH DESCRIPTION Once a form has been posted (displayed), you should funnel input events to it through \fBform_driver\fR. This routine has two major input cases; either -the input is a form navigation request or it's a printable ASCII character. +the input is a form navigation request or it is a printable ASCII character. The form driver requests are as follows: .TP 5 REQ_NEXT_PAGE @@ -221,6 +221,57 @@ Display previous field choice. If the second argument is a printable ASCII character, the driver places it in the current position in the current field. If it is one of the forms requests listed above, that request is executed. +.SS MOUSE HANDLING +.PP +If the second argument is the KEY_MOUSE special key, the associated +mouse event is translated into one of the above pre-defined requests. +Currently only clicks in the user window (e.g. inside the form display +area or the decoration window) are handled. +.PP +If you click above the display region of the form: +.RS +.TP +a REQ_PREV_FIELD is generated for a single click, +.TP +a REQ_PREV_PAGE is generated for a double-click and +.TP +a REQ_FIRST_FIELD is generated for a triple-click. +.RE +.PP +If you click below the display region of the form: +.RS +.TP +a REQ_NEXT_FIELD is generated for a single click, +.TP +a REQ_NEXT_PAGE is generated for a double-click and +.TP +a REQ_LAST_FIELD is generated for a triple-click. +.RE +.PP +If you click at an field inside the display area of the form: +.RS +.TP 3 +- +the form cursor is positioned to that field. +.TP 3 +- +If you double-click a field, +the form cursor is positioned to that field +and \fBE_UNKNOWN_COMMAND\fR is returned. +This return value makes sense, +because a double click usually means that an field-specific action should +be returned. +It is exactly the purpose of this return value to signal that an +application specific command should be executed. +.TP 3 +- +If a translation +into a request was done, \fBform_driver\fR returns the result of this request. +.RE +.PP +If you clicked outside the user window or the mouse event couldn't be translated +into a form request an \fBE_REQUEST_DENIED\fR is returned. +.SS APPLICATION-DEFINED COMMANDS .PP If the second argument is neither printable ASCII nor one of the above pre-defined form requests, the driver assumes it is an application-specific diff --git a/contrib/ncurses/man/form_field_new.3x b/contrib/ncurses/man/form_field_new.3x index 168349ee77e9..6095de1ccbb2 100644 --- a/contrib/ncurses/man/form_field_new.3x +++ b/contrib/ncurses/man/form_field_new.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998-2003,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2006,2007 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: form_field_new.3x,v 1.14 2006/11/04 17:12:00 tom Exp $ +.\" $Id: form_field_new.3x,v 1.16 2007/06/02 20:40:07 tom Exp $ .TH form_field_new 3X "" .SH NAME \fBform_field_new\fR - create and destroy form fields @@ -93,8 +93,8 @@ These routines emulate the System V forms library. They were not supported on Version 7 or BSD versions. .PP It may be unwise to count on the set of attributes copied by -\fBdup_field\fR(3X) being portable; the System V forms library documents are -not very explicit about what gets copied and what doesn't. +\fBdup_field\fR being portable; the System V forms library documents are +not very explicit about what gets copied and what does not. .SH AUTHORS Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. diff --git a/contrib/ncurses/man/form_field_opts.3x b/contrib/ncurses/man/form_field_opts.3x index 87449f224993..d505279ceb20 100644 --- a/contrib/ncurses/man/form_field_opts.3x +++ b/contrib/ncurses/man/form_field_opts.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998-2005,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2006,2007 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,20 +27,20 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: form_field_opts.3x,v 1.12 2006/11/04 17:12:00 tom Exp $ +.\" $Id: form_field_opts.3x,v 1.13 2007/02/24 17:34:27 tom Exp $ .TH form_field_opts 3X "" .SH NAME \fBform_field_opts\fR - set and get field options .SH SYNOPSIS \fB#include <form.h>\fR .br -int set_field_opts(FIELD *field, OPTIONS opts); +int set_field_opts(FIELD *field, Field_Options opts); .br -int field_opts_on(FIELD *field, OPTIONS opts); +int field_opts_on(FIELD *field, Field_Options opts); .br -int field_opts_off(FIELD *field, OPTIONS opts); +int field_opts_off(FIELD *field, Field_Options opts); .br -OPTIONS field_opts(const FIELD *field); +Field_Options field_opts(const FIELD *field); .br .SH DESCRIPTION The function \fBset_field_opts\fR sets all the given field's option bits (field diff --git a/contrib/ncurses/man/form_field_validation.3x b/contrib/ncurses/man/form_field_validation.3x index 175268b49ea9..2da52efd2e36 100644 --- a/contrib/ncurses/man/form_field_validation.3x +++ b/contrib/ncurses/man/form_field_validation.3x @@ -26,7 +26,7 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: form_field_validation.3x,v 1.15 2006/11/04 17:14:19 tom Exp $ +.\" $Id: form_field_validation.3x,v 1.16 2006/12/24 16:08:08 tom Exp $ .TH form_field_validation 3X "" .SH NAME \fBform_field_validation\fR - data type validation for fields @@ -99,7 +99,7 @@ For details of the precision handling see \fBprintf's\fR man-page. TYPE_REGEXP Regular expression data. Requires a regular expression \fB(char *)\fR third argument; the data is valid if the regular expression matches it. Regular expressions -are in the format of \fBregcomp\fR(3X) and \fBregexec\fR(3X). Please notice +are in the format of \fBregcomp\fR and \fBregexec\fR. Please notice that the regular expression must match the whole field. If you have for example an eight character wide field, a regular expression "^[0-9]*$" always means that you have to fill all eight positions with digits. If you want to diff --git a/contrib/ncurses/man/form_hook.3x b/contrib/ncurses/man/form_hook.3x index 82b62c3f0293..cd47a24a59c8 100644 --- a/contrib/ncurses/man/form_hook.3x +++ b/contrib/ncurses/man/form_hook.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2006,2007 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,28 +27,28 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: form_hook.3x,v 1.8 2006/11/04 17:12:00 tom Exp $ +.\" $Id: form_hook.3x,v 1.9 2007/02/24 17:34:18 tom Exp $ .TH form_hook 3X "" .SH NAME \fBform_hook\fR - set hooks for automatic invocation by applications .SH SYNOPSIS \fB#include <form.h>\fR .br -int set_field_init(FORM *form, void (*func)(FORM *)); +int set_field_init(FORM *form, Form_Hook func); .br -void (*)(FORM *) field_init(const FORM *form); +Form_Hook field_init(const FORM *form); .br -int set_field_term(FORM *form, void (*func)(FORM *)); +int set_field_term(FORM *form, Form_Hook func); .br -void (*)(FORM *) field_term(const FORM *form); +Form_Hook field_term(const FORM *form); .br -int set_form_init(FORM *form, void (*func)(FORM *)); +int set_form_init(FORM *form, Form_Hook func); .br -void (*)(FORM *) form_init(const FORM *form); +Form_Hook form_init(const FORM *form); .br -int set_form_term(FORM *form, void (*func)(FORM *)); +int set_form_term(FORM *form, Form_Hook func); .br -void (*)(FORM *) form_term(const FORM *form); +Form_Hook form_term(const FORM *form); .br .SH DESCRIPTION These functions make it possible to set hook functions to be called at various diff --git a/contrib/ncurses/man/form_opts.3x b/contrib/ncurses/man/form_opts.3x index 4bf5b1e2c8d8..0caaae7c8837 100644 --- a/contrib/ncurses/man/form_opts.3x +++ b/contrib/ncurses/man/form_opts.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2006,2007 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,20 +27,20 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: form_opts.3x,v 1.8 2006/11/04 17:12:00 tom Exp $ +.\" $Id: form_opts.3x,v 1.9 2007/02/24 17:34:36 tom Exp $ .TH form_opts 3X "" .SH NAME \fBform_opts\fR - set and get form options .SH SYNOPSIS \fB#include <form.h>\fR .br -int set_form_opts(FORM *form, OPTIONS opts); +int set_form_opts(FORM *form, Field_Options opts); .br -int form_opts_on(FORM *form, OPTIONS opts); +int form_opts_on(FORM *form, Field_Options opts); .br -int form_opts_off(FORM *form, OPTIONS opts); +int form_opts_off(FORM *form, Field_Options opts); .br -OPTIONS form_opts(const FORM *form); +Field_Options form_opts(const FORM *form); .br .SH DESCRIPTION The function \fBset_form_opts\fR sets all the given form's option bits (form diff --git a/contrib/ncurses/man/infocmp.1m b/contrib/ncurses/man/infocmp.1m index a7feb4495766..b1a88e76723b 100644 --- a/contrib/ncurses/man/infocmp.1m +++ b/contrib/ncurses/man/infocmp.1m @@ -27,14 +27,14 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: infocmp.1m,v 1.43 2006/05/13 15:14:01 tom Exp $ -.TH infocmp 1M "" +.\" $Id: infocmp.1m,v 1.44 2006/12/24 18:16:31 tom Exp $ +.TH @INFOCMP@ 1M "" .ds n 5 .ds d @TERMINFO@ .SH NAME -\fBinfocmp\fR - compare or print out \fIterminfo\fR descriptions +\fB@INFOCMP@\fR - compare or print out \fIterminfo\fR descriptions .SH SYNOPSIS -\fBinfocmp\fR [\fB-\ +\fB@INFOCMP@\fR [\fB-\ 1\ C\ E\ @@ -66,7 +66,7 @@ x\ .br [\fItermname\fR...] .SH DESCRIPTION -\fBinfocmp\fR can be used to compare a binary \fBterminfo\fR entry with other +\fB@INFOCMP@\fR can be used to compare a binary \fBterminfo\fR entry with other terminfo entries, rewrite a \fBterminfo\fR description to take advantage of the \fBuse=\fR terminfo field, or print out a \fBterminfo\fR description from the binary file (\fBterm\fR) in a variety of formats. In all cases, the boolean @@ -77,7 +77,7 @@ If no options are specified and zero or one \fItermnames\fR are specified, the \fB-I\fR option will be assumed. If more than one \fItermname\fR is specified, the \fB-d\fR option will be assumed. .SS Comparison Options [-d] [-c] [-n] -\fBinfocmp\fR compares the \fBterminfo\fR description of the first terminal +\fB@INFOCMP@\fR compares the \fBterminfo\fR description of the first terminal \fItermname\fR with each of the descriptions given by the entries for the other terminal's \fItermnames\fR. If a capability is defined for only one of the terminals, the value returned will depend on the type of the capability: @@ -114,7 +114,7 @@ used for the terminal name. .PP The source produced by the \fB-C\fR option may be used directly as a \fBtermcap\fR entry, but not all parameterized strings can be changed to -the \fBtermcap\fR format. \fBinfocmp\fR will attempt to convert most of the +the \fBtermcap\fR format. \fB@INFOCMP@\fR will attempt to convert most of the parameterized information, and anything not converted will be plainly marked in the output and commented out. These should be edited by hand. .PP @@ -162,7 +162,7 @@ analyzing the differences between the first \fItermname\fR and the other other terminals. In this manner, it is possible to retrofit generic terminfo entries into a terminal's description. Or, if two similar terminals exist, but were coded at different times or by different people so that each description -is a full description, using \fBinfocmp\fR will show what can be done to change +is a full description, using \fB@INFOCMP@\fR will show what can be done to change one description to be relative to the other. .PP A capability will get printed with an at-sign (@) if it no longer exists in the @@ -176,18 +176,18 @@ The order of the other \fItermname\fR entries is significant. Since the terminfo compiler \fBtic\fR does a left-to-right scan of the capabilities, specifying two \fBuse=\fR entries that contain differing entries for the same capabilities will produce different results depending on the order that the -entries are given in. \fBinfocmp\fR will flag any such inconsistencies between +entries are given in. \fB@INFOCMP@\fR will flag any such inconsistencies between the other \fItermname\fR entries as they are found. .PP Alternatively, specifying a capability \fIafter\fR a \fBuse=\fR entry that contains that capability will cause the second specification to be ignored. -Using \fBinfocmp\fR to recreate a description can be a useful check to make +Using \fB@INFOCMP@\fR to recreate a description can be a useful check to make sure that everything was specified correctly in the original source description. .PP Another error that does not cause incorrect compiled files, but will slow down the compilation time, is specifying extra \fBuse=\fR fields that are -superfluous. \fBinfocmp\fR will flag any other \fItermname use=\fR fields that +superfluous. \fB@INFOCMP@\fR will flag any other \fItermname use=\fR fields that were not needed. .SS Changing Databases [-A \fIdirectory\fR] [-B \fIdirectory\fR] The location of the compiled \fBterminfo\fR database is taken from the @@ -208,7 +208,7 @@ the fields will be printed several to a line to a maximum width of 60 characters. .TP \fB-a\fR -tells \fBinfocmp\fP to retain commented-out capabilities rather than discarding +tells \fB@INFOCMP@\fP to retain commented-out capabilities rather than discarding them. Capabilities are commented by prefixing them with a period. .TP 5 \fB-E\fR @@ -367,9 +367,9 @@ Normally when translating from terminfo to termcap, untranslatable capabilities are commented-out. .TP 5 \fB-U\fR -tells \fBinfocmp\fP to not post-process the data after parsing the source file. +tells \fB@INFOCMP@\fP to not post-process the data after parsing the source file. This feature helps when comparing the actual contents of two source files, -since it excludes the inferences that \fBinfocmp\fP makes to fill in missing +since it excludes the inferences that \fB@INFOCMP@\fP makes to fill in missing data. .TP 5 \fB-V\fR @@ -413,7 +413,7 @@ The \fB-r\fR option's notion of `termcap' capabilities is System V Release 4's. Actual BSD curses versions will have a more restricted set. To see only the 4.4BSD set, use \fB-r\fR \fB-RBSD\fR. .SH BUGS -The \fB-F\fR option of \fBinfocmp\fR(1M) should be a \fBtoe\fR(1M) mode. +The \fB-F\fR option of \fB@INFOCMP@\fR(1M) should be a \fB@TOE@\fR(1M) mode. .SH SEE ALSO \fB@CAPTOINFO@\fR(1M), \fB@INFOTOCAP@\fR(1M), diff --git a/contrib/ncurses/man/infotocap.1m b/contrib/ncurses/man/infotocap.1m index 1d20ef081e7f..19160b449561 100644 --- a/contrib/ncurses/man/infotocap.1m +++ b/contrib/ncurses/man/infotocap.1m @@ -27,16 +27,16 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: infotocap.1m,v 1.6 2006/05/13 15:35:45 tom Exp $ -.TH infotocap 1M "" +.\" $Id: infotocap.1m,v 1.8 2006/12/24 20:13:56 tom Exp $ +.TH @INFOTOCAP@ 1M "" .ds n 5 .ds d @TERMINFO@ .SH NAME -\fBinfotocap\fR - convert a \fIterminfo\fR description into a \fItermcap\fR description +\fB@INFOTOCAP@\fR - convert a \fIterminfo\fR description into a \fItermcap\fR description .SH SYNOPSIS -\fBinfotocap\fR [\fB-v\fR\fIn\fR \fIwidth\fR] [\fB-V\fR] [\fB-1\fR] [\fB-w\fR \fIwidth\fR] \fIfile\fR . . . +\fB@INFOTOCAP@\fR [\fB-v\fR\fIn\fR \fIwidth\fR] [\fB-V\fR] [\fB-1\fR] [\fB-w\fR \fIwidth\fR] \fIfile\fR . . . .SH DESCRIPTION -\fBinfotocap\fR looks in \fIfile\fR for \fBterminfo\fR descriptions. For each +\fB@INFOTOCAP@\fR looks in \fIfile\fR for \fBterminfo\fR descriptions. For each one found, an equivalent \fBtermcap\fR description is written to standard output. Terminfo \fBuse\fR capabilities are translated directly to termcap \fBtc\fR capabilities. @@ -59,12 +59,12 @@ change the output to \fIwidth\fR characters. \*d Compiled terminal description database. .SH NOTES -This utility is actually a link to \fItic\fR(1M), running in \fI-C\fR mode. -You can use other \fItic\fR options such as \fB-f\fR and \fB-x\fR. +This utility is actually a link to \fI@TIC@\fR, running in \fI-C\fR mode. +You can use other \fI@TIC@\fR options such as \fB-f\fR and \fB-x\fR. .SH SEE ALSO \fBcurses\fR(3X), -\fBtic\fR(1M), -\fBinfocmp\fR(1M), +\fB@TIC@\fR(1M), +\fB@INFOCMP@\fR(1M), \fBterminfo\fR(\*n) .PP This describes \fBncurses\fR diff --git a/contrib/ncurses/man/legacy_coding.3x b/contrib/ncurses/man/legacy_coding.3x index b8b0561072a6..42c49fe5e96c 100644 --- a/contrib/ncurses/man/legacy_coding.3x +++ b/contrib/ncurses/man/legacy_coding.3x @@ -28,7 +28,7 @@ .\" .\" Author: Thomas E. Dickey .\" -.\" $Id: legacy_coding.3x,v 1.2 2006/02/25 21:50:01 tom Exp $ +.\" $Id: legacy_coding.3x,v 1.3 2006/12/24 15:12:55 tom Exp $ .TH legacy_coding 3X "" .SH NAME \fBuse_legacy_coding\fR \- use terminal's default colors @@ -50,7 +50,7 @@ The \fIlevel\fP parameter controls the result: .TP 5 0 the library functions normally, -rendering nonprinting characters as described in \fBunctrl\fP(3X). +rendering nonprinting characters as described in \fBunctrl\fP. .TP 1 the library ignores \fBisprintf\fP for codes in the range 160-255. diff --git a/contrib/ncurses/man/man_db.renames b/contrib/ncurses/man/man_db.renames index 8e968ac47f74..a84ae809892b 100644 --- a/contrib/ncurses/man/man_db.renames +++ b/contrib/ncurses/man/man_db.renames @@ -1,5 +1,5 @@ ############################################################################## -# Copyright (c) 1998-2005,2006 Free Software Foundation, Inc. # +# Copyright (c) 1998-2006,2007 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 "Software"), # @@ -25,7 +25,7 @@ # use or other dealings in this Software without prior written # # authorization. # ############################################################################## -# $Id: man_db.renames,v 0.36 2006/05/13 23:47:25 tom Exp $ +# $Id: man_db.renames,v 0.39 2007/04/07 23:06:31 tom Exp $ # Manual-page renamings for the man_db program # # Files: @@ -67,8 +67,10 @@ curs_insstr.3x insstr.3ncurses curs_instr.3x instr.3ncurses curs_inwstr.3x inwstr.3ncurses curs_kernel.3x kernel.3ncurses +curs_legacy.3x legacy.3ncurses curs_mouse.3x mouse.3ncurses curs_move.3x move.3ncurses +curs_opaque.3x opaque.3ncurses curs_outopts.3x outopts.3ncurses curs_overlay.3x overlay.3ncurses curs_pad.3x pad.3ncurses @@ -159,12 +161,15 @@ tset.1 tset.1 vprintf.3s vprintf.3 wresize.3x wresize.3ncurses # -# Other cross-references: -addch.3x addch.3ncurses -can_change_color.3x can_change_color.3ncurses -curs_attr_get.3x attr_get.3ncurses -dup_field.3x dup_field.3ncurses -init_pair.3x init_pair.3ncurses -# # Other: tack.1m tack.1 +# +getty.1 getty.8 +scanf.3 scanf.3 +ttys.5 ttys.4 +termio.7 termios.3 +system.3 system.3 +regcomp.3x regcomp.3 +regexec.3x regexec.3 +# +# vile:cfgmode diff --git a/contrib/ncurses/man/menu_driver.3x b/contrib/ncurses/man/menu_driver.3x index a256141ae7db..bf7d8770a449 100644 --- a/contrib/ncurses/man/menu_driver.3x +++ b/contrib/ncurses/man/menu_driver.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2003,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2006,2007 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 * @@ -26,7 +26,7 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: menu_driver.3x,v 1.12 2006/11/04 17:13:50 tom Exp $ +.\" $Id: menu_driver.3x,v 1.14 2007/06/02 22:50:09 tom Exp $ .TH menu_driver 3X "" .SH NAME \fBmenu_driver\fR - command-processing loop of the menu system @@ -38,7 +38,7 @@ int menu_driver(MENU *menu, int c); .SH DESCRIPTION Once a menu has been posted (displayed), you should funnel input events to it through \fBmenu_driver\fR. This routine has three major input cases; either -the input is a menu navigation request, it's a printable ASCII character or it +the input is a menu navigation request, it is a printable ASCII character or it is the KEY_MOUSE special key associated with an mouse event. The menu driver requests are as follows: .TP 5 @@ -100,25 +100,56 @@ the new pattern. If there is no such match, \fBmenu_driver\fR returns .PP If the second argument is one of the above pre-defined requests, the corresponding action is performed. +.SS MOUSE HANDLING .PP If the second argument is the KEY_MOUSE special key, the associated mouse event is translated into one of the above pre-defined requests. Currently only clicks in the user window (e.g. inside the menu display -area or the decoration window) are handled. If you click above the -display region of the menu, a REQ_SCR_ULINE is generated, if you -doubleclick a REQ_SCR_UPAGE is generated and if you tripleclick a -REQ_FIRST_ITEM is generated. If you click below the display region of -the menu, a REQ_SCR_DLINE is generated, if you doubleclick a REQ_SCR_DPAGE -is generated and if you tripleclick a REQ_LAST_ITEM is generated. If you -click at an item inside the display area of the menu, the menu cursor -is positioned to that item. If you double-click at an item a REQ_TOGGLE_ITEM -is generated and \fBE_UNKNOWN_COMMAND\fR is returned. This return value makes -sense, because a double click usually means that an item-specific action should -be returned. It's exactly the purpose of this return value to signal that an -application specific command should be executed. If a translation +area or the decoration window) are handled. +.PP +If you click above the display region of the menu: +.RS +.TP +a REQ_SCR_ULINE is generated for a single click, +.TP +a REQ_SCR_UPAGE is generated for a double-click and +.TP +a REQ_FIRST_ITEM is generated for a triple-click. +.RE +.PP +If you click below the display region of the menu: +.RS +.TP +a REQ_SCR_DLINE is generated for a single click, +.TP +a REQ_SCR_DPAGE is generated for a double-click and +.TP +a REQ_LAST_ITEM is generated for a triple-click. +.RE +.PP +If you click at an item inside the display area of the menu: +.RS +.TP 3 +- +the menu cursor is positioned to that item. +.TP 3 +- +If you double-click an item a REQ_TOGGLE_ITEM +is generated and \fBE_UNKNOWN_COMMAND\fR is returned. +This return value makes sense, +because a double click usually means that an item-specific action should +be returned. +It is exactly the purpose of this return value to signal that an +application specific command should be executed. +.TP 3 +- +If a translation into a request was done, \fBmenu_driver\fR returns the result of this request. +.RE +.PP If you clicked outside the user window or the mouse event couldn't be translated into a menu request an \fBE_REQUEST_DENIED\fR is returned. +.SS APPLICATION-DEFINED COMMANDS .PP If the second argument is neither printable ASCII nor one of the above pre-defined menu requests or KEY_MOUSE, the drive assumes it is an application-specific diff --git a/contrib/ncurses/man/menu_hook.3x b/contrib/ncurses/man/menu_hook.3x index 840552315675..204e1ec41500 100644 --- a/contrib/ncurses/man/menu_hook.3x +++ b/contrib/ncurses/man/menu_hook.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2006,2007 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,28 +27,28 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: menu_hook.3x,v 1.8 2006/11/04 17:12:00 tom Exp $ +.\" $Id: menu_hook.3x,v 1.9 2007/02/24 17:34:08 tom Exp $ .TH menu_hook 3X "" .SH NAME \fBmenu_hook\fR - set hooks for automatic invocation by applications .SH SYNOPSIS \fB#include <menu.h>\fR .br -int set_item_init(MENU *menu, void (*func)(MENU *)); +int set_item_init(MENU *menu, Menu_Hook func); .br -void (*)(MENU *) item_init(const MENU *menu); +Menu_Hook item_init(const MENU *menu); .br -int set_item_term(MENU *menu, void (*func)(MENU *)); +int set_item_term(MENU *menu, Menu_Hook func); .br -void (*)(MENU *) item_term(const MENU *menu); +Menu_Hook item_term(const MENU *menu); .br -int set_menu_init(MENU *menu, void (*func)(MENU *)); +int set_menu_init(MENU *menu, Menu_Hook func); .br -void (*)(MENU *) menu_init(const MENU *menu); +Menu_Hook menu_init(const MENU *menu); .br -int set_menu_term(MENU *menu, void (*func)(MENU *)); +int set_menu_term(MENU *menu, Menu_Hook func); .br -void (*)(MENU *) menu_term(const MENU *menu); +Menu_Hook menu_term(const MENU *menu); .br .SH DESCRIPTION These functions make it possible to set hook functions to be called at various diff --git a/contrib/ncurses/man/menu_opts.3x b/contrib/ncurses/man/menu_opts.3x index 890b2c265134..dc927c47700c 100644 --- a/contrib/ncurses/man/menu_opts.3x +++ b/contrib/ncurses/man/menu_opts.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2006,2007 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,20 +27,20 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: menu_opts.3x,v 1.9 2006/11/04 17:12:00 tom Exp $ +.\" $Id: menu_opts.3x,v 1.10 2007/02/24 17:33:59 tom Exp $ .TH menu_opts 3X "" .SH NAME \fBmenu_opts\fR - set and get menu options .SH SYNOPSIS \fB#include <menu.h>\fR .br -int set_menu_opts(MENU *menu, OPTIONS opts); +int set_menu_opts(MENU *menu, Menu_Options opts); .br -int menu_opts_on(MENU *menu, OPTIONS opts); +int menu_opts_on(MENU *menu, Menu_Options opts); .br -int menu_opts_off(MENU *menu, OPTIONS opts); +int menu_opts_off(MENU *menu, Menu_Options opts); .br -OPTIONS menu_opts(const MENU *menu); +Menu_Options menu_opts(const MENU *menu); .br .SH DESCRIPTION The function \fBset_menu_opts\fR sets all the given menu's option bits (menu diff --git a/contrib/ncurses/man/mitem_opts.3x b/contrib/ncurses/man/mitem_opts.3x index 2a4a8761d081..2459dabfbae6 100644 --- a/contrib/ncurses/man/mitem_opts.3x +++ b/contrib/ncurses/man/mitem_opts.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2006,2007 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,20 +27,20 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: mitem_opts.3x,v 1.8 2006/11/04 17:12:00 tom Exp $ +.\" $Id: mitem_opts.3x,v 1.9 2007/02/24 17:33:32 tom Exp $ .TH mitem_opts 3X "" .SH NAME \fBmitem_opts\fR - set and get menu item options .SH SYNOPSIS \fB#include <menu.h>\fR .br -int set_item_opts(ITEM *item, OPTIONS opts); +int set_item_opts(ITEM *item, Item_Options opts); .br -int item_opts_on(ITEM *item, OPTIONS opts); +int item_opts_on(ITEM *item, Item_Options opts); .br -int item_opts_off(ITEM *item, OPTIONS opts); +int item_opts_off(ITEM *item, Item_Options opts); .br -OPTIONS item_opts(const ITEM *item); +Item_Options item_opts(const ITEM *item); .br .SH DESCRIPTION The function \fBset_item_opts\fR sets all the given item's option bits (menu diff --git a/contrib/ncurses/man/ncurses.3x b/contrib/ncurses/man/ncurses.3x index 19678daab005..ac3d049528c2 100644 --- a/contrib/ncurses/man/ncurses.3x +++ b/contrib/ncurses/man/ncurses.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998-2005,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2006,2007 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.81 2006/12/02 19:23:11 tom Exp $ +.\" $Id: ncurses.3x,v 1.89 2007/09/01 18:57:29 tom Exp $ .hy 0 .TH ncurses 3X "" .ds n 5 @@ -39,19 +39,27 @@ .br .SH DESCRIPTION The \fBncurses\fR library routines give the user a terminal-independent method -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 4.4BSD classic curses, which has been discontinued. This describes \fBncurses\fR version @NCURSES_MAJOR@.@NCURSES_MINOR@ (patch @NCURSES_PATCH@). .PP -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 curses are summarized under the \fBEXTENSIONS\fP and \fBPORTABILITY\fP sections below and described in detail in the respective \fBEXTENSIONS\fP, \fBPORTABILITY\fP and \fBBUGS\fP sections of individual man pages. .PP +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. (Your system integrator may also have installed these libraries under @@ -68,8 +76,9 @@ and access to low-level terminal-manipulation routines. .PP To initialize the routines, the routine \fBinitscr\fR or \fBnewterm\fR must be called before any of the other routines that deal with windows -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 interactive, screen oriented programs want this), the following sequence should be used: .sp @@ -82,60 +91,72 @@ Most programs would additionally use the sequence: \fBkeypad(stdscr, TRUE);\fR .sp 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 \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 after the shell environment variable \fBTERM\fR has been exported. \fBtset(1)\fR is usually responsible for doing this. [See \fBterminfo\fR(\*n) for further details.] .PP The \fBncurses\fR library permits manipulation of data structures, called \fIwindows\fR, which can be thought of as two-dimensional -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. .PP Note that \fBcurses\fR does not handle overlapping windows, that's done by -the \fBpanel\fR(3X) library. This means that you can either use +the \fBpanel\fR(3X) library. +This means that you can either use \fBstdscr\fR or divide the screen into tiled windows and not using -\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. .PP Windows are referred to by variables declared as \fBWINDOW *\fR. These data structures are manipulated with routines described here and -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 these routines are included with names beginning with \fBw\fR, -allowing the user to specify a window. The routines not beginning +allowing the user to specify a window. +The routines not beginning with \fBw\fR affect \fBstdscr\fR. .PP After using routines to manipulate a window, \fBrefresh\fR is called, telling \fBcurses\fR to make the user's CRT screen look like -\fBstdscr\fR. The characters in a window are actually of type +\fBstdscr\fR. +The characters in a window are actually of type \fBchtype\fR, (character and attribute data) so that other information about the character may also be stored with each character. .PP -Special windows called \fIpads\fR may also be manipulated. These are windows +Special windows called \fIpads\fR may also be manipulated. +These are windows which are not constrained to the size of the screen and whose contents need not -be completely displayed. See \fBcurs_pad\fR(3X) for more information. +be completely displayed. +See \fBcurs_pad\fR(3X) for more information. .PP In addition to drawing characters on the screen, video attributes and colors may be supported, causing the characters to show up in such modes as underlined, in reverse video, or in color on terminals that support such -display enhancements. Line drawing characters may be specified to be output. +display enhancements. +Line drawing characters may be specified to be output. On input, \fBcurses\fR is also able to translate arrow and function keys that -transmit escape sequences into single values. The video attributes, line +transmit escape sequences into single values. +The video attributes, line drawing characters, and input values use names, defined in \fB<curses.h>\fR, such as \fBA_REVERSE\fR, \fBACS_HLINE\fR, and \fBKEY_LEFT\fR. .PP If the environment variables \fBLINES\fR and \fBCOLUMNS\fR are set, or if the program is executing in a window environment, line and column information in -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 screen is changeable (see \fBENVIRONMENT\fR). .PP If the environment variable \fBTERMINFO\fR is defined, any program using \fBcurses\fR checks for a local terminal definition before checking in the -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 compiled terminal definition is found in .sp \fB\*d/a/att4424\fR. @@ -155,43 +176,100 @@ permission in \fB\*d\fR is not available. .PP The integer variables \fBLINES\fR and \fBCOLS\fR are defined in \fB<curses.h>\fR and will be filled in by \fBinitscr\fR with the size of the -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 \fB0\fR, respectively. .PP The \fBcurses\fR routines also define the \fBWINDOW *\fR variable \fBcurscr\fR which is used for certain low-level operations like clearing and redrawing a -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. +.\" .SS Routine and Argument Names -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. .PP The routines prefixed with \fBmv\fR require a \fIy\fR and \fIx\fR -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). .PP The routines prefixed with \fBmvw\fR take both a window argument and -\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. .PP In each case, \fIwin\fR is the window affected, and \fIpad\fR is the pad affected; \fIwin\fR and \fIpad\fR are always pointers to type \fBWINDOW\fR. .PP Option setting routines require a Boolean flag \fIbf\fR with the value -\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 +.\" .SS Routine Name Index The following table lists each \fBcurses\fR routine and the name of -the manual page on which it is described. Routines flagged with `*' +the manual page on which it is described. +Routines flagged with `*' are ncurses-specific, not described by XPG4 or present in SVr4. .PP .TS @@ -275,15 +353,24 @@ flash/\fBcurs_beep\fR(3X) flushinp/\fBcurs_util\fR(3X) get_wch/\fBcurs_get_wch\fR(3X) get_wstr/\fBcurs_get_wstr\fR(3X) +getattrs/\fBcurs_attr\fR(3X) +getbegx/\fBcurs_legacy\fR(3X)* +getbegy/\fBcurs_legacy\fR(3X)* getbegyx/\fBcurs_getyx\fR(3X) getbkgd/\fBcurs_bkgd\fR(3X) getbkgrnd/\fBcurs_bkgrnd\fR(3X) getcchar/\fBcurs_getcchar\fR(3X) getch/\fBcurs_getch\fR(3X) +getcurx/\fBcurs_legacy\fR(3X)* +getcury/\fBcurs_legacy\fR(3X)* +getmaxx/\fBcurs_legacy\fR(3X)* +getmaxy/\fBcurs_legacy\fR(3X)* getmaxyx/\fBcurs_getyx\fR(3X) getmouse/\fBcurs_mouse\fR(3X)* getn_wstr/\fBcurs_get_wstr\fR(3X) getnstr/\fBcurs_getstr\fR(3X) +getparx/\fBcurs_legacy\fR(3X)* +getpary/\fBcurs_legacy\fR(3X)* getparyx/\fBcurs_getyx\fR(3X) getstr/\fBcurs_getstr\fR(3X) getsyx/\fBcurs_kernel\fR(3X) @@ -321,7 +408,18 @@ insstr/\fBcurs_insstr\fR(3X) instr/\fBcurs_instr\fR(3X) intrflush/\fBcurs_inopts\fR(3X) inwstr/\fBcurs_inwstr\fR(3X) +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)* is_linetouched/\fBcurs_touch\fR(3X) +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)* is_wintouched/\fBcurs_touch\fR(3X) isendwin/\fBcurs_initscr\fR(3X) key_defined/\fBkey_defined\fR(3X)* @@ -431,6 +529,7 @@ nl/\fBcurs_outopts\fR(3X) nocbreak/\fBcurs_inopts\fR(3X) nodelay/\fBcurs_inopts\fR(3X) noecho/\fBcurs_inopts\fR(3X) +nofilter/\fBcurs_util\fR(3X)* nonl/\fBcurs_outopts\fR(3X) noqiflush/\fBcurs_inopts\fR(3X) noraw/\fBcurs_inopts\fR(3X) @@ -519,6 +618,7 @@ untouchwin/\fBcurs_touch\fR(3X) 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)* vid_attr/\fBcurs_terminfo\fR(3X) vid_puts/\fBcurs_terminfo\fR(3X) vidattr/\fBcurs_terminfo\fR(3X) @@ -617,16 +717,16 @@ integer value other than \fBERR\fR upon successful completion, unless otherwise noted in the routine descriptions. .PP All macros return the value of the \fBw\fR version, except \fBsetscrreg\fR, -\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 \fBgetmaxyx\fR are undefined (i.e., these should not be used as the right-hand side of assignment statements). .PP Routines that return pointers return \fBNULL\fR on error. .SH ENVIRONMENT 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. +runtime behavior of the \fBncurses\fR library. +The most important ones have been already discussed in detail. .TP 5 BAUDRATE The debugging library checks this environment symbol when the application @@ -722,7 +822,7 @@ If it is not specified, \fBncurses\fR uses 132. NCURSES_ASSUMED_COLORS Override the compiled-in assumption that the terminal's default colors are white-on-black -(see \fBassume_default_colors\fR(3X)). +(see \fBdefault_colors\fR(3X)). 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 @@ -739,7 +839,7 @@ You can also adjust your \fBstty\fP settings to avoid the problem. .TP 5 NCURSES_NO_MAGIC_COOKIES Some terminals use a magic-cookie feature which requires special handling -to make highlighting and other video attributes display properly. +to make highlighting and other video attributes display properly. You can suppress the highlighting entirely for these terminals by setting this environment variable. .TP 5 @@ -761,18 +861,21 @@ is for your program to do this by pausing after operations that the terminal does slowly, such as clearing the display. .IP As a result, many terminal descriptions (including the vt100) -have delay times embedded. You may wish to use these descriptions, +have delay times embedded. +You may wish to use these descriptions, but not want to pay the performance penalty. .IP Set the NCURSES_NO_PADDING symbol to disable all but mandatory -padding. Mandatory padding is used as a part of special control +padding. +Mandatory padding is used as a part of special control sequences such as \fIflash\fR. .TP 5 NCURSES_NO_SETBUF Normally \fBncurses\fR enables buffered output during terminal initialization. This is done (as in SVr4 curses) for performance reasons. For testing purposes, both of \fBncurses\fR and certain applications, -this feature is made optional. Setting the NCURSES_NO_SETBUF variable +this feature is made optional. +Setting the NCURSES_NO_SETBUF variable disables output buffering, leaving the output in the original (usually line buffered) mode. .TP 5 @@ -944,12 +1047,14 @@ descriptions. .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 -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 is not recommended, as it essentially includes an entire termcap compiler in the \fBncurses\fR startup code, at significant cost in core and startup cycles. .PP The \fBncurses\fR library includes facilities for capturing mouse events on -certain terminals (including xterm). See the \fBcurs_mouse\fR(3X) +certain terminals (including xterm). +See the \fBcurs_mouse\fR(3X) manual page for details. .PP The \fBncurses\fR library includes facilities for responding to window @@ -974,38 +1079,48 @@ control over color contrasts. See the \fBdefault_colors\fR(3X) manual page for details. .PP The \fBncurses\fR library includes a function for directing application output -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. .SH PORTABILITY -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 (including color support) is supported. .PP A small number of local differences (that is, individual differences between the XSI Curses and \fBncurses\fR calls) are described in \fBPORTABILITY\fR sections of the library man pages. .PP -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 +.PP +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 -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 \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 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. +part of XPG4, nor are they present in SVr4. +See the \fBcurs_mouse\fR(3X) manual page for details. .PP -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. .PP -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. +.PP +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 In historic curses versions, delays embedded in the capabilities \fBcr\fR, \fBind\fR, \fBcub1\fR, \fBff\fR and \fBtab\fR activated corresponding delay -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 to the UNIX kernel significantly and increases the package's portability correspondingly. .SH NOTES @@ -1013,8 +1128,8 @@ The header file \fB<curses.h>\fR automatically includes the header files \fB<stdio.h>\fR and \fB<unctrl.h>\fR. .PP If standard output from a \fBncurses\fR program is re-directed to something -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. .SH AUTHORS Zeyd M. Ben-Halim, Eric S. Raymond, Thomas E. Dickey. Based on pcurses by Pavel Curtis. diff --git a/contrib/ncurses/man/panel.3x b/contrib/ncurses/man/panel.3x index 2896f01adc49..719a9e636bc5 100644 --- a/contrib/ncurses/man/panel.3x +++ b/contrib/ncurses/man/panel.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2003,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2006,2007 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 * @@ -26,7 +26,7 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: panel.3x,v 1.12 2006/05/13 15:35:45 tom Exp $ +.\" $Id: panel.3x,v 1.14 2007/05/12 20:45:20 tom Exp $ .TH panel 3X "" .ds n 5 .ds d @TERMINFO@ @@ -84,13 +84,13 @@ Panel routines are a functional layer added to \fBcurses\fR(3X), make only high-level curses calls, and work anywhere terminfo curses does. .SH FUNCTIONS .TP -\fBnew_panel(win)\fR +.B new_panel(win) allocates a \fBPANEL\fR structure, associates it with \fBwin\fR, places the panel on the top of the stack (causes it to be displayed above any other panel) and returns a pointer to the new panel. .TP -\fBvoid update_panels()\fR +.B update_panels() refreshes the virtual screen to reflect the relations between the panels in the stack, but does not call doupdate() to refresh the physical screen. Use this function and not wrefresh or wnoutrefresh. @@ -98,52 +98,57 @@ update_panels() may be called more than once before a call to doupdate(), but doupdate() is the function responsible for updating the physical screen. .TP -\fBdel_panel(pan)\fR +.B del_panel(pan) removes the given panel from the stack and deallocates the \fBPANEL\fR structure (but not its associated window). .TP -\fBhide_panel(pan)\fR +.B hide_panel(pan) removes the given panel from the panel stack and thus hides it from view. The \fBPANEL\fR structure is not lost, merely removed from the stack. .TP -\fBshow_panel(pan)\fR +.B panel_hidden(pan) +returns TRUE if the panel is in the panel stack, +FALSE if it is not. +If the panel is a null pointer, return ERR. +.TP +.B show_panel(pan) makes a hidden panel visible by placing it on top of the panels in the panel stack. See COMPATIBILITY below. .TP -\fBtop_panel(pan)\fR +.B top_panel(pan) puts the given visible panel on top of all panels in the stack. See COMPATIBILITY below. .TP -\fBbottom_panel(pan)\fR +.B bottom_panel(pan) puts panel at the bottom of all panels. .TP -\fBmove_panel(pan,starty,startx)\fR +.B move_panel(pan,starty,startx) moves the given panel window so that its upper-left corner is at \fBstarty\fR, \fBstartx\fR. It does not change the position of the panel in the stack. Be sure to use this function, not \fBmvwin()\fR, to move a panel window. .TP -\fBreplace_panel(pan,window)\fR +.B replace_panel(pan,window) replaces the current window of panel with \fBwindow\fR (useful, for example if you want to resize a panel; if you're using \fBncurses\fR, you can call \fBreplace_panel\fR on the output of \fBwresize\fR(3X)). It does not change the position of the panel in the stack. .TP -\fBpanel_above(pan)\fR +.B panel_above(pan) returns a pointer to the panel above pan. If the panel argument is \fB(PANEL *)0\fR, it returns a pointer to the bottom panel in the stack. .TP -\fBpanel_below(pan)\fR +.B panel_below(pan) returns a pointer to the panel just below pan. If the panel argument is \fB(PANEL *)0\fR, it returns a pointer to the top panel in the stack. .TP -\fBset_panel_userptr(pan,ptr)\fR +.B set_panel_userptr(pan,ptr) sets the panel's user pointer. .TP -\fBpanel_userptr(pan)\fR +.B panel_userptr(pan) returns the user pointer for a given panel. .TP -\fBpanel_window(pan)\fR +.B panel_window(pan) returns a pointer to the window of the given panel. .SH DIAGNOSTICS Each routine that returns a pointer returns \fBNULL\fR if an error diff --git a/contrib/ncurses/man/term.5 b/contrib/ncurses/man/term.5 index cd7e79ae9d36..19af62a350ed 100644 --- a/contrib/ncurses/man/term.5 +++ b/contrib/ncurses/man/term.5 @@ -26,8 +26,8 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: term.5,v 1.17 2006/12/03 01:08:16 tom Exp $ -.TH TERM 5 +.\" $Id: term.5,v 1.19 2006/12/24 18:12:38 tom Exp $ +.TH term 5 .ds n 5 .ds d @TERMINFO@ .SH NAME @@ -74,7 +74,7 @@ An 8 or more bit byte is assumed, but no assumptions about byte ordering or sign extension are made. .PP The compiled file is created with the -.I tic +.B @TIC@ program, and read by the routine .IR setupterm . The file is divided into six parts: diff --git a/contrib/ncurses/man/term.7 b/contrib/ncurses/man/term.7 index 0a77cf694bd3..7eda6fbd5870 100644 --- a/contrib/ncurses/man/term.7 +++ b/contrib/ncurses/man/term.7 @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2003,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2006,2007 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 * @@ -26,8 +26,8 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: term.7,v 1.15 2006/02/25 21:47:06 tom Exp $ -.TH TERM 7 +.\" $Id: term.7,v 1.18 2007/06/02 20:40:07 tom Exp $ +.TH term 7 .ds n 5 .ds d @TERMINFO@ .SH NAME @@ -66,14 +66,14 @@ which you wish to override the system default type for your line. Terminal type descriptions are stored as files of capability data underneath \*d. To browse a list of all terminal names recognized by the system, do .sp - toe | more + @TOE@ | more .sp from your shell. These capability files are in a binary format optimized for retrieval speed (unlike the old text-based \fBtermcap\fR format they replace); -to examine an entry, you must use the \fBinfocmp\fR(1) command. Invoke it as -follows: +to examine an entry, you must use the \fB@INFOCMP@\fR(1M) command. +Invoke it as follows: .sp - infocmp \fIentry-name\fR + @INFOCMP@ \fIentry-name\fR .sp where \fIentry-name\fR is the name of the type you wish to examine (and the name of its capability file the subdirectory of \*d named for its first @@ -119,7 +119,7 @@ i.e. \fBlinux\fR, \fBbsdos\fR, \fBfreebsd\fR, \fBnetbsd\fR. It should multi-platform environment! If a model number follows, it should indicate either the OS release level or the console driver release level. .PP -The root name for a terminal emulator (assuming it doesn't fit one of the +The root name for a terminal emulator (assuming it does not fit one of the standard ANSI or vt100 types) should be the program name or a readily recognizable abbreviation of it (i.e. \fBversaterm\fR, \fBctrm\fR). .PP diff --git a/contrib/ncurses/man/terminfo.head b/contrib/ncurses/man/terminfo.head index 28006d3b68c7..7455675ab953 100644 --- a/contrib/ncurses/man/terminfo.head +++ b/contrib/ncurses/man/terminfo.head @@ -26,8 +26,8 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: terminfo.head,v 1.13 2006/05/13 15:35:45 tom Exp $ -.TH TERMINFO 5 "" "" "File Formats" +.\" $Id: terminfo.head,v 1.16 2007/03/04 00:09:46 tom Exp $ +.TH terminfo 5 "" "" "File Formats" .ds n 5 .ds d @TERMINFO@ .SH NAME @@ -51,7 +51,7 @@ version @NCURSES_MAJOR@.@NCURSES_MINOR@ (patch @NCURSES_PATCH@). Entries in .I terminfo consist of a sequence of `,' separated fields (embedded commas may be -escaped with a backslash or notated as \e054). +escaped with a backslash or notated as \\054). White space after the `,' separator is ignored. The first entry for each terminal gives the names which are known for the terminal, separated by `|' characters. @@ -62,14 +62,14 @@ All names but the last should be in lower case and contain no blanks; the last name may well contain upper case and blanks for readability. .PP Lines beginning with a `#' in the first column are treated as comments. -While comment lines are legal at any point, the output of \fIcaptoinfo\fP -and \fIinfotocap\fP (aliases for \fItic\fP) +While comment lines are legal at any point, the output of \fB@CAPTOINFO@\fP +and \fB@INFOTOCAP@\fP (aliases for \fB@TIC@\fP) will move comments so they occur only between entries. .PP Newlines and leading tabs may be used for formatting entries for readability. These are removed from parsed entries. -The \fIinfocmp\ -f\fP option relies on this to format if-then-else expressions: -the result can be read by \fItic\fP. +The \fB@INFOCMP@\ -f\fP option relies on this to format if-then-else expressions: +the result can be read by \fB@TIC@\fP. .PP Terminal names (except for the last, verbose entry) should be chosen using the following conventions. diff --git a/contrib/ncurses/man/terminfo.tail b/contrib/ncurses/man/terminfo.tail index fa9a90d86654..60d0b70d170a 100644 --- a/contrib/ncurses/man/terminfo.tail +++ b/contrib/ncurses/man/terminfo.tail @@ -1,11 +1,11 @@ -.\" $Id: terminfo.tail,v 1.44 2006/04/01 22:47:01 tom Exp $ +.\" $Id: terminfo.tail,v 1.48 2007/06/02 20:30:40 tom Exp $ .\" Beginning of terminfo.tail file .\" This file is part of ncurses. .\" See "terminfo.head" for copyright. .ps +1 -.. +. .SS A Sample Entry -.. +. The following entry, describing an ANSI-standard terminal, is representative of what a \fBterminfo\fR entry for a modern terminal typically looks like. .PP @@ -297,7 +297,7 @@ while the Lear Siegler \s-1ADM-3\s0 is described as Cursor addressing and other strings requiring parameters in the terminal are described by a parameterized string capability, with -.IR printf (3S) +.IR printf (3) like escapes \fB%x\fR in it. For example, to address the cursor, the .B cup @@ -395,7 +395,7 @@ It is possible to form else-if's a la Algol 68: .IP where c\di\u are conditions, b\di\u are bodies. .IP -Use the \fB-f\fP option of \fBtic\fP or \fBinfocmp\fP to see +Use the \fB-f\fP option of \fBtic\fP or \fB@INFOCMP@\fP to see the structure of if-the-else's. Some strings, e.g., \fBsgr\fP can be very complicated when written on one line. @@ -993,7 +993,7 @@ with the rest of the terminfo description. They are normally sent to the terminal, by the .I init option of the -.IR tput +.IR @TPUT@ program, each time the user logs in. They will be printed in the following order: .RS @@ -1578,7 +1578,7 @@ and the application has only allocated a 1k buffer, * and the termcap library (like the one in BSD/OS 1.1 and GNU) reads the whole entry into the buffer, no matter what its length, to see -if it's the entry it wants, +if it is the entry it wants, .TP 5 * and \fBtgetent()\fP is searching for a terminal type that either is the @@ -1599,19 +1599,19 @@ here but will return incorrect data for the terminal. .PP The "after tc expansion" length will have a similar effect to the above, but only for people who actually set TERM to that terminal -type, since \fBtgetent()\fP only does "tc" expansion once it's found the +type, since \fBtgetent()\fP only does "tc" expansion once it is found the terminal type it was looking for, not while searching. .PP In summary, a termcap entry that is longer than 1023 bytes can cause, on various combinations of termcap libraries and applications, a core dump, warnings, or incorrect operation. -If it's too long even before +If it is too long even before "tc" expansion, it will have this effect even for users of some other terminal types and users whose TERM variable does not have a termcap entry. .PP When in -C (translate to termcap) mode, the \fBncurses\fR implementation of -\fBtic\fR(1) issues warning messages when the pre-tc length of a termcap +\fB@TIC@\fR(1M) issues warning messages when the pre-tc length of a termcap translation is too long. The -c (check) option also checks resolved (after tc expansion) lengths. @@ -1688,7 +1688,7 @@ files containing terminal descriptions \fB@TIC@\fR(1M), \fB@INFOCMP@\fR(1M), \fBcurses\fR(3X), -\fBprintf\fR(3S), +\fBprintf\fR(3), \fBterm\fR(\*n). .SH AUTHORS Zeyd M. Ben-Halim, Eric S. Raymond, Thomas E. Dickey. diff --git a/contrib/ncurses/man/tic.1m b/contrib/ncurses/man/tic.1m index f13e0fd31f6c..343ec323140d 100644 --- a/contrib/ncurses/man/tic.1m +++ b/contrib/ncurses/man/tic.1m @@ -26,8 +26,8 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: tic.1m,v 1.43 2006/05/13 15:14:01 tom Exp $ -.TH tic 1M "" +.\" $Id: tic.1m,v 1.44 2006/12/24 17:59:11 tom Exp $ +.TH @TIC@ 1M "" .ds n 5 .ds d @TERMINFO@ .SH NAME @@ -92,7 +92,7 @@ Otherwise these are ignored. .TP \fB-C\fR Force source translation to termcap format. Note: this differs from the \fB-C\fR -option of \fIinfocmp\fR(1M) in that it does not merely translate capability +option of \fB@INFOCMP@\fR(1M) in that it does not merely translate capability names, but also translates terminfo strings to termcap format. Capabilities that are not translatable are left in the entry under their terminfo names but commented out with two preceding dots. diff --git a/contrib/ncurses/man/toe.1m b/contrib/ncurses/man/toe.1m index 1419674b3958..36cc3d039984 100644 --- a/contrib/ncurses/man/toe.1m +++ b/contrib/ncurses/man/toe.1m @@ -26,8 +26,8 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: toe.1m,v 1.18 2006/05/13 15:14:01 tom Exp $ -.TH toe 1M "" +.\" $Id: toe.1m,v 1.20 2006/12/24 17:20:37 tom Exp $ +.TH @TOE@ 1M "" .ds n 5 .ds d @TERMINFO@ .SH NAME @@ -67,7 +67,7 @@ followed by a newline. specifies that (verbose) output be written to standard error, showing \fBtoe\fR's progress. The optional parameter \fIn\fR is a number from 1 to 10, -interpreted as for \fBtic\fR(1). +interpreted as for \fB@TIC@\fR(1M). .TP \fB-V\fR reports the version of ncurses which was used in this program, and exits. diff --git a/contrib/ncurses/man/tput.1 b/contrib/ncurses/man/tput.1 index 4de0b73a3a82..bada0b1595ed 100644 --- a/contrib/ncurses/man/tput.1 +++ b/contrib/ncurses/man/tput.1 @@ -27,27 +27,27 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: tput.1,v 1.25 2006/05/13 15:14:01 tom Exp $ -.TH tput 1 "" +.\" $Id: tput.1,v 1.27 2006/12/24 18:11:31 tom Exp $ +.TH @TPUT@ 1 "" .ds d @TERMINFO@ .ds n 1 .SH NAME -\fBtput\fR, \fBreset\fR - initialize a terminal or query terminfo database +\fB@TPUT@\fR, \fBreset\fR - initialize a terminal or query terminfo database .SH SYNOPSIS -\fBtput\fR [\fB-T\fR\fItype\fR] \fIcapname\fR [\fIparms\fR ... ] +\fB@TPUT@\fR [\fB-T\fR\fItype\fR] \fIcapname\fR [\fIparms\fR ... ] .br -\fBtput\fR [\fB-T\fR\fItype\fR] \fBinit\fR +\fB@TPUT@\fR [\fB-T\fR\fItype\fR] \fBinit\fR .br -\fBtput\fR [\fB-T\fR\fItype\fR] \fBreset\fR +\fB@TPUT@\fR [\fB-T\fR\fItype\fR] \fBreset\fR .br -\fBtput\fR [\fB-T\fR\fItype\fR] \fBlongname\fR +\fB@TPUT@\fR [\fB-T\fR\fItype\fR] \fBlongname\fR .br -\fBtput -S\fR \fB<<\fR +\fB@TPUT@ -S\fR \fB<<\fR .br -\fBtput -V\fR +\fB@TPUT@ -V\fR .br .SH DESCRIPTION -The \fBtput\fR utility uses the \fBterminfo\fR database to make the +The \fB@TPUT@\fR utility uses the \fBterminfo\fR database to make the values of terminal-dependent capabilities and information available to the shell (see \fBsh\fR(1)), to initialize or reset the terminal, or return the long name of the requested terminal type. @@ -55,15 +55,15 @@ The result depends upon the capability's type: .RS .TP 5 string -\fBtput\fR writes the string to the standard output. +\fB@TPUT@\fR writes the string to the standard output. No trailing newline is supplied. .TP integer -\fBtput\fR writes the decimal value to the standard output, +\fB@TPUT@\fR writes the decimal value to the standard output, with a trailing newline. .TP boolean -\fBtput\fR simply sets the exit code +\fB@TPUT@\fR simply sets the exit code (\fB0\fR for TRUE if the terminal has the capability, \fB1\fR for FALSE if it does not), and writes nothing to the standard output. @@ -74,7 +74,7 @@ the application should test the exit code (e.g., \fB$?\fR, see \fBsh\fR(1)) to be sure it is \fB0\fR. (See the \fBEXIT CODES\fR and \fBDIAGNOSTICS\fR sections.) For a complete list of capabilities -and the \fIcapname\fR associated with each, see \fBterminfo\fR(\*n). +and the \fIcapname\fR associated with each, see \fBterminfo\fR(5). .TP \fB-T\fR\fItype\fR indicates the \fItype\fR of terminal. Normally this option is @@ -94,21 +94,21 @@ If the capability is a string that takes parameters, the arguments .IP Most parameters are numbers. Only a few terminfo capabilities require string parameters; -\fBtput\fR uses a table to decide which to pass as strings. -Normally \fBtput\fR uses \fBtparm\fR (3X) to perform the substitution. +\fB@TPUT@\fR uses a table to decide which to pass as strings. +Normally \fB@TPUT@\fR uses \fBtparm\fR (3X) to perform the substitution. If no parameters are given for the capability, -\fBtput\fR writes the string without performing the substitution. +\fB@TPUT@\fR writes the string without performing the substitution. .TP \fB-S\fR -allows more than one capability per invocation of \fBtput\fR. The -capabilities must be passed to \fBtput\fR from the standard input +allows more than one capability per invocation of \fB@TPUT@\fR. The +capabilities must be passed to \fB@TPUT@\fR from the standard input instead of from the command line (see example). Only one \fIcapname\fR is allowed per line. The \fB-S\fR option changes the meaning of the \fB0\fR and \fB1\fR boolean and string exit codes (see the EXIT CODES section). .IP -Again, \fBtput\fR uses a table and the presence of parameters in its input +Again, \fB@TPUT@\fR uses a table and the presence of parameters in its input to decide whether to use \fBtparm\fR (3X), and how to interpret the parameters. .TP @@ -157,58 +157,58 @@ of the terminal will be put out. The long name is the last name in the first line of the terminal's description in the \fBterminfo\fR database [see \fBterm\fR(5)]. .PP -If \fBtput\fR is invoked by a link named \fBreset\fR, this has the -same effect as \fBtput reset\fR. +If \fB@TPUT@\fR is invoked by a link named \fBreset\fR, this has the +same effect as \fB@TPUT@ reset\fR. See \fBtset\fR for comparison, which has similar behavior. .SH EXAMPLES .TP 5 -\fBtput init\fR +\fB@TPUT@ init\fR Initialize the terminal according to the type of terminal in the environmental variable \fBTERM\fR. This command should be included in everyone's .profile after the environmental variable \fBTERM\fR has been exported, as illustrated on the \fBprofile\fR(5) manual page. .TP 5 -\fBtput -T5620 reset\fR +\fB@TPUT@ -T5620 reset\fR Reset an AT&T 5620 terminal, overriding the type of terminal in the environmental variable \fBTERM\fR. .TP 5 -\fBtput cup 0 0\fR +\fB@TPUT@ cup 0 0\fR Send the sequence to move the cursor to row \fB0\fR, column \fB0\fR (the upper left corner of the screen, usually known as the "home" cursor position). .TP 5 -\fBtput clear\fR +\fB@TPUT@ clear\fR Echo the clear-screen sequence for the current terminal. .TP 5 -\fBtput cols\fR +\fB@TPUT@ cols\fR Print the number of columns for the current terminal. .TP 5 -\fBtput -T450 cols\fR +\fB@TPUT@ -T450 cols\fR Print the number of columns for the 450 terminal. .TP 5 -\fBbold=`tput smso` offbold=`tput rmso`\fR +\fBbold=`@TPUT@ smso` offbold=`@TPUT@ rmso`\fR Set the shell variables \fBbold\fR, to begin stand-out mode sequence, and \fBoffbold\fR, to end standout mode sequence, for the current terminal. This might be followed by a prompt: \fBecho "${bold}Please type in your name: ${offbold}\\c"\fR .TP 5 -\fBtput hc\fR +\fB@TPUT@ hc\fR Set exit code to indicate if the current terminal is a hard copy terminal. .TP 5 -\fBtput cup 23 4\fR +\fB@TPUT@ cup 23 4\fR Send the sequence to move the cursor to row 23, column 4. .TP 5 -\fBtput cup\fR +\fB@TPUT@ cup\fR Send the terminfo string for cursor-movement, with no parameters substituted. .TP 5 -\fBtput longname\fR +\fB@TPUT@ longname\fR Print the long name from the \fBterminfo\fR database for the type of terminal specified in the environmental variable \fBTERM\fR. .PP .RS 5 -\fBtput -S <<!\fR +\fB@TPUT@ -S <<!\fR .br \fB> clear\fR .br @@ -220,7 +220,7 @@ variable \fBTERM\fR. .RE .TP 5 \& -This example shows \fBtput\fR processing several capabilities in one invocation. +This example shows \fB@TPUT@\fR processing several capabilities in one invocation. It clears the screen, moves the cursor to position 10, 10 and turns on bold (extra bright) mode. @@ -238,7 +238,7 @@ information, see the "Tabs and Initialization" section of \fBterminfo\fR(5) .SH EXIT CODES If the \fB-S\fR option is used, -\fBtput\fR checks for errors from each line, +\fB@TPUT@\fR checks for errors from each line, and if any errors are found, will set the exit code to 4 plus the number of lines with errors. If no errors are found, the exit code is \fB0\fR. @@ -285,8 +285,8 @@ exit code error message = \fB0\fR T{ (\fIcapname\fR is a numeric variable that is not specified in the -\fBterminfo\fR(\*n) database for this terminal type, e.g. -\fBtput -T450 lines\fR and \fBtput -T2621 xmc\fR) +\fBterminfo\fR(5) database for this terminal type, e.g. +\fB@TPUT@ -T450 lines\fR and \fB@TPUT@ -T2621 xmc\fR) T} \fB1\fR no error message is printed, see the \fBEXIT CODES\fR section. \fB2\fR usage error diff --git a/contrib/ncurses/man/tset.1 b/contrib/ncurses/man/tset.1 index 93e7c38580c7..e023064c08b7 100644 --- a/contrib/ncurses/man/tset.1 +++ b/contrib/ncurses/man/tset.1 @@ -26,7 +26,7 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: tset.1,v 1.18 2006/07/29 11:34:07 tom Exp $ +.\" $Id: tset.1,v 1.19 2006/12/24 15:00:30 tom Exp $ .TH tset 1 "" .SH NAME \fBtset\fR, \fBreset\fR - terminal initialization @@ -272,7 +272,7 @@ terminal capability database csh(1), sh(1), stty(1), -setupterm(3X), +curs_terminfo(3X), tty(4), terminfo(5), ttys(5), |