X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fcurs_getstr.3x;h=d82034f9e4f86ef70a053dc58d4e7afb808c56a7;hp=f131765043a10ffcc9c4530c687d62d811340f82;hb=61d8ae54ff6acd69e9dab2afb21591d44c46ee1f;hpb=027ae42953e3186daed8f3882da73de48291b606 diff --git a/man/curs_getstr.3x b/man/curs_getstr.3x index f1317650..d82034f9 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-2010,2017 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,12 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_getstr.3x,v 1.15 2006/01/12 00:30:58 tom Exp $ +.\" $Id: curs_getstr.3x,v 1.23 2017/11/21 00:45:48 tom Exp $ .TH curs_getstr 3X "" +.ie \n(.g .ds `` \(lq +.el .ds `` `` +.ie \n(.g .ds '' \(rq +.el .ds '' '' .na .hy 0 .SH NAME @@ -38,7 +42,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 @@ -81,7 +85,7 @@ backspace is echoed as deletion of the previous character (typically a left motion). .SH RETURN VALUE 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 +specifies only \*(``an integer value other than \fBERR\fR\*('') upon successful completion. .PP X/Open defines no error conditions. @@ -92,31 +96,36 @@ 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 +If a \fBSIGWINCH\fP 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 These functions are described in the XSI Curses standard, Issue 4. 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. +This implementation returns \fBERR\fP if the window pointer is null, +or if the lower-level \fBwgetch\fR(3X) call returns an \fBERR\fP. .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 +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).