summaryrefslogtreecommitdiffstats
path: root/man3/wcwidth.3
diff options
context:
space:
mode:
Diffstat (limited to 'man3/wcwidth.3')
-rw-r--r--man3/wcwidth.340
1 files changed, 40 insertions, 0 deletions
diff --git a/man3/wcwidth.3 b/man3/wcwidth.3
new file mode 100644
index 000000000..5d31b95e8
--- /dev/null
+++ b/man3/wcwidth.3
@@ -0,0 +1,40 @@
+.\" Copyright (c) Bruno Haible <haible@clisp.cons.org>
+.\"
+.\" This is free documentation; you can redistribute it and/or
+.\" modify it under the terms of the GNU General Public License as
+.\" published by the Free Software Foundation; either version 2 of
+.\" the License, or (at your option) any later version.
+.\"
+.\" 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 WCWIDTH 3 1999-07-25 "GNU" "Linux Programmer's Manual"
+.SH NAME
+wcwidth \- determine columns needed for a wide character
+.SH SYNOPSIS
+.nf
+.B #include <wchar.h>
+.sp
+.BI "int wcwidth(wchar_t " c );
+.fi
+.SH DESCRIPTION
+The \fBwcwidth\fP function returns the number of columns needed to represent
+the wide character \fIc\fP. If \fIc\fP is a printable wide character, the value
+is at least 0. If \fIc\fP is L'\\0', the value is 0. Otherwise \-1 is returned.
+.SH "RETURN VALUE"
+The \fBwcwidth\fP function returns the number of column positions for \fIc\fP.
+.SH "CONFORMING TO"
+UNIX98, POSIX 1003.1-2001
+Note that glibc before 2.2.5 used the prototype
+.br
+.nf
+.BI "int wcwidth(wint_t " c );
+.fi
+.SH "SEE ALSO"
+.BR iswprint (3),
+.BR wcswidth (3)
+.SH NOTES
+The behaviour of \fBwcwidth\fP depends on the LC_CTYPE category of the
+current locale.