path: root/contrib/ncurses/man
diff options
authorPeter Wemm <peter@FreeBSD.org>2001-05-17 08:21:06 +0000
committerPeter Wemm <peter@FreeBSD.org>2001-05-17 08:21:06 +0000
commit7a69bbfb278952228c9aa1eca241e65fcdef425e (patch)
treee83b2ef47811e687a6c54035c9af6d4a2b7f14e1 /contrib/ncurses/man
parent18259542b2f8fa7e3f76f4bb0dd37995dfd424aa (diff)
Import ncurses-5.2-20010512 onto the vendor branch
Obtained from: ftp://dickey.his.com/ncurses/
Notes: svn path=/vendor/ncurses/dist/; revision=76726
Diffstat (limited to 'contrib/ncurses/man')
8 files changed, 43 insertions, 21 deletions
diff --git a/contrib/ncurses/man/curs_deleteln.3x b/contrib/ncurses/man/curs_deleteln.3x
index 8e48384af2eb..8b39402d1968 100644
--- a/contrib/ncurses/man/curs_deleteln.3x
+++ b/contrib/ncurses/man/curs_deleteln.3x
@@ -26,7 +26,7 @@
.\" authorization. *
-.\" $Id: curs_deleteln.3x,v 1.6 2000/07/01 19:56:12 tom Exp $
+.\" $Id: curs_deleteln.3x,v 1.7 2000/11/11 20:43:20 Bernhard.Rosenkraenzer Exp $
.TH curs_deleteln 3X ""
@@ -61,7 +61,7 @@ bottom lines are lost. For negative \fIn\fR, delete \fIn\fR lines (starting
with the one under the cursor), and move the remaining lines up. The bottom
\fIn\fR lines are cleared. The current cursor position remains the same.
-The \fBinsertln\fR and \fBinsertln\fR routines, insert a blank line above the
+The \fBinsertln\fR and \fBwinsertln\fR routines, insert a blank line above the
current line and the bottom line is lost.
All routines return the integer \fBERR\fR upon failure and an \fBOK\fR (SVr4
diff --git a/contrib/ncurses/man/curs_getch.3x b/contrib/ncurses/man/curs_getch.3x
index b2b20ef4da15..56028f8f1352 100644
--- a/contrib/ncurses/man/curs_getch.3x
+++ b/contrib/ncurses/man/curs_getch.3x
@@ -27,7 +27,7 @@
.\" authorization. *
-.\" $Id: curs_getch.3x,v 1.17 2000/07/01 16:45:36 tom Exp $
+.\" $Id: curs_getch.3x,v 1.18 2001/02/25 00:20:30 tom Exp $
.TH curs_getch 3X ""
@@ -223,6 +223,15 @@ 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
keypad code looks for a following function-key sequence.
+Note that some keys may be the same as commonly used control
+keys, e.g., KEY_ENTER versus control/M, KEY_BACKSPACE versus control/H.
+Some curses implementations may differ according to whether they
+treat these control keys specially (and ignore the terminfo), or
+use the terminfo definitions.
+\fBNcurses\fR uses the terminfo definition.
+If it says that KEY_ENTER is control/M, \fBgetch\fR, will return KEY_ENTER
+when you press control/M.
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. Depending on the
diff --git a/contrib/ncurses/man/curs_outopts.3x b/contrib/ncurses/man/curs_outopts.3x
index 4c5bf1f456a8..3ba7cf531cd4 100644
--- a/contrib/ncurses/man/curs_outopts.3x
+++ b/contrib/ncurses/man/curs_outopts.3x
@@ -26,10 +26,10 @@
.\" authorization. *
-.\" $Id: curs_outopts.3x,v 1.14 2000/02/27 01:41:58 tom Exp $
+.\" $Id: curs_outopts.3x,v 1.16 2001/03/31 23:47:31 tom Exp $
.TH curs_outopts 3X ""
-\fBclearok\fR, \fBidlok\fR, \fBidcok immedok\fR,
+\fBclearok\fR, \fBidlok\fR, \fBidcok\fR, \fBimmedok\fR,
\fBleaveok\fR, \fBsetscrreg\fR, \fBwsetscrreg\fR, \fBscrollok\fR,
\fBnl\fR, \fBnonl\fR - \fBcurses\fR output options
@@ -92,8 +92,7 @@ It is disabled by default.
Normally, the hardware cursor is left at the location of the window cursor
being refreshed. The \fBleaveok\fR option allows the cursor to be left
wherever the update happens to leave it. It is useful for applications where
-the cursor is not used, since it reduces the need for cursor motions. If
-possible, the cursor is made invisible when this option is enabled.
+the cursor is not used, since it reduces the need for cursor motions.
The \fBsetscrreg\fR and \fBwsetscrreg\fR routines allow the application
programmer to set a software scrolling region in a window. \fItop\fR and
diff --git a/contrib/ncurses/man/curs_slk.3x b/contrib/ncurses/man/curs_slk.3x
index c52a70556f01..8f1ae8a0d9bf 100644
--- a/contrib/ncurses/man/curs_slk.3x
+++ b/contrib/ncurses/man/curs_slk.3x
@@ -26,7 +26,7 @@
.\" authorization. *
-.\" $Id: curs_slk.3x,v 1.10 2000/07/01 17:52:44 tom Exp $
+.\" $Id: curs_slk.3x,v 1.11 2001/03/03 21:05:41 Todd.C.Miller Exp $
.TH curs_slk 3X ""
\fBslk_init\fR, \fBslk_set\fR, \fBslk_refresh\fR,
@@ -34,7 +34,7 @@
\fBslk_clear\fR, \fBslk_restore\fR, \fBslk_touch\fR,
\fBslk_attron\fR, \fBslk_attrset\fR, \fBslk_attroff\fR,
\fBslk_attr_on\fR, \fBslk_attr_set\fR, \fBslk_attr_off\fR,
-\fBslk_attr\fR \fBslk_color\fR - \fBcurses\fR soft label routines
+\fBslk_attr\fR, \fBslk_color\fR - \fBcurses\fR soft label routines
\fB#include <curses.h>\fR
diff --git a/contrib/ncurses/man/curs_termcap.3x b/contrib/ncurses/man/curs_termcap.3x
index 01395bfe1d3d..c7bd81ac3ac7 100644
--- a/contrib/ncurses/man/curs_termcap.3x
+++ b/contrib/ncurses/man/curs_termcap.3x
@@ -26,7 +26,7 @@
.\" authorization. *
-.\" $Id: curs_termcap.3x,v 1.13 2000/07/01 20:10:57 tom Exp $
+.\" $Id: curs_termcap.3x,v 1.14 2000/12/02 22:47:14 tom Exp $
.TH curs_termcap 3X ""
.ds n 5
@@ -41,13 +41,13 @@
\fB#include <term.h>\fR
-\fBint tgetent(const char *bp, char *name);\fR
+\fBint tgetent(char *bp, const char *name);\fR
-\fBint tgetflag(const char *id);\fR
+\fBint tgetflag(char *id);\fR
-\fBint tgetnum(const char *id);\fR
+\fBint tgetnum(char *id);\fR
-\fBchar *tgetstr(const char *id, char **area);\fR
+\fBchar *tgetstr(char *id, char **area);\fR
\fBchar *tgoto(const char *cap, int col, int row);\fR
@@ -78,6 +78,11 @@ The return value will also be copied to the buffer pointed to by \fIarea\fR,
and the \fIarea\fR value will be updated to point past the null ending
this value.
+Only the first two characters of the \fBid\fR parameter of
+\fBtgetnum\fR and
+\fBtgetstr\fR are compared in lookups.
The \fBtgoto\fR routine instantiates the parameters into the given capability.
The output from this routine is to be passed to \fBtputs\fR.
@@ -96,7 +101,11 @@ If you call \fBtgetstr\fR to fetch \fBca\fR or any other parameterized string,
be aware that it will be returned in terminfo notation, not the older and
not-quite-compatible termcap notation. This won't cause problems if all
you do with it is call \fBtgoto\fR or \fBtparm\fR, which both expand
+terminfo-style strings as terminfo.
+(The \fBtgoto\fR function, if configured to support termcap, will check
+if the string is indeed terminfo-style by looking for "%p" parameters or
+"$<..>" delays, and invoke a termcap-style parser if the string does not
+appear to be terminfo).
Because terminfo conventions for representing padding in string capabilities
differ from termcap's, \fBtputs("50");\fR will put out a literal "50" rather
diff --git a/contrib/ncurses/man/curs_terminfo.3x b/contrib/ncurses/man/curs_terminfo.3x
index bb5c8ca6cfa3..d55fa24ce10a 100644
--- a/contrib/ncurses/man/curs_terminfo.3x
+++ b/contrib/ncurses/man/curs_terminfo.3x
@@ -26,7 +26,7 @@
.\" authorization. *
-.\" $Id: curs_terminfo.3x,v 1.13 2000/07/01 20:07:34 tom Exp $
+.\" $Id: curs_terminfo.3x,v 1.14 2000/12/03 00:07:23 tom Exp $
.TH curs_terminfo 3X ""
.ds n 5
@@ -253,6 +253,10 @@ In System V Release 4, the third argument of \fBtputs\fR has the type
The XSI Curses standard prototypes \fBtparm\fR with a fixed number of parameters,
rather than a variable argument list.
+That prototype assumes that none of the parameters are strings
+(or if so, that a long is big enough to hold a pointer).
+The variable argument list implemented in ncurses does not rely on
+that assumption.
XSI notes that after calling \fBmvcur\fR, the curses state may not match the
actual terminal state, and that an application should touch and refresh
diff --git a/contrib/ncurses/man/ncurses.3x b/contrib/ncurses/man/ncurses.3x
index 3b36fa9a6df1..6ce50d87ac4f 100644
--- a/contrib/ncurses/man/ncurses.3x
+++ b/contrib/ncurses/man/ncurses.3x
@@ -27,7 +27,7 @@
.\" authorization. *
-.\" $Id: ncurses.3x,v 1.44 2000/10/08 01:39:26 tom Exp $
+.\" $Id: ncurses.3x,v 1.46 2000/11/25 21:58:45 tom Exp $
.hy 0
.TH ncurses 3X ""
.ds n 5
@@ -699,14 +699,14 @@ ncurses library, e.g.,
.TP 5
Specifies a list of directories to search for terminal descriptions.
-The list is separated by colons (i.e., ":").
+The list is separated by colons (i.e., ":") on Unix, semicolons on OS/2 EMX.
All of the terminal descriptions are in terminfo form, which makes
a subdirectory named for the first letter of the terminal names therein.
.TP 5
If TERMCAP does not hold a file name then \fBncurses\fR checks
the TERMPATH symbol.
-This is a list of filenames separated by colons (i.e., ":").
+This is a list of filenames separated by spaces or colons (i.e., ":") on Unix, semicolons on OS/2 EMX.
If the TERMPATH symbol is not set, \fBncurses\fR looks in the files
/etc/termcap, /usr/share/misc/termcap and $HOME/.termcap, in that order.
diff --git a/contrib/ncurses/man/terminfo.tail b/contrib/ncurses/man/terminfo.tail
index 65a83c990cf2..e39230f83863 100644
--- a/contrib/ncurses/man/terminfo.tail
+++ b/contrib/ncurses/man/terminfo.tail
@@ -1,4 +1,4 @@
-.\" $Id: terminfo.tail,v 1.32 2000/04/15 20:04:58 tom Exp $
+.\" $Id: terminfo.tail,v 1.33 2000/10/14 14:06:50 tom Exp $
.\" Beginning of terminfo.tail file
.ps +1
@@ -912,7 +912,8 @@ output
.BR is2 ;
set the margins using
.BR mgc ,
-.BR smgl and
+.BR smgl
.BR smgr ;
set tabs using
.B tbc