ncurses 6.4 - patch 20231111

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

diff --git a/man/curs_getcchar.3x b/man/curs_getcchar.3x
index b674a7793bc11ecea7ee29b3d7da1c00239704b4..3ec21e4b8132f85cf611b2edcb184e3c19500f70 100644 (file)
--- a/man/curs_getcchar.3x
+++ b/man/curs_getcchar.3x
@@ -1,5 +1,5 @@
 .\"***************************************************************************
 .\"***************************************************************************

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

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


@@ -27,44 +27,36 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"

-.\" $Id: curs_getcchar.3x,v 1.28 2021/12/25 20:35:03 tom Exp $
-.TH curs_getcchar 3X 2021-12-25 "ncurses 6.4" "Library calls"
+.\" $Id: curs_getcchar.3x,v 1.40 2023/11/11 11:39:43 tom Exp $
+.TH curs_getcchar 3X 2023-11-11 "ncurses 6.4" "Library calls"

 .de bP
 .ie n  .IP \(bu 4
 .el    .IP \(bu 2
 ..
 .SH NAME
 .de bP
 .ie n  .IP \(bu 4
 .el    .IP \(bu 2
 ..
 .SH NAME

-\fBgetcchar\fP,
-\fBsetcchar\fP \- Get a wide character string and rendition from a \fBcchar_t\fP or set a \fBcchar_t\fP from a wide-character string
+\fB\%getcchar\fP,
+\fB\%setcchar\fP \-
+convert between a wide-character string and a \fIcurses\fR complex character string

 .SH SYNOPSIS
 .SH SYNOPSIS

-\fB#include <curses.h>\fP
-.sp
-\fBint getcchar(\fP
-.br
+.nf
+\fB#include <curses.h>
+.PP
+\fBint getcchar(

 .B "        const cchar_t *\fIwcval\fP,"
 .B "        const cchar_t *\fIwcval\fP,"

-.br

 .B "        wchar_t *\fIwch\fP,"
 .B "        wchar_t *\fIwch\fP,"

-.br

 .B "        attr_t *\fIattrs\fP,"
 .B "        attr_t *\fIattrs\fP,"

-.br

 .B "        short *\fIcolor_pair\fP,"
 .B "        short *\fIcolor_pair\fP,"

-.br

 .B "        void *\fIopts\fP );"
 .B "        void *\fIopts\fP );"

-.sp
+.PP

 .B "int setcchar("
 .B "int setcchar("

-.br

 .B "        cchar_t *\fIwcval\fP,"
 .B "        cchar_t *\fIwcval\fP,"

-.br

 .B "        const wchar_t *\fIwch\fP,"
 .B "        const wchar_t *\fIwch\fP,"

-.br

 .B "        const attr_t \fIattrs\fP,"
 .B "        const attr_t \fIattrs\fP,"

-.br

 .B "        short \fIcolor_pair\fP,"
 .B "        short \fIcolor_pair\fP,"

-.br

 .B "        const void *\fIopts\fP );"
 .B "        const void *\fIopts\fP );"

+.fi

 .SH DESCRIPTION
 .SS getcchar
 .SH DESCRIPTION
 .SS getcchar

-.PP

 The \fBgetcchar\fP function gets a wide-character string
 and rendition from a \fBcchar_t\fP argument.
 When \fIwch\fP is not a null pointer,
 The \fBgetcchar\fP function gets a wide-character string
 and rendition from a \fBcchar_t\fP argument.
 When \fIwch\fP is not a null pointer,


@@ -92,7 +84,6 @@ Does not change the data referenced by
 or
 \fIcolor_pair\fP
 .SS setcchar
 or
 \fIcolor_pair\fP
 .SS setcchar

-.PP

 The \fBsetcchar\fP function initializes the location pointed to by \fIwcval\fP
 by using:
 .bP
 The \fBsetcchar\fP function initializes the location pointed to by \fIwcval\fP
 by using:
 .bP


@@ -103,7 +94,7 @@ The color pair in
 \fIcolor_pair\fP
 .bP
 The wide-character string pointed to by \fIwch\fP.
 \fIcolor_pair\fP
 .bP
 The wide-character string pointed to by \fIwch\fP.

-The string must be L'\\0' terminated,
+The string must be L'\e0' terminated,

 contain at most one spacing character,
 which must be the first.
 .IP
 contain at most one spacing character,
 which must be the first.
 .IP


@@ -113,7 +104,6 @@ Additional nonspacing characters are ignored.
 The string may contain a single control character instead.
 In that case, no nonspacing characters are allowed.
 .SH EXTENSIONS
 The string may contain a single control character instead.
 In that case, no nonspacing characters are allowed.
 .SH EXTENSIONS

-.PP

 X/Open Curses documents the \fIopts\fP argument as reserved for future use,
 saying that it must be null.
 This implementation
 X/Open Curses documents the \fIopts\fP argument as reserved for future use,
 saying that it must be null.
 This implementation


@@ -129,12 +119,10 @@ if \fIopts\fP is set it is treated as a pointer to \fBint\fP,
 and  used  to  retrieve  the color pair as an \fBint\fP value,
 in addition retrieving it via the standard pointer to \fBshort\fP parameter.
 .SH NOTES
 and  used  to  retrieve  the color pair as an \fBint\fP value,
 in addition retrieving it via the standard pointer to \fBshort\fP parameter.
 .SH NOTES

-.PP

 The \fIwcval\fP argument may be a value generated by a call to
 \fBsetcchar\fP or by a function that has a \fBcchar_t\fP output argument.
 If \fIwcval\fP is constructed by any other means, the effect is unspecified.
 .SH RETURN VALUE
 The \fIwcval\fP argument may be a value generated by a call to
 \fBsetcchar\fP or by a function that has a \fBcchar_t\fP output argument.
 If \fIwcval\fP is constructed by any other means, the effect is unspecified.
 .SH RETURN VALUE

-.PP

 When \fIwch\fP is a null pointer,
 \fBgetcchar\fP returns the number of wide characters referenced by
 \fIwcval\fP,
 When \fIwch\fP is a null pointer,
 \fBgetcchar\fP returns the number of wide characters referenced by
 \fIwcval\fP,


@@ -194,9 +182,7 @@ including using them for ligatures between characters
 Unicode does not limit the (analogous) number of combining characters,
 so some applications may be affected.
 .SH SEE ALSO
 Unicode does not limit the (analogous) number of combining characters,
 so some applications may be affected.
 .SH SEE ALSO

-.PP
-Functions:
-\fBcurs_attr\fP(3X),
-\fBcurs_color\fP(3X),
-\fBcurses\fP(3X),
-\fBwcwidth\fP(3).
+\fB\%curses\fP(3X),
+\fB\%curs_attr\fP(3X),
+\fB\%curs_color\fP(3X),
+\fB\%wcwidth\fP(3)