X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fcurs_getstr.3x;h=74c690d2f97346612d7a036c9d0ccbfc1cd34258;hp=d82034f9e4f86ef70a053dc58d4e7afb808c56a7;hb=17c5992a16be94247b83f2bbb9accdd9b7e7bb72;hpb=6941ed1e8bfdfc7634a57655dc71e7a7ed02a6e8 diff --git a/man/curs_getstr.3x b/man/curs_getstr.3x index d82034f9..74c690d2 100644 --- a/man/curs_getstr.3x +++ b/man/curs_getstr.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2010,2017 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2017,2018 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.23 2017/11/21 00:45:48 tom Exp $ +.\" $Id: curs_getstr.3x,v 1.24 2018/07/28 21:34:56 tom Exp $ .TH curs_getstr 3X "" .ie \n(.g .ds `` \(lq .el .ds `` `` @@ -67,20 +67,26 @@ .SH DESCRIPTION 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 +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 +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 +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, +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). .SH RETURN VALUE