ncurses 6.4 - patch 20231028

[ncurses.git] / man / curs_inwstr.3x

diff --git a/man/curs_inwstr.3x b/man/curs_inwstr.3x
index c33b2f59660f4f8b13ff44b443ebfb60f90c0323..27843122c90554fbefdbdae813572bccd1de500d 100644 (file)
--- a/man/curs_inwstr.3x
+++ b/man/curs_inwstr.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,43 +27,43 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
-.\" $Id: curs_inwstr.3x,v 1.16 2021/12/25 21:49:32 tom Exp $
-.TH curs_inwstr 3X ""
-.ie \n(.g .ds `` \(lq
-.el       .ds `` ``
-.ie \n(.g .ds '' \(rq
-.el       .ds '' ''
+.\" $Id: curs_inwstr.3x,v 1.28 2023/10/07 21:19:07 tom Exp $
+.TH curs_inwstr 3X 2023-10-07 "ncurses 6.4" "Library calls"
+.ie \n(.g \{\
+.ds `` \(lq
+.ds '' \(rq
+.\}
+.el \{\
+.ie t .ds `` ``
+.el   .ds `` ""
+.ie t .ds '' ''
+.el   .ds '' ""
+.\}
 .SH NAME
-\fBinwstr\fP,
-\fBinnwstr\fP,
-\fBwinwstr\fP,
-\fBwinnwstr\fP,
-\fBmvinwstr\fP,
-\fBmvinnwstr\fP,
-\fBmvwinwstr\fP,
-\fBmvwinnwstr\fP \- get a string of \fBwchar_t\fP characters from a curses window
+\fB\%inwstr\fP,
+\fB\%innwstr\fP,
+\fB\%winwstr\fP,
+\fB\%winnwstr\fP,
+\fB\%mvinwstr\fP,
+\fB\%mvinnwstr\fP,
+\fB\%mvwinwstr\fP,
+\fB\%mvwinnwstr\fP \-
+get a wide-character string from a \fIcurses\fR window
 .SH SYNOPSIS
 .nf
-\fB#include <curses.h> \fP
-.sp
-\fBint inwstr(\fP\fBwchar_t *\fP\fIwstr\fP\fB);\fP
-.br
-\fBint innwstr(\fP\fBwchar_t *\fP\fIwstr\fP\fB, int \fP\fIn\fP\fB);\fP
-.br
-\fBint winwstr(\fP\fBWINDOW *\fP\fIwin\fP\fB, wchar_t *\fP\fIwstr\fP\fB);\fP
-.br
-\fBint winnwstr(\fP\fBWINDOW *\fP\fIwin\fP\fB, wchar_t *\fP\fIwstr\fP\fB, int \fP\fIn\fP\fB);\fP
-.sp
-\fBint mvinwstr(\fP\fBint \fP\fIy\fP\fB, int \fP\fIx\fP\fB, wchar_t *\fP\fIwstr\fP\fB);\fP
-.br
-\fBint mvinnwstr(\fP\fBint \fP\fIy\fP\fB, int \fP\fIx\fP\fB, wchar_t *\fP\fIwstr\fP\fB, int \fP\fIn\fP\fB);\fP
-.br
-\fBint mvwinwstr(\fP\fBWINDOW *\fP\fIwin\fP\fB, int \fP\fIy\fP\fB, int \fP\fIx\fP\fB, wchar_t *\fP\fIwstr\fP\fB);\fP
-.br
-\fBint mvwinnwstr(\fP\fBWINDOW *\fP\fIwin\fP\fB, int \fP\fIy\fP\fB, int \fP\fIx\fP\fB, wchar_t *\fP\fIwstr\fP\fB, int \fP\fIn\fP\fB);\fP
+\fB#include <curses.h>
+.PP
+\fBint inwstr(wchar_t *\fIwstr\fP);
+\fBint innwstr(wchar_t *\fIwstr\fP, int \fIn\fP);
+\fBint winwstr(WINDOW *\fIwin\fP, wchar_t *\fIwstr\fP);
+\fBint winnwstr(WINDOW *\fIwin\fP, wchar_t *\fIwstr\fP, int \fIn\fP);
+.PP
+\fBint mvinwstr(int \fIy\fP, int \fIx\fP, wchar_t *\fIwstr\fP);
+\fBint mvinnwstr(int \fIy\fP, int \fIx\fP, wchar_t *\fIwstr\fP, int \fIn\fP);
+\fBint mvwinwstr(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP, wchar_t *\fIwstr\fP);
+\fBint mvwinnwstr(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP, wchar_t *\fIwstr\fP, int \fIn\fP);
 .fi
 .SH DESCRIPTION
-.PP
 These routines return a string of \fBwchar_t\fP wide characters in \fIwstr\fP,
 extracted starting at the current cursor position in the named window.
 .PP
@@ -76,7 +76,6 @@ been stored at the location referenced by \fIwstr\fP.
 If the size \fIn\fP is not large enough to store a complete complex character,
 an error is generated.
 .SH NOTES
-.PP
 All routines except
 \fBwinnwstr\fP
 may be macros.
@@ -101,6 +100,6 @@ 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 SEE ALSO
-\fBcurses\fP(3X),
-\fBcurs_instr\fP(3X),
-\fBcurs_in_wchstr\fP(3X)
+\fB\%curses\fP(3X),
+\fB\%curs_instr\fP(3X),
+\fB\%curs_in_wchstr\fP(3X)