summaryrefslogtreecommitdiffstats
path: root/man3/wcswidth.3
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-15 19:40:15 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-15 19:40:15 +0000
commit399644e47874bff147afb19c89228901ac39340e (patch)
tree1c4c0b733f4c16b5783b41bebb19194a9ef62ad1 /man3/wcswidth.3
parentInitial commit. (diff)
downloadmanpages-399644e47874bff147afb19c89228901ac39340e.tar.xz
manpages-399644e47874bff147afb19c89228901ac39340e.zip
Adding upstream version 6.05.01.upstream/6.05.01
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'man3/wcswidth.3')
-rw-r--r--man3/wcswidth.374
1 files changed, 74 insertions, 0 deletions
diff --git a/man3/wcswidth.3 b/man3/wcswidth.3
new file mode 100644
index 0000000..a85254a
--- /dev/null
+++ b/man3/wcswidth.3
@@ -0,0 +1,74 @@
+'\" t
+.\" Copyright (c) Bruno Haible <haible@clisp.cons.org>
+.\"
+.\" SPDX-License-Identifier: GPL-2.0-or-later
+.\"
+.\" References consulted:
+.\" GNU glibc-2 source code and manual
+.\" Dinkumware C library reference http://www.dinkumware.com/
+.\" OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html
+.\"
+.TH wcswidth 3 2023-07-20 "Linux man-pages 6.05.01"
+.SH NAME
+wcswidth \- determine columns needed for a fixed-size wide-character string
+.SH LIBRARY
+Standard C library
+.RI ( libc ", " \-lc )
+.SH SYNOPSIS
+.nf
+.BR "#define _XOPEN_SOURCE" " /* See feature_test_macros(7) */"
+.B #include <wchar.h>
+.PP
+.BI "int wcswidth(const wchar_t *" s ", size_t " n );
+.fi
+.SH DESCRIPTION
+The
+.BR wcswidth ()
+function returns the
+number of columns needed to represent
+the wide-character string pointed to by
+.IR s ,
+but at most
+.I n
+wide
+characters.
+If a nonprintable wide character occurs among these characters,
+\-1 is returned.
+.SH RETURN VALUE
+The
+.BR wcswidth ()
+function
+returns the number of column positions for the
+wide-character string
+.IR s ,
+truncated to at most length
+.IR n .
+.SH ATTRIBUTES
+For an explanation of the terms used in this section, see
+.BR attributes (7).
+.TS
+allbox;
+lbx lb lb
+l l l.
+Interface Attribute Value
+T{
+.na
+.nh
+.BR wcswidth ()
+T} Thread safety MT-Safe locale
+.TE
+.sp 1
+.SH STANDARDS
+POSIX.1-2008.
+.SH HISTORY
+POSIX.1-2001.
+.SH NOTES
+The behavior of
+.BR wcswidth ()
+depends on the
+.B LC_CTYPE
+category of the
+current locale.
+.SH SEE ALSO
+.BR iswprint (3),
+.BR wcwidth (3)