ncurses 6.4 - patch 20240414

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

diff --git a/man/curs_in_wch.3x b/man/curs_in_wch.3x
index a17135ec2d0440af183a47964dd566d0985c29b0..b3f9c08b31a040bcb24411b1dfa6444d818c698c 100644 (file)
--- a/man/curs_in_wch.3x
+++ b/man/curs_in_wch.3x
@@ -1,5 +1,5 @@
 .\"***************************************************************************
 .\"***************************************************************************

-.\" Copyright 2018-2019,2020 Thomas E. Dickey                                *
+.\" Copyright 2018-2023,2024 Thomas E. Dickey                                *

 .\" Copyright 2002-2010,2017 Free Software Foundation, Inc.                  *
 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
 .\" Copyright 2002-2010,2017 Free Software Foundation, Inc.                  *
 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *


@@ -27,35 +27,42 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"

-.\" $Id: curs_in_wch.3x,v 1.9 2020/02/02 23:34:34 tom Exp $
-.TH curs_in_wch 3X ""
-.ie \n(.g .ds `` \(lq
-.el       .ds `` ``
-.ie \n(.g .ds '' \(rq
-.el       .ds '' ''
+.\" $Id: curs_in_wch.3x,v 1.28 2024/04/13 22:14:06 tom Exp $
+.TH curs_in_wch 3X 2024-04-13 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls"
+.ie \n(.g \{\
+.ds `` \(lq
+.ds '' \(rq
+.\}
+.el \{\
+.ie t .ds `` ``
+.el   .ds `` ""
+.ie t .ds '' ''
+.el   .ds '' ""
+.\}

 .SH NAME
 .SH NAME

-\fBin_wch\fR,
-\fBmvin_wch\fR,
-\fBmvwin_wch\fR,
-\fBwin_wch\fR \- extract a complex character and rendition from a window
+\fB\%in_wch\fP,
+\fB\%mvin_wch\fP,
+\fB\%mvwin_wch\fP,
+\fB\%win_wch\fP \-
+get a \fIcurses\fR complex character from a window

 .SH SYNOPSIS
 .SH SYNOPSIS

-\fB#include <curses.h>\fR
-.sp
-\fBint in_wch(cchar_t *\fR\fIwcval\fR\fB);\fR
-.br
-\fBint mvin_wch(int \fR\fIy\fR\fB, int \fR\fIx\fR\fB, cchar_t *\fR\fIwcval\fR\fB);\fR
-.br
-\fBint mvwin_wch(WINDOW *\fR\fIwin\fR\fB, int \fR\fIy\fR\fB, int \fR\fIx\fR\fB, cchar_t *\fR\fIwcval\fR\fB);\fR
-.br
-\fBint win_wch(WINDOW *\fR\fIwin\fR\fB, cchar_t *\fR\fIwcval\fR\fB);\fR
+.nf
+\fB#include <curses.h>
+.PP
+\fBint in_wch(cchar_t *\fIwcval\fP);
+\fBint win_wch(WINDOW *\fIwin\fP, cchar_t *\fIwcval\fP);
+.PP
+\fBint mvin_wch(int \fIy\fP, int \fIx\fP, cchar_t *\fIwcval\fP);
+\fBint mvwin_wch(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP, cchar_t *\fIwcval\fP);
+.fi

 .SH DESCRIPTION
 These functions extract the complex character and rendition from
 .SH DESCRIPTION
 These functions extract the complex character and rendition from

-the current position in the named window into the \fBcchar_t\fR object
+the current position in the named window into the \fBcchar_t\fP object

 referenced by wcval.
 .SH RETURN VALUE
 No errors are defined in the XSI Curses standard.
 This implementation checks for null pointers, returns \fBERR\fP in that case.
 referenced by wcval.
 .SH RETURN VALUE
 No errors are defined in the XSI Curses standard.
 This implementation checks for null pointers, returns \fBERR\fP in that case.

-Also, the \fImv\fR routines check for error moving the cursor,
+Also, the \fImv\fP routines check for error moving the cursor,

 returning \fBERR\fP in that case.
 Otherwise they return \fBOK\fP.
 .PP
 returning \fBERR\fP in that case.
 Otherwise they return \fBOK\fP.
 .PP


@@ -67,5 +74,9 @@ Note that all of these routines may be macros.
 .SH PORTABILITY
 These functions are described in the XSI Curses standard, Issue 4.
 .SH SEE ALSO
 .SH PORTABILITY
 These functions are described in the XSI Curses standard, Issue 4.
 .SH SEE ALSO

-\fBcurses\fR(3X),
-\fBcurs_inch\fR(3X).
+\fB\%curs_inch\fP(3X) describes comparable functions of the
+.I \%ncurses
+library in its non-wide-character configuration.
+.PP
+\fB\%curses\fP(3X),
+\fB\%curs_inwstr\fP(3X)