ncurses 5.9 - patch 20120303
[ncurses.git] / man / curs_getstr.3x
index a5f186e8ccfa80673d1bbdb393a2a58bf03e3c18..e548cf145c2580fb6000d7843c91c6d4fb6fadcc 100644 (file)
@@ -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.14 2005/05/15 16:17:55 tom Exp $
+.\" $Id: curs_getstr.3x,v 1.19 2010/12/04 18:36:44 tom Exp $
 .TH curs_getstr 3X ""
 .na
 .hy 0
 \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
 \fB#include <curses.h>\fR
-
+.sp
 \fBint getstr(char *str);\fR
 .br
 \fBint getnstr(char *str, int n);\fR
@@ -65,17 +65,17 @@ The function \fBgetstr\fR is equivalent to a series of calls to \fBgetch\fR,
 until a newline or carriage return is received (the terminating character is
 not included in the returned string).  The resulting value is placed in the
 area pointed to by the character pointer \fIstr\fR.
-
+.PP
 \fBwgetnstr\fR reads at most \fIn\fR characters, thus preventing a possible
 overflow of the input buffer.  Any attempt to enter more characters (other
 than the terminating newline or carriage return) causes a beep.  Function
 keys also cause a beep and are ignored.  The \fBgetnstr\fR function reads
 from the \fIstdscr\fR default window.
-
+.PP
 The user's erase and kill characters are interpreted.  If keypad
 mode is on for the window, \fBKEY_LEFT\fR and \fBKEY_BACKSPACE\fR
 are both considered equivalent to the user's kill character.
-
+.PP
 Characters input are echoed only if \fBecho\fR is currently on.  In that case,
 backspace is echoed as deletion of the previous character (typically a left
 motion).
@@ -90,6 +90,14 @@ In this implementation,
 these functions return an error
 if the window pointer is null, or
 if its timeout expires without having any data.
+.PP
+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
@@ -98,21 +106,17 @@ They read single-byte characters only.
 The standard does not define any error conditions.
 This implementation returns ERR if the window pointer is null,
 or if the lower-level \fBwgetch\fR call returns an ERR.
-
+.PP
 SVr3 and early SVr4 curses implementations did not reject function keys;
 the SVr4.0 documentation claimed that "special keys" (such as function
 keys, "home" key, "clear" key, \fIetc\fR.) are "interpreted", without
 giving details.  It lied.  In fact, the `character' value appended to the
 string by those implementations was predictable but not useful
 (being, in fact, the low-order eight bits of the key's KEY_ value).
-
+.PP
 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).