diff options
Diffstat (limited to 'man')
136 files changed, 2544 insertions, 1806 deletions
diff --git a/man/MKada_config.in b/man/MKada_config.in new file mode 100644 index 0000000..2be3c41 --- /dev/null +++ b/man/MKada_config.in @@ -0,0 +1,57 @@ +.\"*************************************************************************** +.\" Copyright (c) 2010,2011 Free Software Foundation, Inc. * +.\" * +.\" Permission is hereby granted, free of charge, to any person obtaining a * +.\" copy of this software and associated documentation files (the * +.\" "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: MKada_config.in,v 1.5 2011/03/26 14:44:51 tom Exp $ +.TH ADACURSES "1" "" "" "User Commands" +.SH NAME +adacurses\-config \- helper script for AdaCurses libraries +.SH SYNOPSIS +.B adacurses\-config +[\fIoptions\fR] +.SH DESCRIPTION +This is a shell script which simplifies configuring an application to use +the AdaCurses library binding to ncurses. +.SH OPTIONS +.TP +\fB\-\-cflags\fR +echos the gnat (Ada compiler) flags needed to compile with AdaCurses. +.TP +\fB\-\-libs\fR +echos the gnat libraries needed to link with AdaCurses. +.TP +\fB\-\-version\fR +echos the release+patchdate version of the ncurses libraries used +to configure and build AdaCurses. +.TP +\fB\-\-help\fR +prints a list of the \fBadacurses\-config\fP script's options. +.SH "SEE ALSO" +\fBcurses\fR(3X) +.PP +This describes \fBncurses\fR +version @NCURSES_MAJOR@.@NCURSES_MINOR@ (patch @NCURSES_PATCH@). diff --git a/man/MKncu_config.in b/man/MKncu_config.in new file mode 100644 index 0000000..3de772c --- /dev/null +++ b/man/MKncu_config.in @@ -0,0 +1,98 @@ +.\"*************************************************************************** +.\" Copyright (c) 2010 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: MKncu_config.in,v 1.3 2010/03/06 22:29:17 tom Exp $ +.TH @LIB_NAME@@DFT_ARG_SUFFIX@@cf_cv_abi_version@-config 1 "" +.SH NAME +@LIB_NAME@@DFT_ARG_SUFFIX@@cf_cv_abi_version@-config \- helper script for ncurses libraries +.SH SYNOPSIS +.B @LIB_NAME@@DFT_ARG_SUFFIX@@cf_cv_abi_version@-config +[\fIoptions\fR] +.SH DESCRIPTION +This is a shell script which simplifies configuring applications against +a particular set of ncurses libraries. +.SH OPTIONS +.TP +\fB\-\-prefix\fR +echos the package\-prefix of ncurses +.TP +\fB\-\-exec\-prefix\fR +echos the executable\-prefix of ncurses +.TP +\fB\-\-cflags\fR +echos the C compiler flags needed to compile with ncurses +.TP +\fB\-\-libs\fR +echos the libraries needed to link with ncurses +.TP +\fB\-\-version\fR +echos the release+patchdate version of ncurses +.TP +\fB\-\-abi\-version\fR +echos the ABI version of ncurses +.TP +\fB\-\-mouse\-version\fR +echos the mouse\-interface version of ncurses +.TP +\fB\-\-bindir\fR +echos the directory containing ncurses programs +.TP +\fB\-\-datadir\fR +echos the directory containing ncurses data +.TP +\fB\-\-includedir\fR +echos the directory containing ncurses header files +.TP +\fB\-\-libdir\fR +echos the directory containing ncurses libraries +.TP +\fB\-\-mandir\fR +echos the directory containing ncurses manpages +.TP +\fB\-\-terminfo\fR +echos the $TERMINFO terminfo database path, e.g., +.RS +@TERMINFO@ +.RE +.TP +\fB\-\-terminfo\-dirs\fR +echos the $TERMINFO_DIRS directory list, e.g., +.RS +@TERMINFO_DIRS@ +.RE +.TP +\fB\-\-termpath\fR +echos the $TERMPATH termcap list, if support for termcap is configured. +.TP +\fB\-\-help\fR +prints this message +.SH "SEE ALSO" +\fBcurses\fR(3X) +.PP +This describes \fBncurses\fR +version @NCURSES_MAJOR@.@NCURSES_MINOR@ (patch @NCURSES_PATCH@). diff --git a/man/Makefile.in b/man/Makefile.in index c04f7c9..82a6706 100644 --- a/man/Makefile.in +++ b/man/Makefile.in @@ -1,6 +1,6 @@ -# $Id: Makefile.in,v 1.41 2007/03/31 15:54:06 tom Exp $ +# $Id: Makefile.in,v 1.45 2010/11/27 21:45:27 tom Exp $ ############################################################################## -# Copyright (c) 1998-2006,2007 Free Software Foundation, Inc. # +# Copyright (c) 1998-2007,2010 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"), # @@ -35,6 +35,7 @@ # the top-level MANIFEST and any man/*.renames files! SHELL = /bin/sh +VPATH = @srcdir@ DESTDIR = @DESTDIR@ srcdir = @srcdir@ @@ -52,9 +53,9 @@ depend : tags : $(DESTDIR)$(mandir) : - sh $(srcdir)/../mkdirs.sh $@ + mkdir -p $@ -EDITARGS = $(DESTDIR)$(mandir) $(srcdir) terminfo.5 $(srcdir)/*.[0-9]* +EDITARGS = $(DESTDIR)$(mandir) $(srcdir) terminfo.5 *-config.1 $(srcdir)/*.[0-9]* install install.man : terminfo.5 $(DESTDIR)$(mandir) sh ../edit_man.sh normal installing $(EDITARGS) @@ -77,4 +78,4 @@ clean: mostlyclean sh $(srcdir)/make_sed.sh @MANPAGE_RENAMES@ >../edit_man.sed distclean realclean: clean - rm -f Makefile ../edit_man.* ../man_alias.* + rm -f Makefile *-config.1 ../edit_man.* ../man_alias.* diff --git a/man/captoinfo.1m b/man/captoinfo.1m index de57a27..c7a3364 100644 --- a/man/captoinfo.1m +++ b/man/captoinfo.1m @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998-2006,2007 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2007,2010 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,38 +27,44 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: captoinfo.1m,v 1.22 2007/06/02 20:40:07 tom Exp $ +.\" $Id: captoinfo.1m,v 1.25 2010/12/04 18:36:44 tom Exp $ .TH @CAPTOINFO@ 1M "" .ds n 5 .ds d @TERMINFO@ .SH NAME -\fB@CAPTOINFO@\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 -\fB@CAPTOINFO@\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 -\fB@CAPTOINFO@\fR looks in \fIfile\fR for \fBtermcap\fR descriptions. For each +\fB@CAPTOINFO@\fR looks in each given text +\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 +output. +Termcap \fBtc\fR capabilities are translated directly to terminfo \fBuse\fR capabilities. .PP If no \fIfile\fR is given, then the environment variable \fBTERMCAP\fR is used -for the filename or entry. If \fBTERMCAP\fR is a full pathname to a file, only +for the filename or entry. +If \fBTERMCAP\fR is a full pathname to a file, only the terminal whose name is specified in the environment variable \fBTERM\fR is -extracted from that file. If the environment variable \fBTERMCAP\fR is not +extracted from that file. +If the environment variable \fBTERMCAP\fR is not set, then the file \fB\*d\fR is read. .TP 5 -\fB-v\fR +\fB\-v\fR print out tracing information on standard error as the program runs. .TP 5 -\fB-V\fR +\fB\-V\fR print out the version of the program in use on standard error and exit. .TP 5 -\fB-1\fR -cause the fields to print out one to a line. Otherwise, the fields +\fB\-1\fR +cause the fields to print out one to a line. +Otherwise, the fields will be printed several to a line to a maximum width of 60 characters. .TP 5 -\fB-w\fR +\fB\-w\fR change the output to \fIwidth\fR characters. .SH FILES .TP 20 @@ -112,7 +118,8 @@ HS mh Iris enter_dim_mode .PP XENIX termcap also used to have a set of extension capabilities for forms drawing, designed to take advantage of the IBM PC -high-half graphics. They were as follows: +high-half graphics. +They were as follows: .PP .TS H c c @@ -145,11 +152,13 @@ GG acs magic cookie count .TE .PP If the single-line capabilities occur in an entry, they will automatically -be composed into an \fIacsc\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 -with the SVr4 format. The following AIX extensions are automatically +with the SVr4 format. +The following AIX extensions are automatically translated: .TS c c @@ -171,11 +180,12 @@ Hewlett-Packard's terminfo library supports two nonstandard terminfo 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 \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. +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 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. +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), \fBcurses\fR(3X), @@ -185,9 +195,6 @@ This describes \fBncurses\fR version @NCURSES_MAJOR@.@NCURSES_MINOR@ (patch @NCURSES_PATCH@). .SH AUTHOR Eric S. Raymond <esr@snark.thyrsus.com> -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: +and +.br +Thomas E. Dickey <dickey@invisible-island.net> diff --git a/man/clear.1 b/man/clear.1 index 31d0f93..b70d37e 100644 --- a/man/clear.1 +++ b/man/clear.1 @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2000,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2006,2010 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,11 +26,11 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: clear.1,v 1.6 2006/12/24 18:07:53 tom Exp $ +.\" $Id: clear.1,v 1.8 2010/12/04 18:36:44 tom Exp $ .TH @CLEAR@ 1 "" .ds n 5 .SH NAME -\fB@CLEAR@\fR - clear the terminal screen +\fB@CLEAR@\fR \- clear the terminal screen .SH SYNOPSIS \fB@CLEAR@\fR .br @@ -45,9 +45,3 @@ figure out how to clear the screen. .PP This describes \fBncurses\fR version @NCURSES_MAJOR@.@NCURSES_MINOR@ (patch @NCURSES_PATCH@). -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/curs_add_wch.3x b/man/curs_add_wch.3x index 51ac1a4..26319a8 100644 --- a/man/curs_add_wch.3x +++ b/man/curs_add_wch.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 2001-2002,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 2001-2010,2011 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * .\" copy of this software and associated documentation files (the * @@ -26,15 +26,18 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_add_wch.3x,v 1.6 2006/12/24 15:22:22 tom Exp $ +.\" $Id: curs_add_wch.3x,v 1.14 2011/01/15 15:27:43 tom Exp $ .TH curs_add_wch 3X "" +.de bP +.IP \(bu 4 +.. .SH NAME \fBadd_wch\fP, \fBwadd_wch\fP, \fBmvadd_wch\fP, \fBmvwadd_wch\fP, \fBecho_wchar\fP, -\fBwecho_wchar\fP - add a complex character and rendition to a \fBcurses\fR window, then advance the cursor +\fBwecho_wchar\fP \- add a complex character and rendition to a \fBcurses\fR window, then advance the cursor .SH SYNOPSIS .PP \fB#include <curses.h>\fP @@ -63,23 +66,20 @@ window at its current position, which is then advanced. These functions perform wrapping and special-character processing as follows: -.TP 5 -- +.bP If \fIwch\fP refers to a spacing character, then any previous character at that location is removed. A new character specified by \fIwch\fP is placed at that location with rendition specified by \fIwch\fP. The cursor then advances to the next spacing character on the screen. -.TP 5 -- +.bP If \fIwch\fP refers to a non-spacing character, all previous characters at that location are preserved. The non-spacing characters of \fIwch\fP are added to the spacing complex character, and the rendition specified by \fIwch\fP is ignored. -.TP 5 -- +.bP 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 were called. @@ -99,9 +99,90 @@ The knowledge that only a single character is being output is taken into consideration and, for non-control characters, a considerable performance gain might be seen by using the *\fBecho\fP* functions instead of their equivalents. +.SS Line Graphics +Like \fBaddch\fP(3X), +\fBaddch_wch\fP accepts symbols which make it simple to draw lines and other +frequently used special characters. +These symbols correspond to the same VT100 line-drawing set as +\fBaddch\fP(3X). +.PP +.TS +l l l l +_ _ _ _ +lw(1.5i) lw7 lw7 lw20. +\fIName\fR \fIUnicode\fP \fIDefault\fR \fIDescription\fR +WACS_BLOCK 0x25ae # solid square block +WACS_BOARD 0x2592 # board of squares +WACS_BTEE 0x2534 + bottom tee +WACS_BULLET 0x00b7 o bullet +WACS_CKBOARD 0x2592 : checker board (stipple) +WACS_DARROW 0x2193 v arrow pointing down +WACS_DEGREE 0x00b0 ' degree symbol +WACS_DIAMOND 0x25c6 + diamond +WACS_GEQUAL 0x2265 > greater-than-or-equal-to +WACS_HLINE 0x2500 \- horizontal line +WACS_LANTERN 0x2603 # lantern symbol +WACS_LARROW 0x2190 < arrow pointing left +WACS_LEQUAL 0x2264 < less-than-or-equal-to +WACS_LLCORNER 0x2514 + lower left-hand corner +WACS_LRCORNER 0x2518 + lower right-hand corner +WACS_LTEE 0x2524 + left tee +WACS_NEQUAL 0x2260 ! not-equal +WACS_PI 0x03c0 * greek pi +WACS_PLMINUS 0x00b1 # plus/minus +WACS_PLUS 0x253c + plus +WACS_RARROW 0x2192 > arrow pointing right +WACS_RTEE 0x251c + right tee +WACS_S1 0x23ba \- scan line 1 +WACS_S3 0x23bb \- scan line 3 +WACS_S7 0x23bc \- scan line 7 +WACS_S9 0x23bd \&_ scan line 9 +WACS_STERLING 0x00a3 f pound-sterling symbol +WACS_TTEE 0x252c + top tee +WACS_UARROW 0x2191 ^ arrow pointing up +WACS_ULCORNER 0x250c + upper left-hand corner +WACS_URCORNER 0x2510 + upper right-hand corner +WACS_VLINE 0x2502 | vertical line +.TE +.PP +The wide-character configuration of ncurses also defines symbols +for thick- and double-lines: +.PP +.TS +l l l l +_ _ _ _ +lw(1.5i) lw7 lw7 lw20. +\fIName\fR \fIUnicode\fP \fIDefault\fR \fIDescription\fR +WACS_T_ULCORNER 0x250f + thick upper left corner +WACS_T_LLCORNER 0x2517 + thick lower left corner +WACS_T_URCORNER 0x2513 + thick upper right corner +WACS_T_LRCORNER 0x251b + thick lower right corner +WACS_T_LTEE 0x252b + thick tee pointing right +WACS_T_RTEE 0x2523 + thick tee pointing left +WACS_T_BTEE 0x253b + thick tee pointing up +WACS_T_TTEE 0x2533 + thick tee pointing down +WACS_T_HLINE 0x2501 - thick horizontal line +WACS_T_VLINE 0x2503 | thick vertical line +WACS_T_PLUS 0x254b + thick large plus or crossover +WACS_D_ULCORNER 0x2554 + double upper left corner +WACS_D_LLCORNER 0x255a + double lower left corner +WACS_D_URCORNER 0x2557 + double upper right corner +WACS_D_LRCORNER 0x255d + double lower right corner +WACS_D_RTEE 0x2563 + double tee pointing left +WACS_D_LTEE 0x2560 + double tee pointing right +WACS_D_BTEE 0x2569 + double tee pointing up +WACS_D_TTEE 0x2566 + double tee pointing down +WACS_D_HLINE 0x2550 - double horizontal line +WACS_D_VLINE 0x2551 | double vertical line +WACS_D_PLUS 0x256c + double large plus or crossover +.TE .SH RETURN VALUES .PP All routines return the integer \fBERR\fR upon failure and \fBOK\fR on success. +.PP +Functions with a "mv" prefix first perform a cursor movement using +\fBwmove\fP, and return an error if the position is outside the window, +or if the window pointer is null. .SH NOTES .PP Note that @@ -112,12 +193,26 @@ Note that may be macros. .SH PORTABILITY .PP -All these functions are described in the XSI Curses standard, Issue 4. -The defaults specified for forms-drawing characters apply in the POSIX locale. +All of these functions are described in the XSI Curses standard, Issue 4. +The defaults specified for line-drawing characters apply in the POSIX locale. +.PP +X/Open Curses makes it clear that the WACS_ symbols should be defined as +a pointer to \fBcchar_t\fP data, e.g., in the discussion of \fBborder_set\fR. +A few implementations are problematic: +.bP +NetBSD curses defines the symbols as a \fBwchar_t\fP within a \fBcchar_t\fP. +.bP +HPUX curses equates some of the \fIACS_\fP symbols +to the analogous \fIWACS_\fP symbols as if the \fIACS_\fP symbols were +wide characters. +The misdefined symbols are the arrows +and other symbols which are not used for line-drawing. .PP -XSI documents constants beginning with \fBWACS_\fP which are used for -line-drawing. -Those are not currently implemented in \fBncurses\fP. +X/Open Curses does not define symbols for thick- or double-lines. +SVr4 curses implementations defined their line-drawing symbols in +terms of intermediate symbols. +This implementation extends those symbols, providing new definitions +which are not in the SVr4 implementations. .SH SEE ALSO .PP \fBcurses\fR(3X), @@ -127,9 +222,3 @@ Those are not currently implemented in \fBncurses\fP. \fBcurs_outopts\fR(3X), \fBcurs_refresh\fR(3X), \fBputwc\fR(3) -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/curs_add_wchstr.3x b/man/curs_add_wchstr.3x index f84c2cb..957adc0 100644 --- a/man/curs_add_wchstr.3x +++ b/man/curs_add_wchstr.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 2002-2004,2005 Free Software Foundation, Inc. * +.\" Copyright (c) 2002-2005,2010 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_add_wchstr.3x,v 1.6 2005/01/02 01:28:49 tom Exp $ +.\" $Id: curs_add_wchstr.3x,v 1.9 2010/12/04 18:36:44 tom Exp $ .TH curs_add_wchstr 3X "" .SH NAME \fBadd_wchstr\fR, @@ -62,7 +62,7 @@ These routines copy the array of complex characters \fIwchstr\fR into the window image structure at and after the current cursor position. The four routines with \fIn\fR as the last argument copy at most \fIn\fR elements, but no more than will fit on the line. -If \fBn\fR=\fB-1\fR then the whole array is copied, +If \fBn\fR=\fB\-1\fR then the whole array is copied, to the maximum number of characters that will fit on the line. .PP The window cursor is \fInot\fR advanced. @@ -83,15 +83,13 @@ the remaining columns are filled with the background character and rendition. All functions except \fBwadd_wchnstr\fR may be macros. .SH RETURN VALUES All routines return the integer \fBERR\fR upon failure and \fBOK\fR on success. +.PP +Functions with a "mv" prefix first perform a cursor movement using +\fBwmove\fP, and return an error if the position is outside the window, +or if the window pointer is null. .SH PORTABILITY All these entry points are described in the XSI Curses standard, Issue 4. .SH SEE ALSO \fBcurses\fR(3X), \fBcurs_addchstr\fR(3X), \fBcurs_addwstr\fR(3X) -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/curs_addch.3x b/man/curs_addch.3x index 73918b8..1ad071a 100644 --- a/man/curs_addch.3x +++ b/man/curs_addch.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998-2006,2007 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2010,2011 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * .\" copy of this software and associated documentation files (the * @@ -27,12 +27,15 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_addch.3x,v 1.27 2007/06/02 20:40:07 tom Exp $ +.\" $Id: curs_addch.3x,v 1.32 2011/01/15 14:15:10 tom Exp $ .TH curs_addch 3X "" .SH NAME -\fBaddch\fR, \fBwaddch\fR, \fBmvaddch\fR, \fBmvwaddch\fR, +\fBaddch\fR, +\fBwaddch\fR, +\fBmvaddch\fR, +\fBmvwaddch\fR, \fBechochar\fR, -\fBwechochar\fR - add a character (with attributes) to a \fBcurses\fR window, then advance the cursor +\fBwechochar\fR \- add a character (with attributes) to a \fBcurses\fR window, then advance the cursor .SH SYNOPSIS \fB#include <curses.h>\fR .PP @@ -105,7 +108,7 @@ ACS_DARROW v arrow pointing down ACS_DEGREE ' degree symbol ACS_DIAMOND + diamond ACS_GEQUAL > greater-than-or-equal-to -ACS_HLINE - horizontal line +ACS_HLINE \- horizontal line ACS_LANTERN # lantern symbol ACS_LARROW < arrow pointing left ACS_LEQUAL < less-than-or-equal-to @@ -118,9 +121,9 @@ ACS_PLMINUS # plus/minus ACS_PLUS + plus ACS_RARROW > arrow pointing right ACS_RTEE + right tee -ACS_S1 - scan line 1 -ACS_S3 - scan line 3 -ACS_S7 - scan line 7 +ACS_S1 \- scan line 1 +ACS_S3 \- scan line 3 +ACS_S7 \- scan line 7 ACS_S9 \&_ scan line 9 ACS_STERLING f pound-sterling symbol ACS_TTEE + top tee @@ -134,6 +137,10 @@ All routines return the integer \fBERR\fR upon failure and \fBOK\fR on success (the SVr4 manuals specify only "an integer value other than \fBERR\fR") upon successful completion, unless otherwise noted in the preceding routine descriptions. +.PP +Functions with a "mv" prefix first perform a cursor movement using +\fBwmove\fP, and return an error if the position is outside the window, +or if the window pointer is null. .SH NOTES Note that \fBaddch\fR, \fBmvaddch\fR, \fBmvwaddch\fR, and \fBechochar\fR may be macros. @@ -141,6 +148,10 @@ Note that \fBaddch\fR, \fBmvaddch\fR, \fBmvwaddch\fR, and All these functions are described in the XSI Curses standard, Issue 4. The defaults specified for forms-drawing characters apply in the POSIX locale. .LP +X/Open Curses states that the \fIACS_\fP definitions are \fBchar\fP constants. +For the wide-character implementation (see \fBcurs_add_wch\fP), +there are analogous \fIWACS_\fP definitions which are \fBcchar_t\fP constants. +.LP Some ACS symbols (ACS_S3, ACS_S7, @@ -168,14 +179,9 @@ This is true of other implementations, but is not documented. \fBcurs_inch\fR(3X), \fBcurs_outopts\fR(3X), \fBcurs_refresh\fR(3X), +\fBcurs_variables\fR(3X), \fBputc\fR(3). .PP Comparable functions in the wide-character (ncursesw) library are described in \fBcurs_add_wch\fR(3X). -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/curs_addchstr.3x b/man/curs_addchstr.3x index ac1b040..1547219 100644 --- a/man/curs_addchstr.3x +++ b/man/curs_addchstr.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2005,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2006,2010 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_addchstr.3x,v 1.12 2006/12/02 17:02:45 tom Exp $ +.\" $Id: curs_addchstr.3x,v 1.15 2010/12/04 18:36:44 tom Exp $ .TH curs_addchstr 3X "" .na .hy 0 @@ -38,7 +38,7 @@ \fBmvaddchstr\fR, \fBmvaddchnstr\fR, \fBmvwaddchstr\fR, -\fBmvwaddchnstr\fR - add a string of characters (and attributes) to a \fBcurses\fR window +\fBmvwaddchnstr\fR \- add a string of characters (and attributes) to a \fBcurses\fR window .ad .hy .SH SYNOPSIS @@ -63,7 +63,7 @@ These routines copy \fIchstr\fR into the window image structure at and after the current cursor position. The four routines with \fIn\fR as the last argument copy at most \fIn\fR elements, but no more than will fit on the line. -If \fBn\fR=\fB-1\fR then the whole string is copied, to the maximum number of +If \fBn\fR=\fB\-1\fR then the whole string is copied, to the maximum number of characters that will fit on the line. .PP The window cursor is \fInot\fR advanced, and these routines work faster than @@ -81,6 +81,10 @@ descriptions. X/Open does not define any error conditions. This implementation returns an error if the window pointer is null. +.PP +Functions with a "mv" prefix first perform a cursor movement using +\fBwmove\fP, and return an error if the position is outside the window, +or if the window pointer is null. .SH NOTES Note that all routines except \fBwaddchnstr\fR may be macros. .SH PORTABILITY @@ -91,9 +95,3 @@ These entry points are described in the XSI Curses standard, Issue 4. Comparable functions in the wide-character (ncursesw) library are described in \fBcurs_add_wchstr\fR(3X). -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/curs_addstr.3x b/man/curs_addstr.3x index 488b9dd..a52619e 100644 --- a/man/curs_addstr.3x +++ b/man/curs_addstr.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2003,2005 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2005,2010 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_addstr.3x,v 1.13 2005/05/15 16:17:14 tom Exp $ +.\" $Id: curs_addstr.3x,v 1.16 2010/12/04 18:36:44 tom Exp $ .TH curs_addstr 3X "" .na .hy 0 @@ -38,7 +38,7 @@ \fBmvaddstr\fR, \fBmvaddnstr\fR, \fBmvwaddstr\fR, -\fBmvwaddnstr\fR - add a string of characters to a \fBcurses\fR window and advance cursor +\fBmvwaddnstr\fR \- add a string of characters to a \fBcurses\fR window and advance cursor .ad .hy .SH SYNOPSIS @@ -67,7 +67,7 @@ These routines write the characters of the (null-terminated) character string It is similar to calling \fBwaddch\fR once for each character in the string. The four routines with \fIn\fR as the last argument write at most \fIn\fR characters. -If \fIn\fR is -1, then the entire string will be added, +If \fIn\fR is \-1, then the entire string will be added, up to the maximum number of characters that will fit on the line, or until a terminating null is reached. .SH RETURN VALUE @@ -80,6 +80,10 @@ This implementation returns an error if the window pointer is null or if the string pointer is null or if the corresponding calls to \fBwaddch\fP return an error. +.PP +Functions with a "mv" prefix first perform a cursor movement using +\fBwmove\fP, and return an error if the position is outside the window, +or if the window pointer is null. .SH NOTES Note that all of these routines except \fBwaddstr\fR and \fBwaddnstr\fR may be macros. @@ -89,9 +93,3 @@ XSI errors EILSEQ and EOVERFLOW, associated with extended-level conformance, are not yet detected. .SH SEE ALSO \fBcurses\fR(3X), \fBcurs_addch\fR(3X). -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/curs_addwstr.3x b/man/curs_addwstr.3x index 63d2746..4e10d30 100644 --- a/man/curs_addwstr.3x +++ b/man/curs_addwstr.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 2002-2005,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 2002-2006,2010 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_addwstr.3x,v 1.7 2006/02/25 20:59:08 tom Exp $ +.\" $Id: curs_addwstr.3x,v 1.10 2010/12/04 18:36:44 tom Exp $ .TH curs_addwstr 3X "" .na .hy 0 @@ -74,11 +74,15 @@ Thereafter, the cursor is advanced as a side-effect of writing to the window. .PP The four routines with \fIn\fR as the last argument write at most \fIn\fR \fBwchar_t\fR characters. -If \fIn\fR is -1, then the entire string will be added, +If \fIn\fR is \-1, then the entire string will be added, up to the maximum number of characters that will fit on the line, or until a terminating null is reached. .SH RETURN VALUES All routines return the integer \fBERR\fR upon failure and \fBOK\fR on success. +.PP +Functions with a "mv" prefix first perform a cursor movement using +\fBwmove\fP, and return an error if the position is outside the window, +or if the window pointer is null. .SH NOTES Note that all of these routines except \fBwaddnwstr\fR may be macros. .SH PORTABILITY @@ -86,9 +90,3 @@ All these entry points are described in the XSI Curses standard, Issue 4. .SH SEE ALSO \fBcurses\fR(3X), \fBcurs_add_wch\fR(3X) -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/curs_attr.3x b/man/curs_attr.3x index cf58aff..67740f9 100644 --- a/man/curs_attr.3x +++ b/man/curs_attr.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998-2006,2007 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2009,2010 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.31 2007/03/17 20:30:33 tom Exp $ +.\" $Id: curs_attr.3x,v 1.36 2010/12/04 18:36:44 tom Exp $ .TH curs_attr 3X "" .na .hy 0 @@ -56,7 +56,7 @@ \fBwchgat\fR, \fBmvchgat\fR, \fBmvwchgat\fR, -\fBPAIR_NUMBER\fR - \fBcurses\fR character and window attribute control routines +\fBPAIR_NUMBER\fR \- \fBcurses\fR character and window attribute control routines .ad .hy .SH SYNOPSIS @@ -152,7 +152,7 @@ rather than \fBint\fR. .PP The routine \fBchgat\fR changes the attributes of a given number of characters starting at the current cursor location of \fBstdscr\fR. It does not update -the cursor and does not perform wrapping. A character count of -1 or greater +the cursor and does not perform wrapping. A character count of \-1 or greater than the remaining window width means to change attributes all the way to the end of the current line. The \fBwchgat\fR function generalizes this to any window; the \fBmvwchgat\fR function does a cursor move before acting. In these @@ -223,6 +223,7 @@ Older versions of this library did not force an update of the screen when changing the attributes. Use \fBtouchwin\fR to force the screen to match the updated attributes. .PP +.ne 9 .TS center ; l l . @@ -252,19 +253,18 @@ X/Open does not define any error conditions. 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. +is outside the range 0..COLOR_PAIRS\-1. This implementation also provides \fBgetattrs\fR for compatibility with older versions of curses. +.PP +Functions with a "mv" prefix first perform a cursor movement using +\fBwmove\fP, and return an error if the position is outside the window, +or if the window pointer is null. .SH SEE ALSO \fBcurses\fR(3X), \fBcurs_addch\fR(3X), \fBcurs_addstr\fR(3X), \fBcurs_bkgd\fR(3X), -\fBcurs_printw\fR(3X) -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: +\fBcurs_printw\fR(3X), +\fBcurs_variables\fR(3X) diff --git a/man/curs_beep.3x b/man/curs_beep.3x index 49e5761..c6af6f0 100644 --- a/man/curs_beep.3x +++ b/man/curs_beep.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2003,2005 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2005,2010 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,10 +26,10 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_beep.3x,v 1.10 2005/01/08 17:55:51 tom Exp $ +.\" $Id: curs_beep.3x,v 1.12 2010/12/04 18:36:44 tom Exp $ .TH curs_beep 3X "" .SH NAME -\fBbeep\fR, \fBflash\fR - \fBcurses\fR bell and screen flash routines +\fBbeep\fR, \fBflash\fR \- \fBcurses\fR bell and screen flash routines .SH SYNOPSIS \fB#include <curses.h>\fR .PP @@ -55,9 +55,3 @@ These functions are described in the XSI Curses standard, Issue 4. Like SVr4, it specifies that they always return \fBOK\fR. .SH SEE ALSO \fBcurses\fR(3X) -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/curs_bkgd.3x b/man/curs_bkgd.3x index b2d768a..67e2ab8 100644 --- a/man/curs_bkgd.3x +++ b/man/curs_bkgd.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2002,2003 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2003,2010 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,12 +26,12 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_bkgd.3x,v 1.19 2003/12/27 18:50:40 tom Exp $ +.\" $Id: curs_bkgd.3x,v 1.22 2010/12/04 18:36:44 tom Exp $ .TH curs_bkgd 3X "" .SH NAME \fBbkgdset\fR, \fBwbkgdset\fR, \fBbkgd\fR, \fBwbkgd\fR, -\fBgetbkgd\fR - \fBcurses\fR window background manipulation routines +\fBgetbkgd\fR \- \fBcurses\fR window background manipulation routines .SH SYNOPSIS \fB#include <curses.h>\fR .PP @@ -83,16 +83,10 @@ but this appears to be an error. Note that \fBbkgdset\fR and \fBbkgd\fR may be macros. .SH PORTABILITY These functions are described in the XSI Curses standard, Issue 4. -It specifies that \fBbkgd\fR and \fBwbkgd\fR return \fBERR\fR on failure. +It specifies that \fBbkgd\fR and \fBwbkgd\fR return \fBERR\fR on failure, but gives no failure conditions. .SH SEE ALSO \fBcurses\fR(3X), \fBcurs_addch\fR(3X), \fBcurs_attr\fR(3X), \fBcurs_outopts\fR(3X) -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/curs_bkgrnd.3x b/man/curs_bkgrnd.3x index 8c6f6af..43112a7 100644 --- a/man/curs_bkgrnd.3x +++ b/man/curs_bkgrnd.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 2002-2004,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 2002-2006,2010 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_bkgrnd.3x,v 1.3 2006/02/25 21:49:19 tom Exp $ +.\" $Id: curs_bkgrnd.3x,v 1.4 2010/12/04 18:49:20 tom Exp $ .TH curs_bkgrnd 3X "" .SH NAME \fBbkgrnd\fR, @@ -98,9 +98,3 @@ A null window pointer is treated as an error. .SH SEE ALSO \fBcurses\fR(3X), \fBcurs_bkgd\fR(3X) -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/curs_border.3x b/man/curs_border.3x index 09f9a4c..5a58e9d 100644 --- a/man/curs_border.3x +++ b/man/curs_border.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2006,2007 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2007,2010 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.19 2007/02/24 16:15:38 tom Exp $ +.\" $Id: curs_border.3x,v 1.22 2010/12/04 18:36:44 tom Exp $ .TH curs_border 3X "" .na .hy 0 @@ -41,7 +41,7 @@ \fBmvhline\fR, \fBmvwhline\fR, \fBmvvline\fR, -\fBmvwvline\fR - create \fBcurses\fR borders, horizontal and vertical lines +\fBmvwvline\fR \- create \fBcurses\fR borders, horizontal and vertical lines .ad .hy .SH SYNOPSIS @@ -78,21 +78,21 @@ draw a box around the edges of a window. Other than the window, each argument is a character with attributes: .sp .RS -\fIls\fR - left side, +\fIls\fR \- left side, .br -\fIrs\fR - right side, +\fIrs\fR \- right side, .br -\fIts\fR - top side, +\fIts\fR \- top side, .br -\fIbs\fR - bottom side, +\fIbs\fR \- bottom side, .br -\fItl\fR - top left-hand corner, +\fItl\fR \- top left-hand corner, .br -\fItr\fR - top right-hand corner, +\fItr\fR \- top right-hand corner, .br -\fIbl\fR - bottom left-hand corner, and +\fIbl\fR \- bottom left-hand corner, and .br -\fIbr\fR - bottom right-hand corner. +\fIbr\fR \- bottom right-hand corner. .RE .PP If any of these arguments is zero, then the corresponding @@ -136,6 +136,10 @@ non-negative integer if \fBimmedok\fR is set", but this appears to be an error. X/Open does not define any error conditions. This implementation returns an error if the window pointer is null. +.PP +Functions with a "mv" prefix first perform a cursor movement using +\fBwmove\fP, and return an error if the position is outside the window, +or if the window pointer is null. .SH NOTES The borders generated by these functions are \fIinside\fR borders (this is also true of SVr4 curses, though the fact is not documented). @@ -147,9 +151,3 @@ The standard specifies that they return \fBERR\fR on failure, but specifies no error conditions. .SH SEE ALSO \fBcurses\fR(3X), \fBcurs_outopts\fR(3X). -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/curs_border_set.3x b/man/curs_border_set.3x index dbf8653..8f831dd 100644 --- a/man/curs_border_set.3x +++ b/man/curs_border_set.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 2002-2004,2005 Free Software Foundation, Inc. * +.\" Copyright (c) 2002-2010,2011 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * .\" copy of this software and associated documentation files (the * @@ -26,7 +26,7 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_border_set.3x,v 1.6 2005/05/15 16:17:37 tom Exp $ +.\" $Id: curs_border_set.3x,v 1.10 2011/01/15 12:56:18 tom Exp $ .TH curs_border_set 3X "" .na .hy 0 @@ -110,21 +110,21 @@ These functions do not change the cursor position, and do not wrap. .PP Other than the window, each argument is a complex character with attributes: .RS -\fIls\fR - left side, +\fIls\fR \- left side, .br -\fIrs\fR - right side, +\fIrs\fR \- right side, .br -\fIts\fR - top side, +\fIts\fR \- top side, .br -\fIbs\fR - bottom side, +\fIbs\fR \- bottom side, .br -\fItl\fR - top left-hand corner, +\fItl\fR \- top left-hand corner, .br -\fItr\fR - top right-hand corner, +\fItr\fR \- top right-hand corner, .br -\fIbl\fR - bottom left-hand corner, and +\fIbl\fR \- bottom left-hand corner, and .br -\fIbr\fR - bottom right-hand corner. +\fIbr\fR \- bottom right-hand corner. .RE .PP If any of these arguments is zero, then the corresponding @@ -195,13 +195,12 @@ Otherwise, they return \fBERR\fR. .PP Functions using a window parameter return an error if it is null. +.PP +Functions with a "mv" prefix first perform a cursor movement using +\fBwmove\fP, and return an error if the position is outside the window, +or if the window pointer is null. .SH SEE ALSO \fBncurses\fR(3X), +\fBcurs_add_wch\fR(3X), \fBcurs_border\fR(3X), \fBcurs_outopts\fR(3X) -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/curs_clear.3x b/man/curs_clear.3x index adbfd2c..305c608 100644 --- a/man/curs_clear.3x +++ b/man/curs_clear.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2005,2007 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2007,2010 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_clear.3x,v 1.11 2007/12/29 15:58:38 tom Exp $ +.\" $Id: curs_clear.3x,v 1.14 2010/12/04 18:36:44 tom Exp $ .TH curs_clear 3X "" .na .hy 0 @@ -38,7 +38,7 @@ \fBclrtobot\fR, \fBwclrtobot\fR, \fBclrtoeol\fR, -\fBwclrtoeol\fR - clear all or part of a \fBcurses\fR window +\fBwclrtoeol\fR \- clear all or part of a \fBcurses\fR window .ad .hy .SH SYNOPSIS @@ -112,10 +112,7 @@ even for a subwindow or derived window. If you do not want to clear the screen during the next \fBwrefresh\fP, use \fBwerase\fP instead. .SH SEE ALSO -\fBcurses\fR(3X), \fBcurs_outopts\fR(3X), \fBcurs_refresh\fR(3X) -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: +\fBcurses\fR(3X), +\fBcurs_outopts\fR(3X), +\fBcurs_refresh\fR(3X), +\fBcurs_variables\fR(3X) diff --git a/man/curs_color.3x b/man/curs_color.3x index 99e63ef..2f63c84 100644 --- a/man/curs_color.3x +++ b/man/curs_color.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2004,2005 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2009,2010 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,11 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_color.3x,v 1.28 2005/12/18 00:00:37 tom Exp $ +.\" $Id: curs_color.3x,v 1.35 2010/12/20 00:50:58 tom Exp $ .TH curs_color 3X "" +.de bP +.IP \(bu 4 +.. .na .hy 0 .SH NAME @@ -38,12 +41,12 @@ \fBcan_change_color\fR, \fBcolor_content\fR, \fBpair_content\fR, -\fBCOLOR_PAIR\fR - \fBcurses\fR color manipulation routines +\fBCOLOR_PAIR\fR \- \fBcurses\fR color manipulation routines .ad .hy .SH SYNOPSIS \fB# include <curses.h>\fR -.br +.sp \fBint start_color(void);\fR .br \fBint init_pair(short pair, short f, short b);\fR @@ -93,12 +96,13 @@ The \fBinit_pair\fR routine changes the definition of a color-pair. It takes three arguments: the number of the color-pair to be changed, the foreground color number, and the background color number. For portable applications: -.TP 5 -- +.bP The value of the first argument -must be between \fB1\fR and \fBCOLOR_PAIRS-1\fR. -.TP 5 -- +must be between \fB1\fR and \fBCOLOR_PAIRS\-1\fR, +except that if default colors are used (see \fBuse_default_colors\fP) +the upper limit is adjusted to allow for extra pairs which use +a default color in foreground and/or background. +.bP The value of the second and third arguments must be between 0 and \fBCOLORS\fR. Color pair 0 is assumed to be white on black, @@ -111,7 +115,7 @@ are changed to the new definition. .PP As an extension, ncurses allows you to set color pair 0 via the \fBassume_default_colors\fR routine, or to specify the use of -default colors (color number \fB-1\fR) if you first invoke the +default colors (color number \fB\-1\fR) if you first invoke the \fBuse_default_colors\fR routine. .PP The \fBinit_color\fR routine changes the definition of a color. It takes four @@ -147,7 +151,7 @@ The \fBpair_content\fR routine allows programmers to find out what colors a given color-pair consists of. It requires three arguments: the color-pair number, and two addresses of \fBshort\fRs for storing the foreground and the background color numbers. The value of the first argument must be between 1 -and \fBCOLOR_PAIRS-1\fR. The values that are stored at the addresses pointed +and \fBCOLOR_PAIRS\-1\fR. The values that are stored at the addresses pointed to by the second and third arguments are between 0 and \fBCOLORS\fR. .SS Colors In \fB<curses.h>\fR the following macros are defined. These are the default @@ -174,15 +178,15 @@ completion. .PP X/Open defines no error conditions. This implementation will return \fBERR\fR on attempts to -use color values outside the range 0 to COLORS-1 +use color values outside the range 0 to COLORS\-1 (except for the default colors extension), -or use color pairs outside the range 0 to COLOR_PAIR-1. +or use color pairs outside the range 0 to COLOR_PAIRS\-1. Color values used in \fBinit_color\fP must be in the range 0 to 1000. An error is returned from all functions if the terminal has not been initialized. An error is returned from secondary functions such as \fBinit_pair\fP if \fBstart_color\fP was not called. -.RS +.RS 3 .TP 5 \fBinit_color\fP returns an error if the terminal does not support @@ -190,8 +194,7 @@ this feature, e.g., if the \fIinitialize_color\fP capability is absent from the terminal description. .TP 5 \fBstart_color\fP -returns an error -If the color table cannot be allocated. +returns an error if the color table cannot be allocated. .RE .SH NOTES In the \fIncurses\fR implementation, there is a separate color activation flag, @@ -206,18 +209,15 @@ the background color used when parts of a window are blanked by erasing or scrolling operations, see \fBcurs_bkgd\fR(3X). .PP Several caveats apply on 386 and 486 machines with VGA-compatible graphics: -.TP 5 -- +.bP COLOR_YELLOW is actually brown. To get yellow, use COLOR_YELLOW combined with the \fBA_BOLD\fR attribute. -.TP 5 -- +.bP The A_BLINK attribute should in theory cause the background to go bright. This often fails to work, and even some cards for which it mostly works (such as the Paradise and compatibles) do the wrong thing when you try to set a bright "yellow" background (you get a blinking yellow foreground instead). -.TP 5 -- +.bP Color RGB values are not settable. .SH PORTABILITY This implementation satisfies XSI Curses's minimum maximums @@ -239,10 +239,5 @@ and will treat those as optional parameters when null. \fBcurses\fR(3X), \fBcurs_initscr\fR(3X), \fBcurs_attr\fR(3X), +\fBcurs_variables\fR(3X), \fBdefault_colors\fR(3X) -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/curs_delch.3x b/man/curs_delch.3x index 7026667..6dfc0a0 100644 --- a/man/curs_delch.3x +++ b/man/curs_delch.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2000,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2006,2010 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,13 +26,13 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_delch.3x,v 1.8 2006/02/25 21:42:57 tom Exp $ +.\" $Id: curs_delch.3x,v 1.11 2010/12/04 18:36:44 tom Exp $ .TH curs_delch 3X "" .SH NAME \fBdelch\fR, \fBwdelch\fR, \fBmvdelch\fR, -\fBmvwdelch\fR - delete character under the cursor in a \fBcurses\fR window +\fBmvwdelch\fR \- delete character under the cursor in a \fBcurses\fR window .SH SYNOPSIS \fB#include <curses.h>\fR .sp @@ -54,6 +54,10 @@ imply use of the hardware delete character feature.) All routines return the integer \fBERR\fR upon failure and an \fBOK\fR (SVr4 specifies only "an integer value other than \fBERR\fR") upon successful completion. +.PP +Functions with a "mv" prefix first perform a cursor movement using +\fBwmove\fP, and return an error if the position is outside the window, +or if the window pointer is null. .SH NOTES Note that \fBdelch\fR, \fBmvdelch\fR, and \fBmvwdelch\fR may be macros. .SH PORTABILITY @@ -62,9 +66,3 @@ standard specifies that they return \fBERR\fR on failure, but specifies no error conditions. .SH SEE ALSO \fBcurses\fR(3X) -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/curs_deleteln.3x b/man/curs_deleteln.3x index fc7b16a..83cbdec 100644 --- a/man/curs_deleteln.3x +++ b/man/curs_deleteln.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2006,2007 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2007,2010 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.11 2007/06/02 20:40:07 tom Exp $ +.\" $Id: curs_deleteln.3x,v 1.13 2010/12/04 18:36:44 tom Exp $ .TH curs_deleteln 3X "" .SH NAME \fBdeleteln\fR, @@ -34,7 +34,7 @@ \fBinsdelln\fR, \fBwinsdelln\fR, \fBinsertln\fR, -\fBwinsertln\fR - delete and insert lines in a \fBcurses\fR window +\fBwinsertln\fR \- delete and insert lines in a \fBcurses\fR window .SH SYNOPSIS \fB#include <curses.h>\fR .sp @@ -83,9 +83,3 @@ 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) -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/curs_extend.3x b/man/curs_extend.3x index 3092253..9a52f93 100644 --- a/man/curs_extend.3x +++ b/man/curs_extend.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1999-2004,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 1999-2006,2010 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 * @@ -28,7 +28,7 @@ .\" .\" Author: Thomas E. Dickey 1999-on .\" -.\" $Id: curs_extend.3x,v 1.17 2006/12/24 18:01:48 tom Exp $ +.\" $Id: curs_extend.3x,v 1.19 2010/12/04 18:36:44 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 \fB@TIC@\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. @@ -77,9 +77,3 @@ any code depending on them be conditioned using NCURSES_VERSION. \fBwresize\fR(3X). .SH AUTHOR Thomas Dickey. -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/curs_get_wch.3x b/man/curs_get_wch.3x index 6ecff79..fe49849 100644 --- a/man/curs_get_wch.3x +++ b/man/curs_get_wch.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 2002-2003,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 2002-2006,2010 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_get_wch.3x,v 1.6 2006/02/25 21:47:06 tom Exp $ +.\" $Id: curs_get_wch.3x,v 1.7 2010/08/14 23:31:42 tom Exp $ .TH curs_get_wch 3X "" .SH NAME \fBget_wch\fR, @@ -152,6 +152,10 @@ returns \fBOK\fR. Otherwise, the function returns \fBERR\fR. +.PP +Functions with a "mv" prefix first perform a cursor movement using +\fBwmove\fP, and return an error if the position is outside the window, +or if the window pointer is null. .SH SEE ALSO \fBcurses\fR(3X), \fBcurs_getch\fR(3X), diff --git a/man/curs_get_wstr.3x b/man/curs_get_wstr.3x index 4286c78..9beb177 100644 --- a/man/curs_get_wstr.3x +++ b/man/curs_get_wstr.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 2002-2005,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 2002-2006,2010 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_get_wstr.3x,v 1.6 2006/02/25 21:49:19 tom Exp $ +.\" $Id: curs_get_wstr.3x,v 1.8 2010/12/04 18:36:44 tom Exp $ .TH curs_get_wstr 3X "" .na .hy 0 @@ -154,6 +154,10 @@ Functions using a window parameter return an error if it is null. \fBwgetn_wstr\fP returns an error if the associated call to \fBwget_wch\fP failed. .RE +.PP +Functions with a "mv" prefix first perform a cursor movement using +\fBwmove\fP, and return an error if the position is outside the window, +or if the window pointer is null. .SH PORTABILITY These functions are described in The Single Unix Specification, Version 2. No error conditions are defined. @@ -170,9 +174,3 @@ Functions: \fBcurses\fR(3X), \fBcurs_get_wch\fR(3X), \fBcurs_getstr\fR(3X). -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/curs_getcchar.3x b/man/curs_getcchar.3x index cb02f5d..1b878f3 100644 --- a/man/curs_getcchar.3x +++ b/man/curs_getcchar.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 2001-2006,2008 Free Software Foundation, Inc. * +.\" Copyright (c) 2001-2009,2010 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,11 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_getcchar.3x,v 1.11 2008/05/17 19:37:05 tom Exp $ +.\" $Id: curs_getcchar.3x,v 1.15 2010/12/04 18:36:44 tom Exp $ .TH curs_getcchar 3X "" +.de bP +.IP \(bu 4 +.. .SH NAME \fBgetcchar\fP, \fBsetcchar\fP \- Get a wide character string and rendition from a \fBcchar_t\fP or set a \fBcchar_t\fP from a wide-character string @@ -63,17 +66,13 @@ The \fBgetcchar\fP function gets a wide-character string and rendition from a \fBcchar_t\fP argument. When \fIwch\fP is not a null pointer, the \fBgetcchar\fP function does the following: -.TP 5 -- +.bP Extracts information from a \fBcchar_t\fP value \fIwcval\fP -.TP 5 -- +.bP Stores the character attributes in the location pointed to by \fIattrs\fP -.TP 5 -- +.bP Stores the color-pair in the location pointed to by \fIcolor_pair\fP -.TP 5 -- +.bP Stores the wide-character string, characters referenced by \fIwcval\fP, into the array pointed to by \fIwch\fP. .PP @@ -82,11 +81,9 @@ When is a null pointer, the \fBgetcchar\fP function does the following: -.TP 5 -- +.bP Obtains the number of wide characters pointed to by \fIwcval\fP -.TP 5 -- +.bP Does not change the data referenced by \fIattrs\fP or @@ -94,22 +91,19 @@ or .PP The \fBsetcchar\fP function initializes the location pointed to by \fIwcval\fP by using: -.TP 5 -- +.bP The character attributes in \fIattrs\fP -.TP 5 -- +.bP The color pair in \fIcolor_pair\fP -.TP 5 -- +.bP The wide-character string pointed to by \fIwch\fP. The string must be L'\\0' terminated, contain at most one spacing character, which must be the first. .IP -Up to \fBCCHARW_MAX\fP-1 nonspacing characters may follow. +Up to \fBCCHARW_MAX\fP\-1 nonspacing characters may follow. Additional nonspacing characters are ignored. .IP The string may contain a single control character instead. @@ -126,7 +120,8 @@ If \fIwcval\fP is constructed by any other means, the effect is unspecified. .PP When \fIwch\fP is a null pointer, \fBgetcchar\fP returns the number of wide characters referenced by -\fIwcval\fP. +\fIwcval\fP, +including one for a trailing null. .PP When \fIwch\fP is not a null pointer, \fBgetcchar\fP returns \fBOK\fP upon successful completion, @@ -141,9 +136,3 @@ Functions: \fBcurs_color\fR(3X), \fBcurses\fR(3X), \fBwcwidth\fR(3). -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/curs_getch.3x b/man/curs_getch.3x index 71fed5f..2d5d6fd 100644 --- a/man/curs_getch.3x +++ b/man/curs_getch.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998-2005,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2010,2011 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * .\" copy of this software and associated documentation files (the * @@ -27,10 +27,13 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_getch.3x,v 1.30 2006/12/02 17:02:53 tom Exp $ +.\" $Id: curs_getch.3x,v 1.36 2011/01/22 19:38:51 tom Exp $ .TH curs_getch 3X "" .na .hy 0 +.de bP +.IP \(bu 4 +.. .SH NAME \fBgetch\fR, \fBwgetch\fR, @@ -71,7 +74,7 @@ specified timeout has been reached. Unless \fBnoecho\fR has been set, then the character will also be echoed into the designated window according to the following rules: -If the character is the current erase character, left arrow, or backspace, +if the character is the current erase character, left arrow, or backspace, the cursor is moved one space to the left and that screen position is erased as if \fBdelch\fR had been called. If the character value is any other \fBKEY_\fR define, the user is alerted @@ -245,6 +248,10 @@ returns an error if the window pointer is null, or if its timeout expires without having any data. .RE +.PP +Functions with a "mv" prefix first perform a cursor movement using +\fBwmove\fP, and return an error if the position is outside the window, +or if the window pointer is null. .SH NOTES Use of the escape key by a programmer for a single character function is discouraged, as it will cause a delay of up to one second while the @@ -260,6 +267,20 @@ If it says that \fBKEY_ENTER\fP is control/M, \fBgetch\fR will return \fBKEY_ENTER\fP when you press control/M. .PP +Generally, \fBKEY_ENTER\fP denotes the character(s) sent by the \fIEnter\fP +key on the numeric keypad: +.bP +the terminal description lists the most useful keys, +.bP +the \fIEnter\fP key on the regular keyboard is already handled by +the standard ASCII characters for carriage-return and line-feed, +.bP +depending on whether \fBnl\fP or \fBnonl\fP was called, +pressing "Enter" on the regular keyboard may return either a carriage-return +or line-feed, and finally +.bP +"Enter or send" is the standard description for this key. +.PP When using \fBgetch\fR, \fBwgetch\fR, \fBmvgetch\fR, or \fBmvwgetch\fR, nocbreak mode (\fBnocbreak\fR) and echo mode (\fBecho\fR) should not be used at the same time. @@ -312,6 +333,7 @@ any code using it be conditionalized on the \fBNCURSES_VERSION\fR feature macro. .SH SEE ALSO \fBcurses\fR(3X), \fBcurs_inopts\fR(3X), +\fBcurs_outopts\fR(3X), \fBcurs_mouse\fR(3X), \fBcurs_move\fR(3X), \fBcurs_refresh\fR(3X), @@ -320,9 +342,3 @@ any code using it be conditionalized on the \fBNCURSES_VERSION\fR feature macro. Comparable functions in the wide-character (ncursesw) library are described in \fBcurs_get_wch\fR(3X). -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/curs_getstr.3x b/man/curs_getstr.3x index f131765..e548cf1 100644 --- a/man/curs_getstr.3x +++ b/man/curs_getstr.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2003,2005 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2005,2010 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_getstr.3x,v 1.15 2006/01/12 00:30:58 tom Exp $ +.\" $Id: curs_getstr.3x,v 1.19 2010/12/04 18:36:44 tom Exp $ .TH curs_getstr 3X "" .na .hy 0 @@ -38,7 +38,7 @@ \fBmvgetstr\fR, \fBmvgetnstr\fR, \fBmvwgetstr\fR, -\fBmvwgetnstr\fR - accept character strings from \fBcurses\fR terminal keyboard +\fBmvwgetnstr\fR \- accept character strings from \fBcurses\fR terminal keyboard .ad .hy .SH SYNOPSIS @@ -94,6 +94,10 @@ if its timeout expires without having any data. This implementation provides an extension as well. If a SIGWINCH interrupts the function, it will return \fBKEY_RESIZE\fP rather than \fBOK\fP or \fBERR\fP. +.PP +Functions with a "mv" prefix first perform a cursor movement using +\fBwmove\fP, and return an error if the position is outside the window, +or if the window pointer is null. .SH NOTES Note that \fBgetstr\fR, \fBmvgetstr\fR, and \fBmvwgetstr\fR may be macros. .SH PORTABILITY @@ -113,10 +117,6 @@ string by those implementations was predictable but not useful The functions \fBgetnstr\fR, \fBmvgetnstr\fR, and \fBmvwgetnstr\fR were present but not documented in SVr4. .SH SEE ALSO -\fBcurses\fR(3X), \fBcurs_getch\fR(3X). -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: +\fBcurses\fR(3X), +\fBcurs_getch\fR(3X), +\fBcurs_variables\fR(3X). diff --git a/man/curs_getyx.3x b/man/curs_getyx.3x index 2581253..980968e 100644 --- a/man/curs_getyx.3x +++ b/man/curs_getyx.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2006,2007 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2007,2010 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,13 +26,13 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_getyx.3x,v 1.16 2007/05/12 16:34:49 tom Exp $ +.\" $Id: curs_getyx.3x,v 1.18 2010/12/04 18:36:44 tom Exp $ .TH curs_getyx 3X "" .SH NAME \fBgetyx\fR, \fBgetparyx\fR, \fBgetbegyx\fR, -\fBgetmaxyx\fR - get \fBcurses\fR cursor and window coordinates +\fBgetmaxyx\fR \- get \fBcurses\fR cursor and window coordinates .SH SYNOPSIS \fB#include <curses.h>\fR .sp @@ -51,7 +51,7 @@ the two integer variables \fIy\fR and \fIx\fR. If \fIwin\fR is a subwindow, the \fBgetparyx\fR macro places the beginning coordinates of the subwindow relative to the parent window into two integer variables \fIy\fR and \fIx\fR. -Otherwise, \fB-1\fR is placed into \fIy\fR and \fIx\fR. +Otherwise, \fB\-1\fR is placed into \fIy\fR and \fIx\fR. .PP Like \fBgetyx\fR, the \fBgetbegyx\fR and \fBgetmaxyx\fR macros store the current beginning coordinates and size of the specified window. @@ -98,9 +98,3 @@ The difference is hidden by means of the macro \fBgetmaxyx\fP. \fBcurses\fR(3X), \fBcurs_legacy\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/man/curs_in_wch.3x b/man/curs_in_wch.3x index 8709d13..5f50e5a 100644 --- a/man/curs_in_wch.3x +++ b/man/curs_in_wch.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 2002,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 2002-2006,2010 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,13 +26,13 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_in_wch.3x,v 1.2 2006/02/25 21:42:22 tom Exp $ +.\" $Id: curs_in_wch.3x,v 1.5 2010/12/04 18:36:44 tom Exp $ .TH curs_in_wch 3X "" .SH NAME \fBin_wch\fR, \fBmvin_wch\fR, \fBmvwin_wch\fR, -\fBwin_wch\fR - extract a complex character and rendition from a window +\fBwin_wch\fR \- extract a complex character and rendition from a window .SH SYNOPSIS \fB#include <curses.h>\fR .sp @@ -53,6 +53,10 @@ This implementation checks for null pointers, returns ERR in that case. Also, the \fImv\fR routines check for error moving the cursor, returning ERR in that case. Otherwise they return OK +.PP +Functions with a "mv" prefix first perform a cursor movement using +\fBwmove\fP, and return an error if the position is outside the window, +or if the window pointer is null. .SH NOTES Note that all of these routines may be macros. .SH PORTABILITY @@ -60,9 +64,3 @@ These functions are described in the XSI Curses standard, Issue 4. .SH SEE ALSO \fBcurses\fR(3X), \fBcurs_inch\fR(3X). -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/curs_in_wchstr.3x b/man/curs_in_wchstr.3x index b04a1f5..042abfd 100644 --- a/man/curs_in_wchstr.3x +++ b/man/curs_in_wchstr.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 2002-2005,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 2002-2006,2010 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_in_wchstr.3x,v 1.6 2006/12/02 17:03:07 tom Exp $ +.\" $Id: curs_in_wchstr.3x,v 1.8 2010/12/04 18:36:44 tom Exp $ .TH curs_in_wchstr 3X "" .na .hy 0 @@ -103,6 +103,10 @@ Upon successful completion, these functions return \fBOK\fR. Otherwise, they return \fBERR\fR. +.PP +Functions with a "mv" prefix first perform a cursor movement using +\fBwmove\fP, and return an error if the position is outside the window, +or if the window pointer is null. .SH PORTABILITY The XSI Curses defines no error conditions. This implementation checks for null pointers, @@ -114,9 +118,3 @@ Functions: \fBcurs_instr\fR(3X), \fBcurs_inwstr\fR(3X) \fBcurs_inchstr\fR(3X) -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/curs_inch.3x b/man/curs_inch.3x index 3091b9c..7e1e3b4 100644 --- a/man/curs_inch.3x +++ b/man/curs_inch.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2006,2010 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,11 +27,13 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_inch.3x,v 1.13 2006/12/02 16:58:55 tom Exp $ +.\" $Id: curs_inch.3x,v 1.17 2010/12/04 18:36:44 tom Exp $ .TH curs_inch 3X "" .SH NAME -\fBinch\fR, \fBwinch\fR, \fBmvinch\fR, \fBmvwinch\fR -- get a character and attributes from a \fBcurses\fR window +\fBinch\fR, +\fBwinch\fR, +\fBmvinch\fR, +\fBmvwinch\fR \- get a character and attributes from a \fBcurses\fR window .SH SYNOPSIS \fB#include <curses.h>\fR .sp @@ -59,6 +61,10 @@ l l . \fBA_ATTRIBUTES\fR Bit-mask to extract attributes \fBA_COLOR\fR Bit-mask to extract color-pair field information .TE +.SH RETURN VALUE +Functions with a "mv" prefix first perform a cursor movement using +\fBwmove\fP, and return an error if the position is outside the window, +or if the window pointer is null. .SH NOTES Note that all of these routines may be macros. .SH PORTABILITY @@ -69,9 +75,3 @@ These functions are described in the XSI Curses standard, Issue 4. Comparable functions in the wide-character (ncursesw) library are described in \fBcurs_in_wch\fR(3X). -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/curs_inchstr.3x b/man/curs_inchstr.3x index 18c21dc..2dc7673 100644 --- a/man/curs_inchstr.3x +++ b/man/curs_inchstr.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2005,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2006,2010 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_inchstr.3x,v 1.12 2006/12/02 17:00:58 tom Exp $ +.\" $Id: curs_inchstr.3x,v 1.15 2010/12/04 18:36:44 tom Exp $ .TH curs_inchstr 3X "" .na .hy 0 @@ -38,7 +38,7 @@ \fBmvinchstr\fR, \fBmvinchnstr\fR, \fBmvwinchstr\fR, -\fBmvwinchnstr\fR - get a string of characters (and attributes) from a \fBcurses\fR window +\fBmvwinchnstr\fR \- get a string of characters (and attributes) from a \fBcurses\fR window .ad .hy .SH SYNOPSIS @@ -78,9 +78,13 @@ No error conditions are defined. If the \fIchstr\fP parameter is null, no data is returned, and the return value is zero. +.PP +Functions with a "mv" prefix first perform a cursor movement using +\fBwmove\fP, and return an error if the position is outside the window, +or if the window pointer is null. .SH NOTES Note that all routines except \fBwinchnstr\fR may be macros. SVr4 does not -document whether the result string is 0-terminated; it does not document +document whether the result string is zero-terminated; it does not document whether a length limit argument includes any trailing 0; and it does not document the meaning of the return value. .SH PORTABILITY @@ -93,9 +97,3 @@ that the successful return of the functions is \fBOK\fR. Comparable functions in the wide-character (ncursesw) library are described in \fBcurs_in_wchstr\fR(3X). -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/curs_initscr.3x b/man/curs_initscr.3x index 1a865f9..83a01ea 100644 --- a/man/curs_initscr.3x +++ b/man/curs_initscr.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2003,2005 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2005,2010 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_initscr.3x,v 1.14 2005/05/15 16:18:01 tom Exp $ +.\" $Id: curs_initscr.3x,v 1.17 2010/12/04 18:36:58 tom Exp $ .TH curs_initscr 3X "" .na .hy 0 @@ -36,7 +36,7 @@ \fBendwin\fR, \fBisendwin\fR, \fBset_term\fR, -\fBdelscreen\fR - \fBcurses\fR screen initialization and manipulation routines +\fBdelscreen\fR \- \fBcurses\fR screen initialization and manipulation routines .ad .hy .SH SYNOPSIS @@ -122,11 +122,9 @@ from \fBinitscr\fR when an error is detected, rather than exiting. It is safe but redundant to check the return value of \fBinitscr\fR in XSI Curses. .SH SEE ALSO -\fBcurses\fR(3X), \fBcurs_kernel\fR(3X), \fBcurs_refresh\fR(3X), -\fBcurs_slk\fR(3X), \fBcurs_util\fR(3X) -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: +\fBcurses\fR(3X), +\fBcurs_kernel\fR(3X), +\fBcurs_refresh\fR(3X), +\fBcurs_slk\fR(3X), +\fBcurs_util\fR(3X), +\fBcurs_variables\fR(3X). diff --git a/man/curs_inopts.3x b/man/curs_inopts.3x index 7b5a17b..aecb2e3 100644 --- a/man/curs_inopts.3x +++ b/man/curs_inopts.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2003,2005 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2005,2010 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_inopts.3x,v 1.13 2005/05/15 16:18:07 tom Exp $ +.\" $Id: curs_inopts.3x,v 1.15 2010/12/04 18:40:45 tom Exp $ .TH curs_inopts 3X "" .na .hy 0 @@ -47,7 +47,7 @@ \fBqiflush\fR, \fBtimeout\fR, \fBwtimeout\fR, -\fBtypeahead\fR - \fBcurses\fR input options +\fBtypeahead\fR \- \fBcurses\fR input options .ad .hy .SH SYNOPSIS @@ -197,7 +197,7 @@ pointer passed to \fBnewterm\fR, or \fBstdin\fR in the case that \fBinitscr\fR was used, will be used to do this typeahead checking. The \fBtypeahead\fR routine specifies that the file descriptor \fIfd\fR is to be used to check for typeahead instead. If \fIfd\fR is --1, then no typeahead checking is done. +\-1, then no typeahead checking is done. .SH RETURN VALUE All routines that return an integer return \fBERR\fR upon failure and OK (SVr4 specifies only "an integer value other than \fBERR\fR") upon successful @@ -234,9 +234,3 @@ respectively. Mixing raw/noraw and cbreak/nocbreak calls leads to tty driver control states that are hard to predict or understand; it is not recommended. .SH SEE ALSO \fBcurses\fR(3X), \fBcurs_getch\fR(3X), \fBcurs_initscr\fR(3X), \fBtermio\fR(7) -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/curs_ins_wch.3x b/man/curs_ins_wch.3x index bb8a9a3..4c6a925 100644 --- a/man/curs_ins_wch.3x +++ b/man/curs_ins_wch.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 2002,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 2002-2006,2010 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_ins_wch.3x,v 1.3 2006/02/25 21:42:22 tom Exp $ +.\" $Id: curs_ins_wch.3x,v 1.5 2010/12/04 18:38:55 tom Exp $ .TH curs_ins_wch 3X "" .SH NAME \fBins_wch\fR, @@ -52,14 +52,12 @@ The insertion operation does not change the cursor position. .SH RETURN VALUE If successful, these functions return OK. If not, they return ERR. +.PP +Functions with a "mv" prefix first perform a cursor movement using +\fBwmove\fP, and return an error if the position is outside the window, +or if the window pointer is null. .SH ERRORS No errors are defined. .SH SEE ALSO \fBcurses\fR(3X), \fBcurs_insch\fR(3X). -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/curs_ins_wstr.3x b/man/curs_ins_wstr.3x index 0c153c4..d016545 100644 --- a/man/curs_ins_wstr.3x +++ b/man/curs_ins_wstr.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 2002,2005 Free Software Foundation, Inc. * +.\" Copyright (c) 2002-2005,2010 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_ins_wstr.3x,v 1.4 2005/05/15 17:02:54 tom Exp $ +.\" $Id: curs_ins_wstr.3x,v 1.6 2010/12/04 18:38:55 tom Exp $ .TH curs_ins_wstr 3X "" .na .hy 0 @@ -95,14 +95,12 @@ a control character. .SH RETURN VALUES Upon successful completion, these functions return OK. Otherwise, they return ERR. +.PP +Functions with a "mv" prefix first perform a cursor movement using +\fBwmove\fP, and return an error if the position is outside the window, +or if the window pointer is null. .SH SEE ALSO \fBcurses\fR(3X), \fBcurs_insstr\fR(3X), \fBcurs_in_wch\fR(3X), \fBcurs_ins_wch\fR(3X). -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/curs_insch.3x b/man/curs_insch.3x index 78ab5a5..77e92ec 100644 --- a/man/curs_insch.3x +++ b/man/curs_insch.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2003,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2006,2010 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,13 +26,13 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_insch.3x,v 1.10 2006/12/02 17:01:50 tom Exp $ +.\" $Id: curs_insch.3x,v 1.13 2010/12/04 18:38:55 tom Exp $ .TH curs_insch 3X "" .SH NAME \fBinsch\fR, \fBwinsch\fR, \fBmvinsch\fR, -\fBmvwinsch\fR - insert a character before cursor in a \fBcurses\fR window +\fBmvwinsch\fR \- insert a character before cursor in a \fBcurses\fR window .SH SYNOPSIS \fB#include <curses.h>\fR .sp @@ -53,6 +53,10 @@ The insertion operation does not change the cursor position. All routines that return an integer return \fBERR\fR upon failure and OK (SVr4 specifies only "an integer value other than \fBERR\fR") upon successful completion, unless otherwise noted in the preceding routine descriptions. +.PP +Functions with a "mv" prefix first perform a cursor movement using +\fBwmove\fP, and return an error if the position is outside the window, +or if the window pointer is null. .SH NOTES These routines do not necessarily imply use of a hardware insert character feature. @@ -66,9 +70,3 @@ These functions are described in the XSI Curses standard, Issue 4. Comparable functions in the wide-character (ncursesw) library are described in \fBcurs_ins_wch\fR(3X). -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/curs_insstr.3x b/man/curs_insstr.3x index 1536ea2..3e38a53 100644 --- a/man/curs_insstr.3x +++ b/man/curs_insstr.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2005,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2006,2010 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_insstr.3x,v 1.18 2006/12/24 14:59:30 tom Exp $ +.\" $Id: curs_insstr.3x,v 1.21 2010/12/04 18:38:55 tom Exp $ .TH curs_insstr 3X "" .SH NAME \fBinsstr\fR, @@ -36,7 +36,7 @@ \fBmvinsstr\fR, \fBmvinsnstr\fR, \fBmvwinsstr\fR, -\fBmvwinsnstr\fR - insert string before cursor in a \fBcurses\fR window +\fBmvwinsnstr\fR \- insert string before cursor in a \fBcurses\fR window .SH SYNOPSIS \fB#include <curses.h>\fR .br @@ -78,6 +78,10 @@ X/Open defines no error conditions. In this implementation, if the window parameter is null or the str parameter is null, an error is returned. +.PP +Functions with a "mv" prefix first perform a cursor movement using +\fBwmove\fP, and return an error if the position is outside the window, +or if the window pointer is null. .SH NOTES Note that all but \fBwinsnstr\fR may be macros. .SH PORTABILITY @@ -93,9 +97,3 @@ Also, no implementation of curses documents this inconsistency. \fBcurs_util\fR(3X), \fBcurs_clear\fR(3X), \fBcurs_inch\fR(3X). -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/curs_instr.3x b/man/curs_instr.3x index a93de27..1b17db9 100644 --- a/man/curs_instr.3x +++ b/man/curs_instr.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2005,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2006,2010 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_instr.3x,v 1.13 2006/02/25 21:49:19 tom Exp $ +.\" $Id: curs_instr.3x,v 1.16 2010/12/04 18:38:55 tom Exp $ .TH curs_instr 3X "" .SH NAME \fBinstr\fR, @@ -36,7 +36,7 @@ \fBmvinstr\fR, \fBmvinnstr\fR, \fBmvwinstr\fR, -\fBmvwinnstr\fR - get a string of characters from a \fBcurses\fR window +\fBmvwinnstr\fR \- get a string of characters from a \fBcurses\fR window .SH SYNOPSIS \fB#include <curses.h>\fR .sp @@ -70,6 +70,10 @@ X/Open defines no error conditions. In this implementation, if the window parameter is null or the str parameter is null, a zero is returned. +.PP +Functions with a "mv" prefix first perform a cursor movement using +\fBwmove\fP, and return an error if the position is outside the window, +or if the window pointer is null. .SH NOTES Note that all routines except \fBwinnstr\fR may be macros. .SH PORTABILITY @@ -81,9 +85,3 @@ value for \fIn\fR. In this case, the functions return the string ending at the right margin. .SH SEE ALSO \fBcurses\fR(3X). -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/curs_inwstr.3x b/man/curs_inwstr.3x index 990789c..966c7b4 100644 --- a/man/curs_inwstr.3x +++ b/man/curs_inwstr.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 2002-2005,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 2002-2006,2010 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_inwstr.3x,v 1.5 2006/02/25 21:20:20 tom Exp $ +.\" $Id: curs_inwstr.3x,v 1.7 2010/12/04 18:38:55 tom Exp $ .TH curs_inwstr 3X "" .SH NAME \fBinwstr\fR, @@ -81,13 +81,11 @@ routines return \fBOK\fR, and the *\fBinnwstr\fR routines return the number of characters read into the string. +.PP +Functions with a "mv" prefix first perform a cursor movement using +\fBwmove\fP, and return an error if the position is outside the window, +or if the window pointer is null. .SH SEE ALSO \fBcurses\fR(3X), \fBcurs_instr\fR(3X), \fBcurs_in_wchstr\fR(3X) -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/curs_kernel.3x b/man/curs_kernel.3x index 9403973..d81b134 100644 --- a/man/curs_kernel.3x +++ b/man/curs_kernel.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2001,2005 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2005,2010 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_kernel.3x,v 1.15 2005/05/15 16:18:13 tom Exp $ +.\" $Id: curs_kernel.3x,v 1.19 2010/12/04 18:38:55 tom Exp $ .TH curs_kernel 3X "" .na .hy 0 @@ -41,7 +41,7 @@ \fBsetsyx\fR, \fBripoffline\fR, \fBcurs_set\fR, -\fBnapms\fR - low-level \fBcurses\fR routines +\fBnapms\fR \- low-level \fBcurses\fR routines .ad .hy .SH SYNOPSIS @@ -71,7 +71,7 @@ .br .SH DESCRIPTION The following routines give low-level access to various \fBcurses\fR -capabilities. Theses routines typically are used inside library +capabilities. These routines typically are used inside library routines. .PP The \fBdef_prog_mode\fR and \fBdef_shell_mode\fR routines save the @@ -94,13 +94,13 @@ last call to \fBsavetty\fR. .PP The \fBgetsyx\fR routine returns the current coordinates of the virtual screen cursor in \fIy\fR and \fIx\fR. If \fBleaveok\fR is currently \fBTRUE\fR, then -\fB-1\fR,\fB-1\fR is returned. If lines have been removed from the top of the +\fB\-1\fR,\fB\-1\fR is returned. If lines have been removed from the top of the screen, using \fBripoffline\fR, \fIy\fR and \fIx\fR include these lines; therefore, \fIy\fR and \fIx\fR should be used only as arguments for \fBsetsyx\fR. .PP The \fBsetsyx\fR routine sets the virtual screen cursor to -\fIy\fR, \fIx\fR. If \fIy\fR and \fIx\fR are both \fB-1\fR, then +\fIy\fR, \fIx\fR. If \fIy\fR and \fIx\fR are both \fB\-1\fR, then \fBleaveok\fR is set. The two routines \fBgetsyx\fR and \fBsetsyx\fR are designed to be used by a library routine, which manipulates \fBcurses\fR windows but does not want to change the current position @@ -127,7 +127,7 @@ routine. \fBripoffline\fR can be called up to five times before calling \fBinitscr\fR or \fBnewterm\fR. .PP -The \fBcurs_set\fR routine sets the cursor state is set to invisible, +The \fBcurs_set\fR routine sets the cursor state to invisible, normal, or very visible for \fBvisibility\fR equal to \fB0\fR, \fB1\fR, or \fB2\fR respectively. If the terminal supports the \fIvisibility\fR requested, the previous \fIcursor\fR state is @@ -176,11 +176,10 @@ The SVr4 documentation describes \fBsetsyx\fR and \fBgetsyx\fR as having return type int. This is misleading, as they are macros with no documented semantics for the return value. .SH SEE ALSO -\fBcurses\fR(3X), \fBcurs_initscr\fR(3X), \fBcurs_outopts\fR(3X), \fBcurs_refresh\fR(3X), -\fBcurs_scr_dump\fR(3X), \fBcurs_slk\fR(3X) -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: +\fBcurses\fR(3X), +\fBcurs_initscr\fR(3X), +\fBcurs_outopts\fR(3X), +\fBcurs_refresh\fR(3X), +\fBcurs_scr_dump\fR(3X), +\fBcurs_slk\fR(3X), +\fBcurs_variables\fR(3X). diff --git a/man/curs_legacy.3x b/man/curs_legacy.3x index 251ae49..febaf29 100644 --- a/man/curs_legacy.3x +++ b/man/curs_legacy.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 2007 Free Software Foundation, Inc. * +.\" Copyright (c) 2007,2010 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,20 +26,15 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_legacy.3x,v 1.1 2007/04/07 23:54:29 tom Exp $ +.\" $Id: curs_legacy.3x,v 1.5 2010/12/04 18:38:55 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 +getattrs \- get \fBcurses\fR cursor and window coordinates, attributes .SH SYNOPSIS \fB#include <curses.h>\fR .sp +\fBint getattrs(WINDOW *win);\fR +.br \fBint getbegx(WINDOW *win);\fR .br \fBint getbegy(WINDOW *win);\fR @@ -85,9 +80,3 @@ These functions were supported on Version 7, BSD or System V implementations. \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/man/curs_memleaks.3x b/man/curs_memleaks.3x index a8a4552..5ebc0d0 100644 --- a/man/curs_memleaks.3x +++ b/man/curs_memleaks.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 2008 Free Software Foundation, Inc. * +.\" Copyright (c) 2008,2010 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,13 +26,13 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_memleaks.3x,v 1.1 2008/10/25 23:38:13 tom Exp $ +.\" $Id: curs_memleaks.3x,v 1.3 2010/12/04 18:40:45 tom Exp $ .TH curs_memleaks 3X "" .na .hy 0 .SH NAME \fB_nc_freeall\fP -\fB_nc_free_and_exit\fP - \fBcurses\fR memory-leak checking +\fB_nc_free_and_exit\fP \- \fBcurses\fR memory-leak checking .ad .hy .SH SYNOPSIS @@ -45,7 +45,7 @@ These functions are used to simplify analysis of memory leaks in the ncurses library. They are normally not available; they must be configured into the library -at build time using the \fB--disable-leaks\fP option. +at build time using the \fB\-\-disable-leaks\fP option. That compiles-in code that frees memory that normally would not be freed. .PP Any implementation of curses must not free the memory associated with @@ -67,9 +67,3 @@ These functions do not return a value. These functions are not part of the XSI interface. .SH SEE ALSO \fBcurses\fR(3X). -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/curs_mouse.3x b/man/curs_mouse.3x index 23f9f9c..01dc682 100644 --- a/man/curs_mouse.3x +++ b/man/curs_mouse.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998-2005,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2009,2010 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,15 +27,16 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_mouse.3x,v 1.30 2006/12/30 23:43:34 tom Exp $ +.\" $Id: curs_mouse.3x,v 1.38 2010/12/04 18:38:55 tom Exp $ .TH curs_mouse 3X "" .na .hy 0 .SH NAME +\fBhas_mouse\fR, \fBgetmouse\fR, \fBungetmouse\fR, \fBmousemask\fR, \fBwenclose\fR, \fBmouse_trafo\fR, \fBwmouse_trafo\fR, -\fBmouseinterval\fR - mouse interface through curses +\fBmouseinterval\fR \- mouse interface through curses .ad .hy .SH SYNOPSIS @@ -53,6 +54,8 @@ typedef struct MEVENT;\fR .fi .br +\fBbool has_mouse(void);\fR +.br \fBint getmouse(MEVENT *event);\fR .br \fBint ungetmouse(MEVENT *event);\fR @@ -146,6 +149,9 @@ x in the event structure coordinates will be screen-relative character-cell coordinates. The returned state mask will have exactly one bit set to indicate the event type. +The corresponding data in the queue is marked invalid. +A subsequent call to \fBgetmouse\fP will retrieve the next older +item from the queue. .PP The \fBungetmouse\fR function behaves analogously to \fBungetch\fR. It pushes @@ -194,9 +200,12 @@ second) that can elapse between press and release events for them to be recognized as a click. Use \fBmouseinterval(0)\fR to disable click resolution. This function returns the previous interval value. -Use \fBmouseinterval(-1)\fR to obtain the interval without altering it. +Use \fBmouseinterval(\-1)\fR to obtain the interval without altering it. The default is one sixth of a second. .PP +The \fBhas_mouse\fP function returns TRUE if the mouse driver has been +successfully initialized. +.PP Note that mouse events will be ignored when input is in cooked mode, and will cause an error beep when cooked mode is being simulated in a window by a function such as \fBgetstr\fR that expects a linefeed for input-loop @@ -211,6 +220,7 @@ upon successful completion. returns an error. If no mouse driver was initialized, or if the mask parameter is zero, +it also returns an error if no more events remain in the queue. .TP 5 \fBungetmouse\fP returns an error if the FIFO is full. @@ -256,7 +266,7 @@ Under \fBncurses\fR(3X), these calls are implemented using either xterm's built-in mouse-tracking API or platform-specific drivers including .RS -Alessandro Rubini's gpm server. +Alessandro Rubini's gpm server .br FreeBSD sysmouse .br @@ -301,10 +311,5 @@ the terminal description, then the terminal may send mouse events. .SH SEE ALSO \fBcurses\fR(3X), \fBcurs_kernel\fR(3X), -\fBcurs_slk\fR(3X). -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: +\fBcurs_slk\fR(3X), +\fBcurs_variables\fR(3X). diff --git a/man/curs_move.3x b/man/curs_move.3x index 8046377..226595c 100644 --- a/man/curs_move.3x +++ b/man/curs_move.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2005,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2006,2010 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,13 +26,13 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_move.3x,v 1.12 2006/02/25 21:49:19 tom Exp $ +.\" $Id: curs_move.3x,v 1.14 2010/12/04 18:40:45 tom Exp $ .TH curs_move 3X "" .na .hy 0 .SH NAME \fBmove\fR, -\fBwmove\fR - move \fBcurses\fR window cursor +\fBwmove\fR \- move \fBcurses\fR window cursor .ad .hy .SH SYNOPSIS @@ -61,9 +61,3 @@ Note that \fBmove\fR may be a macro. These functions are described in the XSI Curses standard, Issue 4. .SH SEE ALSO \fBcurses\fR(3X), \fBcurs_refresh\fR(3X) -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/curs_opaque.3x b/man/curs_opaque.3x index 6c9cfaa..f3ad22e 100644 --- a/man/curs_opaque.3x +++ b/man/curs_opaque.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 2007 Free Software Foundation, Inc. * +.\" Copyright (c) 2007-2009,2010 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_opaque.3x,v 1.6 2007/09/08 18:49:13 tom Exp $ +.\" $Id: curs_opaque.3x,v 1.9 2010/12/04 18:40:45 tom Exp $ .TH curs_opaque 3X "" .na .hy 0 @@ -38,9 +38,11 @@ \fBis_keypad\fR, \fBis_leaveok\fR, \fBis_nodelay\fR, -\fBis_timeout\fR, +\fBis_notimeout\fR, +\fBis_pad\fR, \fBis_scrollok\fR, -\fBis_syncok\fR - \fBcurses\fR window properties +\fBis_subwin\fR, +\fBis_syncok\fR \- \fBcurses\fR window properties .ad .hy .SH SYNOPSIS @@ -62,8 +64,12 @@ .br \fBbool is_notimeout(const WINDOW *win);\fR .br +\fBbool is_pad(const WINDOW *win);\fR +.br \fBbool is_scrollok(const WINDOW *win);\fR .br +\fBbool is_subwin(const WINDOW *win);\fR +.br \fBbool is_syncok(const WINDOW *win);\fR .br \fBWINDOW * wgetparent(const WINDOW *win);\fR @@ -99,9 +105,17 @@ returns the value set in \fBnodelay\fR \fBis_notimeout\fR returns the value set in \fBnotimeout\fR .TP 5 +\fBis_pad\fR +returns TRUE if the window is a pad +i.e., created by \fBnewpad\fP +.TP 5 \fBis_scrollok\fR returns the value set in \fBscrollok\fR .TP 5 +\fBis_subwin\fR +returns TRUE if the window is a subwindow, +i.e., created by \fBsubwin\fP or \fBderwin\fP +.TP 5 \fBis_syncok\fR returns the value set in \fBsyncok\fR .TP 5 @@ -125,9 +139,3 @@ be conditioned using NCURSES_VERSION. \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/man/curs_outopts.3x b/man/curs_outopts.3x index 3fd437a..52c04cd 100644 --- a/man/curs_outopts.3x +++ b/man/curs_outopts.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2005,2007 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2007,2010 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.21 2007/06/02 20:40:07 tom Exp $ +.\" $Id: curs_outopts.3x,v 1.25 2010/12/04 18:38:55 tom Exp $ .TH curs_outopts 3X "" .na .hy 0 @@ -40,7 +40,7 @@ \fBwsetscrreg\fR, \fBscrollok\fR, \fBnl\fR, -\fBnonl\fR - \fBcurses\fR output options +\fBnonl\fR \- \fBcurses\fR output options .ad .hy .SH SYNOPSIS @@ -118,8 +118,9 @@ the cursor is not used, since it reduces the need for cursor motions. .PP The \fBsetscrreg\fR and \fBwsetscrreg\fR routines allow the application programmer to set a software scrolling region in a window. -\fItop\fR and -\fIbot\fR are the line numbers of the top and bottom margin of the scrolling +The \fItop\fR and +\fIbot\fR parameters +are the line numbers of the top and bottom margin of the scrolling region. (Line 0 is the top line of the window.) If this option and \fBscrollok\fR are enabled, an attempt to move off the bottom margin line @@ -212,11 +213,10 @@ Note that \fBclearok\fR, \fBleaveok\fR, \fBscrollok\fR, \fBidcok\fR, \fBnl\fR, The \fBimmedok\fR routine is useful for windows that are used as terminal emulators. .SH SEE ALSO -\fBcurses\fR(3X), \fBcurs_addch\fR(3X), \fBcurs_clear\fR(3X), -\fBcurs_initscr\fR(3X), \fBcurs_scroll\fR(3X), \fBcurs_refresh\fR(3X) -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: +\fBcurses\fR(3X), +\fBcurs_addch\fR(3X), +\fBcurs_clear\fR(3X), +\fBcurs_initscr\fR(3X), +\fBcurs_scroll\fR(3X), +\fBcurs_refresh\fR(3X), +\fBcurs_variables\fR(3X). diff --git a/man/curs_overlay.3x b/man/curs_overlay.3x index 066c3a4..cea734e 100644 --- a/man/curs_overlay.3x +++ b/man/curs_overlay.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2005,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2006,2010 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,14 +26,14 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_overlay.3x,v 1.14 2006/02/25 21:49:19 tom Exp $ +.\" $Id: curs_overlay.3x,v 1.16 2010/12/04 18:40:45 tom Exp $ .TH curs_overlay 3X "" .na .hy 0 .SH NAME \fBoverlay\fR, \fBoverwrite\fR, -\fBcopywin\fR - overlay and manipulate overlapped \fBcurses\fR windows +\fBcopywin\fR \- overlay and manipulate overlapped \fBcurses\fR windows .ad .hy .SH SYNOPSIS @@ -79,9 +79,3 @@ qualifiers). It further specifies their behavior in the presence of characters with multibyte renditions (not yet supported in this implementation). .SH SEE ALSO \fBcurses\fR(3X), \fBcurs_pad\fR(3X), \fBcurs_refresh\fR(3X) -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/curs_pad.3x b/man/curs_pad.3x index c722207..6ce640b 100644 --- a/man/curs_pad.3x +++ b/man/curs_pad.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2004,2005 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2005,2010 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_pad.3x,v 1.14 2005/05/15 16:18:43 tom Exp $ +.\" $Id: curs_pad.3x,v 1.17 2010/12/04 18:41:07 tom Exp $ .TH curs_pad 3X "" .na .hy 0 @@ -36,7 +36,7 @@ \fBprefresh\fR, \fBpnoutrefresh\fR, \fBpechochar\fR, -\fBpecho_wchar\fR - create and display \fBcurses\fR pads +\fBpecho_wchar\fR \- create and display \fBcurses\fR pads .ad .hy .SH SYNOPSIS @@ -90,10 +90,11 @@ The \fBprefresh\fR and \fBpnoutrefresh\fR routines are analogous to of windows. The additional parameters are needed to indicate what part of the pad and screen are involved. -\fIpminrow\fR and \fIpmincol\fR specify the upper +The \fIpminrow\fR and \fIpmincol\fR parameters specify the upper left-hand corner of the rectangle to be displayed in the pad. -\fIsminrow\fR, -\fIsmincol\fR, \fIsmaxrow\fR, and \fIsmaxcol\fR specify the edges of the +The \fIsminrow\fR, +\fIsmincol\fR, \fIsmaxrow\fR, and \fIsmaxcol\fR +parameters specify the edges of the rectangle to be displayed on the screen. The lower right-hand corner of the rectangle to be displayed in the pad is calculated from the screen coordinates, @@ -154,9 +155,3 @@ Note that \fBpechochar\fR may be a macro. The XSI Curses standard, Issue 4 describes these functions. .SH SEE ALSO \fBcurses\fR(3X), \fBcurs_refresh\fR(3X), \fBcurs_touch\fR(3X), \fBcurs_addch\fR(3X). -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/curs_print.3x b/man/curs_print.3x index 92b9ca2..31a4535 100644 --- a/man/curs_print.3x +++ b/man/curs_print.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2005,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2006,2010 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,10 +26,10 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_print.3x,v 1.8 2006/02/25 21:49:19 tom Exp $ +.\" $Id: curs_print.3x,v 1.10 2010/12/04 18:40:45 tom Exp $ .TH curs_print 3X "" .SH NAME -\fBmcprint\fR - ship binary data to printer +\fBmcprint\fR \- ship binary data to printer .SH SYNOPSIS \fB#include <curses.h>\fR .sp @@ -66,9 +66,3 @@ Padding in the \fBmc5p\fR, \fBmc4\fR and \fBmc5\fR capabilities will not be interpreted. .SH SEE ALSO \fBcurses\fR(3X)\fR -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/curs_printw.3x b/man/curs_printw.3x index ead0f18..9918f9d 100644 --- a/man/curs_printw.3x +++ b/man/curs_printw.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2005,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2006,2010 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_printw.3x,v 1.17 2006/12/24 16:05:17 tom Exp $ +.\" $Id: curs_printw.3x,v 1.20 2010/12/04 18:40:45 tom Exp $ .TH curs_printw 3X "" .na .hy 0 @@ -35,7 +35,7 @@ \fBwprintw\fR, \fBmvprintw\fR, \fBmvwprintw\fR, -\fBvwprintw\fR, \fBvw_printw\fR - print formatted output in \fBcurses\fR windows +\fBvwprintw\fR, \fBvw_printw\fR \- print formatted output in \fBcurses\fR windows .ad .hy .SH SYNOPSIS @@ -74,6 +74,10 @@ In this implementation, an error may be returned if it cannot allocate enough memory for the buffer used to format the results. It will return an error if the window pointer is null. +.PP +Functions with a "mv" prefix first perform a cursor movement using +\fBwmove\fP, and return an error if the position is outside the window, +or if the window pointer is null. .SH PORTABILITY The XSI Curses standard, Issue 4 describes these functions. The function \fBvwprintw\fR is marked TO BE WITHDRAWN, and is to be replaced by a function @@ -86,9 +90,3 @@ 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(3), \fBvprintf(3)\fR -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/curs_refresh.3x b/man/curs_refresh.3x index 5ce0690..e1552c37 100644 --- a/man/curs_refresh.3x +++ b/man/curs_refresh.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2001,2005 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2005,2010 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_refresh.3x,v 1.12 2005/05/15 16:18:49 tom Exp $ +.\" $Id: curs_refresh.3x,v 1.15 2010/12/04 18:38:55 tom Exp $ .TH curs_refresh 3X "" .na .hy 0 @@ -36,7 +36,7 @@ \fBrefresh\fR, \fBwnoutrefresh\fR, \fBwredrawln\fR, -\fBwrefresh\fR - refresh \fBcurses\fR windows and lines +\fBwrefresh\fR \- refresh \fBcurses\fR windows and lines .ad .hy .SH SYNOPSIS @@ -135,10 +135,6 @@ implementations. Instead, you can do an explicit \fBtouchwin()\fR before the \fBwnoutrefresh()\fR call to guarantee an entire-contents copy anywhere. .SH SEE ALSO -\fBcurses\fR(3X), \fBcurs_outopts\fR(3X) -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: +\fBcurses\fR(3X), +\fBcurs_outopts\fR(3X) +\fBcurs_variables\fR(3X). diff --git a/man/curs_scanw.3x b/man/curs_scanw.3x index 71ba9ee..a3208f5 100644 --- a/man/curs_scanw.3x +++ b/man/curs_scanw.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2000,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2006,2010 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,14 +26,14 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_scanw.3x,v 1.14 2006/12/24 16:05:49 tom Exp $ +.\" $Id: curs_scanw.3x,v 1.17 2010/12/04 18:40:45 tom Exp $ .TH curs_scanw 3X "" .SH NAME \fBscanw\fR, \fBwscanw\fR, \fBmvscanw\fR, \fBmvwscanw\fR, -\fBvwscanw\fR, \fBvw_scanw\fR - convert formatted input from a \fBcurses\fR window +\fBvwscanw\fR, \fBvw_scanw\fR \- convert formatted input from a \fBcurses\fR window .SH SYNOPSIS \fB#include <curses.h>\fR .sp @@ -66,6 +66,10 @@ number of fields scanned on success. Applications may use the return value from the \fBscanw\fR, \fBwscanw\fR, \fBmvscanw\fR and \fBmvwscanw\fR routines to determine the number of fields which were mapped in the call. +.PP +Functions with a "mv" prefix first perform a cursor movement using +\fBwmove\fP, and return an error if the position is outside the window, +or if the window pointer is null. .SH PORTABILITY The XSI Curses standard, Issue 4 describes these functions. The function \fBvwscanw\fR is marked TO BE WITHDRAWN, and is to be replaced by a function @@ -89,9 +93,3 @@ 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(3) -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/curs_scr_dump.3x b/man/curs_scr_dump.3x index 7884f6a..df3e79c 100644 --- a/man/curs_scr_dump.3x +++ b/man/curs_scr_dump.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2005,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2006,2010 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_scr_dump.3x,v 1.7 2006/12/24 16:05:49 tom Exp $ +.\" $Id: curs_scr_dump.3x,v 1.9 2010/12/04 18:40:45 tom Exp $ .TH curs_scr_dump 3X "" .na .hy 0 @@ -34,7 +34,7 @@ \fBscr_dump\fR, \fBscr_restore\fR, \fBscr_init\fR, -\fBscr_set\fR - read (write) a \fBcurses\fR screen from (to) a file +\fBscr_set\fR \- read (write) a \fBcurses\fR screen from (to) a file .ad .hy .SH SYNOPSIS @@ -94,9 +94,3 @@ considered invalid "if the time-stamp of the tty is old" but do not define .SH SEE ALSO \fBcurses\fR(3X), \fBcurs_initscr\fR(3X), \fBcurs_refresh\fR(3X), \fBcurs_util\fR(3X), \fBsystem\fR(3) -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/curs_scroll.3x b/man/curs_scroll.3x index 754b714..2cb152d 100644 --- a/man/curs_scroll.3x +++ b/man/curs_scroll.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2005,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2006,2010 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,14 +26,14 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_scroll.3x,v 1.13 2006/02/25 21:49:19 tom Exp $ +.\" $Id: curs_scroll.3x,v 1.15 2010/12/04 18:40:45 tom Exp $ .TH curs_scroll 3X "" .na .hy 0 .SH NAME \fBscroll\fR, \fBscrl\fR, -\fBwscrl\fR - scroll a \fBcurses\fR window +\fBwscrl\fR \- scroll a \fBcurses\fR window .ad .hy .SH SYNOPSIS @@ -88,9 +88,3 @@ Under this implementation it is. The XSI Curses standard, Issue 4 describes these functions. .SH SEE ALSO \fBcurses\fR(3X), \fBcurs_outopts\fR(3X) -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/curs_slk.3x b/man/curs_slk.3x index 6361268..e8f7afb 100644 --- a/man/curs_slk.3x +++ b/man/curs_slk.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2006,2007 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2007,2010 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,13 +26,14 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_slk.3x,v 1.16 2007/06/02 20:40:07 tom Exp $ +.\" $Id: curs_slk.3x,v 1.22 2010/12/04 18:38:55 tom Exp $ .TH curs_slk 3X "" .na .hy 0 .SH NAME \fBslk_init\fR, \fBslk_set\fR, +\fBslk_wset\fR, \fBslk_refresh\fR, \fBslk_noutrefresh\fR, \fBslk_label\fR, @@ -46,7 +47,7 @@ \fBslk_attr_set\fR, \fBslk_attr_off\fR, \fBslk_attr\fR, -\fBslk_color\fR - \fBcurses\fR soft label routines +\fBslk_color\fR \- \fBcurses\fR soft label routines .ad .hy .SH SYNOPSIS @@ -78,42 +79,76 @@ .br \fBint slk_attr_off(const attr_t attrs, void * opts);\fR .br -\fBint slk_attr_set(const attr_t attrs,\fR -.br - \fBshort color_pair_number, void* opts);\fR +\fBint slk_attr_set(const attr_t attrs, short color_pair, void* opts);\fR .br \fBattr_t slk_attr(void);\fR .br -\fBint slk_color(short color_pair_number);\fR +\fBint slk_color(short color_pair);\fR +.br +\fBint slk_wset(int labnum, const wchar_t *label, int fmt);\fR .br .SH DESCRIPTION The slk* functions manipulate the set of soft function-key labels that exist on -many terminals. For those terminals that do not have soft labels, +many terminals. +For those terminals that do not have soft labels, \fBcurses\fR takes over the bottom line of \fBstdscr\fR, reducing the size of -\fBstdscr\fR and the variable \fBLINES\fR. \fBcurses\fR standardizes on eight -labels of up to eight characters each. In addition to this, the ncurses +\fBstdscr\fR and the variable \fBLINES\fR. +\fBcurses\fR standardizes on eight +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 does not try to use any hardware support for this +characters each. +This is useful for today's PC-like enduser devices. +ncurses simulates this mode by taking over up to two lines at +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 -is called. If \fBinitscr\fR eventually uses a line from \fBstdscr\fR to -emulate the soft labels, then \fIfmt\fR determines how the labels are arranged -on the screen. Setting \fIfmt\fR to \fB0\fR indicates a 3-2-3 arrangement of -the labels, \fB1\fR indicates a 4-4 arrangement and \fB2\fR indicates the -PC like 4-4-4 mode. If \fBfmt\fR is set to \fB3\fR, it is again the PC like -4-4-4 mode, but in addition an index line is generated, helping the user to +is called. +If \fBinitscr\fR eventually uses a line from \fBstdscr\fR to +emulate the soft labels, +then \fIfmt\fR determines how the labels are arranged on the screen: +.RS +.TP 3 +.B 0 +indicates a 3\-2\-3 arrangement of +the labels. +.TP 3 +.B 1 +indicates a 4\-4 arrangement +.TP 3 +.B 2 +indicates the PC-like 4\-4\-4 mode. +.TP 3 +.B 3 +is again the PC-like 4\-4\-4 mode, +but in addition an index line is generated, helping the user to identify the key numbers easily. +.RE .PP -The \fBslk_set\fR routine requires \fIlabnum\fR to be a label number, -from \fB1\fR to \fB8\fR (resp. \fB12\fR); \fIlabel\fR must be the string -to be put on the label, up to eight (resp. five) characters in length. -A null string or a null pointer sets up a blank label. \fIfmt\fR is either -\fB0\fR, \fB1\fR, or \fB2\fR, indicating whether the label is to be +The \fBslk_set\fR routine +(and the \fBslk_wset\fR routine for the wide-character library) +has three parameters: +.RS +.TP 5 +.I labnum +is the label number, from \fB1\fR to \fB8\fR +(12 for \fIfmt\fP in \fBslk_init\fP is \fB2\fP or \fB3\fP); +.TP +.I label +is be the string to put on the label, +up to eight +(five for \fIfmt\fP in \fBslk_init\fP is \fB2\fP or \fB3\fP) +characters in length. +A null string or a null pointer sets up a blank label. +.TP +.I fmt +is either +\fB0\fR, \fB1\fR, or \fB2\fR, indicating whether the label is to be left-justified, centered, or right-justified, respectively, within the label. +.RE .PP The \fBslk_refresh\fR and \fBslk_noutrefresh\fR routines correspond to the \fBwrefresh\fR and \fBwnoutrefresh\fR routines. @@ -132,10 +167,12 @@ the next time a \fBslk_noutrefresh\fR is performed. The \fBslk_attron\fR, \fBslk_attrset\fR, \fBslk_attroff\fR and \fBslk_attr\fR routines correspond to \fBattron\fR, \fBattrset\fR, \fBattroff\fR and \fBattr_get\fR. They have an effect only if soft labels are simulated on the bottom line of -the screen. The default highlight for soft keys is A_STANDOUT (as in +the screen. +The default highlight for soft keys is A_STANDOUT (as in System V curses, which does not document this fact). .PP -The \fBslk_color\fR routine corresponds to \fBcolor_set\fR. It has an effect only +The \fBslk_color\fR routine corresponds to \fBcolor_set\fR. +It has an effect only if soft labels are simulated on the bottom line of the screen. . .SH RETURN VALUE @@ -164,13 +201,13 @@ if the terminal or the softkeys were not initialized. \fBslk_attr_set\fP returns an error if the terminal or the softkeys were not initialized, or -the color pair is outside the range 0..COLOR_PAIRS-1, +the color pair is outside the range 0..COLOR_PAIRS\-1, or opts is not null. .TP 5 \fBslk_color\fP returns an error if the terminal or the softkeys were not initialized, or -the color pair is outside the range 0..COLOR_PAIRS-1. +the color pair is outside the range 0..COLOR_PAIRS\-1. .TP 5 \fBslk_init\fR returns an error @@ -190,16 +227,16 @@ memory for the labels cannot be allocated. Most applications would use \fBslk_noutrefresh\fR because a \fBwrefresh\fR is likely to follow soon. .SH PORTABILITY -The XSI Curses standard, Issue 4, describes these functions. It changes the +The XSI Curses standard, Issue 4, describes these functions. +It changes the argument type of the attribute-manipulation functions \fBslk_attron\fR, \fBslk_attroff\fR, \fBslk_attrset\fR to be \fBattr_t\fR, and adds \fBconst\fR -qualifiers. The format codes \fB2\fR and \fB3\fR for \fBslk_init()\fR and the +qualifiers. +The format codes \fB2\fR and \fB3\fR for \fBslk_init()\fR and the function \fBslk_attr\fR are specific to ncurses. .SH SEE ALSO -\fBcurses\fR(3X), \fBcurs_attr\fR(3X), \fBcurs_initscr\fR(3X), \fBcurs_refresh\fR(3X) -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: +\fBcurses\fR(3X), +\fBcurs_attr\fR(3X), +\fBcurs_initscr\fR(3X), +\fBcurs_refresh\fR(3X), +\fBcurs_variables\fR(3X). diff --git a/man/curs_sp_funcs.3x b/man/curs_sp_funcs.3x new file mode 100644 index 0000000..020e5c1 --- /dev/null +++ b/man/curs_sp_funcs.3x @@ -0,0 +1,353 @@ +.\"*************************************************************************** +.\" Copyright (c) 2010 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_sp_funcs.3x,v 1.5 2010/12/04 18:38:55 tom Exp $ +.TH curs_sp_funcs 3X "" +.na +.hy 0 +.SH NAME +new_prescr \- \fBcurses\fR screen-pointer extension +.ad +.hy +.SH SYNOPSIS +\fB#include <curses.h>\fR +.nf +.sp +\fBint assume_default_colors_sp(SCREEN*, int, int);\fR +.br +\fBint baudrate_sp(SCREEN*);\fR +.br +\fBint beep_sp(SCREEN*);\fR +.br +\fBbool can_change_color_sp(SCREEN*);\fR +.br +\fBint cbreak_sp(SCREEN*);\fR +.br +\fBint color_content_sp(SCREEN*, short, short*, short*, short*);\fR +.br +\fBint curs_set_sp(SCREEN*, int);\fR +.br +\fBint define_key_sp(SCREEN*, const char *, int);\fR +.br +\fBint def_prog_mode_sp(SCREEN*);\fR +.br +\fBint def_shell_mode_sp(SCREEN*);\fR +.br +\fBint delay_output_sp(SCREEN*, int);\fR +.br +\fBint doupdate_sp(SCREEN*);\fR +.br +\fBint echo_sp(SCREEN*);\fR +.br +\fBint endwin_sp(SCREEN*);\fR +.br +\fBint erasechar_sp(SCREEN*);\fR +.br +\fBint filter_sp(SCREEN*);\fR +.br +\fBint flash_sp(SCREEN*);\fR +.br +\fBint flushinp_sp(SCREEN*);\fR +.br +\fBint get_escdelay_sp(SCREEN*);\fR +.br +\fBint getmouse_sp(SCREEN*, MEVENT*);\fR +.br +\fBWINDOW* getwin_sp(SCREEN*, FILE*);\fR +.br +\fBint halfdelay_sp(SCREEN*);\fR +.br +\fBbool has_colors_sp(SCREEN*);\fR +.br +\fBbool has_ic_sp(SCREEN*);\fR +.br +\fBbool has_il_sp(SCREEN*);\fR +.br +\fBint has_key_sp(SCREEN*, int);\fR +.br +\fBbool has_mouse_sp(SCREEN*);\fR +.br +\fBint init_color_sp(SCREEN*, short, short, short, short);\fR +.br +\fBint init_pair_sp(SCREEN*, short, short, short);\fR +.br +\fBint intrflush_sp(SCREEN*, WINDOW*, bool);\fR +.br +\fBbool isendwin_sp(SCREEN*);\fR +.br +\fBbool is_term_resized_sp(SCREEN*, int, int);\fR +.br +\fBchar* keybound_sp(SCREEN*, int, int);\fR +.br +\fBint key_defined_sp(SCREEN*, const char *);\fR +.br +\fBNCURSES_CONST char * keyname_sp(SCREEN*, int);\fR +.br +\fBint keyok_sp(SCREEN*, int, bool);\fR +.br +\fBchar killchar_sp(SCREEN*);\fR +.br +\fBint mcprint_sp(SCREEN*, char *, int);\fR +.br +\fBint mouseinterval_sp(SCREEN*, int);\fR +.br +\fBmmask_t mousemask_sp(SCREEN*, mmask_t, mmask_t *);\fR +.br +\fBint mvcur_sp(SCREEN*, int, int, int, int);\fR +.br +\fBint napms_sp(SCREEN*, int);\fR +.br +\fBWINDOW* newpad_sp(SCREEN*, int, int);\fR +.br +\fBSCREEN* new_prescr(void);\fR +.br +\fBSCREEN* newterm_sp(SCREEN*, NCURSES_CONST char *, FILE *, FILE *);\fR +.br +\fBWINDOW* newwin_sp(SCREEN*, int, int, int, int);\fR +.br +\fBint nl_sp(SCREEN*);\fR +.br +\fBint nocbreak_sp(SCREEN*);\fR +.br +\fBint noecho_sp(SCREEN*);\fR +.br +\fBint nofilter_sp(SCREEN*);\fR +.br +\fBint nonl_sp(SCREEN*);\fR +.br +\fBvoid noqiflush_sp(SCREEN*);\fR +.br +\fBint noraw_sp(SCREEN*);\fR +.br +\fBint pair_content_sp(SCREEN*, short, short*, short*);\fR +.br +\fBvoid qiflush_sp(SCREEN*);\fR +.br +\fBint raw_sp(SCREEN*);\fR +.br +\fBint reset_prog_mode_sp(SCREEN*);\fR +.br +\fBint reset_shell_mode_sp(SCREEN*);\fR +.br +\fBint resetty_sp(SCREEN*);\fR +.br +\fBint resize_term_sp(SCREEN*, int, int);\fR +.br +\fBint resizeterm_sp(SCREEN*, int, int);\fR +.br +\fBint restartterm_sp(SCREEN*, NCURSES_CONST char*, int, int *);\fR +.br +\fBint ripoffline_sp(SCREEN*, int, int (*)(WINDOW*, int));\fR +.br +\fBint savetty_sp(SCREEN*);\fR +.br +\fBint scr_init_sp(SCREEN*, const char *);\fR +.br +\fBint scr_restore_sp(SCREEN*, const char *);\fR +.br +\fBint scr_set_sp(SCREEN*, const char *);\fR +.br +\fBTERMINAL* set_curterm_sp(SCREEN*, TERMINAL*);\fR +.br +\fBint set_escdelay_sp(SCREEN*, int);\fR +.br +\fBint set_tabsize_sp(SCREEN*, int);\fR +.br +\fBint slk_attroff_sp(SCREEN*, const chtype);\fR +.br +\fBint slk_attron_sp(SCREEN*, const chtype);\fR +.br +\fBint slk_attr_set_sp(SCREEN*, const attr_t, short, void*);\fR +.br +\fBint slk_attrset_sp(SCREEN*, const chtype);\fR +.br +\fBint slk_attr_sp((SCREEN*);\fR +.br +\fBint slk_clear_sp(SCREEN*);\fR +.br +\fBint slk_color_sp(SCREEN*, short);\fR +.br +\fBint slk_init_sp(SCREEN*, int);\fR +.br +\fBint slk_label_sp(SCREEN*, int);\fR +.br +\fBint slk_noutrefresh_sp(SCREEN*);\fR +.br +\fBint slk_refresh_sp(SCREEN*);\fR +.br +\fBint slk_restore_sp(SCREEN*);\fR +.br +\fBint slk_set_sp(SCREEN*, int, const char *, int);\fR +.br +\fBint slk_touch_sp(SCREEN*);\fR +.br +\fBint start_color_sp(SCREEN*);\fR +.br +\fBattr_t term_attrs_sp(SCREEN*);\fR +.br +\fBchtype termattrs_sp(SCREEN*);\fR +.br +\fBchar* termname_sp(SCREEN*);\fR +.br +\fBint typeahead_sp(SCREEN*, int);\fR +.br +\fBNCURSES_CONST char* unctrl_sp(SCREEN*, chtype);\fR +.br +\fBint ungetch_sp(SCREEN*, int);\fR +.br +\fBint ungetmouse_sp(SCREEN*,MEVENT *);\fR +.br +\fBint unget_wch_sp(SCREEN*, const wchar_t);\fR +.br +\fBint use_default_colors_sp(SCREEN*);\fR +.br +\fBvoid use_env_sp(SCREEN*, bool);\fR +.br +\fBint use_legacy_coding_sp(SCREEN*, int);\fR +.br +\fBint vid_attr_sp(SCREEN*, attr_t, short, void *);\fR +.br +\fBint vidattr_sp(SCREEN*, chtype);\fR +.br +\fBint vid_puts_sp(SCREEN*, attr_t, short, void *, NCURSES_SP_OUTC);\fR +.br +\fBint vidputs_sp(SCREEN*, chtype, NCURSES_SP_OUTC);\fR +.br +\fBwchar_t* wunctrl_sp(SCREEN*, cchar_t *);\fR +.sp +\fB#include <form.h>\fR +.sp +\fBint new_form_sp(SCREEN*, FIELD **);\fR +.sp +\fB#include <menu.h>\fR +.sp +\fBint new_menu_sp(SCREEN*, ITEM **);\fR +.sp +\fB#include <panel.h>\fR +.sp +\fBint ceiling_panel(SCREEN*);\fR +.br +\fBPANEL* ground_panel(SCREEN*);\fR +.br +\fBint update_panels_sp(SCREEN*);\fR +.sp +\fB#include <term.h>\fR +.sp +\fBint del_curterm_sp(SCREEN*, TERMINAL *);\fR +.br +\fBint putp_sp(SCREEN*, const char *);\fR +.br +\fBint tgetflag_sp(SCREEN*, char *, const char *);\fR +.br +\fBint tgetent_sp(SCREEN*, char *, const char *);\fR +.br +\fBint tgetnum_sp(SCREEN*, NCURSES_CONST char *);\fR +.br +\fBchar* tgetstr_sp(SCREEN*, NCURSES_CONST char *, char **);\fR +.br +\fBint tigetflag_sp(SCREEN*, NCURSES_CONST char *);\fR +.br +\fBint tigetnum_sp(SCREEN*, NCURSES_CONST char *);\fR +.br +\fBchar* tigetstr_sp(SCREEN*, NCURSES_CONST char *);\fR +.br +\fBint tputs_sp(SCREEN*, const char *, int, NCURSES_SP_OUTC);\fR +.ad +.br +.SH DESCRIPTION +This implementation can be configured to provide a set of functions which +improve the ability to manage multiple screens. +This feature can be added to any of the configurations supported by ncurses; +it adds new entrypoints +without changing the meaning of any of the existing ones. +.PP +.\" *************************************************************************** +.SS IMPROVED FUNCTIONS +Most of the functions are new versions of existing functions. +A parameter is added at the front of the parameter list. +It is a SCREEN pointer. +.PP +The existing functions all use the current screen, +which is a static variable. +The extended functions use the specified screen, +thereby reducing the number of variables which must be modified +to update multiple screens. +.\" *************************************************************************** +.SS NEW FUNCTIONS +Here are the new functions: +.TP 5 +ceiling_panel +this returns a pointer to the topmost panel in the given screen. +.TP 5 +ground_panel +this returns a pointer to the lowest panel in the given screen. +.TP 5 +new_prescr +when creating a new screen, the library uses static variables which +have been preset, e.g., by \fBuse_env\fP(3X), \fBfilter\fP(3X), etc. +With the screen-pointer extension, +there are situations where it must create a current screen before +the unextended library does. +The \fBnew_prescr\fP function is used internally to handle these cases. +It is also provided as an entrypoint to allow applications to customize +the library initialization. +.\" *************************************************************************** +.SH NOTES +This extension introduces some new names: +.TP 5 +NCURSES_SP_FUNCS +This is set to the library patch-level number. +In the unextended library, this is zero (0), +to make it useful for checking if the extension is provided. +.TP 5 +NCURSES_SP_NAME +The new functions are named using the macro \fINCURSES_SP_NAME\fP, +which hides the actual implementation. +Currently this adds a "_sp" suffix to the name of the unextended function. +This manual page indexes the extensions showing the full name. +However the proper usage of these functions uses the macro, +to provide for the possibility of changing the naming convention +for specific library configurations. +.TP 5 +NCURSES_SP_OUTC +This is a new function-pointer type to use in the screen-pointer functions +where an \fINCURSES_OUTC\fP is used in the unextended library. +.TP 5 +NCURSES_OUTC +This is a function-pointer type used for the cases where a function passes +characters to the output stream, e.g., \fBvidputs\fP(3X). +.PP +.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 \fINCURSES_SP_FUNCS\fP. +.SH SEE ALSO +\fBcurses\fR(3X), +\fBcurs_opaque\fR(3X), +\fBcurs_threads\fR(3X). diff --git a/man/curs_termattrs.3x b/man/curs_termattrs.3x index 1e07307..0f0294c 100644 --- a/man/curs_termattrs.3x +++ b/man/curs_termattrs.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2003,2007 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2007,2010 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.10 2007/06/02 20:40:07 tom Exp $ +.\" $Id: curs_termattrs.3x,v 1.12 2010/12/04 18:40:45 tom Exp $ .TH curs_termattrs 3X "" .SH NAME \fBbaudrate\fR, @@ -39,7 +39,7 @@ \fBlongname\fR, \fBterm_attrs\fR, \fBtermattrs\fR, -\fBtermname\fR - \fBcurses\fR environment query routines +\fBtermname\fR \- \fBcurses\fR environment query routines .SH SYNOPSIS \fB#include <curses.h>\fR .PP @@ -126,9 +126,3 @@ Most versions of curses truncate the result returned by \fBtermname\fR to 14 characters. .SH SEE ALSO \fBcurses\fR(3X), \fBcurs_initscr\fR(3X), \fBcurs_outopts\fR(3X) -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/curs_termcap.3x b/man/curs_termcap.3x index 93ac2fb..70a6710 100644 --- a/man/curs_termcap.3x +++ b/man/curs_termcap.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2006,2007 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2007,2010 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,16 +26,24 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_termcap.3x,v 1.22 2007/06/02 20:40:07 tom Exp $ +.\" $Id: curs_termcap.3x,v 1.26 2010/12/04 18:38:55 tom Exp $ .TH curs_termcap 3X "" +.na +.hy 0 .ds n 5 .SH NAME +\fBPC\fR, +\fBUP\fR, +\fBBC\fR, +\fBospeed\fR, \fBtgetent\fR, \fBtgetflag\fR, \fBtgetnum\fR, \fBtgetstr\fR, \fBtgoto\fR, -\fBtputs\fR - direct \fBcurses\fR interface to the terminfo capability database +\fBtputs\fR \- direct \fBcurses\fR interface to the terminfo capability database +.ad +.hy .SH SYNOPSIS \fB#include <curses.h>\fR .br @@ -69,7 +77,7 @@ can only be used to query the capabilities of entries for which a terminfo entry has been compiled. .PP The \fBtgetent\fR routine loads the entry for \fIname\fR. -It returns 1 on success, 0 if there is no such entry, and -1 if the +It returns 1 on success, 0 if there is no such entry, and \-1 if the terminfo database could not be found. The emulation ignores the buffer pointer \fIbp\fR. .PP @@ -77,7 +85,7 @@ The \fBtgetflag\fR routine gets the boolean entry for \fIid\fR, or zero if it is not available. .PP The \fBtgetnum\fR routine gets the numeric entry for \fIid\fR, -or -1 if it is not available. +or \-1 if it is not available. .PP The \fBtgetstr\fR routine returns the string entry for \fIid\fR, or zero if it is not available. @@ -158,10 +166,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(3). -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: +\fBcurses\fR(3X), +\fBterminfo\fR(\*n), +\fBterm_variables\fR(3X), +\fBputc\fR(3). diff --git a/man/curs_terminfo.3x b/man/curs_terminfo.3x index 4412a6a..0e95d1c 100644 --- a/man/curs_terminfo.3x +++ b/man/curs_terminfo.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1999-2007,2008 Free Software Foundation, Inc. * +.\" Copyright (c) 1999-2008,2010 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.30 2008/08/16 20:53:27 tom Exp $ +.\" $Id: curs_terminfo.3x,v 1.35 2010/12/04 18:38:55 tom Exp $ .TH curs_terminfo 3X "" .ds n 5 .na @@ -42,12 +42,13 @@ \fBtigetflag\fR, \fBtigetnum\fR, \fBtigetstr\fR, +\fBtiparm\fR, \fBtparm\fR, \fBtputs\fR, \fBvid_attr\fR, \fBvid_puts\fR, \fBvidattr\fR, -\fBvidputs\fR - \fBcurses\fR interfaces to terminfo database +\fBvidputs\fR \- \fBcurses\fR interfaces to terminfo database .ad .hy .SH SYNOPSIS @@ -88,6 +89,8 @@ .br \fBchar *tigetstr(char *\fR\fIcapname\fR\fB);\fR .br +\fBchar *tiparm(const char *\fR\fIstr\fR\fB, ...);\fR +.br .fi .SH DESCRIPTION These low-level routines must be called by programs that have to deal @@ -153,7 +156,7 @@ means that the terminal could not be found, or that it is a generic type, having too little information for curses applications to run. .TP 5 -.B -1 +.B \-1 means that the \fBterminfo\fR database could not be found. .RE .PP @@ -196,6 +199,10 @@ The \fBtparm\fR routine instantiates the string \fIstr\fR with parameters \fIpi\fR. A pointer is returned to the result of \fIstr\fR with the parameters applied. .PP +\fBtiparm\fP is a newer form of \fBtparm\fP which uses \fI<stdarg.h>\fP +rather than a fixed-parameter list. +Its numeric parameters are integers (int) rather than longs. +.PP The \fBtputs\fR routine applies padding information to the string \fIstr\fR and outputs it. The \fIstr\fR must be a terminfo string variable or the return value from \fBtparm\fR, \fBtgetstr\fR, or @@ -233,15 +240,15 @@ The \fBtigetflag\fR, \fBtigetnum\fR and \fBtigetstr\fR routines return the value of the capability corresponding to the \fBterminfo\fR \fIcapname\fR passed to them, such as \fBxenl\fR. .PP -The \fBtigetflag\fR routine returns the value \fB-1\fR if +The \fBtigetflag\fR routine returns the value \fB\-1\fR if \fIcapname\fR is not a boolean capability, or \fB0\fR if it is canceled or absent from the terminal description. .PP -The \fBtigetnum\fR routine returns the value \fB-2\fR if +The \fBtigetnum\fR routine returns the value \fB\-2\fR if \fIcapname\fR is not a numeric capability, -or \fB-1\fR if it is canceled or absent from the terminal description. +or \fB\-1\fR if it is canceled or absent from the terminal description. .PP -The \fBtigetstr\fR routine returns the value \fB(char *)-1\fR +The \fBtigetstr\fR routine returns the value \fB(char *)\-1\fR if \fIcapname\fR is not a string capability, or \fB0\fR if it is canceled or absent from the terminal description. .PP @@ -319,10 +326,14 @@ That returns the length of the string, and does no error-checking. .PP X/Open Curses prototypes \fBtparm\fR with a fixed number of parameters, rather than a variable argument list. -This implementation uses a variable argument list. +This implementation uses a variable argument list, but can be +configured to use the fixed-parameter list. Portable applications should provide 9 parameters after the format; zeroes are fine for this purpose. .PP +In response to comments by Thomas E. Dickey, +X/Open Curses Issue 7 proposed the \fBtiparam\fP function in mid-2009. +.PP X/Open notes that after calling \fBmvcur\fR, the curses state may not match the actual terminal state, and that an application should touch and refresh the window before resuming normal curses calls. @@ -332,21 +343,17 @@ So though it is documented as a terminfo function, \fBmvcur\fR is really a curses function which is not well specified. .PP X/Open states that the old location must be given for \fBmvcur\fP. -This implementation allows the caller to use -1's for the old ordinates. +This implementation allows the caller to use \-1's for the old ordinates. In that case, the old location is unknown. .PP -Extended terminal capability names, e.g., as defined by \fBtic\ -x\fP, +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), +\fBcurs_variables\fR(3X), +\fBterm_variables\fR(3X), \fBputc\fR(3), \fBterminfo\fR(\*n) -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/curs_threads.3x b/man/curs_threads.3x index 17dabdb..4baa2a1 100644 --- a/man/curs_threads.3x +++ b/man/curs_threads.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 2008 Free Software Foundation, Inc. * +.\" Copyright (c) 2008,2010 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,21 +26,27 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_threads.3x,v 1.12 2008/04/12 18:22:51 tom Exp $ +.\" $Id: curs_threads.3x,v 1.18 2010/12/04 18:38:55 tom Exp $ .TH curs_threads 3X "" +.de bP +.IP \(bu 4 +.. .na .hy 0 .SH NAME \fBuse_screen\fR, -\fBuse_window\fR - \fBcurses\fR thread support +\fBuse_window\fR \- \fBcurses\fR thread support .ad .hy .SH SYNOPSIS \fB#include <curses.h>\fR .sp \fBtypedef int (*NCURSES_WINDOW_CB)(WINDOW *, void *);\fR +.br \fBtypedef int (*NCURSES_SCREEN_CB)(SCREEN *, void *);\fR .br +\fBint get_escdelay(void);\fR +.br \fBint set_escdelay(int size);\fR .br \fBint set_tabsize(int size);\fR @@ -89,6 +95,8 @@ To modify them in any configuration, use the \fBset_escdelay\fP or \fBset_tabsize\fP functions. Other global variables are not modifiable. .PP +The \fBget_escdelay\fP function returns the value for ESCDELAY. +.PP The \fBuse_window\fP and \fBuse_screen\fP functions provide coarse granularity mutexes for their respective \fBWINDOW\fP and \fBSCREEN\fP parameters, and call a user-supplied function, @@ -100,26 +108,21 @@ All of the ncurses library functions assume that the locale is not altered during operation. In addition, they use data which is maintained within a hierarchy of scopes. -.RS -.TP 3 -- +.RS 3 +.bP global data, e.g., used in the low-level terminfo or termcap interfaces. -.TP 3 -- +.bP terminal data, e.g., associated with a call to \fIset_curterm\fP. The terminal data are initialized when screens are created. -.TP 3 -- +.bP screen data, e.g., associated with a call to \fInewterm\fP or \fIinitscr\fP. -.TP 3 -- +.bP window data, e.g., associated with a call to \fInewwin\fP or \fIsubwin\fP. Windows are associated with screens. Pads are not necessarily associated with a particular screen. .IP Most curses applications operate on one or more windows within a single screen. -.TP 3 -- +.bP reentrant, i.e., it uses only the data passed as parameters. .RE .PP @@ -594,10 +597,5 @@ It is recommended that any code depending on ncurses extensions be conditioned using NCURSES_VERSION. .SH SEE ALSO \fBcurses\fR(3X), -\fBcurs_opaque\fR(3X) -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: +\fBcurs_opaque\fR(3X), +\fBcurs_variables\fR(3X). diff --git a/man/curs_touch.3x b/man/curs_touch.3x index a7d07bc..9fa6d37 100644 --- a/man/curs_touch.3x +++ b/man/curs_touch.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2005,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2006,2010 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_touch.3x,v 1.11 2006/02/25 21:49:19 tom Exp $ +.\" $Id: curs_touch.3x,v 1.14 2010/12/04 18:38:55 tom Exp $ .TH curs_touch 3X "" .na .hy 0 @@ -36,7 +36,7 @@ \fBuntouchwin\fR, \fBwtouchln\fR, \fBis_linetouched\fR, -\fBis_wintouched\fR - \fBcurses\fR refresh control routines +\fBis_wintouched\fR \- \fBcurses\fR refresh control routines .ad .hy .SH SYNOPSIS @@ -107,10 +107,6 @@ ncurses. .SH NOTES Note that all routines except \fBwtouchln\fR may be macros. .SH SEE ALSO -\fBcurses\fR(3X), \fBcurs_refresh\fR(3X). -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: +\fBcurses\fR(3X), +\fBcurs_refresh\fR(3X), +\fBcurs_variables\fR(3X). diff --git a/man/curs_trace.3x b/man/curs_trace.3x index ca74952..ef78416 100644 --- a/man/curs_trace.3x +++ b/man/curs_trace.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 2000-2005,2007 Free Software Foundation, Inc. * +.\" Copyright (c) 2000-2009,2010 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.8 2007/02/24 17:33:49 tom Exp $ +.\" $Id: curs_trace.3x,v 1.12 2010/12/04 18:40:45 tom Exp $ .TH curs_trace 3X "" .na .hy 0 @@ -36,11 +36,13 @@ \fB_traceattr\fR, \fB_traceattr2\fR, \fB_nc_tracebits\fR, +\fB_tracecchar_t\fR, +\fB_tracecchar_t2\fR, \fB_tracechar\fR, \fB_tracechtype\fR, \fB_tracechtype2\fR, \fB_tracemouse\fR, -\fBtrace\fR - \fBcurses\fR debugging routines +\fBtrace\fR \- \fBcurses\fR debugging routines .ad .hy .SH SYNOPSIS @@ -56,7 +58,11 @@ .br \fBchar *_nc_tracebits(void);\fR .br -\fBchar *_tracechar(int);\fR +\fBchar * _tracecchar_t(const cchar_t *string);\fR +.br +\fBchar * _tracecchar_t2(int buffer, const cchar_t *string);\fR +.br +\fBchar *_tracechar(int ch);\fR .br \fBchar *_tracechtype(chtype ch);\fR .br @@ -71,6 +77,8 @@ as well as applications which use the ncurses libraries. These functions are normally available only with the debugging library \fIlibncurses_g.a\fR, but may be compiled into any model (shared, static, profile) by defining the symbol \fBTRACE\fR. +Additionally, some functions are only available with the wide-character +configuration of the libraries. .PP The principal parts of this interface are the \fBtrace\fR routine which selectively enables different tracing features, and the \fB_tracef\fR @@ -135,6 +143,21 @@ maximum trace level, enables all of the separate trace features. Some tracing features are enabled whenever the \fBtrace\fR parameter is nonzero. Some features overlap. The specific names are used as a guideline. +.PP +These functions check the \fBNCURSES_TRACE\fP environment variable, +to set the tracing feature as if \fBtrace\fP was called: +.RS +filter, +initscr, +new_prescr, +newterm, +nofilter, +ripoffline, +setupterm, +slk_init, +tgetent +.RE + .SH RETURN VALUE Routines which return a value are designed to be used as parameters to the \fB_tracef\fR routine. @@ -145,9 +168,3 @@ have similar, undocumented features, but they are not compatible with ncurses. .SH SEE ALSO \fBcurses\fR(3X). -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/curs_util.3x b/man/curs_util.3x index 18e2b32..fb912b6 100644 --- a/man/curs_util.3x +++ b/man/curs_util.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2007,2008 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2008,2010 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,11 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_util.3x,v 1.27 2008/10/25 23:45:41 tom Exp $ +.\" $Id: curs_util.3x,v 1.32 2010/12/04 18:38:55 tom Exp $ .TH curs_util 3X "" +.de bP +.IP \(bu 4 +.. .na .hy 0 .SH NAME @@ -41,7 +44,7 @@ \fBputwin\fR, \fBunctrl\fR, \fBuse_env\fR, -\fBwunctrl\fR - miscellaneous \fBcurses\fR utility routines +\fBwunctrl\fR \- miscellaneous \fBcurses\fR utility routines .ad .hy .SH SYNOPSIS @@ -75,33 +78,27 @@ representation of the character \fIc\fR, ignoring attributes. Control characters are displayed in the \fB^\fR\fIX\fR notation. Printing characters are displayed as is. The corresponding \fBwunctrl\fR returns a printable representation of -a wide-character. +a wide character. .PP The \fBkeyname\fR routine returns a character string corresponding to the key \fIc\fR: .RS 3 -.TP 3 -- +.bP Printable characters are displayed as themselves, e.g., a one-character string containing the key. -.TP 3 -- +.bP Control characters are displayed in the \fB^\fR\fIX\fR notation. -.TP 3 -- +.bP DEL (character 127) is displayed as \fB^?\fP. -.TP 3 -- +.bP Values above 128 are either meta characters (if the screen has not been initialized, or if \fBmeta\fP has been called with a TRUE parameter), -shown in the \fBM-\fR\fIX\fR notation, +shown in the \fBM\-\fR\fIX\fR notation, or are displayed as themselves. In the latter case, the values may not be printable; this follows the X/Open specification. -.TP 3 -- +.bP Values above 256 may be the names of the names of function keys. -.TP 3 -- +.bP Otherwise (if there is no corresponding name) the function returns null, to denote an error. X/Open also lists an "UNKNOWN KEY" return value, which some implementations @@ -177,14 +174,12 @@ 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. +.RS 3 +.bP +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. +.bP +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. @@ -194,8 +189,7 @@ 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 -- +.bP parameter values outside the 0 to 255 range. \fBunctrl\fP returns a null pointer. .RE @@ -219,17 +213,17 @@ 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 +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. +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 +string capabilities which are defined in the terminfo entry via the \fB\-x\fP option of \fBtic\fP. This implementation automatically assigns at run-time keycodes to user-defined strings which begin with "k". @@ -249,10 +243,5 @@ be conditioned using NCURSES_VERSION. \fBcurs_initscr\fR(3X), \fBcurs_kernel\fR(3X), \fBcurs_scr_dump\fR(3X), +\fBcurs_variables\fR(3X), \fBlegacy_coding\fR(3X). -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/curs_variables.3x b/man/curs_variables.3x new file mode 100644 index 0000000..8cfee52 --- /dev/null +++ b/man/curs_variables.3x @@ -0,0 +1,135 @@ +.\"*************************************************************************** +.\" Copyright (c) 2010 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_variables.3x,v 1.4 2010/12/04 18:38:55 tom Exp $ +.TH curs_variables 3X "" +.de bP +.IP \(bu 4 +.. +.ds n 5 +.na +.hy 0 +.SH NAME +\fBCOLORS\fR, +\fBCOLOR_PAIRS\fR, +\fBCOLS\fR, +\fBESCDELAY\fR, +\fBLINES\fR, +\fBTABSIZE\fR, +\fBcurscr\fR, +\fBnewscr\fR, +\fBstdscr\fR +\- \fBcurses\fR global variables +.ad +.hy +.SH SYNOPSIS +.nf +\fB#include <curses.h>\fR +.PP +\fBint COLOR_PAIRS;\fR +.br +\fBint COLORS;\fR +.br +\fBint COLS;\fR +.br +\fBint ESCDELAY;\fR +.br +\fBint LINES;\fR +.br +\fBint TABSIZE;\fR +.br +\fBWINDOW * curscr;\fR +.br +\fBWINDOW * newscr;\fR +.br +\fBWINDOW * stdscr;\fR +.fi +.SH DESCRIPTION +This page summarizes variables provided by the \fBcurses\fP library. +A more complete description is given in the \fBcurses\fP(3X) manual page. +.PP +Depending on the configuration, these may be actual variables, +or macros (see \fBcurs_threads\fR(3X)) +which provide read-only access to \fIcurses\fP's state. +In either case, applications should treat them as read-only to avoid +confusing the library. +.SS COLOR_PAIRS +After initializing curses, this variable contains the number of color pairs +which the terminal can support. +Usually the number of color pairs will be the product \fBCOLORS\fP*\fBCOLORS\fP, +however this is not always true: +.bP +a few terminals use HLS colors, which do not follow this rule +.bP +terminals supporting a large number of colors are limited by the number +of color pairs that can be represented in a \fIsigned short\fP value. +.SS COLORS +After initializing curses, this variable contains the number of colors +which the terminal can support. +.SS COLS +After initializing curses, this variable contains the width of the screen, +i.e., the number of columns. +.SS ESCDELAY +This variable holds the number of milliseconds to wait after reading an +escape character, +to distinguish between an individual escape character entered on the +keyboard from escape sequences sent by cursor- and function-keys +(see curses(3X). +.SS LINES +After initializing curses, this variable contains the height of the screen, +i.e., the number of lines. +.SS TABSIZE +This variable holds the number of columns used by the \fIcurses\fP library +when converting a tab character to spaces as it adds the tab to a window +(see curs_addch(3X). +.SS The Current Screen +This implementation of curses uses a special window \fBcurscr\fP to +record its updates to the terminal screen. +.SS The New Screen +This implementation of curses uses a special window \fBnewscr\fP to +hold updates to the terminal screen before applying them to \fBcurscr\fP. +.SS The Standard Screen +Upon initializing curses, +a default window called \fBstdscr\fP, +which is the size of the terminal screen, is created. +Many curses functions use this window. +.SH NOTES +The curses library is initialized using either \fBinitscr\fR(3X), +or \fBnewterm\fR(3X). +.PP +If \fBcurses\fP is configured to use separate curses/terminfo libraries, +most of these variables reside in the curses library. +.SH PORTABILITY +ESCDELAY and TABSIZE are extensions, +not provided in most other implementations of curses. +.SH SEE ALSO +\fBcurses\fR(3X), +\fBcurs_threads\fR(3X), +\fBterm_variables\fR(3X), +\fBterminfo\fR(3X), +\fBterminfo\fR(\*n). diff --git a/man/curs_window.3x b/man/curs_window.3x index 552862e..9ef41ff 100644 --- a/man/curs_window.3x +++ b/man/curs_window.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2005,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2006,2010 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_window.3x,v 1.14 2006/02/25 21:49:19 tom Exp $ +.\" $Id: curs_window.3x,v 1.17 2010/12/04 18:38:55 tom Exp $ .TH curs_window 3X "" .na .hy 0 @@ -41,7 +41,7 @@ \fBwsyncup\fR, \fBsyncok\fR, \fBwcursyncup\fR, -\fBwsyncdown\fR - create \fBcurses\fR windows +\fBwsyncdown\fR \- create \fBcurses\fR windows .ad .hy .SH SYNOPSIS @@ -76,8 +76,8 @@ Calling \fBnewwin\fR creates and returns a pointer to a new window with the given number of lines and columns. The upper left-hand corner of the window is at line \fIbegin\fR_\fIy\fR, column \fIbegin\fR_\fIx\fR. If either -\fInlines\fR or \fIncols\fR is zero, they default to \fBLINES -\fR -\fIbegin\fR_\fIy\fR and \fBCOLS -\fR \fIbegin\fR_\fIx\fR. A new full-screen +\fInlines\fR or \fIncols\fR is zero, they default to \fBLINES \-\fR +\fIbegin\fR_\fIy\fR and \fBCOLS \-\fR \fIbegin\fR_\fIx\fR. A new full-screen window is created by calling \fBnewwin(0,0,0,0)\fR. .PP Calling \fBdelwin\fR deletes the named window, freeing all memory @@ -179,10 +179,7 @@ in slower updates. .SH PORTABILITY The XSI Curses standard, Issue 4 describes these functions. .SH SEE ALSO -\fBcurses\fR(3X), \fBcurs_refresh\fR(3X), \fBcurs_touch\fR(3X) -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: +\fBcurses\fR(3X), +\fBcurs_refresh\fR(3X), +\fBcurs_touch\fR(3X), +\fBcurs_variables\fR(3X) diff --git a/man/default_colors.3x b/man/default_colors.3x index 32518ba..0b85598 100644 --- a/man/default_colors.3x +++ b/man/default_colors.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2005,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2010,2011 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * .\" copy of this software and associated documentation files (the * @@ -28,7 +28,7 @@ .\" .\" Author: Thomas E. Dickey 1997,1999,2000,2005 .\" -.\" $Id: default_colors.3x,v 1.20 2006/12/24 15:02:53 tom Exp $ +.\" $Id: default_colors.3x,v 1.23 2011/01/03 21:52:27 Tim.van.der.Molen Exp $ .TH default_colors 3X "" .SH NAME \fBuse_default_colors\fR, @@ -64,14 +64,14 @@ visual effects. The first function, .I use_default_colors() tells the curses library to assign terminal default -foreground/background colors to color number -1. So init_pair(x,COLOR_RED,-1) -will initialize pair x as red on default background and init_pair(x,-1,COLOR_BLUE) will +foreground/background colors to color number \-1. So init_pair(x,COLOR_RED,\-1) +will initialize pair x as red on default background and init_pair(x,\-1,COLOR_BLUE) will initialize pair x as default foreground on blue. .PP The other, .I assume_default_colors() is a refinement which tells which colors to paint for color pair 0. -This function recognizes a special color number -1, +This function recognizes a special color number \-1, which denotes the default terminal color. .PP The following are equivalent: @@ -79,12 +79,12 @@ The following are equivalent: .br .I use_default_colors(); .br -.I assume_default_colors(-1,-1); +.I assume_default_colors(\-1,\-1); .RE .PP These are ncurses extensions. For other curses implementations, color -number -1 does not mean anything, just as for ncurses before a +number \-1 does not mean anything, just as for ncurses before a successful call of \fIuse_default_colors()\fP or \fIassume_default_colors()\fP. .PP Other curses implementations do not allow an application to modify color pair 0. @@ -101,7 +101,7 @@ for color pair 0. These functions return the integer \fBERR\fP upon failure and \fBOK\fP on success. They will fail if either the terminal does not support the \fIorig_pair\fP or \fIorig_colors\fP capability. -If the \fIinitialize_pair\fP capability is found, this causes an +If the \fIinitialize_pair\fP capability is not found, this causes an error as well. .SH NOTES Associated with this extension, the \fBinit_pair\fR function accepts @@ -136,9 +136,3 @@ any code depending on them be conditioned using NCURSES_VERSION. .SH AUTHOR Thomas Dickey (from an analysis of the requirements for color xterm for XFree86 3.1.2C, February 1996). -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/define_key.3x b/man/define_key.3x index 216a3cb..18eaff8 100644 --- a/man/define_key.3x +++ b/man/define_key.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2004,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2009,2010 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 * @@ -28,7 +28,7 @@ .\" .\" Author: Thomas E. Dickey 1997 .\" -.\" $Id: define_key.3x,v 1.12 2006/02/25 21:49:19 tom Exp $ +.\" $Id: define_key.3x,v 1.14 2010/12/04 18:49:20 tom Exp $ .TH define_key 3X "" .SH NAME \fBdefine_key\fP \- define a keycode @@ -47,7 +47,11 @@ removed. Similarly, if the given keycode is negative or zero, any existing string for the given definition is removed. .SH RETURN VALUE -The keycode must be greater than zero, else ERR is returned. +The keycode must be greater than zero, and the string non-null, +otherwise ERR is returned. +ERR may also be returned if there is insufficient memory to allocate the +data to store the definition. +If no error is detected, OK is returned. .SH PORTABILITY These routines are specific to ncurses. They were not supported on Version 7, BSD or System V implementations. It is recommended that @@ -57,9 +61,3 @@ any code depending on them be conditioned using NCURSES_VERSION. \fBkey_defined\fR(3X). .SH AUTHOR Thomas Dickey. -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/form.3x b/man/form.3x index dcba19b..775c833 100644 --- a/man/form.3x +++ b/man/form.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998-2006,2008 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2008,2010 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,10 +27,10 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: form.3x,v 1.22 2008/10/11 20:48:11 tom Exp $ +.\" $Id: form.3x,v 1.24 2010/12/04 18:40:45 tom Exp $ .TH form 3X "" .SH NAME -\fBform\fR - curses extension for programming forms +\fBform\fR \- curses extension for programming forms .SH SYNOPSIS \fB#include <form.h>\fR .br @@ -43,7 +43,7 @@ user. .PP The \fBform\fR library uses the \fBcurses\fR libraries. To use the \fBform\fR library, link with the options -\fB-lform -lcurses\fR. +\fB\-lform \-lcurses\fR. .PP Your program should set up the locale, e.g., .sp @@ -197,7 +197,7 @@ The header file \fB<form.h>\fR automatically includes the header files \fB<curses.h>\fR and \fB<eti.h>\fR. .PP In your library list, libform.a should be before libncurses.a; that is, -you want to say `-lform -lncurses', not the other way around (which would +you want to say `\-lform \-lncurses', not the other way around (which would give you a link error using most linkers). .SH PORTABILITY These routines emulate the System V forms library. They were not supported on @@ -208,9 +208,3 @@ S. Raymond. .SH SEE ALSO This describes \fBncurses\fR version @NCURSES_MAJOR@.@NCURSES_MINOR@ (patch @NCURSES_PATCH@). -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/form_cursor.3x b/man/form_cursor.3x index bf9f28d..ed4b420 100644 --- a/man/form_cursor.3x +++ b/man/form_cursor.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2006,2010 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,10 +27,10 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: form_cursor.3x,v 1.6 2006/11/04 18:50:24 tom Exp $ +.\" $Id: form_cursor.3x,v 1.8 2010/12/04 18:40:45 tom Exp $ .TH form_cursor 3X "" .SH NAME -\fBform_cursor\fR - position a form window cursor +\fBform_cursor\fR \- position a form window cursor .SH SYNOPSIS \fB#include <form.h>\fR .br @@ -67,9 +67,3 @@ Version 7 or BSD versions. .SH AUTHORS Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/form_data.3x b/man/form_data.3x index 2ba004c..ed39bf5 100644 --- a/man/form_data.3x +++ b/man/form_data.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2006,2010 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,10 +27,10 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: form_data.3x,v 1.8 2006/02/25 21:38:26 tom Exp $ +.\" $Id: form_data.3x,v 1.10 2010/12/04 18:40:45 tom Exp $ .TH form_data 3X "" .SH NAME -\fBform_data\fR - test for off-screen data in given forms +\fBform_data\fR \- test for off-screen data in given forms .SH SYNOPSIS \fB#include <form.h>\fR .br @@ -55,9 +55,3 @@ Version 7 or BSD versions. .SH AUTHORS Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/form_driver.3x b/man/form_driver.3x index 4b0576f..67a986b 100644 --- a/man/form_driver.3x +++ b/man/form_driver.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2007,2008 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2008,2010 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,10 +26,13 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: form_driver.3x,v 1.16 2008/06/21 21:55:39 tom Exp $ +.\" $Id: form_driver.3x,v 1.22 2010/12/04 18:38:55 tom Exp $ .TH form_driver 3X "" +.de bP +.IP \(bu 4 +.. .SH NAME -\fBform_driver\fR - command-processing loop of the form system +\fBform_driver\fR \- command-processing loop of the form system .SH SYNOPSIS \fB#include <form.h>\fR .br @@ -38,18 +41,15 @@ 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 three major input cases: -.TP 3 -- +.bP The input is a form navigation request. Navigation request codes are constants defined in \fB<form.h>\fP, which are distinct from the key- and character codes returned by \fBwgetch\fP. -.TP 3 -- +.bP The input is a printable character. Printable characters (which must be positive, less than 256) are checked according to the program's locale settings. -.TP 3 -- +.bP The input is the KEY_MOUSE special key associated with an mouse event. .PP The form driver requests are as follows: @@ -238,11 +238,11 @@ requests listed above, that request is executed. .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 +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 +.RS 3 .TP a REQ_PREV_FIELD is generated for a single click, .TP @@ -252,7 +252,7 @@ a REQ_FIRST_FIELD is generated for a triple-click. .RE .PP If you click below the display region of the form: -.RS +.RS 3 .TP a REQ_NEXT_FIELD is generated for a single click, .TP @@ -262,12 +262,10 @@ 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 -- +.RS 3 +.bP the form cursor is positioned to that field. -.TP 3 -- +.bP If you double-click a field, the form cursor is positioned to that field and \fBE_UNKNOWN_COMMAND\fR is returned. @@ -276,8 +274,7 @@ 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 -- +.bP If a translation into a request was done, \fBform_driver\fR returns the result of this request. .RE @@ -321,7 +318,8 @@ The form driver code saw an unknown request code. .SH SEE ALSO \fBcurses\fR(3X), \fBform\fR(3X), -\fBwgetch\fR(3X). +\fBform_variables\fR(3X), +\fBgetch\fR(3X). .SH NOTES The header file \fB<form.h>\fR automatically includes the header files \fB<curses.h>\fR. @@ -331,9 +329,3 @@ Version 7 or BSD versions. .SH AUTHORS Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/form_field.3x b/man/form_field.3x index f3a26c5..7a39a0c 100644 --- a/man/form_field.3x +++ b/man/form_field.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998-2003,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2006,2010 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,10 +27,10 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: form_field.3x,v 1.8 2006/11/04 18:01:38 tom Exp $ +.\" $Id: form_field.3x,v 1.10 2010/12/04 18:40:45 tom Exp $ .TH form_field 3X "" .SH NAME -\fBform_field\fR - make and break connections between fields and forms +\fBform_field\fR \- make and break connections between fields and forms .SH SYNOPSIS \fB#include <form.h>\fR .br @@ -86,13 +86,7 @@ These routines emulate the System V forms library. They were not supported on Version 7 or BSD versions. .PP The SVr4 forms library documentation specifies the \fBfield_count\fR error value -as -1 (which is the value of \fBERR\fR). +as \-1 (which is the value of \fBERR\fR). .SH AUTHORS Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/form_field_attributes.3x b/man/form_field_attributes.3x index 90dc0f3..da3ad79 100644 --- a/man/form_field_attributes.3x +++ b/man/form_field_attributes.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998-2002,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2006,2010 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,10 +27,10 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: form_field_attributes.3x,v 1.10 2006/11/04 18:51:26 tom Exp $ +.\" $Id: form_field_attributes.3x,v 1.12 2010/12/04 18:40:45 tom Exp $ .TH form_field_attributes 3X "" .SH NAME -\fBform_field_attributes\fR - color and attribute control for form fields +\fBform_field_attributes\fR \- color and attribute control for form fields .SH SYNOPSIS \fB#include <form.h>\fR .br @@ -84,9 +84,3 @@ Version 7 or BSD versions. .SH AUTHORS Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/form_field_buffer.3x b/man/form_field_buffer.3x index 566072f..b4ff8cb 100644 --- a/man/form_field_buffer.3x +++ b/man/form_field_buffer.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998-2006,2008 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2008,2010 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * .\" copy of this software and associated documentation files (the * @@ -27,13 +27,16 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: form_field_buffer.3x,v 1.15 2008/10/18 18:35:17 tom Exp $ +.\" $Id: form_field_buffer.3x,v 1.19 2010/12/04 18:38:55 tom Exp $ .TH form_field_buffer 3X "" +.de bP +.IP \(bu 4 +.. .SH NAME -\fBform_field_buffer\fR - field buffer control +\fBform_field_buffer\fR \- field buffer control .SH SYNOPSIS \fB#include <form.h>\fR -.br +.sp int set_field_buffer(FIELD *field, int buf, const char *value); .br char *field_buffer(const FIELD *field, int buffer); @@ -48,11 +51,9 @@ int set_max_field(FIELD *field, int max); The function \fBset_field_buffer\fR sets the numbered buffer of the given field to contain a given string: .RS 3 -.TP 3 -- +.bP Buffer 0 is the displayed value of the field. -.TP 3 -- +.bP Other numbered buffers may be allocated by applications through the \fBnbuf\fR argument of (see \fBform_field_new\fR(3X)) but are not manipulated by the forms library. @@ -61,28 +62,23 @@ but are not manipulated by the forms library. The function \fBfield_buffer\fR returns a pointer to the contents of the given numbered buffer: .RS 3 -.TP 3 -- +.bP The buffer contents always have the same length, and are padded with trailing spaces as needed to ensure this length is the same. -.TP 3 -- +.bP The buffer may contain leading spaces, depending on how it was set. -.TP 3 -- +.bP The buffer contents are set with \fBset_field_buffer\fP, or as a side effect of any editing operations on the corresponding field. -.TP 3 -- +.bP Editing operations are based on the \fIwindow\fP which displays the field, rather than a \fIstring\fP. The window contains only printable characters, and is filled with blanks. If you want the raw data, you must write your own routine that copies the value out of the buffer and removes the leading and trailing spaces. -.TP 3 -- +.bP Because editing operations change the content of the buffer to correspond to the window, you should not rely on using buffers for long-term storage of form data. @@ -122,7 +118,7 @@ descriptions of the entry points. .SH NOTES The header file \fB<form.h>\fR automatically includes the header file .PP -When configured for wide-characters, \fBfield_buffer\fP returns a pointer +When configured for wide characters, \fBfield_buffer\fP returns a pointer to temporary storage (allocated and freed by the library). The application should not attempt to modify the data. It will be freed on the next call to \fBfield_buffer\fP to return the @@ -134,9 +130,3 @@ Version 7 or BSD versions. .SH AUTHORS Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/form_field_info.3x b/man/form_field_info.3x index bde3128..6a1af6c 100644 --- a/man/form_field_info.3x +++ b/man/form_field_info.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998-2005,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2006,2010 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,10 +27,10 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: form_field_info.3x,v 1.10 2006/11/04 17:14:31 tom Exp $ +.\" $Id: form_field_info.3x,v 1.12 2010/12/04 18:40:45 tom Exp $ .TH form_field_info 3X "" .SH NAME -\fBform_field_info\fR - retrieve field characteristics +\fBform_field_info\fR \- retrieve field characteristics .SH SYNOPSIS \fB#include <form.h>\fR .br @@ -77,9 +77,3 @@ Not all implementations allow this, e.g., Solaris 2.7 does not. .SH AUTHORS Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/form_field_just.3x b/man/form_field_just.3x index 15d6cb2..2f223e9 100644 --- a/man/form_field_just.3x +++ b/man/form_field_just.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998-2003,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2006,2010 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,10 +27,10 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: form_field_just.3x,v 1.9 2006/11/04 17:12:00 tom Exp $ +.\" $Id: form_field_just.3x,v 1.11 2010/12/04 18:40:45 tom Exp $ .TH form_field_just 3X "" .SH NAME -\fBform_field_just\fR - retrieve field characteristics +\fBform_field_just\fR \- retrieve field characteristics .SH SYNOPSIS \fB#include <form.h>\fR .br @@ -70,9 +70,3 @@ Version 7 or BSD versions. .SH AUTHORS Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/form_field_new.3x b/man/form_field_new.3x index 6095de1..23a3516 100644 --- a/man/form_field_new.3x +++ b/man/form_field_new.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998-2006,2007 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2007,2010 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,10 +27,10 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: form_field_new.3x,v 1.16 2007/06/02 20:40:07 tom Exp $ +.\" $Id: form_field_new.3x,v 1.18 2010/12/04 18:40:45 tom Exp $ .TH form_field_new 3X "" .SH NAME -\fBform_field_new\fR - create and destroy form fields +\fBform_field_new\fR \- create and destroy form fields .SH SYNOPSIS \fB#include <form.h>\fR .br @@ -98,9 +98,3 @@ 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. -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/form_field_opts.3x b/man/form_field_opts.3x index d505279..a33a041 100644 --- a/man/form_field_opts.3x +++ b/man/form_field_opts.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998-2006,2007 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2007,2010 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,10 +27,10 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: form_field_opts.3x,v 1.13 2007/02/24 17:34:27 tom Exp $ +.\" $Id: form_field_opts.3x,v 1.16 2010/12/04 18:41:07 tom Exp $ .TH form_field_opts 3X "" .SH NAME -\fBform_field_opts\fR - set and get field options +\fBform_field_opts\fR \- set and get field options .SH SYNOPSIS \fB#include <form.h>\fR .br @@ -106,7 +106,6 @@ The field is the current field. System error occurred (see \fBerrno\fR). .SH SEE ALSO \fBcurses\fR(3X), \fBform\fR(3X). -.TP 5 .SH NOTES The header file \fB<form.h>\fR automatically includes the header file \fB<curses.h>\fR. @@ -116,9 +115,3 @@ Version 7 or BSD versions. .SH AUTHORS Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/form_field_userptr.3x b/man/form_field_userptr.3x index 47b9ed4..898da97 100644 --- a/man/form_field_userptr.3x +++ b/man/form_field_userptr.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2006,2010 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,10 +27,10 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: form_field_userptr.3x,v 1.8 2006/11/04 18:04:37 tom Exp $ +.\" $Id: form_field_userptr.3x,v 1.10 2010/12/04 18:40:45 tom Exp $ .TH form_field_userptr 3X "" .SH NAME -\fBform_field_userptr\fR - associate application data with a form field +\fBform_field_userptr\fR \- associate application data with a form field .SH SYNOPSIS \fB#include <form.h>\fR .br @@ -61,9 +61,3 @@ We chose not to leave it as a char pointer for SVr4 compatibility. .SH AUTHORS Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/form_field_validation.3x b/man/form_field_validation.3x index 2da52ef..3505fdb 100644 --- a/man/form_field_validation.3x +++ b/man/form_field_validation.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2003,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2006,2010 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,10 +26,10 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: form_field_validation.3x,v 1.16 2006/12/24 16:08:08 tom Exp $ +.\" $Id: form_field_validation.3x,v 1.20 2010/12/04 18:38:55 tom Exp $ .TH form_field_validation 3X "" .SH NAME -\fBform_field_validation\fR - data type validation for fields +\fBform_field_validation\fR \- data type validation for fields .SH SYNOPSIS \fB#include <form.h>\fR .br @@ -70,9 +70,7 @@ argument pointing to a string list; a fourth \fBint\fR flag argument to enable case-sensitivity; and a fifth \fBint\fR flag argument specifying whether a partial match must be a unique one (if this flag is off, a prefix matches the first of any set of more than one list elements with that prefix). Please notice -that the string list is not copied, only a reference to it is stored in the -field. So you should avoid using a list that lives in automatic variables -on the stack. +that the string list is copied. So you may use a list that lives in automatic variables on the stack. .TP 5 TYPE_INTEGER Integer data, parsable to an integer by \fBatoi(3)\fR. Requires a third @@ -101,10 +99,10 @@ Regular expression data. Requires a regular expression \fB(char *)\fR third arg the data is valid if the regular expression matches it. Regular expressions 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 +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 -allow fewer digits, you may use for example "^[0-9]* *$" which is good for -trailing spaces (up to an empty field), or "^ *[0-9]* *$" which is good for +allow fewer digits, you may use for example "^[0\-9]* *$" which is good for +trailing spaces (up to an empty field), or "^ *[0\-9]* *$" which is good for leading and trailing spaces around the digits. .TP 5 TYPE_IPV4 @@ -126,7 +124,9 @@ The routine succeeded. .B E_SYSTEM_ERROR System error occurred (see \fBerrno\fR). .SH SEE ALSO -\fBcurses\fR(3X), \fBform\fR(3X). +\fBcurses\fR(3X), +\fBform\fR(3X), +\fBform_variables\fR(3X). .SH NOTES The header file \fB<form.h>\fR automatically includes the header file \fB<curses.h>\fR. @@ -136,9 +136,3 @@ Version 7 or BSD versions. .SH AUTHORS Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/form_fieldtype.3x b/man/form_fieldtype.3x index 0d42fae..028e9b0 100644 --- a/man/form_fieldtype.3x +++ b/man/form_fieldtype.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998-2003,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2006,2010 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,10 +27,10 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: form_fieldtype.3x,v 1.14 2006/11/04 17:12:00 tom Exp $ +.\" $Id: form_fieldtype.3x,v 1.16 2010/12/04 18:40:45 tom Exp $ .TH form_fieldtype 3X "" .SH NAME -\fBform_fieldtype\fR - define validation-field types +\fBform_fieldtype\fR \- define validation-field types .SH SYNOPSIS \fB#include <form.h>\fR .br @@ -140,9 +140,3 @@ Version 7 or BSD versions. .SH AUTHORS Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/form_hook.3x b/man/form_hook.3x index cd47a24..2943b88 100644 --- a/man/form_hook.3x +++ b/man/form_hook.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998-2006,2007 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2007,2010 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,10 +27,10 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: form_hook.3x,v 1.9 2007/02/24 17:34:18 tom Exp $ +.\" $Id: form_hook.3x,v 1.11 2010/12/04 18:40:45 tom Exp $ .TH form_hook 3X "" .SH NAME -\fBform_hook\fR - set hooks for automatic invocation by applications +\fBform_hook\fR \- set hooks for automatic invocation by applications .SH SYNOPSIS \fB#include <form.h>\fR .br @@ -92,9 +92,3 @@ Version 7 or BSD versions. .SH AUTHORS Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/form_new.3x b/man/form_new.3x index cac4f50..b69f642 100644 --- a/man/form_new.3x +++ b/man/form_new.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2006,2010 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,10 +27,10 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: form_new.3x,v 1.7 2006/11/04 17:12:00 tom Exp $ +.\" $Id: form_new.3x,v 1.9 2010/12/04 18:40:45 tom Exp $ .TH form_new 3X "" .SH NAME -\fBform_new\fR - create and destroy forms +\fBform_new\fR \- create and destroy forms .SH SYNOPSIS \fB#include <form.h>\fR .br @@ -81,9 +81,3 @@ Version 7 or BSD versions. .SH AUTHORS Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/form_new_page.3x b/man/form_new_page.3x index 5b7f58d..635822d 100644 --- a/man/form_new_page.3x +++ b/man/form_new_page.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998-2002,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2006,2010 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,10 +27,10 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: form_new_page.3x,v 1.8 2006/11/04 17:12:00 tom Exp $ +.\" $Id: form_new_page.3x,v 1.10 2010/12/04 18:40:45 tom Exp $ .TH form_new_page 3X "" .SH NAME -\fBform_new_page\fR - form pagination functions +\fBform_new_page\fR \- form pagination functions .SH SYNOPSIS \fB#include <form.h>\fR .br @@ -69,9 +69,3 @@ Version 7 or BSD versions. .SH AUTHORS Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/form_opts.3x b/man/form_opts.3x index 0caaae7..f02cec6 100644 --- a/man/form_opts.3x +++ b/man/form_opts.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998-2006,2007 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2007,2010 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,10 +27,10 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: form_opts.3x,v 1.9 2007/02/24 17:34:36 tom Exp $ +.\" $Id: form_opts.3x,v 1.11 2010/12/04 18:40:45 tom Exp $ .TH form_opts 3X "" .SH NAME -\fBform_opts\fR - set and get form options +\fBform_opts\fR \- set and get form options .SH SYNOPSIS \fB#include <form.h>\fR .br @@ -82,9 +82,3 @@ Version 7 or BSD versions. .SH AUTHORS Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/form_page.3x b/man/form_page.3x index 50ed54d..2211216 100644 --- a/man/form_page.3x +++ b/man/form_page.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2006,2010 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,10 +27,10 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: form_page.3x,v 1.10 2006/11/04 18:52:32 tom Exp $ +.\" $Id: form_page.3x,v 1.12 2010/12/04 18:40:45 tom Exp $ .TH form_page 3X "" .SH NAME -\fBform_page\fR - set and get form page number +\fBform_page\fR \- set and get form page number .SH SYNOPSIS \fB#include <form.h>\fR .br @@ -88,9 +88,3 @@ Version 7 or BSD versions. .SH AUTHORS Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/form_post.3x b/man/form_post.3x index 6bf1607..4799d9d 100644 --- a/man/form_post.3x +++ b/man/form_post.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2006,2010 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,10 +27,10 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: form_post.3x,v 1.7 2006/11/04 18:53:20 tom Exp $ +.\" $Id: form_post.3x,v 1.9 2010/12/04 18:40:45 tom Exp $ .TH form_post 3X "" .SH NAME -\fBform_post\fR - write or erase forms from associated subwindows +\fBform_post\fR \- write or erase forms from associated subwindows .SH SYNOPSIS \fB#include <form.h>\fR .br @@ -83,9 +83,3 @@ Version 7 or BSD versions. .SH AUTHORS Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/form_requestname.3x b/man/form_requestname.3x index a172f85..4a4e7eb0 100644 --- a/man/form_requestname.3x +++ b/man/form_requestname.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2006,2010 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,10 +27,10 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: form_requestname.3x,v 1.7 2006/11/04 17:57:49 tom Exp $ +.\" $Id: form_requestname.3x,v 1.9 2010/12/04 18:40:45 tom Exp $ .TH form_requestname 3X "" .SH NAME -\fBform_requestname\fR - handle printable form request names +\fBform_requestname\fR \- handle printable form request names .SH SYNOPSIS \fB#include <form.h>\fR .br @@ -62,9 +62,3 @@ any code depending on them be conditioned using NCURSES_VERSION. .SH AUTHORS Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/form_userptr.3x b/man/form_userptr.3x index 7be0bf8..bd29b54 100644 --- a/man/form_userptr.3x +++ b/man/form_userptr.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2006,2010 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,10 +27,10 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: form_userptr.3x,v 1.11 2006/11/04 18:43:24 tom Exp $ +.\" $Id: form_userptr.3x,v 1.13 2010/12/04 18:40:45 tom Exp $ .TH form_userptr 3X "" .SH NAME -\fBform_userptr\fR - associate application data with a form item +\fBform_userptr\fR \- associate application data with a form item .SH SYNOPSIS \fB#include <form.h>\fR .br @@ -61,9 +61,3 @@ We chose not to leave it as a char pointer for SVr4 compatibility. .SH AUTHORS Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/form_variables.3x b/man/form_variables.3x new file mode 100644 index 0000000..49f2876 --- /dev/null +++ b/man/form_variables.3x @@ -0,0 +1,82 @@ +.\"*************************************************************************** +.\" Copyright (c) 2010 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: form_variables.3x,v 1.3 2010/12/04 18:38:55 tom Exp $ +.TH form_variables 3X "" +.ds n 5 +.na +.hy 0 +.SH NAME +\fBTYPE_ALNUM\fR, +\fBTYPE_ALPHA\fR, +\fBTYPE_ENUM\fR, +\fBTYPE_INTEGER\fR, +\fBTYPE_IPV4\fR, +\fBTYPE_NUMERIC\fR, +\fBTYPE_REGEXP\fR +\- form system global variables +.ad +.hy +.SH SYNOPSIS +.nf +\fB#include <form.h>\fR +.br +.PP +\fBFIELDTYPE * TYPE_ALNUM;\fR +\fBFIELDTYPE * TYPE_ALPHA;\fR +\fBFIELDTYPE * TYPE_ENUM;\fR +\fBFIELDTYPE * TYPE_INTEGER;\fR +\fBFIELDTYPE * TYPE_IPV4;\fR +\fBFIELDTYPE * TYPE_NUMERIC;\fR +\fBFIELDTYPE * TYPE_REGEXP;\fR +.br +.fi +.SH DESCRIPTION +These are building blocks for the form library, +defining fields that can be created using \fBset_fieldtype\fP(3X). +Each provides functions for field- and character-validation, +according to the given datatype. +.SS TYPE_ALNUM +This holds alphanumeric data. +.SS TYPE_ALPHA +This holds alphabetic data. +.SS TYPE_ENUM +This holds an enumerated type. +.SS TYPE_INTEGER +This holds a decimal integer. +.SS TYPE_IPV4 +This holds an IPv4 internet address, e.g., "127.0.0.1". +.SS TYPE_NUMERIC +This holds a decimal number, with optional sign and decimal point. +.SS TYPE_REGEXP +This holds a regular expression. +.SH PORTABILITY +The \fBTYPE_IPV4\fP variable is an extension not provided by older +implementations of the form library. +.SH SEE ALSO +\fBform\fR(3X). diff --git a/man/form_win.3x b/man/form_win.3x index c8f64f2..32af49b 100644 --- a/man/form_win.3x +++ b/man/form_win.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2006,2010 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,10 +27,10 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: form_win.3x,v 1.10 2006/11/04 17:12:00 tom Exp $ +.\" $Id: form_win.3x,v 1.13 2010/12/04 18:38:55 tom Exp $ .TH form_win 3X "" .SH NAME -\fBform_win\fR - make and break form window and subwindow associations +\fBform_win\fR \- make and break form window and subwindow associations .SH SYNOPSIS \fB#include <form.h>\fR .br @@ -77,7 +77,9 @@ The form has already been posted. .B E_NOT_CONNECTED No items are connected to the form. .SH SEE ALSO -\fBcurses\fR(3X), \fBform\fR(3X). +\fBcurses\fR(3X), +\fBcurs_variables\fR(3X), +\fBform\fR(3X). .SH NOTES The header file \fB<form.h>\fR automatically includes the header file \fB<curses.h>\fR. @@ -87,9 +89,3 @@ Version 7 or BSD versions. .SH AUTHORS Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/infocmp.1m b/man/infocmp.1m index b1a88e7..bfc3cc3 100644 --- a/man/infocmp.1m +++ b/man/infocmp.1m @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998-2004,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2006,2010 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,14 +27,14 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: infocmp.1m,v 1.44 2006/12/24 18:16:31 tom Exp $ +.\" $Id: infocmp.1m,v 1.46 2010/12/04 18:40:45 tom Exp $ .TH @INFOCMP@ 1M "" .ds n 5 .ds d @TERMINFO@ .SH NAME -\fB@INFOCMP@\fR - compare or print out \fIterminfo\fR descriptions +\fB@INFOCMP@\fR \- compare or print out \fIterminfo\fR descriptions .SH SYNOPSIS -\fB@INFOCMP@\fR [\fB-\ +\fB@INFOCMP@\fR [\fB\-\ 1\ C\ E\ @@ -60,9 +60,9 @@ u\ x\ \fR] .br - [\fB-v\fR \fIn\fR] [\fB-s d\fR| \fBi\fR| \fBl\fR| \fBc\fR] [\fB-R \fR\fBsubset\fR] + [\fB\-v\fR \fIn\fR] [\fB\-s d\fR| \fBi\fR| \fBl\fR| \fBc\fR] [\fB\-R \fR\fBsubset\fR] .br - [\fB-w\fR\ \fIwidth\fR] [\fB-A\fR\ \fIdirectory\fR] [\fB-B\fR\ \fIdirectory\fR] + [\fB\-w\fR\ \fIwidth\fR] [\fB\-A\fR\ \fIdirectory\fR] [\fB\-B\fR\ \fIdirectory\fR] .br [\fItermname\fR...] .SH DESCRIPTION @@ -74,45 +74,45 @@ fields will be printed first, followed by the numeric fields, followed by the string fields. .SS Default Options 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] +\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] \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: -\fBF\fR for boolean variables, \fB-1\fR for integer variables, and \fBNULL\fR +\fBF\fR for boolean variables, \fB\-1\fR for integer variables, and \fBNULL\fR for string variables. .PP -The \fB-d\fR option produces a list of each capability that is different +The \fB\-d\fR option produces a list of each capability that is different between two entries. This option is useful to show the difference between two entries, created by different people, for the same or similar terminals. .PP -The \fB-c\fR option produces a list of each capability that is common between +The \fB\-c\fR option produces a list of each capability that is common between two entries. Capabilities that are not set are ignored. This option can be -used as a quick check to see if the \fB-u\fR option is worth using. +used as a quick check to see if the \fB\-u\fR option is worth using. .PP -The \fB-n\fR option produces a list of each capability that is in neither +The \fB\-n\fR option produces a list of each capability that is in neither entry. If no \fItermnames\fR are given, the environment variable \fBTERM\fR will be used for both of the \fItermnames\fR. This can be used as a quick check to see if anything was left out of a description. -.SS Source Listing Options [-I] [-L] [-C] [-r] -The \fB-I\fR, \fB-L\fR, and \fB-C\fR options will produce a source listing for +.SS Source Listing Options [\-I] [\-L] [\-C] [\-r] +The \fB\-I\fR, \fB\-L\fR, and \fB\-C\fR options will produce a source listing for each terminal named. . .TS center tab(/) ; l l . -\fB-I\fR/use the \fBterminfo\fR names -\fB-L\fR/use the long C variable name listed in <\fBterm.h\fR> -\fB-C\fR/use the \fBtermcap\fR names -\fB-r\fR/when using \fB-C\fR, put out all capabilities in \fBtermcap\fR form +\fB\-I\fR/use the \fBterminfo\fR names +\fB\-L\fR/use the long C variable name listed in <\fBterm.h\fR> +\fB\-C\fR/use the \fBtermcap\fR names +\fB\-r\fR/when using \fB\-C\fR, put out all capabilities in \fBtermcap\fR form .TE .PP If no \fItermnames\fR are given, the environment variable \fBTERM\fR will be used for the terminal name. .PP -The source produced by the \fB-C\fR option may be used directly as a +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. \fB@INFOCMP@\fR will attempt to convert most of the parameterized information, and anything not converted will be plainly marked in @@ -125,7 +125,7 @@ padding (padding information with a trailing '/') will become optional. All \fBtermcap\fR variables no longer supported by \fBterminfo\fR, but which are derivable from other \fBterminfo\fR variables, will be output. Not all \fBterminfo\fR capabilities will be translated; only those variables which were -part of \fBtermcap\fR will normally be output. Specifying the \fB-r\fR option +part of \fBtermcap\fR will normally be output. Specifying the \fB\-r\fR option will take off this restriction, allowing all capabilities to be output in \fItermcap\fR form. .PP @@ -153,8 +153,8 @@ l l l. \fB%p1%?%'x'%>%t%p1%'y'%+%;/%>xy\fR/concept \fB%p2\fR is printed before \fB%p1/%r\fR/hp .TE -.SS Use= Option [-u] -The \fB-u\fR option produces a \fBterminfo\fR source description of the first +.SS Use= Option [\-u] +The \fB\-u\fR option produces a \fBterminfo\fR source description of the first terminal \fItermname\fR which is relative to the sum of the descriptions given by the entries for the other terminals \fItermnames\fR. It does this by analyzing the differences between the first \fItermname\fR and the other @@ -189,29 +189,29 @@ 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. \fB@INFOCMP@\fR will flag any other \fItermname use=\fR fields that were not needed. -.SS Changing Databases [-A \fIdirectory\fR] [-B \fIdirectory\fR] +.SS Changing Databases [\-A \fIdirectory\fR] [\-B \fIdirectory\fR] The location of the compiled \fBterminfo\fR database is taken from the environment variable \fBTERMINFO\fR . If the variable is not defined, or the terminal is not found in that location, the system \fBterminfo\fR database, -in \fB@TERMINFO@\fR, will be used. The options \fB-A\fR -and \fB-B\fR may be used to override this location. The \fB-A\fR option will -set \fBTERMINFO\fR for the first \fItermname\fR and the \fB-B\fR option will +in \fB@TERMINFO@\fR, will be used. The options \fB\-A\fR +and \fB\-B\fR may be used to override this location. The \fB\-A\fR option will +set \fBTERMINFO\fR for the first \fItermname\fR and the \fB\-B\fR option will set \fBTERMINFO\fR for the other \fItermnames\fR. With this, it is possible to compare descriptions for a terminal with the same name located in two different databases. This is useful for comparing descriptions for the same terminal created by different people. .SS Other Options .TP 5 -\fB-1\fR +\fB\-1\fR causes the fields to be printed out one to a line. Otherwise, the fields will be printed several to a line to a maximum width of 60 characters. .TP -\fB-a\fR +\fB\-a\fR 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 +\fB\-E\fR Dump the capabilities of the given terminal as tables, needed in the C initializer for a TERMTYPE structure (the terminal capability structure in the \fB<term.h>\fR). @@ -220,17 +220,17 @@ for a given terminal type. The tables are all declared static, and are named according to the type and the name of the corresponding terminal entry. .sp -Before ncurses 5.0, the split between the \fB-e\fP and \fB-E\fP +Before ncurses 5.0, the split between the \fB\-e\fP and \fB\-E\fP options was not needed; but support for extended names required making the arrays of terminal capabilities separate from the TERMTYPE structure. .TP 5 -\fB-e\fR +\fB\-e\fR Dump the capabilities of the given terminal as a C initializer for a TERMTYPE structure (the terminal capability structure in the \fB<term.h>\fR). This option is useful for preparing versions of the curses library hardwired for a given terminal type. .TP 5 -\fB-F\fR +\fB\-F\fR compare terminfo files. This assumes that two following arguments are filenames. The files are searched for pairwise matches between entries, with two entries considered to match if any of their names do. @@ -239,25 +239,25 @@ the other file, and entries with more than one match. For entries with exactly one match it includes a difference report. Normally, to reduce the volume of the report, use references are not resolved before looking for differences, but resolution can be forced -by also specifying \fB-r\fR. +by also specifying \fB\-r\fR. .TP 5 -\fB-f\fR +\fB\-f\fR Display complex terminfo strings which contain if/then/else/endif expressions indented for readability. .TP 5 -\fB-G\fR +\fB\-G\fR Display constant literals in decimal form rather than their character equivalents. .TP 5 -\fB-g\fR +\fB\-g\fR Display constant character literals in quoted form rather than their decimal equivalents. .TP 5 -\fB-i\fR +\fB\-i\fR Analyze the initialization (\fBis1\fR, \fBis2\fR, \fBis3\fR), and reset (\fBrs1\fR, \fBrs2\fR, \fBrs3\fR), strings in the entry. For each string, the code tries to analyze it into actions in terms of the other capabilities in the -entry, certain X3.64/ISO 6429/ECMA-48 capabilities, and certain DEC VT-series +entry, certain X3.64/ISO 6429/ECMA\-48 capabilities, and certain DEC VT-series private modes (the set of recognized special sequences has been selected for completeness over the existing terminfo database). Each report line consists of the capability name, followed by a colon and space, followed by a printable @@ -291,38 +291,38 @@ DECPAM/application keypad mode DECPNM/normal keypad mode DECANSI/enter ANSI mode = -ECMA[+-]AM/keyboard action mode -ECMA[+-]IRM/insert replace mode -ECMA[+-]SRM/send receive mode -ECMA[+-]LNM/linefeed mode +ECMA[+\-]AM/keyboard action mode +ECMA[+\-]IRM/insert replace mode +ECMA[+\-]SRM/send receive mode +ECMA[+\-]LNM/linefeed mode = -DEC[+-]CKM/application cursor keys -DEC[+-]ANM/set VT52 mode -DEC[+-]COLM/132-column mode -DEC[+-]SCLM/smooth scroll -DEC[+-]SCNM/reverse video mode -DEC[+-]OM/origin mode -DEC[+-]AWM/wraparound mode -DEC[+-]ARM/auto-repeat mode +DEC[+\-]CKM/application cursor keys +DEC[+\-]ANM/set VT52 mode +DEC[+\-]COLM/132-column mode +DEC[+\-]SCLM/smooth scroll +DEC[+\-]SCNM/reverse video mode +DEC[+\-]OM/origin mode +DEC[+\-]AWM/wraparound mode +DEC[+\-]ARM/auto-repeat mode .TE .sp It also recognizes a SGR action corresponding to ANSI/ISO 6429/ECMA Set Graphics Rendition, with the values NORMAL, BOLD, UNDERLINE, BLINK, and -REVERSE. All but NORMAL may be prefixed with `+' (turn on) or `-' (turn off). +REVERSE. All but NORMAL may be prefixed with `+' (turn on) or `\-' (turn off). .PP An SGR0 designates an empty highlight sequence (equivalent to {SGR:NORMAL}). .TP 5 -\fB-l\fR +\fB\-l\fR Set output format to terminfo. .TP 5 -\fB-p\fR +\fB\-p\fR Ignore padding specifications when comparing strings. .TP 5 -\fB-q\fR +\fB\-q\fR Make the comparison listing shorter by omitting subheadings, and using -"-" for absent capabilities, "@" for canceled rather than "NULL". +"\-" for absent capabilities, "@" for canceled rather than "NULL". .TP 5 -\fB-R\fR\fIsubset\fR +\fB\-R\fR\fIsubset\fR Restrict output to a given subset. This option is for use with archaic versions of terminfo like those on SVr1, Ultrix, or HP/UX that do not support the full set of SVR4/XSI Curses terminfo; and variants such as AIX @@ -331,8 +331,8 @@ subsets are "SVr1", "Ultrix", "HP", and "AIX"; see \fBterminfo\fR(\*n) for details. You can also choose the subset "BSD" which selects only capabilities with termcap equivalents recognized by 4.4BSD. .TP -\fB-s \fR\fI[d|i|l|c]\fR -The \fB-s\fR option sorts the fields within each type according to the argument +\fB\-s \fR\fI[d|i|l|c]\fR +The \fB\-s\fR option sorts the fields within each type according to the argument below: .br .RS 5 @@ -350,70 +350,70 @@ sort by the long C variable name. sort by the \fItermcap\fR name. .RE .IP -If the \fB-s\fR option is not given, the fields printed out will be +If the \fB\-s\fR option is not given, the fields printed out will be sorted alphabetically by the \fBterminfo\fR name within each type, -except in the case of the \fB-C\fR or the \fB-L\fR options, which cause the +except in the case of the \fB\-C\fR or the \fB\-L\fR options, which cause the sorting to be done by the \fBtermcap\fR name or the long C variable name, respectively. .TP 5 -\fB-T\fR +\fB\-T\fR eliminates size-restrictions on the generated text. This is mainly useful for testing and analysis, since the compiled descriptions are limited (e.g., 1023 for termcap, 4096 for terminfo). .TP -\fB-t\fR +\fB\-t\fR tells \fBtic\fP to discard commented-out capabilities. Normally when translating from terminfo to termcap, untranslatable capabilities are commented-out. .TP 5 -\fB-U\fR +\fB\-U\fR 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 \fB@INFOCMP@\fP makes to fill in missing data. .TP 5 -\fB-V\fR +\fB\-V\fR reports the version of ncurses which was used in this program, and exits. .TP 5 -\fB-v\fR \fIn\fR +\fB\-v\fR \fIn\fR prints out tracing information on standard error as the program runs. Higher values of n induce greater verbosity. .TP 5 -\fB-w\fR \fIwidth\fR +\fB\-w\fR \fIwidth\fR changes the output to \fIwidth\fR characters. .TP -\fB-x\fR +\fB\-x\fR print information for user-defined capabilities. These are extensions to the terminfo repertoire which can be loaded -using the \fB-x\fR option of \fBtic\fP. +using the \fB\-x\fR option of \fBtic\fP. .SH FILES .TP 20 \*d Compiled terminal description database. .SH EXTENSIONS The -\fB-E\fR, -\fB-F\fR, -\fB-G\fR, -\fB-R\fR, -\fB-T\fR, -\fB-V\fR, -\fB-a\fR, -\fB-e\fR, -\fB-f\fR, -\fB-g\fR, -\fB-i\fR, -\fB-l\fR, -\fB-p\fR, -\fB-q\fR and -\fB-t\fR +\fB\-E\fR, +\fB\-F\fR, +\fB\-G\fR, +\fB\-R\fR, +\fB\-T\fR, +\fB\-V\fR, +\fB\-a\fR, +\fB\-e\fR, +\fB\-f\fR, +\fB\-g\fR, +\fB\-i\fR, +\fB\-l\fR, +\fB\-p\fR, +\fB\-q\fR and +\fB\-t\fR options are not supported in SVr4 curses. .PP -The \fB-r\fR option's notion of `termcap' capabilities is System V Release 4's. +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. +4.4BSD set, use \fB\-r\fR \fB\-RBSD\fR. .SH BUGS -The \fB-F\fR option of \fB@INFOCMP@\fR(1M) should be a \fB@TOE@\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), @@ -429,9 +429,3 @@ Eric S. Raymond <esr@snark.thyrsus.com> and .br Thomas E. Dickey <dickey@invisible-island.net> -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/infotocap.1m b/man/infotocap.1m index 19160b4..d9b44f0 100644 --- a/man/infotocap.1m +++ b/man/infotocap.1m @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1999-2004,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 1999-2006,2010 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,40 +27,42 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: infotocap.1m,v 1.8 2006/12/24 20:13:56 tom Exp $ +.\" $Id: infotocap.1m,v 1.11 2010/12/04 18:38:55 tom Exp $ .TH @INFOTOCAP@ 1M "" .ds n 5 .ds d @TERMINFO@ .SH NAME -\fB@INFOTOCAP@\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 -\fB@INFOTOCAP@\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 -\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 +\fB@INFOTOCAP@\fR looks in each given text +\fIfile\fR for \fBterminfo\fR descriptions. +For each terminfo description found, +an equivalent \fBtermcap\fR description is written to standard output. +Terminfo \fBuse\fR capabilities are translated directly to termcap \fBtc\fR capabilities. .TP 5 -\fB-v\fR +\fB\-v\fR print out tracing information on standard error as the program runs. .TP 5 -\fB-V\fR +\fB\-V\fR print out the version of the program in use on standard error and exit. .TP 5 -\fB-1\fR -cause the fields to print out one to a line. Otherwise, the fields -will be printed several to a line to a maximum width of 60 -characters. +\fB\-1\fR +cause the fields to print out one to a line. +Otherwise, the fields +will be printed several to a line to a maximum width of 60 characters. .TP 5 -\fB-w\fR +\fB\-w\fR change the output to \fIwidth\fR characters. .SH FILES .TP 20 \*d Compiled terminal description database. .SH NOTES -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. +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), \fB@TIC@\fR(1M), @@ -69,9 +71,8 @@ You can use other \fI@TIC@\fR options such as \fB-f\fR and \fB-x\fR. .PP This describes \fBncurses\fR version @NCURSES_MAJOR@.@NCURSES_MINOR@ (patch @NCURSES_PATCH@). -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: +.SH AUTHOR +Eric S. Raymond <esr@snark.thyrsus.com> +and +.br +Thomas E. Dickey <dickey@invisible-island.net> diff --git a/man/key_defined.3x b/man/key_defined.3x index d7413da..db6c531 100644 --- a/man/key_defined.3x +++ b/man/key_defined.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 2003-2004,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 2003-2006,2010 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 * @@ -28,7 +28,7 @@ .\" .\" Author: Thomas E. Dickey 2003 .\" -.\" $Id: key_defined.3x,v 1.4 2006/02/25 21:50:01 tom Exp $ +.\" $Id: key_defined.3x,v 1.6 2010/12/04 18:40:45 tom Exp $ .TH key_defined 3X "" .SH NAME \fBkey_defined\fP \- check if a keycode is defined @@ -43,7 +43,7 @@ to any keycode. .SH RETURN VALUE If the string is bound to a keycode, its value (greater than zero) is returned. If no keycode is bound, zero is returned. -If the string conflicts with longer strings which are bound to keys, -1 is returned. +If the string conflicts with longer strings which are bound to keys, \-1 is returned. .SH PORTABILITY These routines are specific to ncurses. They were not supported on Version 7, BSD or System V implementations. It is recommended that @@ -52,9 +52,3 @@ any code depending on them be conditioned using NCURSES_VERSION. \fBdefine_key\fR(3X). .SH AUTHOR Thomas Dickey. -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/keybound.3x b/man/keybound.3x index 53c941b..5dd083a 100644 --- a/man/keybound.3x +++ b/man/keybound.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1999-2006,2008 Free Software Foundation, Inc. * +.\" Copyright (c) 1999-2008,2010 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 * @@ -28,7 +28,7 @@ .\" .\" Author: Thomas E. Dickey 1999 .\" -.\" $Id: keybound.3x,v 1.7 2008/12/13 18:19:07 Frederic.Culot Exp $ +.\" $Id: keybound.3x,v 1.8 2010/12/04 18:49:20 tom Exp $ .TH keybound 3X "" .SH NAME \fBkeybound\fP \- return definition of keycode @@ -56,9 +56,3 @@ any code depending on them be conditioned using NCURSES_VERSION. \fBkeyok\fR(3X). .SH AUTHOR Thomas Dickey. -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/keyok.3x b/man/keyok.3x index 08c2a27..8eaf9a3 100644 --- a/man/keyok.3x +++ b/man/keyok.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2003,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2006,2010 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 * @@ -28,7 +28,7 @@ .\" .\" Author: Thomas E. Dickey 1997 .\" -.\" $Id: keyok.3x,v 1.9 2006/02/25 21:47:06 tom Exp $ +.\" $Id: keyok.3x,v 1.11 2010/12/04 18:40:45 tom Exp $ .TH keyok 3X "" .SH NAME \fBkeyok\fP \- enable or disable a keycode @@ -40,7 +40,7 @@ This is an extension to the curses library. It permits an application to disable specific keycodes, rather than use the \fIkeypad\fP function to disable all keycodes. -Keys that have been disabled can be reenabled. +Keys that have been disabled can be re-enabled. .SH RETURN VALUE The keycode must be greater than zero, else ERR is returned. If it does not correspond to a defined key, then ERR is returned. @@ -55,9 +55,3 @@ any code depending on them be conditioned using NCURSES_VERSION. \fBdefine_key\fR(3X). .SH AUTHOR Thomas Dickey. -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/legacy_coding.3x b/man/legacy_coding.3x index 42c49fe..fabb607 100644 --- a/man/legacy_coding.3x +++ b/man/legacy_coding.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 2005,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 2005-2006,2010 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 * @@ -28,7 +28,7 @@ .\" .\" Author: Thomas E. Dickey .\" -.\" $Id: legacy_coding.3x,v 1.3 2006/12/24 15:12:55 tom Exp $ +.\" $Id: legacy_coding.3x,v 1.4 2010/12/04 18:49:20 tom Exp $ .TH legacy_coding 3X "" .SH NAME \fBuse_legacy_coding\fR \- use terminal's default colors @@ -74,9 +74,3 @@ be conditioned using NCURSES_VERSION. \fBunctrl\fR. .SH AUTHOR Thomas Dickey (to support lynx's font-switching feature). -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/man_db.renames b/man/man_db.renames index ff91eec..e98fd69 100644 --- a/man/man_db.renames +++ b/man/man_db.renames @@ -1,5 +1,5 @@ ############################################################################## -# Copyright (c) 1998-2007,2008 Free Software Foundation, Inc. # +# Copyright (c) 1998-2009,2010 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.41 2008/10/25 23:24:03 tom Exp $ +# $Id: man_db.renames,v 1.47 2010/09/18 15:43:20 tom Exp $ # Manual-page renamings for the man_db program # # Files: @@ -82,6 +82,7 @@ curs_scanw.3x scanw.3ncurses curs_scr_dump.3x scr_dump.3ncurses curs_scroll.3x scroll.3ncurses curs_slk.3x slk.3ncurses +curs_sp_funcs.3x sp_funcs.3ncurses curs_termattrs.3x termattrs.3ncurses curs_termcap.3x termcap.3ncurses curs_terminfo.3x terminfo.3ncurses @@ -89,6 +90,7 @@ curs_threads.3x threads.3ncurses curs_touch.3x touch.3ncurses curs_trace.3x trace.3ncurses curs_util.3x util.3ncurses +curs_variables.3x curses_variables.3ncurses curs_window.3x window.3ncurses curses.3x ncurses.3ncurses default_colors.3x default_colors.3ncurses @@ -115,6 +117,7 @@ form_page.3x page.3form form_post.3x post.3form form_requestname.3x requestname.3form form_userptr.3x userptr.3form +form_variables.3x form_variables.3form form_win.3x win.3form infocmp.1m infocmp.1 infotocap.1m infotocap.1 @@ -152,8 +155,10 @@ putc.3s putc.3 resizeterm.3x resizeterm.3ncurses scanf.3s scanf.3 system.3s system.3 +tabs.1 tabs.1 term.5 term.5 term.7 term.7 +term_variables.3x terminfo_variables.3ncurses terminfo.5 terminfo.5 terminfo.\\\*n terminfo.5 tic.1m tic.1 @@ -174,4 +179,15 @@ system.3 system.3 regcomp.3x regcomp.3 regexec.3x regexec.3 # +# Generated: +adacurses-config.1 adacurses-config.1 +# +ncurses5-config.1 ncurses5-config.1 +ncursesw5-config.1 ncursesw5-config.1 +# +ncurses6-config.1 ncurses6-config.1 +ncursesw6-config.1 ncursesw6-config.1 +ncursest6-config.1 ncursest6-config.1 +ncurseswt6-config.1 ncurseswt6-config.1 +# # vile:cfgmode diff --git a/man/menu.3x b/man/menu.3x index 17d6fc1..ff3a19c 100644 --- a/man/menu.3x +++ b/man/menu.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998-2002,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2006,2010 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,10 +27,10 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: menu.3x,v 1.19 2006/11/04 18:38:29 tom Exp $ +.\" $Id: menu.3x,v 1.21 2010/12/04 18:40:45 tom Exp $ .TH menu 3X "" .SH NAME -\fBmenu\fR - curses extension for programming menus +\fBmenu\fR \- curses extension for programming menus .SH SYNOPSIS \fB#include <menu.h>\fR .br @@ -43,7 +43,7 @@ menus, display menus on the screen, and handle interaction with the user. The \fBmenu\fR library uses the \fBcurses\fR libraries, and a curses initialization routine such as \fBinitscr\fR must be called before using any of these functions. To use the \fBmenu\fR library, link with the options -\fB-lmenu -lcurses\fR. +\fB\-lmenu \-lcurses\fR. . .SS Current Default Values for Item Attributes . @@ -174,7 +174,7 @@ The header file \fB<menu.h>\fR automatically includes the header files \fB<curses.h>\fR and \fB<eti.h>\fR. .PP In your library list, libmenu.a should be before libncurses.a; that is, -you want to say `-lmenu -lncurses', not the other way around (which would +you want to say `\-lmenu \-lncurses', not the other way around (which would usually give a link-error). .SH PORTABILITY These routines emulate the System V menu library. They were not supported on @@ -185,9 +185,3 @@ S. Raymond. .SH SEE ALSO This describes \fBncurses\fR version @NCURSES_MAJOR@.@NCURSES_MINOR@ (patch @NCURSES_PATCH@). -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/menu_attributes.3x b/man/menu_attributes.3x index 505edbc..c33059b 100644 --- a/man/menu_attributes.3x +++ b/man/menu_attributes.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998-2006,2008 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2008,2010 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,10 +27,10 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: menu_attributes.3x,v 1.10 2008/08/23 18:24:23 tom Exp $ +.\" $Id: menu_attributes.3x,v 1.12 2010/12/04 18:40:45 tom Exp $ .TH menu_attributes 3X "" .SH NAME -\fBmenu_attributes\fR - color and attribute control for menus +\fBmenu_attributes\fR \- color and attribute control for menus .SH SYNOPSIS \fB#include <menu.h>\fR .br @@ -92,9 +92,3 @@ Version 7 or BSD versions. .SH AUTHORS Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/menu_cursor.3x b/man/menu_cursor.3x index 4ade0bf..66a835b 100644 --- a/man/menu_cursor.3x +++ b/man/menu_cursor.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2006,2010 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,10 +27,10 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: menu_cursor.3x,v 1.6 2006/11/04 17:13:57 tom Exp $ +.\" $Id: menu_cursor.3x,v 1.8 2010/12/04 18:40:45 tom Exp $ .TH menu_cursor 3X "" .SH NAME -\fBmenu_cursor\fR - position a menu's cursor +\fBmenu_cursor\fR \- position a menu's cursor .SH SYNOPSIS \fB#include <menu.h>\fR .br @@ -65,9 +65,3 @@ Version 7 or BSD versions. .SH AUTHORS Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/menu_driver.3x b/man/menu_driver.3x index 5366040..1fe5001 100644 --- a/man/menu_driver.3x +++ b/man/menu_driver.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2007,2008 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2008,2010 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,10 +26,13 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: menu_driver.3x,v 1.15 2008/06/21 21:55:30 tom Exp $ +.\" $Id: menu_driver.3x,v 1.20 2010/12/04 18:38:55 tom Exp $ .TH menu_driver 3X "" +.de bP +.IP \(bu 4 +.. .SH NAME -\fBmenu_driver\fR - command-processing loop of the menu system +\fBmenu_driver\fR \- command-processing loop of the menu system .SH SYNOPSIS \fB#include <menu.h>\fR .br @@ -38,18 +41,15 @@ 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: -.TP 3 -- +.bP The input is a form navigation request. Navigation request codes are constants defined in \fB<form.h>\fP, which are distinct from the key- and character codes returned by \fBwgetch\fP. -.TP 3 -- +.bP The input is a printable character. Printable characters (which must be positive, less than 256) are checked according to the program's locale settings. -.TP 3 -- +.bP The input is the KEY_MOUSE special key associated with an mouse event. .PP The menu driver requests are as follows: @@ -116,36 +116,29 @@ corresponding action is performed. .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 +Currently only clicks in the user window (e.g., inside the menu display area or the decoration window) are handled. .PP If you click above the display region of the menu: -.RS -.TP +.bP a REQ_SCR_ULINE is generated for a single click, -.TP +.bP a REQ_SCR_UPAGE is generated for a double-click and -.TP +.bP a REQ_FIRST_ITEM is generated for a triple-click. -.RE .PP If you click below the display region of the menu: -.RS -.TP +.bP a REQ_SCR_DLINE is generated for a single click, -.TP +.bP a REQ_SCR_DPAGE is generated for a double-click and -.TP +.bP 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 -- +.bP the menu cursor is positioned to that item. -.TP 3 -- +.bP If you double-click an item a REQ_TOGGLE_ITEM is generated and \fBE_UNKNOWN_COMMAND\fR is returned. This return value makes sense, @@ -153,11 +146,9 @@ 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 -- +.bP 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 could not be translated into a menu request an \fBE_REQUEST_DENIED\fR is returned. @@ -197,7 +188,7 @@ The menu driver could not process the request. .SH SEE ALSO \fBcurses\fR(3X), \fBmenu\fR(3X), -\fBwgetch\fR(3X). +\fBgetch\fR(3X). .SH NOTES The header file \fB<menu.h>\fR automatically includes the header files \fB<curses.h>\fR. @@ -207,9 +198,3 @@ Version 7 or BSD versions. The support for mouse events is ncurses specific. .SH AUTHORS Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/menu_format.3x b/man/menu_format.3x index f4d456f..b9a572b 100644 --- a/man/menu_format.3x +++ b/man/menu_format.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998-2001,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2006,2010 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,10 +27,10 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: menu_format.3x,v 1.10 2006/11/04 17:12:00 tom Exp $ +.\" $Id: menu_format.3x,v 1.12 2010/12/04 18:40:45 tom Exp $ .TH menu_format 3X "" .SH NAME -\fBmenu_format\fR - set and get menu sizes +\fBmenu_format\fR \- set and get menu sizes .SH SYNOPSIS \fB#include <menu.h>\fR .br @@ -79,9 +79,3 @@ Version 7 or BSD versions. .SH AUTHORS Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/menu_hook.3x b/man/menu_hook.3x index 204e1ec..1fd74de7 100644 --- a/man/menu_hook.3x +++ b/man/menu_hook.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998-2006,2007 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2007,2010 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,10 +27,10 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: menu_hook.3x,v 1.9 2007/02/24 17:34:08 tom Exp $ +.\" $Id: menu_hook.3x,v 1.11 2010/12/04 18:40:45 tom Exp $ .TH menu_hook 3X "" .SH NAME -\fBmenu_hook\fR - set hooks for automatic invocation by applications +\fBmenu_hook\fR \- set hooks for automatic invocation by applications .SH SYNOPSIS \fB#include <menu.h>\fR .br @@ -93,9 +93,3 @@ Version 7 or BSD versions. .SH AUTHORS Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/menu_items.3x b/man/menu_items.3x index 0915343..a9c5783 100644 --- a/man/menu_items.3x +++ b/man/menu_items.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2006,2010 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,10 +27,10 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: menu_items.3x,v 1.7 2006/11/04 18:35:31 tom Exp $ +.\" $Id: menu_items.3x,v 1.9 2010/12/04 18:40:45 tom Exp $ .TH menu_items 3X "" .SH NAME -\fBmenu_items\fR - make and break connections between items and menus +\fBmenu_items\fR \- make and break connections between items and menus .SH SYNOPSIS \fB#include <menu.h>\fR .br @@ -81,13 +81,7 @@ These routines emulate the System V menu library. They were not supported on Version 7 or BSD versions. .PP The SVr4 menu library documentation specifies the \fBitem_count\fR error value -as -1 (which is the value of \fBERR\fR). +as \-1 (which is the value of \fBERR\fR). .SH AUTHORS Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/menu_mark.3x b/man/menu_mark.3x index 1db2b3e..1425154 100644 --- a/man/menu_mark.3x +++ b/man/menu_mark.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2006,2010 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,10 +27,10 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: menu_mark.3x,v 1.9 2006/11/04 18:33:18 tom Exp $ +.\" $Id: menu_mark.3x,v 1.11 2010/12/04 18:40:45 tom Exp $ .TH menu_mark 3X "" .SH NAME -\fBmenu_mark\fR - get and set the menu mark string +\fBmenu_mark\fR \- get and set the menu mark string .SH SYNOPSIS \fB#include <menu.h>\fR .br @@ -48,7 +48,7 @@ Calling \fBset_menu_mark\fR with a null menu item will abolish the mark string. Note that changing the length of the mark string for a menu while the menu is posted is likely to produce unhelpful behavior. .PP -The default string is "-" (a dash). Calling \fBset_menu_mark\fR with +The default string is "\-" (a dash). Calling \fBset_menu_mark\fR with a non-\fBNULL\fR menu argument will change this default. .PP The function \fBmenu_mark\fR returns the menu's mark string (or \fBNULL\fR if @@ -78,9 +78,3 @@ Version 7 or BSD versions. .SH AUTHORS Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/menu_new.3x b/man/menu_new.3x index c2b98e4..1197654 100644 --- a/man/menu_new.3x +++ b/man/menu_new.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2006,2010 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,10 +27,10 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: menu_new.3x,v 1.9 2006/11/04 18:31:37 tom Exp $ +.\" $Id: menu_new.3x,v 1.11 2010/12/04 18:40:45 tom Exp $ .TH menu_new 3X "" .SH NAME -\fBmenu_new\fR - create and destroy menus +\fBmenu_new\fR \- create and destroy menus .SH SYNOPSIS \fB#include <menu.h>\fR .br @@ -78,9 +78,3 @@ Version 7 or BSD versions. .SH AUTHORS Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/menu_opts.3x b/man/menu_opts.3x index dc927c4..5f4cb08 100644 --- a/man/menu_opts.3x +++ b/man/menu_opts.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998-2006,2007 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2007,2010 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,10 +27,10 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: menu_opts.3x,v 1.10 2007/02/24 17:33:59 tom Exp $ +.\" $Id: menu_opts.3x,v 1.12 2010/12/04 18:40:45 tom Exp $ .TH menu_opts 3X "" .SH NAME -\fBmenu_opts\fR - set and get menu options +\fBmenu_opts\fR \- set and get menu options .SH SYNOPSIS \fB#include <menu.h>\fR .br @@ -96,9 +96,3 @@ Version 7 or BSD versions. .SH AUTHORS Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/menu_pattern.3x b/man/menu_pattern.3x index 3cde165..e63a9f7 100644 --- a/man/menu_pattern.3x +++ b/man/menu_pattern.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2006,2008 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2008,2010 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,10 +26,10 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: menu_pattern.3x,v 1.11 2008/06/21 21:58:20 tom Exp $ +.\" $Id: menu_pattern.3x,v 1.13 2010/12/04 18:40:45 tom Exp $ .TH menu_pattern 3X "" .SH NAME -\fBmenu_pattern\fR - get and set a menu's pattern buffer +\fBmenu_pattern\fR \- get and set a menu's pattern buffer .SH SYNOPSIS \fB#include <menu.h>\fR .br @@ -83,9 +83,3 @@ Version 7 or BSD versions. .SH AUTHORS Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/menu_post.3x b/man/menu_post.3x index e47facc..d09d0ca 100644 --- a/man/menu_post.3x +++ b/man/menu_post.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2006,2010 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,10 +27,10 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: menu_post.3x,v 1.9 2006/11/04 17:12:00 tom Exp $ +.\" $Id: menu_post.3x,v 1.11 2010/12/04 18:40:45 tom Exp $ .TH menu_post 3X "" .SH NAME -\fBmenu_post\fR - write or erase menus from associated subwindows +\fBmenu_post\fR \- write or erase menus from associated subwindows .SH SYNOPSIS \fB#include <menu.h>\fR .br @@ -83,9 +83,3 @@ Version 7 or BSD versions. .SH AUTHORS Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/menu_requestname.3x b/man/menu_requestname.3x index 1345aa7..d1957a2 100644 --- a/man/menu_requestname.3x +++ b/man/menu_requestname.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2006,2010 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,10 +27,10 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: menu_requestname.3x,v 1.7 2006/11/04 17:56:09 tom Exp $ +.\" $Id: menu_requestname.3x,v 1.9 2010/12/04 18:40:45 tom Exp $ .TH menu_requestname 3X "" .SH NAME -\fBmenu_requestname\fR - handle printable menu request names +\fBmenu_requestname\fR \- handle printable menu request names .SH SYNOPSIS \fB#include <menu.h>\fR .br @@ -63,9 +63,3 @@ any code depending on them be conditioned using NCURSES_VERSION. .SH AUTHORS Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/menu_spacing.3x b/man/menu_spacing.3x index dfe03a8..9e7c3ea 100644 --- a/man/menu_spacing.3x +++ b/man/menu_spacing.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998-2001,2004 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2004,2010 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,10 +27,10 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: menu_spacing.3x,v 1.8 2004/12/11 23:39:07 tom Exp $ +.\" $Id: menu_spacing.3x,v 1.12 2010/12/04 18:38:55 tom Exp $ .TH menu_spacing 3X "" .SH NAME -\fBmenu_spacing\fR - Control spacing between menu items. +\fBmenu_spacing\fR \- Control spacing between menu items. .SH SYNOPSIS \fB#include <menu.h>\fR .br @@ -45,40 +45,44 @@ int menu_spacing(const MENU *menu, int* spc_columns); .br .SH DESCRIPTION -The function \fBset_menu_spacing\fR sets the spacing informations for the menu. -\fBspc_description\fR controls the number of spaces between an item name and an item -description. It must not be larger than \fBTABSIZE\fR. The menu system puts in the -middle of this spacing area the pad character. The remaining parts are filled with +The function \fBset_menu_spacing\fR sets the spacing information for the menu. +Its parameter \fBspc_description\fR controls the number of spaces between an item name and an item +description. +It must not be larger than \fBTABSIZE\fR. +The menu system puts in the +middle of this spacing area the pad character. +The remaining parts are filled with spaces. -\fBspc_rows\fR controls the number of rows that are used for an item. It must not be -larger than 3. The menu system inserts the blank lines between item rows, these lines +The \fBspc_rows\fR parameter controls the number of rows that are used for an item. +It must not be larger than 3. +The menu system inserts the blank lines between item rows, these lines will contain the pad character in the appropriate positions. -\fBspc_columns\fR controls the number of blanks between columns of items. It must not -be larger than TABSIZE. +The \fBspc_columns\fR parameter controls the number of blanks between columns of items. +It must not be larger than TABSIZE. A value of 0 for all the spacing values resets them to the default, which is 1 for all of them. .br -The function \fBmenu_spacing\fR passes back the spacing info for the menu. If a +The function \fBmenu_spacing\fR passes back the spacing info for the menu. +If a pointer is NULL, this specific info is simply not returned. .SH RETURN VALUE -Both routines return \fBE_OK\fR on success. \fBset_menu_spacing\fR may return +Both routines return \fBE_OK\fR on success. +\fBset_menu_spacing\fR may return \fBE_POSTED\fR if the menu is posted, or \fBE_BAD_ARGUMENT\fR if one of the spacing values is out of range. .SH SEE ALSO -\fBcurses\fR(3X), \fBmenu\fR(3X). +\fBcurses\fR(3X), +\fBcurs_variables\fR(3X), +\fBmenu\fR(3X). .SH NOTES The header file \fB<menu.h>\fR automatically includes the header file \fB<curses.h>\fR. .SH PORTABILITY -These routines are specific to ncurses. They were not supported on -Version 7, BSD or System V implementations. It is recommended that +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 them be conditioned using NCURSES_VERSION. .SH AUTHORS -Juergen Pfeifer. Manual pages and adaptation for new curses by Eric -S. Raymond. -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: +Juergen Pfeifer. +Manual pages and adaptation for new curses by Eric S. Raymond. diff --git a/man/menu_userptr.3x b/man/menu_userptr.3x index b7be2ad..0455fe3 100644 --- a/man/menu_userptr.3x +++ b/man/menu_userptr.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2006,2010 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,10 +27,10 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: menu_userptr.3x,v 1.8 2006/11/04 18:21:03 tom Exp $ +.\" $Id: menu_userptr.3x,v 1.10 2010/12/04 18:40:45 tom Exp $ .TH menu_userptr 3X "" .SH NAME -\fBmenu_userptr\fR - associate application data with a menu item +\fBmenu_userptr\fR \- associate application data with a menu item .SH SYNOPSIS \fB#include <menu.h>\fR .br @@ -61,9 +61,3 @@ We chose not to leave it as a char pointer for SVr4 compatibility. .SH AUTHORS Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/menu_win.3x b/man/menu_win.3x index aa356e1..774eafa 100644 --- a/man/menu_win.3x +++ b/man/menu_win.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2006,2010 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,10 +27,10 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: menu_win.3x,v 1.8 2006/11/04 17:12:00 tom Exp $ +.\" $Id: menu_win.3x,v 1.11 2010/12/04 18:38:55 tom Exp $ .TH menu_win 3X "" .SH NAME -\fBmenu_win\fR - make and break menu window and subwindow associations +\fBmenu_win\fR \- make and break menu window and subwindow associations .SH SYNOPSIS \fB#include <menu.h>\fR .br @@ -77,7 +77,9 @@ The menu has already been posted. .B E_NOT_CONNECTED No items are connected to the menu. .SH SEE ALSO -\fBcurses\fR(3X), \fBmenu\fR(3X). +\fBcurses\fR(3X), +\fBcurs_variables\fR(3X), +\fBmenu\fR(3X). .SH NOTES The header file \fB<menu.h>\fR automatically includes the header file \fB<curses.h>\fR. @@ -87,9 +89,3 @@ Version 7 or BSD versions. .SH AUTHORS Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/mitem_current.3x b/man/mitem_current.3x index 979f401..86c9b47 100644 --- a/man/mitem_current.3x +++ b/man/mitem_current.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2006,2010 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,10 +27,10 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: mitem_current.3x,v 1.11 2006/11/04 18:18:19 tom Exp $ +.\" $Id: mitem_current.3x,v 1.13 2010/12/04 18:40:45 tom Exp $ .TH mitem_current 3X "" .SH NAME -\fBmitem_current\fR - set and get current_menu_item +\fBmitem_current\fR \- set and get current_menu_item .SH SYNOPSIS \fB#include <menu.h>\fR .br @@ -90,13 +90,7 @@ These routines emulate the System V menu library. They were not supported on Version 7 or BSD versions. .PP The SVr4 menu library documentation specifies the \fBtop_row\fR and -\fBindex_item\fR error value as -1 (which is the value of \fBERR\fR). +\fBindex_item\fR error value as \-1 (which is the value of \fBERR\fR). .SH AUTHORS Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/mitem_name.3x b/man/mitem_name.3x index 12009ed..ff879e6 100644 --- a/man/mitem_name.3x +++ b/man/mitem_name.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2006,2010 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,10 +27,10 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: mitem_name.3x,v 1.6 2006/11/04 17:53:40 tom Exp $ +.\" $Id: mitem_name.3x,v 1.8 2010/12/04 18:40:45 tom Exp $ .TH mitem_name 3X "" .SH NAME -\fBmitem_name\fR - get menu item name and description fields +\fBmitem_name\fR \- get menu item name and description fields .SH SYNOPSIS \fB#include <menu.h>\fR .br @@ -57,9 +57,3 @@ They were not supported on Version 7 or BSD versions. .SH AUTHORS Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/mitem_new.3x b/man/mitem_new.3x index c0fa6ed..8e2449e 100644 --- a/man/mitem_new.3x +++ b/man/mitem_new.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998-2003,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2006,2010 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,10 +27,10 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: mitem_new.3x,v 1.10 2006/11/04 18:16:36 tom Exp $ +.\" $Id: mitem_new.3x,v 1.12 2010/12/04 18:40:45 tom Exp $ .TH mitem_new 3X "" .SH NAME -\fBmitem_new\fR - create and destroy menu items +\fBmitem_new\fR \- create and destroy menu items .SH SYNOPSIS \fB#include <menu.h>\fR .br @@ -82,9 +82,3 @@ Version 7 or BSD versions. .SH AUTHORS Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/mitem_opts.3x b/man/mitem_opts.3x index 2459dab..37ea552 100644 --- a/man/mitem_opts.3x +++ b/man/mitem_opts.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998-2006,2007 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2007,2010 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,10 +27,10 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: mitem_opts.3x,v 1.9 2007/02/24 17:33:32 tom Exp $ +.\" $Id: mitem_opts.3x,v 1.11 2010/12/04 18:40:45 tom Exp $ .TH mitem_opts 3X "" .SH NAME -\fBmitem_opts\fR - set and get menu item options +\fBmitem_opts\fR \- set and get menu item options .SH SYNOPSIS \fB#include <menu.h>\fR .br @@ -76,9 +76,3 @@ Version 7 or BSD versions. .SH AUTHORS Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/mitem_userptr.3x b/man/mitem_userptr.3x index 5895193..7b51ec5 100644 --- a/man/mitem_userptr.3x +++ b/man/mitem_userptr.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2006,2010 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,10 +27,10 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: mitem_userptr.3x,v 1.9 2006/11/04 18:21:03 tom Exp $ +.\" $Id: mitem_userptr.3x,v 1.11 2010/12/04 18:40:45 tom Exp $ .TH mitem_userptr 3X "" .SH NAME -\fBmitem_userptr\fR - associate application data with a menu item +\fBmitem_userptr\fR \- associate application data with a menu item .SH SYNOPSIS \fB#include <menu.h>\fR .br @@ -62,9 +62,3 @@ We chose not to leave it as a char pointer for SVr4 compatibility. .SH AUTHORS Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/mitem_value.3x b/man/mitem_value.3x index 748fd52..57cfc53 100644 --- a/man/mitem_value.3x +++ b/man/mitem_value.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2002,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2006,2010 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,10 +26,10 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: mitem_value.3x,v 1.8 2006/11/04 17:12:00 tom Exp $ +.\" $Id: mitem_value.3x,v 1.10 2010/12/04 18:40:45 tom Exp $ .TH mitem_value 3X "" .SH NAME -\fBmitem_value\fR - set and get menu item values +\fBmitem_value\fR \- set and get menu item values .SH SYNOPSIS \fB#include <menu.h>\fR .br @@ -68,9 +68,3 @@ Version 7 or BSD versions. .SH AUTHORS Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/mitem_visible.3x b/man/mitem_visible.3x index 8f9039c..4ff9405 100644 --- a/man/mitem_visible.3x +++ b/man/mitem_visible.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998 Free Software Foundation, Inc. * +.\" Copyright (c) 1998,2010 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,10 +27,10 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: mitem_visible.3x,v 1.5 1998/11/29 01:12:55 Rick.Ohnemus Exp $ +.\" $Id: mitem_visible.3x,v 1.7 2010/12/04 18:40:45 tom Exp $ .TH mitem_visible 3X "" .SH NAME -\fBmitem_visible\fR - check visibility of a menu item +\fBmitem_visible\fR \- check visibility of a menu item .SH SYNOPSIS \fB#include <menu.h>\fR .br @@ -51,9 +51,3 @@ Version 7 or BSD versions. .SH AUTHORS Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/ncurses.3x b/man/ncurses.3x index 703a239..4acfc05 100644 --- a/man/ncurses.3x +++ b/man/ncurses.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998-2007,2008 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2010,2011 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * .\" copy of this software and associated documentation files (the * @@ -27,13 +27,16 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: ncurses.3x,v 1.92 2008/10/25 23:31:45 tom Exp $ +.\" $Id: ncurses.3x,v 1.103 2011/02/05 23:21:29 tom Exp $ .hy 0 .TH ncurses 3X "" +.de bP +.IP \(bu 4 +.. .ds n 5 .ds d @TERMINFO@ .SH NAME -\fBncurses\fR - CRT screen handling and optimization package +\fBncurses\fR \- CRT screen handling and optimization package .SH SYNOPSIS \fB#include <curses.h>\fR .br @@ -46,7 +49,7 @@ is the approved replacement for This describes \fBncurses\fR version @NCURSES_MAJOR@.@NCURSES_MINOR@ (patch @NCURSES_PATCH@). .PP -The \fBncurses\fR library emulates the \fBcurses\fR(3X) library of +The \fBncurses\fR library emulates the curses library of System V Release 4 UNIX, and XPG4 (X/Open Portability Guide) curses (also known as XSI curses). XSI stands for X/Open System Interfaces Extension. @@ -60,10 +63,10 @@ The \fBncurses\fR library also provides many useful extensions, i.e., features which cannot be implemented by a simple add-on library but which require access to the internals of the library. .PP -A program using these routines must be linked with the \fB-lncurses\fR option, -or (if it has been generated) with the debugging library \fB-lncurses_g\fR. +A program using these routines must be linked with the \fB\-lncurses\fR option, +or (if it has been generated) with the debugging library \fB\-lncurses_g\fR. (Your system integrator may also have installed these libraries under -the names \fB-lcurses\fR and \fB-lcurses_g\fR.) +the names \fB\-lcurses\fR and \fB\-lcurses_g\fR.) The ncurses_g library generates trace logs (in a file called 'trace' in the current directory) that describe curses actions. See also the section on \fBALTERNATE CONFIGURATIONS\fP. @@ -80,7 +83,7 @@ That is normally done with \fBsetlocale\fP: \fBsetlocale(LC_ALL, "");\fP .sp If the locale is not initialized, -the library assumes that characters are printable as in ISO-8859-1, +the library assumes that characters are printable as in ISO\-8859\-1, to work with certain legacy programs. You should initialize the locale and not rely on specific details of the library when the locale has not been setup. @@ -246,7 +249,7 @@ Each cell (row and column) in a \fBWINDOW\fP is stored as a \fBchtype\fP. .TP 5 ncursesw the so-called "wide" library, which handles multibyte characters -(See the section on \fBALTERNATE CONFIGURATIONS\fP). +(see the section on \fBALTERNATE CONFIGURATIONS\fP). The "wide" library includes all of the calls from the "normal" library. It adds about one third more calls using data types which store multibyte characters: @@ -256,7 +259,7 @@ multibyte characters: corresponds to \fBchtype\fP. However it is a structure, because more data is stored than can fit into an integer. -The characters are large enough to require a full integer value - and there +The characters are large enough to require a full integer value \- and there may be more than one character per cell. The video attributes and color are stored in separate fields of the structure. .IP @@ -267,7 +270,7 @@ stores a "wide" character. Like \fBchtype\fP, this may be an integer. .TP 5 .B wint_t -stores a \fBwchar_t\fP or \fBWEOF\fP - not the same, though both may have +stores a \fBwchar_t\fP or \fBWEOF\fP \- not the same, though both may have the same size. .RE .IP @@ -756,6 +759,10 @@ When set, change occurrences of the command_character (i.e., the \fBcmdch\fP capability) of the loaded terminfo entries to the value of this symbol. Very few terminfo entries provide this feature. +.IP +Because this name is also used in development environments to represent +the C compiler's name, \fBncurses\fR ignores it if it does not happen to +be a single character. .TP 5 COLUMNS Specify the width of the screen in characters. @@ -831,7 +838,7 @@ platforms: 3 = middle. .sp This symbol lets you customize the mouse. -The symbol must be three numeric digits 1-3 in any order, e.g., 123 or 321. +The symbol must be three numeric digits 1\-3 in any order, e.g., 123 or 321. If it is not specified, \fBncurses\fR uses 132. .TP 5 NCURSES_ASSUMED_COLORS @@ -841,7 +848,7 @@ terminal's default colors are white-on-black You may set the foreground and background color values with this environment variable by proving a 2-element list: foreground,background. For example, to tell ncurses to not assume anything -about the colors, set this to "-1,-1". +about the colors, set this to "\-1,\-1". To make it green-on-black, set it to "2,0". Any positive value from zero to the terminfo \fBmax_colors\fR value is allowed. .TP 5 @@ -911,7 +918,7 @@ During initialization, the \fBncurses\fR library checks for special cases where VT100 line-drawing (and the corresponding alternate character set capabilities) described in the terminfo are known to be missing. -Specifically, when running in a UTF-8 locale, +Specifically, when running in a UTF\-8 locale, the Linux console emulator and the GNU screen program ignore these. Ncurses checks the TERM environment variable for these. For other special cases, you should set this environment variable. @@ -922,7 +929,29 @@ and is likely to work for terminal emulators. .IP When setting this variable, you should set it to a nonzero value. Setting it to zero (or to a nonnumber) -disables the special check for Linux and screen. +disables the special check for "linux" and "screen". +.IP +As an alternative to the environment variable, +ncurses checks for an extended terminfo capability \fBU8\fP. +This is a numeric capability which can be compiled using \fBtic\ \-x\fP. +For example +.RS 5 +.sp +.nf +# linux console, if patched to provide working +# VT100 shift-in/shift-out, with corresponding font. +linux-vt100|linux console with VT100 line-graphics, + U8#0, use=linux, +.sp +# uxterm with vt100Graphics resource set to false +xterm-utf8|xterm relying on UTF-8 line-graphics, + U8#1, use=xterm, +.fi +.RE +.IP +The name "U8" is chosen to be two characters, +to permit it to be used by applications that use ncurses' +termcap interface. .TP 5 NCURSES_TRACE During initialization, the \fBncurses\fR debugging library @@ -956,20 +985,15 @@ description. This is the simplest, but not the only way to change the list of directories. The complete list of directories in order follows: .RS -.TP 3 -- +.bP the last directory to which \fBncurses\fR wrote, if any, is searched first -.TP 3 -- +.bP the directory specified by the TERMINFO symbol -.TP 3 -- +.bP $HOME/.terminfo -.TP 3 -- +.bP directories listed in the TERMINFO_DIRS symbol -.TP 3 -- +.bP one or more directories whose names are configured and compiled into the ncurses library, e.g., @TERMINFO@ @@ -998,7 +1022,7 @@ depending on the configure script options used when building \fBncurses\fP. There are a few main options whose effects are visible to the applications developer using \fBncurses\fP: .TP 5 ---disable-overwrite +\-\-disable\-overwrite The standard include for \fBncurses\fP is as noted in \fBSYNOPSIS\fP: .RS .sp @@ -1014,23 +1038,23 @@ a subdirectory, e.g., \fB#include <ncurses/curses.h>\fR .RE .IP -It also omits a symbolic link which would allow you to use \fB-lcurses\fP +It also omits a symbolic link which would allow you to use \fB\-lcurses\fP to build executables. .TP 5 ---enable-widec -The configure script renames the library and (if the \fB--disable-overwrite\fP +\-\-enable\-widec +The configure script renames the library and (if the \fB\-\-disable\-overwrite\fP option is used) puts the header files in a different subdirectory. All of the library names have a "w" appended to them, i.e., instead of .RS .sp -\fB-lncurses\fR +\fB\-lncurses\fR .RE .IP you link with .RS .sp -\fB-lncursesw\fR +\fB\-lncursesw\fR .RE .IP You must also define \fB_XOPEN_SOURCE_EXTENDED\fP when compiling for the @@ -1044,20 +1068,20 @@ the wide-character library's headers should be installed last, to allow applications to be built using either library from the same set of headers. .TP 5 ---with-shared +\-\-with\-shared .TP ---with-normal +\-\-with\-normal .TP ---with-debug +\-\-with\-debug .TP ---with-profile +\-\-with\-profile The shared and normal (static) library names differ by their suffixes, e.g., \fBlibncurses.so\fP and \fBlibncurses.a\fP. The debug and profiling libraries add a "_g" and a "_p" to the root names respectively, e.g., \fBlibncurses_g.a\fP and \fBlibncurses_p.a\fP. .TP 5 ---with-trace +\-\-with\-trace The \fBtrace\fP function normally resides in the debug library, but it is sometimes useful to configure this in the shared library. Configure scripts should check for the function's existence rather @@ -1071,8 +1095,10 @@ terminal capability database .SH SEE ALSO \fBterminfo\fR(\*n) and related pages whose names begin "curs_" for detailed routine descriptions. +.br +\fBcurs_variables\fR(3X) .SH EXTENSIONS -The \fBncurses\fR library can be compiled with an option (\fB-DUSE_GETCAP\fR) +The \fBncurses\fR library can be compiled with an option (\fB\-DUSE_GETCAP\fR) that falls back to the old-style /etc/termcap file if the terminal setup code cannot find a terminfo entry corresponding to \fBTERM\fR. Use of this feature @@ -1098,7 +1124,7 @@ See the \fBdefine_key\fR(3X) and \fBkeyok\fR(3X) manual pages for details. .PP The \fBncurses\fR library can exploit the capabilities of terminals which -implement the ISO-6429 SGR 39 and SGR 49 controls, which allow an application +implement the ISO\-6429 SGR 39 and SGR 49 controls, which allow an application to reset the terminal to its original foreground and background colors. From the users' perspective, the application is able to draw colored text on a background whose color is set independently, providing better @@ -1119,29 +1145,35 @@ the XSI Curses and \fBncurses\fR calls) are described in \fBPORTABILITY\fR sections of the library man pages. .PP This implementation also contains several extensions: -.RS 5 -.PP +.bP The routine \fBhas_key\fR is not part of XPG4, nor is it present in SVr4. See the \fBcurs_getch\fR(3X) manual page for details. -.PP +.bP The routine \fBslk_attr\fR is not part of XPG4, nor is it present in SVr4. See the \fBcurs_slk\fR(3X) manual page for details. -.PP +.bP The routines \fBgetmouse\fR, \fBmousemask\fR, \fBungetmouse\fR, \fBmouseinterval\fR, and \fBwenclose\fR relating to mouse interfacing are not part of XPG4, nor are they present in SVr4. See the \fBcurs_mouse\fR(3X) manual page for details. -.PP +.bP The routine \fBmcprint\fR was not present in any previous curses implementation. See the \fBcurs_print\fR(3X) manual page for details. -.PP +.bP The routine \fBwresize\fR is not part of XPG4, nor is it present in SVr4. See the \fBwresize\fR(3X) manual page for details. -.PP +.bP The WINDOW structure's internal details can be hidden from application programs. See \fBcurs_opaque\fR(3X) for the discussion of \fBis_scrollok\fR, etc. -.RE +.bP +This implementation can be configured to provide rudimentary support +for multi-threaded applications. +See \fBcurs_threads\fR(3X) for details. +.bP +This implementation can also be configured to provide a set of functions which +improve the ability to manage multiple screens. +See \fBcurs_sp_funcs\fR(3X) for details. .PP In historic curses versions, delays embedded in the capabilities \fBcr\fR, \fBind\fR, \fBcub1\fR, \fBff\fR and \fBtab\fR activated corresponding delay @@ -1160,9 +1192,3 @@ This was an undocumented feature of AT&T System V Release 3 curses. .SH AUTHORS Zeyd M. Ben-Halim, Eric S. Raymond, Thomas E. Dickey. Based on pcurses by Pavel Curtis. -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/panel.3x b/man/panel.3x index 719a9e6..25e2348 100644 --- a/man/panel.3x +++ b/man/panel.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2006,2007 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2007,2010 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,16 +26,16 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: panel.3x,v 1.14 2007/05/12 20:45:20 tom Exp $ +.\" $Id: panel.3x,v 1.17 2010/10/02 23:22:44 tom Exp $ .TH panel 3X "" .ds n 5 .ds d @TERMINFO@ .SH NAME -panel - panel stack extension for curses +panel \- panel stack extension for curses .SH SYNOPSIS \fB#include <panel.h>\fR .P -\fBcc [flags] sourcefiles -lpanel -lncurses\fR +\fBcc [flags] sourcefiles \-lpanel \-lncurses\fR .P \fBPANEL *new_panel(WINDOW *win)\fR .br @@ -93,8 +93,10 @@ pointer to the new panel. .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. -update_panels() may be called more than once before a call to +physical screen. +Use this function and not \fBwrefresh\fP or \fBwnoutrefresh\fP. +.B 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 @@ -170,7 +172,7 @@ move to the top of the stack. You are cautioned to use the correct function to ensure compatibility with native panel libraries. .SH NOTE In your library list, libpanel.a should be before libncurses.a; that is, -you want to say `-lpanel -lncurses', not the other way around (which would +you want to say `\-lpanel \-lncurses', not the other way around (which would usually give a link-error). .SH FILES .P @@ -180,7 +182,8 @@ interface for the panels library libpanel.a the panels library itself .SH SEE ALSO -\fBcurses\fR(3X) +\fBcurses\fR(3X), +\fBcurs_variables\fR(3X), .PP This describes \fBncurses\fR version @NCURSES_MAJOR@.@NCURSES_MINOR@ (patch @NCURSES_PATCH@). diff --git a/man/resizeterm.3x b/man/resizeterm.3x index 888eaaf..ddb47e7 100644 --- a/man/resizeterm.3x +++ b/man/resizeterm.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2003,2005 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2005,2010 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 * @@ -28,12 +28,12 @@ .\" .\" Author: Thomas E. Dickey 1996-2005 .\" -.\" $Id: resizeterm.3x,v 1.11 2005/06/25 22:19:42 tom Exp $ +.\" $Id: resizeterm.3x,v 1.14 2010/12/04 18:38:55 tom Exp $ .TH resizeterm 3X "" .SH NAME \fBis_term_resized\fR, \fBresize_term\fR, -\fBresizeterm\fR - change the curses terminal size +\fBresizeterm\fR \- change the curses terminal size .SH SYNOPSIS \fB#include <curses.h>\fR .sp @@ -89,12 +89,7 @@ no screen size change may be recorded. In that case, no \fBKEY_RESIZE\fP is queued for the next call to \fBgetch\fP; an \fBERR\fP will be returned instead. .SH SEE ALSO +\fBcurs_variables\fR(3X), \fBwresize\fR(3X). .SH AUTHOR Thomas Dickey (from an equivalent function written in 1988 for BSD curses). -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/tabs.1 b/man/tabs.1 new file mode 100644 index 0000000..c867db5 --- /dev/null +++ b/man/tabs.1 @@ -0,0 +1,141 @@ +.\"*************************************************************************** +.\" Copyright (c) 2008-2009,2010 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: tabs.1,v 1.8 2010/12/04 18:40:45 tom Exp $ +.TH @TABS@ 1 "" +.ds n 5 +.SH NAME +\fBtabs\fR \- set tabs on a terminal +.SH SYNOPSIS +\fBtabs\fR [\fB\-v\fR[\fIn\fR]] [\fB\-ahuUV\fR] \fIfile...\fR +.br +.SH DESCRIPTION +.PP +The \fBtabs\fP program clears and sets tab-stops on the terminal. +This uses the terminfo \fIclear_all_tabs\fP and \fIset_tab\fP capabilities. +If either is absent, \fBtabs\fP is unable to clear/set tab-stops. +The terminal should be configured to use hard tabs, e.g., +.sp +.RS +stty tab0 +.RE +.SH OPTIONS +.SS General Options +.TP 5 +.BI \-T "name" +Tell \fBtabs\fP which terminal type to use. +If this option is not given, \fBtabs\fP will use the \fB$TERM\fP +environment variable. +If that is not set, it will use the \fIansi+tabs\fP entry. +.TP 5 +.B \-d +The debugging option shows a ruler line, followed by two data lines. +The first data line shows the expected tab-stops marked with asterisks. +The second data line shows the actual tab-stops, marked with asterisks. +.TP 5 +.B \-n +This option tells \fBtabs\fP to check the options and run any debugging +option, but not to modify the terminal settings. +.PP +The \fBtabs\fP program processes a single list of tab stops. +The last option to be processed which defines a list is the one that +determines the list to be processed. +.SS Implicit Lists +Use a single number as an option, e.g., "\fB\-5\fP" to set tabs at the given +interval (in this case 1, 6, 11, 16, 21, etc.). Tabs are repeated up to +the right margin of the screen. +.PP +Use "\fB\-0\fP" to clear all tabs. +.PP +Use "\fB\-8\fP" to set tabs to the standard interval. +.SS Explicit Lists +An explicit list can be defined after the options (this does not use a "\-"). +The values in the list must be in increasing numeric order, and greater than +zero. They are separated by a comma or a blank, for example, +.sp +.RS +tabs 1,6,11,16,21 +.br +tabs 1 6 11 16 21 +.RE +Use a '+' to treat a number as an increment relative to the previous value, +e.g., +.sp +.RS +tabs 1,+5,+5,+5,+5 +.RE +which is equivalent to the 1,6,11,16,21 example. +.SS Predefined Tab-Stops +X/Open defines several predefined lists of tab stops. +.TP 5 +.B \-a +Assembler, IBM S/370, first format +.TP 5 +.B \-a2 +Assembler, IBM S/370, second format +.TP 5 +.B \-c +COBOL, normal format +.TP 5 +.B \-c2 +COBOL compact format +.TP 5 +.B \-c3 +COBOL compact format extended +.TP 5 +.B \-f +FORTRAN +.TP 5 +.B \-p +PL/I +.TP 5 +.B \-s +SNOBOL +.TP 5 +.B \-u +UNIVAC 1100 Assembler +.SH PORTABILITY +.PP +X/Open describes a \fB+m\fP option, to set a terminal's left-margin. +Very few of the entries in the terminal database provide this capability. +.PP +The \fB\-d\fP (debug) and \fB\-n\fP (no-op) options are extensions not provided +by other implementations. +.PP +Documentation for other implementations states that there is a limit on the +number of tab stops. While some terminals may not accept an arbitrary number +of tab stops, this implementation will attempt to set tab stops up to the +right margin of the screen, if the given list happens to be that long. +.SH SEE ALSO +\fB@TSET@\fR(1), +\fB@INFOCMP@\fR(1M), +\fBcurses\fR(3X), +\fBterminfo\fR(\*n). +.PP +This describes \fBncurses\fR +version @NCURSES_MAJOR@.@NCURSES_MINOR@ (patch @NCURSES_PATCH@). @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2004,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2006,2010 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: term.5,v 1.19 2006/12/24 18:12:38 tom Exp $ +.\" $Id: term.5,v 1.21 2010/12/04 18:40:45 tom Exp $ .TH term 5 .ds n 5 .ds d @TERMINFO@ @@ -109,7 +109,7 @@ Short integers are stored in two 8-bit bytes. The first byte contains the least significant 8 bits of the value, and the second byte contains the most significant 8 bits. (Thus, the value represented is 256*second+first.) -The value -1 is represented by the two bytes 0377, 0377; other negative +The value \-1 is represented by the two bytes 0377, 0377; other negative values are illegal. This value generally means that the corresponding capability is missing from this terminal. Note that this format corresponds to the hardware of the \s-1VAX\s+1 @@ -130,7 +130,7 @@ The capabilities are in the same order as the file <term.h>. Between the boolean section and the number section, a null byte will be inserted, if necessary, to ensure that the number section begins on an even byte (this is a -relic of the PDP-11's word-addressed architecture, originally +relic of the PDP\-11's word-addressed architecture, originally designed in to avoid IOT traps induced by addressing a word on an odd byte boundary). All short integers are aligned on a short word boundary. @@ -138,11 +138,11 @@ All short integers are aligned on a short word boundary. The numbers section is similar to the flags section. Each capability takes up two bytes, and is stored as a little-endian short integer. -If the value represented is -1, the capability is taken to be missing. +If the value represented is \-1, the capability is taken to be missing. .PP The strings section is also similar. Each capability is stored as a short integer, in the format above. -A value of -1 means the capability is missing. +A value of \-1 means the capability is missing. Otherwise, the value is taken as an offset from the beginning of the string table. Special characters in ^X or \ec notation are stored in their @@ -217,14 +217,14 @@ of boolean, number, and string capabilities. Despite the consistent use of little-endian for numbers and the otherwise self-describing format, it is not wise to count on portability of binary terminfo entries between commercial UNIX versions. The problem is that there -are at least three versions of terminfo (under HP-UX, AIX, and OSF/1) which +are at least three versions of terminfo (under HP\-UX, AIX, and OSF/1) which diverged from System V terminfo after SVr1, and have added extension capabilities to the string table that (in the binary format) collide with System V and XSI Curses extensions. See \fBterminfo\fR(\*n) for detailed discussion of terminfo source compatibility issues. .SH EXAMPLE As an example, here is a hex dump of the description for the Lear-Siegler -ADM-3, a popular though rather stupid early terminal: +ADM\-3, a popular though rather stupid early terminal: .nf .sp adm3a|lsi adm3a, @@ -275,9 +275,3 @@ extended terminfo format for ncurses 5.0 hashed database support for ncurses 5.6 .sp Eric S. Raymond -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2006,2007 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2007,2010 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: term.7,v 1.18 2007/06/02 20:40:07 tom Exp $ +.\" $Id: term.7,v 1.22 2010/12/04 18:41:07 tom Exp $ .TH term 7 .ds n 5 .ds d @TERMINFO@ @@ -39,9 +39,9 @@ the terminal, console or display-device type you are using. This information is critical for all screen-oriented programs, including your editor and mailer. .PP A default \fBTERM\fR value will be set on a per-line basis by either -\fB/etc/inittab\fR (Linux and System-V-like UNIXes) or \fB/etc/ttys\fR (BSD -UNIXes). This will nearly always suffice for workstation and microcomputer -consoles. +\fB/etc/inittab\fR (e.g., System\-V-like UNIXes) +or \fB/etc/ttys\fR (BSD UNIXes). +This will nearly always suffice for workstation and microcomputer consoles. .PP If you use a dialup line, the type of device attached to it may vary. Older UNIX systems pre-set a very dumb terminal type like `dumb' or `dialup' on @@ -73,9 +73,9 @@ retrieval speed (unlike the old text-based \fBtermcap\fR format they replace); 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 +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 letter). This command dumps a capability file in the text format described by \fBterminfo\fR(\*n). @@ -114,14 +114,14 @@ The root name prefix should be followed when appropriate by a model number; thus \fBvt100\fR, \fBhp2621\fR, \fBwy50\fR. .PP The root name for a PC-Unix console type should be the OS name, -i.e. \fBlinux\fR, \fBbsdos\fR, \fBfreebsd\fR, \fBnetbsd\fR. It should +i.e., \fBlinux\fR, \fBbsdos\fR, \fBfreebsd\fR, \fBnetbsd\fR. It should \fInot\fR be \fBconsole\fR or any other generic that might cause confusion in a 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 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). +recognizable abbreviation of it (i.e., \fBversaterm\fR, \fBctrm\fR). .PP Following the root name, you may add any reasonable number of hyphen-separated feature suffixes. @@ -135,52 +135,52 @@ attribute without magic-cookie lossage. Their base entry is usually paired with another that has this suffix and uses magic cookies to support multiple attributes. .TP 5 --am +\-am Enable auto-margin (right-margin wraparound). .TP 5 --m -Mono mode - suppress color support. +\-m +Mono mode \- suppress color support. .TP 5 --na -No arrow keys - termcap ignores arrow keys which are actually there on the +\-na +No arrow keys \- termcap ignores arrow keys which are actually there on the terminal, so the user can use the arrow keys locally. .TP 5 --nam -No auto-margin - suppress am capability. +\-nam +No auto-margin \- suppress am capability. .TP 5 --nl -No labels - suppress soft labels. +\-nl +No labels \- suppress soft labels. .TP 5 --nsl -No status line - suppress status line. +\-nsl +No status line \- suppress status line. .TP 5 --pp +\-pp Has a printer port which is used. .TP 5 --rv +\-rv Terminal in reverse video mode (black on white). .TP 5 --s +\-s Enable status line. .TP 5 --vb +\-vb Use visible bell (flash) rather than beep. .TP 5 --w +\-w Wide; terminal is in 132 column mode. .PP Conventionally, if your terminal type is a variant intended to specify a line height, that suffix should go first. So, for a hypothetical FuBarCo model 2317 terminal in 30-line mode with reverse video, best form would be -\fBfubar-30-rv\fR (rather than, say, `fubar-rv-30'). +\fBfubar\-30\-rv\fR (rather than, say, `fubar\-rv\-30'). .PP Terminal types that are written not as standalone entries, but rather as components to be plugged into other entries via \fBuse\fP capabilities, are distinguished by using embedded plus signs rather than dashes. .PP -Commands which use a terminal type to control display often accept a -T +Commands which use a terminal type to control display often accept a \-T option that accepts a terminal name argument. Such programs should fall back -on the \fBTERM\fR environment variable when no -T option is specified. +on the \fBTERM\fR environment variable when no \-T option is specified. .SH PORTABILITY For maximum compatibility with older System V UNIXes, names and aliases should be unique within the first 14 characters. @@ -196,9 +196,3 @@ tty line initialization (AT&T-like UNIXes) tty line initialization (BSD-like UNIXes) .SH SEE ALSO \fBcurses\fR(3X), \fBterminfo\fR(\*n), \fBterm\fR(\*n). -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/term_variables.3x b/man/term_variables.3x new file mode 100644 index 0000000..58b7cfe --- /dev/null +++ b/man/term_variables.3x @@ -0,0 +1,153 @@ +.\"*************************************************************************** +.\" Copyright (c) 2010 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: term_variables.3x,v 1.2 2010/12/04 18:38:55 tom Exp $ +.TH term_variables 3X "" +.ds n 5 +.na +.hy 0 +.SH NAME +\fBSP\fP, +\fBacs_map\fP, +\fBboolcodes\fP, +\fBboolfnames\fP, +\fBboolnames\fP, +\fBcur_term\fP, +\fBnumcodes\fP, +\fBnumfnames\fP, +\fBnumnames\fP, +\fBstrcodes\fP, +\fBstrfnames\fP, +\fBstrnames\fP, +\fBttytype\fP +\- \fBcurses\fR terminfo global variables +.ad +.hy +.SH SYNOPSIS +.nf +\fB#include <curses.h>\fR +.br +\fB#include <term.h>\fR +.PP +\fBchtype acs_map[];\fR +.br +\fBNCURSES_CONST char * const * boolcodes;\fR +.br +\fBNCURSES_CONST char * const * boolfnames;\fR +.br +\fBNCURSES_CONST char * const * boolnames;\fR +.br +\fBTERMINAL * cur_term;\fR +.br +\fBNCURSES_CONST char * const * numcodes;\fR +.br +\fBNCURSES_CONST char * const * numfnames;\fR +.br +\fBNCURSES_CONST char * const * numnames;\fR +.br +\fBNCURSES_CONST char * const * strcodes;\fR +.br +\fBNCURSES_CONST char * const * strfnames;\fR +.br +\fBNCURSES_CONST char * const * strnames;\fR +.br +\fBchar ttytype[];\fR +.br +.fi +.SH DESCRIPTION +This page summarizes variables provided by the \fBcurses\fP library's +low-level terminfo interface. +A more complete description is given in the \fBcurs_terminfo\fP(3X) manual page. +.PP +Depending on the configuration, these may be actual variables, +or macros (see \fBcurs_threads\fR(3X)) +which provide read-only access to \fIcurses\fP's state. +In either case, applications should treat them as read-only to avoid +confusing the library. +.SS Alternate Character Set Mapping +After initializing the curses or terminfo interfaces, +the \fBacs_map\fP array holds information used to translate cells +with the \fBA_ALTCHARSET\fP video attribute into line-drawing characters. +.PP +The encoding of the information in this array has changed periodically. +Application developers need only know that it is used for the "ACS_" +constants in <curses.h>. +.PP +The comparable data for the wide-character library is a private variable. +.SS Current Terminal Data +After initializing the curses or terminfo interfaces, +the \fBcur_term\fP contains data describing the current terminal. +This variable is also set as a side-effect of \fBset_term\fP(3X) +and \fBdelscreen\fP(3X). +.PP +It is possible to save a value of \fBcur_term\fP for subsequent +use as a parameter to \fBset_term\fP, for switching between screens. +Alternatively, one can save the return value from \fBnewterm\fP +or \fBsetupterm\fP to reuse in \fBset_term\fP. +.SS Terminfo Names +The \fBtic\fP(1) and \fBinfocmp\fP(1) programs use lookup tables for +the long and short names of terminfo capabilities, +as well as the corresponding names for termcap capabilities. +These are available to other applications, +though the hash-tables are not available. +.PP +The long terminfo capability names use a "l" (ell) in their names: +boolfnames +numfnames +strfnames +.PP +These are the short names for terminfo capabilities: +boolnames, +numnames, and +strnames. +.PP +These are the corresponding names used for termcap descriptions: +boolcodes, +numcodes, and +strcodes. +.SS Terminal Type +On initialization of the curses or terminfo interfaces, +\fBsetupterm\fP copies the terminal name to the array \fBttytype\fP. +.SH NOTES +The low-level terminfo interface is initialized using \fBsetupterm\fR(3X). +The upper-level curses interface uses the low-level terminfo interface, +internally. +.SH PORTABILITY +X/Open Curses does not describe any of these except for \fBcur_term\fP. +(The inclusion of \fBcur_term\fP appears to be an oversight, +since other comparable low-level information is omitted by X/Open). +.PP +Other implementations may have comparable variables. +Some implementations provide the variables in their libraries, +but omit them from the header files. +.SH SEE ALSO +\fBcurses\fR(3X), +\fBcurs_terminfo\fR(3X), +\fBcurs_threads\fR(3X), +\fBterminfo\fR(3X), +\fBterminfo\fR(\*n). diff --git a/man/terminfo.head b/man/terminfo.head index 7455675..da8284c 100644 --- a/man/terminfo.head +++ b/man/terminfo.head @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2004,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2009,2010 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: terminfo.head,v 1.16 2007/03/04 00:09:46 tom Exp $ +.\" $Id: terminfo.head,v 1.18 2010/07/31 16:08:48 tom Exp $ .TH terminfo 5 "" "" "File Formats" .ds n 5 .ds d @TERMINFO@ @@ -68,7 +68,7 @@ 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 \fB@INFOCMP@\ -f\fP option relies on this to format if-then-else expressions: +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 @@ -78,7 +78,7 @@ have a root name, thus ``hp2621''. This name should not contain hyphens. Modes that the hardware can be in, or user preferences, should be indicated by appending a hyphen and a mode suffix. -Thus, a vt100 in 132 column mode would be vt100-w. +Thus, a vt100 in 132 column mode would be vt100\-w. The following suffixes should be used where possible: .PP .TS @@ -86,19 +86,19 @@ center ; l c l l l l. \fBSuffix Meaning Example\fP --\fInn\fP Number of lines on the screen aaa-60 --\fIn\fPp Number of pages of memory c100-4p --am With automargins (usually the default) vt100-am --m Mono mode; suppress color ansi-m --mc Magic cookie; spaces when highlighting wy30-mc --na No arrow keys (leave them in local) c100-na --nam Without automatic margins vt100-nam --nl No status line att4415-nl --ns No status line hp2626-ns --rv Reverse video c100-rv --s Enable status line vt100-s --vb Use visible bell instead of beep wy370-vb --w Wide mode (> 80 columns, usually 132) vt100-w +\-\fInn\fP Number of lines on the screen aaa\-60 +\-\fIn\fPp Number of pages of memory c100\-4p +\-am With automargins (usually the default) vt100\-am +\-m Mono mode; suppress color ansi\-m +\-mc Magic cookie; spaces when highlighting wy30\-mc +\-na No arrow keys (leave them in local) c100\-na +\-nam Without automatic margins vt100\-nam +\-nl No status line att4415\-nl +\-ns No status line hp2626\-ns +\-rv Reverse video c100\-rv +\-s Enable status line vt100\-s +\-vb Use visible bell instead of beep wy370\-vb +\-w Wide mode (> 80 columns, usually 132) vt100\-w .TE .PP For more on terminal naming conventions, see the \fBterm(7)\fR manual page. diff --git a/man/terminfo.tail b/man/terminfo.tail index d06d3a9..4b56e91 100644 --- a/man/terminfo.tail +++ b/man/terminfo.tail @@ -1,4 +1,4 @@ -.\" $Id: terminfo.tail,v 1.49 2008/02/16 20:57:43 tom Exp $ +.\" $Id: terminfo.tail,v 1.53 2010/12/04 18:38:55 tom Exp $ .\" Beginning of terminfo.tail file .\" This file is part of ncurses. .\" See "terminfo.head" for copyright. @@ -25,7 +25,7 @@ of what a \fBterminfo\fR entry for a modern terminal typically looks like. kf11=\\E[W, kf12=\\E[X, kf2=\\E[N, kf3=\\E[O, kf4=\\E[P, kf5=\\E[Q, kf6=\\E[R, kf7=\\E[S, kf8=\\E[T, kf9=\\E[U, kich1=\\E[L, mc4=\\E[4i, mc5=\\E[5i, nel=\\r\\E[S, - op=\\E[37;40m, rep=%p1%c\\E[%p2%{1}%-%db, + op=\\E[37;40m, rep=%p1%c\\E[%p2%{1}%\-%db, rin=\\E[%p1%dT, s0ds=\\E(B, s1ds=\\E)B, s2ds=\\E*B, s3ds=\\E+B, setab=\\E[4%p1%dm, setaf=\\E[3%p1%dm, setb=\\E[4%?%p1%{1}%=%t4%e%p1%{3}%=%t6%e%p1%{4}%=%t1%e%p1%{6}%=%t3%e%p1%d%;m, @@ -325,9 +325,9 @@ The \fB%\fR encodings have the following meanings: outputs `%' .TP %\fI[[\fP:\fI]flags][width[.precision]][\fPdoxXs\fI]\fP -as in \fBprintf\fP, flags are [-+#] and space. -Use a `:' to allow the next character to be a `-' flag, -avoiding interpreting "%-" as an operator. +as in \fBprintf\fP, flags are [\-+#] and space. +Use a `:' to allow the next character to be a `\-' flag, +avoiding interpreting "%\-" as an operator. .TP %c print pop() like %c in \fBprintf\fP @@ -335,20 +335,20 @@ print pop() like %c in \fBprintf\fP %s print pop() like %s in \fBprintf\fP .TP -%p[1-9] +%p[1\-9] push \fIi\fP'th parameter .TP -%P[a-z] -set dynamic variable [a-z] to pop() +%P[a\-z] +set dynamic variable [a\-z] to pop() .TP -%g[a-z] -get dynamic variable [a-z] and push it +%g[a\-z] +get dynamic variable [a\-z] and push it .TP -%P[A-Z] -set static variable [a-z] to pop() +%P[A\-Z] +set static variable [a\-z] to pop() .TP -%g[A-Z] -get static variable [a-z] and push it +%g[A\-Z] +get static variable [a\-z] and push it .IP The terms "static" and "dynamic" are misleading. Historically, these are simply two different sets of variables, @@ -365,7 +365,7 @@ integer constant \fInn\fP %l push strlen(pop) .TP -%+ %- %* %/ %m +%+ %\- %* %/ %m arithmetic (%m is mod): push(pop() op pop()) .TP %& %| %^ @@ -397,14 +397,14 @@ 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 \fB@INFOCMP@\fP to see -the structure of if-the-else's. +Use the \fB\-f\fP option of \fBtic\fP or \fB@INFOCMP@\fP to see +the structure of if-then-else's. Some strings, e.g., \fBsgr\fP can be very complicated when written on one line. -The \fB-f\fP option splits the string into lines with the parts indented. +The \fB\-f\fP option splits the string into lines with the parts indented. .PP Binary operations are in postfix form with the operands in the usual order. -That is, to get x-5 one would use "%gx%{5}%-". +That is, to get x\-5 one would use "%gx%{5}%-". %P and %g variables are persistent across escape-string evaluations. .PP @@ -542,7 +542,7 @@ automatically, so you need not compose insert/delete strings for an entry with \fBcsr\fR). .PP Yet another way to construct insert and delete might be to use a combination of -index with the memory-lock feature found on some terminals (like the HP-700/90 +index with the memory-lock feature found on some terminals (like the HP\-700/90 series, which however also has insert/delete). .PP Inserting lines at the top or bottom of the screen can also be @@ -759,9 +759,9 @@ For example, the DEC vt220 supports most of the modes: .PP .TS center; -l c c -l c c -lw28 lw6 lw2 lw20. +l l l +l l l +lw18 lw14 lw18. \fBtparm parameter attribute escape sequence\fP none none \\E[0m @@ -794,9 +794,9 @@ Writing out the above sequences, along with their dependencies yields .PP .TS center; -l c c -l c c -lw28 lw6 lw2 lw20. +l l l +l l l +lw18 lw14 lw18. \fBsequence when to output terminfo translation\fP \\E[0 always \\E[0 @@ -1174,9 +1174,9 @@ This alternate character set may be specified by the \fBacsc\fR capability. .PP .TS H center expand; -c l l c -c l l c -lw28 lw6 lw2 lw20. +l l l l +l l l l +lw25 lw10 lw6 lw6. .\".TH \fBGlyph ACS Ascii VT100\fR \fBName Name Default Name\fR @@ -1184,7 +1184,7 @@ UK pound sign ACS_STERLING f } arrow pointing down ACS_DARROW v . arrow pointing left ACS_LARROW < , arrow pointing right ACS_RARROW > + -arrow pointing up ACS_UARROW ^ - +arrow pointing up ACS_UARROW ^ \- board of squares ACS_BOARD # h bullet ACS_BULLET o ~ checker board (stipple) ACS_CKBOARD : a @@ -1192,7 +1192,7 @@ degree symbol ACS_DEGREE \e f diamond ACS_DIAMOND + ` greater-than-or-equal-to ACS_GEQUAL > z greek pi ACS_PI * { -horizontal line ACS_HLINE - q +horizontal line ACS_HLINE \- q lantern symbol ACS_LANTERN # i large plus or crossover ACS_PLUS + n less-than-or-equal-to ACS_LEQUAL < y @@ -1201,8 +1201,8 @@ lower right corner ACS_LRCORNER + j not-equal ACS_NEQUAL ! | plus/minus ACS_PLMINUS # g scan line 1 ACS_S1 ~ o -scan line 3 ACS_S3 - p -scan line 7 ACS_S7 - r +scan line 3 ACS_S3 \- p +scan line 7 ACS_S7 \- r scan line 9 ACS_S9 \&_ s solid square block ACS_BLOCK # 0 tee pointing down ACS_TTEE + w @@ -1227,7 +1227,7 @@ Most color terminals are either `Tektronix-like' or `HP-like'. Tektronix-like terminals have a predefined set of N colors (where N usually 8), and can set character-cell foreground and background characters independently, mixing them -into N * N color-pairs. +into N\ *\ N color-pairs. On HP-like terminals, the use must set each color pair up separately (foreground and background are not independently settable). Up to M color-pairs may be set up from 2*M different colors. @@ -1312,7 +1312,7 @@ which color pair is current. On a Tektronix-like terminal, the capability \fBccc\fR may be present to indicate that colors can be modified. If so, the \fBinitc\fR capability will -take a color number (0 to \fBcolors\fR - 1)and three more parameters which +take a color number (0 to \fBcolors\fR \- 1)and three more parameters which describe the color. These three parameters default to being interpreted as RGB (Red, Green, Blue) values. @@ -1324,7 +1324,7 @@ terminal-dependent. On an HP-like terminal, \fBinitp\fR may give a capability for changing a color-pair value. It will take seven parameters; a color-pair number (0 to -\fBmax_pairs\fR - 1), and two triples describing first background and then +\fBmax_pairs\fR \- 1), and two triples describing first background and then foreground colors. These parameters must be (Red, Green, Blue) or (Hue, Lightness, Saturation) depending on \fBhls\fR. @@ -1525,9 +1525,9 @@ A capability can be canceled by placing \fBxx@\fR to the left of the use reference that imports it, where \fIxx\fP is the capability. For example, the entry .PP - 2621-nl, smkx@, rmkx@, use=2621, + 2621\-nl, smkx@, rmkx@, use=2621, .PP -defines a 2621-nl that does not have the \fBsmkx\fR or \fBrmkx\fR capabilities, +defines a 2621\-nl that does not have the \fBsmkx\fR or \fBrmkx\fR capabilities, and hence does not turn on the function key labels when in visual mode. This is useful for different modes for a terminal, or for different user preferences. @@ -1544,7 +1544,7 @@ The man pages for 4.3BSD and older versions of \fBtgetent()\fP instruct the user allocate a 1024-byte buffer for the termcap entry. The entry gets null-terminated by the termcap library, so that makes the maximum safe length for a termcap entry -1k-1 (1023) bytes. +1k\-1 (1023) bytes. Depending on what the application and the termcap library being used does, and where in the termcap file the terminal type that \fBtgetent()\fP is searching for is, several bad things can happen. @@ -1612,16 +1612,16 @@ If it is too long even before 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 +When in \-C (translate to termcap) mode, the \fBncurses\fR implementation of \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 +The \-c (check) option also checks resolved (after tc expansion) lengths. .SS Binary Compatibility It is not wise to count on portability of binary terminfo entries between commercial UNIX versions. The problem is that there are at least two versions -of terminfo (under HP-UX and AIX) which diverged from System V terminfo after +of terminfo (under HP\-UX and AIX) which diverged from System V terminfo after SVr1, and have added extension capabilities to the string table that (in the binary format) collide with System V and XSI Curses extensions. .SH EXTENSIONS @@ -1657,30 +1657,30 @@ the XSI Curses standard and (in some cases) different extension sets. Here is a summary, accurate as of October 1995: .PP -\fBSVR4, Solaris, ncurses\fR -- +\fBSVR4, Solaris, ncurses\fR \-\- These support all SVr4 capabilities. .PP -\fBSGI\fR -- +\fBSGI\fR \-\- Supports the SVr4 set, adds one undocumented extended string capability (\fBset_pglen\fR). .PP -\fBSVr1, Ultrix\fR -- +\fBSVr1, Ultrix\fR \-\- These support a restricted subset of terminfo capabilities. The booleans end with \fBxon_xoff\fR; the numerics with \fBwidth_status_line\fR; and the strings with \fBprtr_non\fR. .PP -\fBHP/UX\fR -- +\fBHP/UX\fR \-\- Supports the SVr1 subset, plus the SVr[234] numerics \fBnum_labels\fR, \fBlabel_height\fR, \fBlabel_width\fR, plus function keys 11 through 63, plus \fBplab_norm\fR, \fBlabel_on\fR, and \fBlabel_off\fR, plus some incompatible extensions in the string table. .PP -\fBAIX\fR -- +\fBAIX\fR \-\- Supports the SVr1 subset, plus function keys 11 through 63, plus a number of incompatible string table extensions. .PP -\fBOSF\fR -- +\fBOSF\fR \-\- Supports both the SVr4 set and the AIX extensions. .SH FILES .TP 25 @@ -1692,12 +1692,7 @@ files containing terminal descriptions \fBcurses\fR(3X), \fBprintf\fR(3), \fBterm\fR(\*n). +\fBterm_variables\fR(3X). .SH AUTHORS Zeyd M. Ben-Halim, Eric S. Raymond, Thomas E. Dickey. Based on pcurses by Pavel Curtis. -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2005,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2006,2010 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,15 +26,15 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: tic.1m,v 1.44 2006/12/24 17:59:11 tom Exp $ +.\" $Id: tic.1m,v 1.47 2010/12/04 18:38:55 tom Exp $ .TH @TIC@ 1M "" .ds n 5 .ds d @TERMINFO@ .SH NAME -\fBtic\fR - the \fIterminfo\fR entry-description compiler +\fBtic\fR \- the \fIterminfo\fR entry-description compiler .SH SYNOPSIS \fBtic\fR -[\fB-\ +[\fB\-\ 1\ C\ G\ @@ -53,20 +53,22 @@ s\ t\ x\ \fR] -[\fB-e\fR \fInames\fR] -[\fB-o\fR \fIdir\fR] -[\fB-R\fR \fIsubset\fR] -[\fB-v\fR[\fIn\fR]] -[\fB-w\fR[\fIn\fR]] +[\fB\-e\fR \fInames\fR] +[\fB\-o\fR \fIdir\fR] +[\fB\-R\fR \fIsubset\fR] +[\fB\-v\fR[\fIn\fR]] +[\fB\-w\fR[\fIn\fR]] \fIfile\fR .br .SH DESCRIPTION The command \fBtic\fR translates a \fBterminfo\fR file from source -format into compiled format. The compiled format is necessary for use with +format into compiled format. +The compiled format is necessary for use with the library routines in \fBncurses\fR(3X). .PP The results are normally placed in the system terminfo -directory \fB\*d\fR. There are two ways to change this behavior. +directory \fB\*d\fR. +There are two ways to change this behavior. .PP First, you may override the system default by setting the variable \fBTERMINFO\fR in your shell environment to a valid (existing) directory name. @@ -79,33 +81,38 @@ Libraries that read terminfo entries are expected to check for a TERMINFO directory first, look at \fI$HOME/.terminfo\fR if TERMINFO is not set, and finally look in \fI\*d\fR. .TP -\fB-1\fR +\fB\-1\fR restricts the output to a single column .TP -\fB-a\fR +\fB\-a\fR tells \fBtic\fP to retain commented-out capabilities rather than discarding -them. Capabilities are commented by prefixing them with a period. -This sets the \fB-x\fR option, because it treats the commented-out +them. +Capabilities are commented by prefixing them with a period. +This sets the \fB\-x\fR option, because it treats the commented-out entries as user-defined names. If the source is termcap, accept the 2-character names required by version 6. Otherwise these are ignored. .TP -\fB-C\fR -Force source translation to termcap format. Note: this differs from the \fB-C\fR +\fB\-C\fR +Force source translation to termcap format. +Note: this differs from the \fB\-C\fR option of \fB@INFOCMP@\fR(1M) in that it does not merely translate capability -names, but also translates terminfo strings to termcap format. Capabilities +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. .TP -\fB-c\fR +\fB\-c\fR tells \fBtic\fP to only check \fIfile\fR for errors, including syntax problems and -bad use links. If you specify \fB-C\fR (\fB-I\fR) with this option, the code +bad use links. +If you specify \fB\-C\fR (\fB\-I\fR) with this option, the code will print warnings about entries which, after use resolution, are more than -1023 (4096) bytes long. Due to a fixed buffer length in older termcap +1023 (4096) bytes long. +Due to a fixed buffer length in older termcap libraries (and a documented limit in terminfo), these entries may cause core dumps. .TP -\fB-e \fR\fInames\fR +\fB\-e \fR\fInames\fR Limit writes and translations to the following comma-separated list of terminals. If any name or alias of a terminal matches one of the names in @@ -113,80 +120,85 @@ the list, the entry will be written or translated as normal. Otherwise no output will be generated for it. The option value is interpreted as a file containing the list if it contains a '/'. -(Note: depending on how tic was compiled, this option may require \fB-I\fR or \fB-C\fR.) +(Note: depending on how tic was compiled, this option may require \fB\-I\fR or \fB\-C\fR.) .TP -\fB-f\fR +\fB\-f\fR Display complex terminfo strings which contain if/then/else/endif expressions indented for readability. .TP -\fB-G\fR +\fB\-G\fR Display constant literals in decimal form rather than their character equivalents. .TP -\fB-g\fR +\fB\-g\fR Display constant character literals in quoted form rather than their decimal equivalents. .TP -\fB-I\fR +\fB\-I\fR Force source translation to terminfo format. .TP -\fB-L\fR +\fB\-L\fR Force source translation to terminfo format using the long C variable names listed in <\fBterm.h\fR> .TP -\fB-N\fR -Disable smart defaults. +\fB\-N\fR +Disable smart defaults. Normally, when translating from termcap to terminfo, the compiler makes a number of assumptions about the defaults of string capabilities \fBreset1_string\fR, \fBcarriage_return\fR, \fBcursor_left\fR, \fBcursor_down\fR, \fBscroll_forward\fR, \fBtab\fR, \fBnewline\fR, \fBkey_backspace\fR, \fBkey_left\fR, and \fBkey_down\fR, then attempts -to use obsolete termcap capabilities to deduce correct values. It also +to use obsolete termcap capabilities to deduce correct values. +It also normally suppresses output of obsolete termcap capabilities such as \fBbs\fR. This option forces a more literal translation that also preserves the obsolete capabilities. .TP -\fB-o\fR\fIdir\fR -Write compiled entries to given directory. Overrides the TERMINFO environment +\fB\-o\fR\fIdir\fR +Write compiled entries to given directory. +Overrides the TERMINFO environment variable. .TP -\fB-R\fR\fIsubset\fR -Restrict output to a given subset. This option is for use with archaic +\fB\-R\fR\fIsubset\fR +Restrict output to a given subset. +This option is for use with archaic versions of terminfo like those on SVr1, Ultrix, or HP/UX that do not support the full set of SVR4/XSI Curses terminfo; and outright broken ports like AIX 3.x -that have their own extensions incompatible with SVr4/XSI. Available subsets +that have their own extensions incompatible with SVr4/XSI. +Available subsets are "SVr1", "Ultrix", "HP", "BSD" and "AIX"; see \fBterminfo\fR(\*n) for details. .TP -\fB-r\fR +\fB\-r\fR Force entry resolution (so there are no remaining tc capabilities) even -when doing translation to termcap format. This may be needed if you are +when doing translation to termcap format. +This may be needed if you are preparing a termcap file for a termcap library (such as GNU termcap through version 1.3 or BSD termcap through 4.3BSD) that does not handle multiple tc capabilities per entry. .TP -\fB-s\fR +\fB\-s\fR Summarize the compile by showing the directory into which entries are written, and the number of entries which are compiled. .TP -\fB-T\fR +\fB\-T\fR eliminates size-restrictions on the generated text. This is mainly useful for testing and analysis, since the compiled descriptions are limited (e.g., 1023 for termcap, 4096 for terminfo). .TP -\fB-t\fR +\fB\-t\fR tells \fBtic\fP to discard commented-out capabilities. Normally when translating from terminfo to termcap, untranslatable capabilities are commented-out. .TP 5 -\fB-U\fR +\fB\-U\fR tells \fBtic\fP to not post-process the data after parsing the source file. Normally, it infers data which is commonly missing in older terminfo data, or in termcaps. .TP -\fB-V\fR +\fB\-V\fR reports the version of ncurses which was used in this program, and exits. .TP -\fB-v\fR\fIn\fR +\fB\-v\fR\fIn\fR specifies that (verbose) output be written to standard error trace information showing \fBtic\fR's progress. The optional parameter \fIn\fR is a number from 1 to 10, inclusive, @@ -195,12 +207,12 @@ If \fIn\fR is omitted, the default level is 1. If \fIn\fR is specified and greater than 1, the level of detail is increased. .TP -\fB-w\fR\fIn\fR +\fB\-w\fR\fIn\fR specifies the width of the output. The parameter is optional. If it is omitted, it defaults to 60. .TP -\fB-x\fR +\fB\-x\fR Treat unknown capabilities as user-defined. That is, if you supply a capability name which \fBtic\fP does not recognize, it will infer its type (boolean, number or string) from the syntax and @@ -210,7 +222,8 @@ whose name begins with ``k'' are treated as function keys. .TP \fIfile\fR contains one or more \fBterminfo\fR terminal descriptions in source -format [see \fBterminfo\fR(\*n)]. Each description in the file +format [see \fBterminfo\fR(\*n)]. +Each description in the file describes the capabilities of a particular terminal. .PP The debug flag levels are as follows: @@ -239,15 +252,18 @@ All values computed in construction of the hash table If the debug level \fIn\fR is not given, it is taken to be one. .PP All but one of the capabilities recognized by \fBtic\fR are documented -in \fBterminfo\fR(\*n). The exception is the \fBuse\fR capability. +in \fBterminfo\fR(\*n). +The exception is the \fBuse\fR capability. .PP -When a \fBuse\fR=\fIentry\fR-\fIname\fR field is discovered in a +When a \fBuse\fR=\fIentry\fR\-\fIname\fR field is discovered in a terminal entry currently being compiled, \fBtic\fR reads in the binary -from \fB\*d\fR to complete the entry. (Entries created from -\fIfile\fR will be used first. If the environment variable +from \fB\*d\fR to complete the entry. +(Entries created from +\fIfile\fR will be used first. +If the environment variable \fBTERMINFO\fR is set, that directory is searched instead of \fB\*d\fR.) \fBtic\fR duplicates the capabilities in -\fIentry\fR-\fIname\fR for the current entry, with the exception of +\fIentry\fR\-\fIname\fR for the current entry, with the exception of those capabilities that explicitly are defined in the current entry. .PP When an entry, e.g., \fBentry_name_1\fR, contains a @@ -259,20 +275,25 @@ canceled in \fBentry_name_1\fR. If the environment variable \fBTERMINFO\fR is set, the compiled results are placed there instead of \fB\*d\fR. .PP -Total compiled entries cannot exceed 4096 bytes. The name field cannot -exceed 512 bytes. Terminal names exceeding the maximum alias length +Total compiled entries cannot exceed 4096 bytes. +The name field cannot +exceed 512 bytes. +Terminal names exceeding the maximum alias length (32 characters on systems with long filenames, 14 characters otherwise) will be truncated to the maximum alias length and a warning message will be printed. .SH COMPATIBILITY There is some evidence that historic \fBtic\fR implementations treated description fields with no whitespace in them as additional aliases or -short names. This \fBtic\fR does not do that, but it does warn when +short names. +This \fBtic\fR does not do that, but it does warn when description fields may be treated that way and check them for dangerous characters. .SH EXTENSIONS Unlike the stock SVr4 \fBtic\fR command, this implementation can actually -compile termcap sources. In fact, entries in terminfo and termcap syntax can -be mixed in a single source file. See \fBterminfo\fR(\*n) for the list of +compile termcap sources. +In fact, entries in terminfo and termcap syntax can +be mixed in a single source file. +See \fBterminfo\fR(\*n) for the list of termcap names taken to be equivalent to terminfo names. .PP The SVr4 manual pages are not clear on the resolution rules for \fBuse\fR @@ -287,25 +308,25 @@ The error messages from this \fBtic\fR have the same format as GNU C error messages, and can be parsed by GNU Emacs's compile facility. .PP The -\fB-C\fR, -\fB-G\fR, -\fB-I\fR, -\fB-N\fR, -\fB-R\fR, -\fB-T\fR, -\fB-V\fR, -\fB-a\fR, -\fB-e\fR, -\fB-f\fR, -\fB-g\fR, -\fB-o\fR, -\fB-r\fR, -\fB-s\fR, -\fB-t\fR and -\fB-x\fR +\fB\-C\fR, +\fB\-G\fR, +\fB\-I\fR, +\fB\-N\fR, +\fB\-R\fR, +\fB\-T\fR, +\fB\-V\fR, +\fB\-a\fR, +\fB\-e\fR, +\fB\-f\fR, +\fB\-g\fR, +\fB\-o\fR, +\fB\-r\fR, +\fB\-s\fR, +\fB\-t\fR and +\fB\-x\fR options are not supported under SVr4. -The SVr4 \fB-c\fR mode does not report bad use links. +The SVr4 \fB\-c\fR mode does not report bad use links. .PP System V does not compile entries to or read entries from your \fI$HOME/.terminfo\fR directory unless TERMINFO is explicitly set to it. @@ -323,9 +344,8 @@ Compiled terminal description database. .PP This describes \fBncurses\fR version @NCURSES_MAJOR@.@NCURSES_MINOR@ (patch @NCURSES_PATCH@). -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: +.SH AUTHOR +Eric S. Raymond <esr@snark.thyrsus.com> +and +.br +Thomas E. Dickey <dickey@invisible-island.net> @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2006,2008 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2008,2010 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,14 +26,14 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: toe.1m,v 1.21 2008/01/05 20:57:16 tom Exp $ +.\" $Id: toe.1m,v 1.23 2010/12/04 18:40:45 tom Exp $ .TH @TOE@ 1M "" .ds n 5 .ds d @TERMINFO@ .SH NAME -\fBtoe\fR - table of (terminfo) entries +\fBtoe\fR \- table of (terminfo) entries .SH SYNOPSIS -\fBtoe\fR [\fB-v\fR[\fIn\fR]] [\fB-ahuUV\fR] \fIfile...\fR +\fBtoe\fR [\fB\-v\fR[\fIn\fR]] [\fB\-ahuUV\fR] \fIfile...\fR .br .SH DESCRIPTION .PP @@ -43,17 +43,17 @@ with descriptions. File arguments specify the directories to be scanned; if no such arguments are given, your default terminfo directory is scanned. -If you also specify the \fB-h\fR option, +If you also specify the \fB\-h\fR option, a directory header will be issued as each directory is entered. .PP There are other options intended for use by terminfo file maintainers: .TP -\fB-a\fR +\fB\-a\fR report on all of the terminal databases which ncurses would search, rather than only the first one that it finds. .TP -\fB-u\fR \fIfile\fR +\fB\-u\fR \fIfile\fR says to write a report to the standard output, listing dependencies in the given terminfo/termcap source file. The report condenses the `use' relation: @@ -65,7 +65,7 @@ whitespace-separated primary names of all terminals which occur in those use capabilities, followed by a newline .TP -\fB-U\fR \fIfile\fR +\fB\-U\fR \fIfile\fR says to write a report to the standard output, listing reverse dependencies in the given terminfo/termcap source file. The report reverses the `use' relation: @@ -76,13 +76,13 @@ followed by the whitespace-separated primary names of all terminals which depend on it, followed by a newline. .TP -\fB-v\fR\fIn\fR +\fB\-v\fR\fIn\fR 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 \fB@TIC@\fR(1M). .TP -\fB-V\fR +\fB\-V\fR reports the version of ncurses which was used in this program, and exits. .SH FILES @@ -99,9 +99,3 @@ Compiled terminal description database. .PP This describes \fBncurses\fR version @NCURSES_MAJOR@.@NCURSES_MINOR@ (patch @NCURSES_PATCH@). -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998-2005,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2006,2010 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,24 +27,24 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: tput.1,v 1.27 2006/12/24 18:11:31 tom Exp $ +.\" $Id: tput.1,v 1.29 2010/12/04 18:41:07 tom Exp $ .TH @TPUT@ 1 "" .ds d @TERMINFO@ .ds n 1 .SH NAME -\fB@TPUT@\fR, \fBreset\fR - initialize a terminal or query terminfo database +\fB@TPUT@\fR, \fBreset\fR \- initialize a terminal or query terminfo database .SH SYNOPSIS -\fB@TPUT@\fR [\fB-T\fR\fItype\fR] \fIcapname\fR [\fIparms\fR ... ] +\fB@TPUT@\fR [\fB\-T\fR\fItype\fR] \fIcapname\fR [\fIparms\fR ... ] .br -\fB@TPUT@\fR [\fB-T\fR\fItype\fR] \fBinit\fR +\fB@TPUT@\fR [\fB\-T\fR\fItype\fR] \fBinit\fR .br -\fB@TPUT@\fR [\fB-T\fR\fItype\fR] \fBreset\fR +\fB@TPUT@\fR [\fB\-T\fR\fItype\fR] \fBreset\fR .br -\fB@TPUT@\fR [\fB-T\fR\fItype\fR] \fBlongname\fR +\fB@TPUT@\fR [\fB\-T\fR\fItype\fR] \fBlongname\fR .br -\fB@TPUT@ -S\fR \fB<<\fR +\fB@TPUT@ \-S\fR \fB<<\fR .br -\fB@TPUT@ -V\fR +\fB@TPUT@ \-V\fR .br .SH DESCRIPTION The \fB@TPUT@\fR utility uses the \fBterminfo\fR database to make the @@ -76,10 +76,10 @@ the application should test the exit code For a complete list of capabilities and the \fIcapname\fR associated with each, see \fBterminfo\fR(5). .TP -\fB-T\fR\fItype\fR +\fB\-T\fR\fItype\fR indicates the \fItype\fR of terminal. Normally this option is unnecessary, because the default is taken from the environment -variable \fBTERM\fR. If \fB-T\fR is specified, then the shell +variable \fBTERM\fR. If \fB\-T\fR is specified, then the shell variables \fBLINES\fR and \fBCOLUMNS\fR will be ignored,and the operating system will not be queried for the actual screen size. .TP @@ -99,12 +99,12 @@ Normally \fB@TPUT@\fR uses \fBtparm\fR (3X) to perform the substitution. If no parameters are given for the capability, \fB@TPUT@\fR writes the string without performing the substitution. .TP -\fB-S\fR +\fB\-S\fR 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 +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 @@ -112,12 +112,12 @@ 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 -\fB-V\fR +\fB\-V\fR reports the version of ncurses which was used in this program, and exits. .TP \fBinit\fR If the \fBterminfo\fR database is present and an entry for the user's -terminal exists (see \fB-T\fR\fItype\fR, above), the following will +terminal exists (see \fB\-T\fR\fItype\fR, above), the following will occur: .RS .TP @@ -152,7 +152,7 @@ Otherwise, \fBreset\fR acts identically to \fBinit\fR. .TP \fBlongname\fR If the \fBterminfo\fR database is present and an entry for the -user's terminal exists (see \fB-T\fR\fItype\fR above), then the long name +user's terminal exists (see \fB\-T\fR\fItype\fR above), then the long name 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)]. @@ -169,7 +169,7 @@ 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 -\fB@TPUT@ -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 @@ -184,7 +184,7 @@ Echo the clear-screen sequence for the current terminal. \fB@TPUT@ cols\fR Print the number of columns for the current terminal. .TP 5 -\fB@TPUT@ -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 @@ -208,7 +208,7 @@ type of terminal specified in the environmental variable \fBTERM\fR. .PP .RS 5 -\fB@TPUT@ -S <<!\fR +\fB@TPUT@ \-S <<!\fR .br \fB> clear\fR .br @@ -237,7 +237,7 @@ sequences that set margins and tabs); for more information, see the "Tabs and Initialization" section of \fBterminfo\fR(5) .SH EXIT CODES -If the \fB-S\fR option is used, +If the \fB\-S\fR option is used, \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. @@ -245,7 +245,7 @@ If no errors are found, the exit code is \fB0\fR. No indication of which line failed can be given so exit code \fB1\fR will never appear. Exit codes \fB2\fR, \fB3\fR, and \fB4\fR retain their usual interpretation. -If the \fB-S\fR option is not used, +If the \fB\-S\fR option is not used, the exit code depends on the type of \fIcapname\fR: .RS 5 .TP @@ -265,7 +265,7 @@ a value of \fB0\fR is always set, whether or not \fIcapname\fR is defined for this terminal \fItype\fR. To determine if \fIcapname\fR is defined for this terminal \fItype\fR, the user must test the value written to standard output. -A value of \fB-1\fR +A value of \fB\-1\fR means that \fIcapname\fR is not defined for this terminal \fItype\fR. .TP .I other @@ -286,18 +286,18 @@ exit code error message \fB0\fR T{ (\fIcapname\fR is a numeric variable that is not specified in the \fBterminfo\fR(5) database for this terminal type, e.g. -\fB@TPUT@ -T450 lines\fR and \fB@TPUT@ -T2621 xmc\fR) +\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 \fB3\fR unknown terminal \fItype\fR or no \fBterminfo\fR database \fB4\fR unknown \fBterminfo\fR capability \fIcapname\fR -\fB>4\fR error occurred in -S +\fB>4\fR error occurred in \-S = .TE .SH PORTABILITY .PP -The \fBlongname\fR and \fB-S\fR options, and the parameter-substitution +The \fBlongname\fR and \fB\-S\fR options, and the parameter-substitution features used in the \fBcup\fR example, are not supported in BSD curses or in AT&T/USL curses before SVr4. .PP @@ -317,9 +317,3 @@ than terminfo capability names in their respective \fBtput\fP commands. .PP This describes \fBncurses\fR version @NCURSES_MAJOR@.@NCURSES_MINOR@ (patch @NCURSES_PATCH@). -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2005,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2008,2010 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,14 +26,14 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: tset.1,v 1.19 2006/12/24 15:00:30 tom Exp $ -.TH tset 1 "" +.\" $Id: tset.1,v 1.25 2010/12/04 18:38:55 tom Exp $ +.TH @TSET@ 1 "" .SH NAME -\fBtset\fR, \fBreset\fR - terminal initialization +\fBtset\fR, \fBreset\fR \- terminal initialization .SH SYNOPSIS -\fBtset\fR [\fB-IQVcqrsw\fR] [\fB-\fR] [\fB-e\fR \fIch\fR] [\fB-i\fR \fIch\fR] [\fB-k\fR \fIch\fR] [\fB-m\fR \fImapping\fR] [\fIterminal\fR] +\fBtset\fR [\fB\-IQVcqrsw\fR] [\fB\-\fR] [\fB\-e\fR \fIch\fR] [\fB\-i\fR \fIch\fR] [\fB\-k\fR \fIch\fR] [\fB\-m\fR \fImapping\fR] [\fIterminal\fR] .br -\fBreset\fR [\fB-IQVcqrsw\fR] [\fB-\fR] [\fB-e\fR \fIch\fR] [\fB-i\fR \fIch\fR] [\fB-k\fR \fIch\fR] [\fB-m\fR \fImapping\fR] [\fIterminal\fR] +\fBreset\fR [\fB\-IQVcqrsw\fR] [\fB\-\fR] [\fB\-e\fR \fIch\fR] [\fB\-i\fR \fIch\fR] [\fB\-k\fR \fIch\fR] [\fB\-m\fR \fImapping\fR] [\fIterminal\fR] .SH DESCRIPTION \&\fBTset\fR initializes terminals. \fBTset\fR first determines the type of terminal that you are using. @@ -44,13 +44,14 @@ This determination is done as follows, using the first terminal type found. 2. The value of the \fBTERM\fR environmental variable. .PP 3. (BSD systems only.) The terminal type associated with the standard -error output device in the \fI/etc/ttys\fR file. (On Linux and -System-V-like UNIXes, \fIgetty\fR does this job by setting +error output device in the \fI/etc/ttys\fR file. +(On System\-V-like UNIXes and systems using that convention, +\fIgetty\fR does this job by setting \fBTERM\fR according to the type passed to it by \fI/etc/inittab\fR.) .PP 4. The default terminal type, ``unknown''. .PP -If the terminal type was not specified on the command-line, the \fB-m\fR +If the terminal type was not specified on the command-line, the \fB\-m\fR option mappings are then applied (see the section .B TERMINAL TYPE MAPPING for more information). @@ -67,7 +68,7 @@ and tab initialization strings are sent to the standard error output. Finally, if the erase, interrupt and line kill characters have changed, or are not set to their default values, their values are displayed to the standard error output. -Use the \fB-c\fP or \fB-w\fP option to select only the window sizing +Use the \fB\-c\fP or \fB\-w\fP option to select only the window sizing versus the other initialization. If neither option is given, both are assumed. .PP @@ -86,64 +87,64 @@ Also, the terminal will often not echo the command. .PP The options are as follows: .TP 5 -.B -c +.B \-c Set control characters and modes. -.B -e +.B \-e Set the erase character to \fIch\fR. .TP -.B -I +.B \-I Do not send the terminal or tab initialization strings to the terminal. .TP -.B -i +.B \-i Set the interrupt character to \fIch\fR. .TP -.B -k +.B \-k Set the line kill character to \fIch\fR. .TP -.B -m +.B \-m Specify a mapping from a port type to a terminal. See the section .B TERMINAL TYPE MAPPING for more information. .TP -.B -Q +.B \-Q Do not display any values for the erase, interrupt and line kill characters. Normally \fBtset\fR displays the values for control characters which differ from the system's default values. .TP -.B -q +.B \-q The terminal type is displayed to the standard output, and the terminal is -not initialized in any way. The option `-' by itself is equivalent but +not initialized in any way. The option `\-' by itself is equivalent but archaic. .TP -.B -r +.B \-r Print the terminal type to the standard error output. .TP -.B -s +.B \-s Print the sequence of shell commands to initialize the environment variable \fBTERM\fR to the standard output. See the section .B SETTING THE ENVIRONMENT for details. .TP -.B -V +.B \-V reports the version of ncurses which was used in this program, and exits. .TP -.B -w +.B \-w Resize the window to match the size deduced via \fBsetupterm\fP. Normally this has no effect, unless \fBsetupterm\fP is not able to detect the window size. .PP -The arguments for the \fB-e\fR, \fB-i\fR, and \fB-k\fR +The arguments for the \fB\-e\fR, \fB\-i\fR, and \fB\-k\fR options may either be entered as actual characters or by using the `hat' -notation, i.e. control-h may be specified as ``^H'' or ``^h''. +notation, i.e., control-h may be specified as ``^H'' or ``^h''. . .SH SETTING THE ENVIRONMENT It is often desirable to enter the terminal type and information about the terminal's capabilities into the shell's environment. -This is done using the \fB-s\fR option. +This is done using the \fB\-s\fR option. .PP -When the \fB-s\fR option is specified, the commands to enter the information +When the \fB\-s\fR option is specified, the commands to enter the information into the shell's environment are written to the standard output. If the \fBSHELL\fR environmental variable ends in ``csh'', the commands are for \fBcsh\fR, otherwise, they are for \fBsh\fR. @@ -151,7 +152,7 @@ Note, the \fBcsh\fR commands set and unset the shell variable \fBnoglob\fR, leaving it unset. The following line in the \fB.login\fR or \fB.profile\fR files will initialize the environment correctly: .sp - eval \`tset -s options ... \` + eval \`tset \-s options ... \` . .SH TERMINAL TYPE MAPPING When the terminal is not hardwired into the system (or the current @@ -161,13 +162,13 @@ something generic like \fBnetwork\fR, \fBdialup\fR, or \fBunknown\fR. When \fBtset\fR is used in a startup script it is often desirable to provide information about the type of terminal used on such ports. .PP -The purpose of the \fB-m\fR option is to map +The purpose of the \fB\-m\fR option is to map from some set of conditions to a terminal type, that is, to tell \fBtset\fR ``If I'm on this port at a particular speed, guess that I'm on that kind of terminal''. .PP -The argument to the \fB-m\fR option consists of an optional port type, an +The argument to the \fB\-m\fR option consists of an optional port type, an optional operator, an optional baud rate specification, an optional colon (``:'') character and a terminal type. The port type is a string (delimited by either the operator or the colon character). The @@ -178,7 +179,7 @@ The baud rate is specified as a number and is compared with the speed of the standard error output (which should be the control terminal). The terminal type is a string. .PP -If the terminal type is not specified on the command line, the \fB-m\fR +If the terminal type is not specified on the command line, the \fB\-m\fR mappings are applied to the terminal type. If the port type and baud rate match the mapping, the terminal type specified in the mapping replaces the current type. If more than one mapping is specified, the @@ -193,16 +194,16 @@ and the baud rate is greater than 9600 baud, a terminal type of .PP If no baud rate is specified, the terminal type will match any baud rate. If no port type is specified, the terminal type will match any port type. -For example, \fB-m dialup:vt100 -m :?xterm\fR +For example, \fB\-m dialup:vt100 \-m :?xterm\fR will cause any dialup port, regardless of baud rate, to match the terminal type vt100, and any non-dialup port type to match the terminal type ?xterm. Note, because of the leading question mark, the user will be queried on a default port as to whether they are actually using an xterm terminal. .PP -No whitespace characters are permitted in the \fB-m\fR option argument. +No whitespace characters are permitted in the \fB\-m\fR option argument. Also, to avoid problems with meta-characters, it is suggested that the -entire \fB-m\fR option argument be placed within single quote characters, +entire \fB\-m\fR option argument be placed within single quote characters, and that \fBcsh\fR users insert a backslash character (``\e'') before any exclamation marks (``!''). .SH HISTORY @@ -216,34 +217,34 @@ can set \fBTERM\fR appropriately for each dial-up line; this obviates what was \fBtset\fR's most important use). This implementation behaves like 4.4BSD tset, with a few exceptions specified here. .PP -The \fB-S\fR option of BSD tset no longer works; it prints an error message to stderr -and dies. The \fB-s\fR option only sets \fBTERM\fR, not \fBTERMCAP\fP. Both these +The \fB\-S\fR option of BSD tset no longer works; it prints an error message to stderr +and dies. The \fB\-s\fR option only sets \fBTERM\fR, not \fBTERMCAP\fP. Both these changes are because the \fBTERMCAP\fR variable is no longer supported under -terminfo-based \fBncurses\fR, which makes \fBtset -S\fR useless (we made it die +terminfo-based \fBncurses\fR, which makes \fBtset \-S\fR useless (we made it die noisily rather than silently induce lossage). .PP There was an undocumented 4.4BSD feature that invoking tset via a link named `TSET` (or via any other name beginning with an upper-case letter) set the terminal to use upper-case only. This feature has been omitted. .PP -The \fB-A\fR, \fB-E\fR, \fB-h\fR, \fB-u\fR and \fB-v\fR +The \fB\-A\fR, \fB\-E\fR, \fB\-h\fR, \fB\-u\fR and \fB\-v\fR options were deleted from the \fBtset\fR utility in 4.4BSD. None of them were documented in 4.3BSD and all are of limited utility at best. -The \fB-a\fR, \fB-d\fR, and \fB-p\fR options are similarly +The \fB\-a\fR, \fB\-d\fR, and \fB\-p\fR options are similarly not documented or useful, but were retained as they appear to be in widespread use. It is strongly recommended that any usage of these -three options be changed to use the \fB-m\fR option instead. The --n option remains, but has no effect. The \fB-adnp\fR options are therefore +three options be changed to use the \fB\-m\fR option instead. The +\fB\-n\fP option remains, but has no effect. The \fB\-adnp\fR options are therefore omitted from the usage summary above. .PP -It is still permissible to specify the \fB-e\fR, \fB-i\fR, and \fB-k\fR options without +It is still permissible to specify the \fB\-e\fR, \fB\-i\fR, and \fB\-k\fR options without arguments, although it is strongly recommended that such usage be fixed to explicitly specify the character. .PP -As of 4.4BSD, executing \fBtset\fR as \fBreset\fR no longer implies the \fB-Q\fR -option. Also, the interaction between the - option and the \fIterminal\fR +As of 4.4BSD, executing \fBtset\fR as \fBreset\fR no longer implies the \fB\-Q\fR +option. Also, the interaction between the \- option and the \fIterminal\fR argument in some historic implementations of \fBtset\fR has been removed. .SH ENVIRONMENT The \fBtset\fR command uses these environment variables: @@ -280,9 +281,3 @@ environ(7) .PP This describes \fBncurses\fR version @NCURSES_MAJOR@.@NCURSES_MINOR@ (patch @NCURSES_PATCH@). -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: diff --git a/man/wresize.3x b/man/wresize.3x index 4d05d3e..0832450 100644 --- a/man/wresize.3x +++ b/man/wresize.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2003,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2006,2010 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 * @@ -28,20 +28,21 @@ .\" .\" Author: Thomas E. Dickey 1996 .\" -.\" $Id: wresize.3x,v 1.9 2006/02/25 21:47:06 tom Exp $ +.\" $Id: wresize.3x,v 1.13 2010/12/04 18:40:45 tom Exp $ .TH wresize 3X "" .SH NAME -\fBwresize\fR - resize a curses window +\fBwresize\fR \- resize a curses window .SH SYNOPSIS \fB#include <curses.h>\fR .sp \fBint wresize(WINDOW *win, int lines, int columns);\fR .SH DESCRIPTION -The \fBwresize\fR function reallocates storage for an \fBncurses\fR +This is an extension to the curses library. +It reallocates storage for an \fBncurses\fR window to adjust its dimensions to the specified values. If either dimension is larger than the current values, the window's data is filled with blanks that have the current background rendition -(as set by \fBwbkgndset\fR) merged into them. +(as set by \fBwbkgdset\fR) merged into them. .SH RETURN VALUE The function returns the integer \fBERR\fR upon failure and \fBOK\fR on success. It will fail if either of the dimensions less than or equal to zero, @@ -56,9 +57,3 @@ actual screen dimensions. \fBresizeterm\fR(3X). .SH AUTHOR Thomas Dickey (from an equivalent function written in 1988 for BSD curses). -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: |
