X-Git-Url: http://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=man%2Fcurs_get_wstr.3x;h=2d632522a84d564e3d11f959868a30887d3ba7de;hb=aef6681d538d4bd02cfdf9f52aeefec62488efd6;hp=07ceb3544bef6b850ddf7c0018ce4747a42ba248;hpb=74433bcf4f6fe40862a28f3c00edaedcd5054b01;p=ncurses.git

diff --git a/man/curs_get_wstr.3x b/man/curs_get_wstr.3x
index 07ceb354..2d632522 100644
--- a/man/curs_get_wstr.3x
+++ b/man/curs_get_wstr.3x
@@ -1,5 +1,5 @@
 .\"***************************************************************************
-.\" Copyright 2018-2020,2021 Thomas E. Dickey                                *
+.\" Copyright 2018-2022,2023 Thomas E. Dickey                                *
 .\" Copyright 2002-2012,2017 Free Software Foundation, Inc.                  *
 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
@@ -27,8 +27,8 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
-.\" $Id: curs_get_wstr.3x,v 1.25 2021/12/25 21:49:32 tom Exp $
-.TH curs_get_wstr 3X ""
+.\" $Id: curs_get_wstr.3x,v 1.30 2023/08/05 12:14:30 tom Exp $
+.TH curs_get_wstr 3X 2023-08-05 "ncurses 6.4" "Library calls"
 .ie \n(.g .ds `` \(lq
 .el       .ds `` ``
 .ie \n(.g .ds '' \(rq
@@ -54,70 +54,65 @@
 .nf
 \fB#include <curses.h>\fP
 .sp
-\fBint get_wstr(wint_t *\fP\fIwstr\fP\fB);\fP
+\fBint get_wstr(wint_t *\fIwstr\fB);\fR
 .br
-\fBint getn_wstr(wint_t *\fP\fIwstr\fP\fB, int \fP\fIn\fP\fB);\fP
+\fBint getn_wstr(wint_t *\fIwstr\fB, int \fIn\fB);\fR
 .br
-\fBint wget_wstr(WINDOW *\fP\fIwin\fP\fB, wint_t *\fP\fIwstr\fP\fB);\fP
+\fBint wget_wstr(WINDOW *\fIwin\fB, wint_t *\fIwstr\fB);\fR
 .br
-\fBint wgetn_wstr(WINDOW *\fP\fIwin\fP\fB, wint_t *\fP\fIwstr\fP\fB, int \fP\fIn\fP\fB);\fP
+\fBint wgetn_wstr(WINDOW *\fIwin\fB, wint_t *\fIwstr\fB, int \fIn\fB);\fR
 .sp
-\fBint mvget_wstr(int \fP\fIy\fP\fB, int \fP\fIx\fP\fB, wint_t *\fP\fIwstr\fP\fB);\fP
+\fBint mvget_wstr(int \fIy\fB, int \fIx\fB, wint_t *\fIwstr\fB);\fR
 .br
-\fBint mvgetn_wstr(int \fP\fIy\fP\fB, int \fP\fIx\fP\fB, wint_t *\fP\fIwstr\fP\fB, int \fP\fIn\fP\fB);\fP
+\fBint mvgetn_wstr(int \fIy\fB, int \fIx\fB, wint_t *\fIwstr\fB, int \fIn\fB);\fR
 .br
-\fBint mvwget_wstr(WINDOW *\fP\fIwin\fP\fB, int \fP\fIy\fP\fB, int \fP\fIx\fP\fB, wint_t *\fP\fIwstr\fP\fB);\fP
+\fBint mvwget_wstr(WINDOW *\fIwin\fB, int \fIy\fB, int \fIx\fB, wint_t *\fIwstr\fB);\fR
 .br
-\fBint mvwgetn_wstr(WINDOW *\fP\fIwin\fP\fB, int \fP\fIy\fP\fB, int \fP\fIx\fP\fB, wint_t *\fP\fIwstr\fP\fB, int \fP\fIn\fP\fB);\fP
+\fBint mvwgetn_wstr(WINDOW *\fIwin\fB, int \fIy\fB, int \fIx\fB, wint_t *\fIwstr\fB, int \fIn\fB);\fR
 .fi
 .SH DESCRIPTION
-The effect of
-\fBget_wstr\fP
-is as though a series of calls
-to
-\fBget_wch\fP(3X)
-were made, until a newline, other end-of-line,
-or end-of-file condition is processed.
+The function
+\fBwgetn_wstr\fP
+is equivalent to a series of calls to
+\fBwget_wch\fP(3X)
+until a newline or carriage return terminates the series:
+.bP
+The terminating character is not included in the returned string.
+.bP
 An end-of-file condition is represented by \fBWEOF\fP,
 as defined in \fB<wchar.h>\fP.
-The newline and end-of-line conditions are represented
-by the \fB\\n\fP \fBwchar_t\fP value.
-In all instances, the end of the string is terminated by a null \fBwchar_t\fP.
-The routine places resulting values in the area pointed to by \fIwstr\fP.
+.bP
+In all instances, the end of the string is terminated
+by a null \fBwchar_t\fP.
+.bP
+The function stores the result in the area pointed to
+by the \fIwstr\fP parameter.
+.bP
+The function reads at most \fIn\fP characters,
+thus preventing a possible overflow of the input buffer.
+.IP
+Any attempt to enter more characters
+(other than the terminating newline or carriage return)
+causes a beep.
+.IP
+Function keys also cause a beep and are ignored.
 .PP
-The user's erase and kill characters are interpreted.
-If keypad
-mode is on for the window, \fBKEY_LEFT\fP and \fBKEY_BACKSPACE\fP
-are both considered equivalent to the user's kill character.
+The user's \fIerase\fP and \fIkill\fP characters are interpreted:
+.bP
+The \fIerase\fP character (e.g., \fB^H\fP) erases the character
+at the end of the buffer, moving the cursor to the left.
+.IP
+If \fIkeypad\fP mode is on for the window,
+\fBKEY_LEFT\fP and \fBKEY_BACKSPACE\fP
+are both considered equivalent to the user's \fIerase\fP character.
+.bP
+The \fIkill\fP character (e.g., \fB^U\fP) erases the entire buffer,
+leaving the cursor at the beginning of the buffer.
 .PP
 Characters input are echoed only if \fBecho\fP is currently on.
 In that case,
-backspace is echoed as deletion of the previous character (typically a left
-motion).
-.PP
-The effect of
-\fBwget_wstr\fP
-is as though a series of
-calls to
-\fBwget_wch\fP
-were made.
-.PP
-The effect of
-\fBmvget_wstr\fP
-is as though a call to
-\fBmove\fP
-and then a series of calls to
-\fBget_wch\fP
-were
-made.
-.PP
-The effect of
-\fBmvwget_wstr\fP
-is as though a call to
-\fBwmove\fP
-and then a series of calls to
-\fBwget_wch\fP
-were made.
+backspace is echoed as deletion of the previous character
+(typically a left motion).
 .PP
 The
 \fBgetn_wstr\fP,
@@ -138,6 +133,10 @@ versions read at most
 characters, letting the application prevent overflow of the
 input buffer.
 .SH NOTES
+Any of these functions other than
+\fBwgetn_wstr\fP
+may be macros.
+.PP
 Using
 \fBget_wstr\fP,
 \fBmvget_wstr\fP,
@@ -152,22 +151,28 @@ The use of
 \fBgetn_wstr\fP,
 \fBmvgetn_wstr\fP,
 \fBmvwgetn_wstr\fP, or
-\fBwgetn_wstr\fP, respectively, is recommended.
+\fBwgetn_wstr\fP,
+respectively, is recommended.
 .PP
 These functions cannot return \fBKEY_\fP values because there
 is no way to distinguish a \fBKEY_\fP value from a valid \fBwchar_t\fP value.
-.PP
-All of these routines except \fBwgetn_wstr\fP may be macros.
+may be macros.
 .SH RETURN VALUE
-All of these functions return \fBOK\fP upon successful completion.
-Otherwise, they return \fBERR\fP.
+All of these functions return the integer \fBOK\fP upon successful completion.
+If unsuccessful, they return \fBERR\fP.
 .PP
-Functions using a window parameter return an error if it is null.
-.RS
-.TP 5
-\fBwgetn_wstr\fP
-returns an error if the associated call to \fBwget_wch\fP failed.
-.RE
+X/Open defines no error conditions.
+.PP
+In this implementation,
+these functions return an error
+.bP
+if the window pointer is null,
+.bP
+if its timeout expires without having any data, or
+.bP
+if the associated call to
+\fBwget_wch\fP
+failed.
 .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,
@@ -175,6 +180,7 @@ or if the window pointer is null.
 .SH PORTABILITY
 These functions are described in The Single Unix Specification, Version 2.
 No error conditions are defined.
+.PP
 This implementation returns \fBERR\fP if the window pointer is null,
 or if the lower-level \fBwget_wch\fP call returns an \fBERR\fP.
 In the latter case,
@@ -195,7 +201,7 @@ while \fBwchar_t\fP is a unsigned type.
 All of the vendors implement this using \fBwint_t\fP, following the standard.
 .PP
 X/Open Curses, Issue 7 (2009) is unclear regarding whether
-the terminating \fInull \fP\fBwchar_t\fP
+the terminating \fInull \fBwchar_t\fR
 value is counted in the length parameter \fIn\fP.
 X/Open Curses, Issue 7 revised the corresponding description
 of \fBwgetnstr\fP to address this issue.