summaryrefslogtreecommitdiffstats
path: root/lib/libcurses/curs_instr.3
diff options
context:
space:
mode:
authormillert <millert@openbsd.org>1997-11-26 04:01:02 +0000
committermillert <millert@openbsd.org>1997-11-26 04:01:02 +0000
commit010b00ebb3f4bdd576ec41ca1d5d0a8994e8fe5b (patch)
tree5ee5e7213ad9b412a927de7effdcb7c8ce4b489e /lib/libcurses/curs_instr.3
parentlibform from ncurses 4.1. Post 4.1 patches to be applied in a separate commit. (diff)
downloadwireguard-openbsd-010b00ebb3f4bdd576ec41ca1d5d0a8994e8fe5b.tar.xz
wireguard-openbsd-010b00ebb3f4bdd576ec41ca1d5d0a8994e8fe5b.zip
ncurses 4.1 + changes to work with our terminfo libs (instead of
the ncurses ones). Changes are #ifdef EXTERN_TERMINFO. Post 4.1 patches will be applied in a separate commit.
Diffstat (limited to 'lib/libcurses/curs_instr.3')
-rw-r--r--lib/libcurses/curs_instr.327
1 files changed, 15 insertions, 12 deletions
diff --git a/lib/libcurses/curs_instr.3 b/lib/libcurses/curs_instr.3
index e7c681664a5..34be1cb3c69 100644
--- a/lib/libcurses/curs_instr.3
+++ b/lib/libcurses/curs_instr.3
@@ -1,3 +1,4 @@
+.\" Id: curs_instr.3x,v 1.7 1997/03/15 23:25:24 tom Exp $
.TH curs_instr 3X ""
.SH NAME
\fBinstr\fR, \fBinnstr\fR, \fBwinstr\fR, \fBwinnstr\fR,
@@ -24,24 +25,26 @@ of characters from a \fBcurses\fR window
.br
.SH DESCRIPTION
These routines return a string of characters in \fIstr\fR, extracted starting
-at the current cursor position in the named window and ending at the right
-margin of the window. Attributes are stripped from the characters. The four
+at the current cursor position in the named window.
+Attributes are stripped from the characters. The four
functions with \fIn\fR as the last argument return a leading substring at most
\fIn\fR characters long (exclusive of the trailing NUL).
.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
-completion, unless otherwise noted in the preceding routine descriptions.
+All of the functions return \fBERR\fR upon failure,
+or the number of characters actually read into the string.
.SH NOTES
-Note that all routines except \fBwinnstr\fR may be macros. SVr4 does not
-document whether a length limit includes or excludes the trailing NUL, and
-does not document the meaning of the return values.
+Note that all routines except \fBwinnstr\fR may be macros.
.SH PORTABILITY
-These functions are described in the XSI Curses standard, Issue 4. The
-standard specifies that they always return \fBOK\fR on success. The XSI Curses
+The XSI Curses
error conditions \fBEILSEQ\fR and \fBEILOVERFLOW\fR associated with
-extebded-level conformance are not yet detected (this implementation does not
-yet support XPG4 multibyte characters).
+extended-level conformance are not yet detected (this implementation does not
+yet support XPG4 multi-byte characters).
+SVr4 does not
+document whether a length limit includes or excludes the trailing NUL.
+.PP
+The curses library extends the XSI description by allowing a negative
+value for \fIn\fR.
+In this case, the functions return the string ending at the right margin.
.SH SEE ALSO
\fBcurses\fR(3X).
.\"#