Sync lib/libc/string with FreeBSD:
[dragonfly.git] / lib / libc / string / wcswidth.3
1 .\" Copyright (c) 2002 Tim J. Robbins
2 .\" All rights reserved.
3 .\"
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
6 .\" are met:
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\"    notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\"    notice, this list of conditions and the following disclaimer in the
11 .\"    documentation and/or other materials provided with the distribution.
12 .\"
13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23 .\" SUCH DAMAGE.
24 .\"
25 .\" $FreeBSD: src/lib/libc/string/wcswidth.3,v 1.2 2002/12/09 14:04:05 ru Exp $
26 .\" $DragonFly: src/lib/libc/string/wcswidth.3,v 1.1 2008/05/31 04:51:55 swildner Exp $
27 .\"
28 .Dd May 30, 2008
29 .Dt WCSWIDTH 3
30 .Os
31 .Sh NAME
32 .Nm wcswidth
33 .Nd "number of column positions in wide-character string"
34 .Sh LIBRARY
35 .Lb libc
36 .Sh SYNOPSIS
37 .In wchar.h
38 .Ft int
39 .Fn wcswidth "const wchar_t *pwcs" "size_t n"
40 .Sh DESCRIPTION
41 The
42 .Fn wcswidth
43 function determines the number of column positions required for the first
44 .Fa n
45 characters of
46 .Fa pwcs ,
47 or until a null wide character (L'\e0') is encountered.
48 .Sh RETURN VALUES
49 The
50 .Fn wcswidth
51 function returns 0 if
52 .Fa pwcs
53 is an empty string (L""),
54 \-1 if a non-printing wide character is encountered,
55 otherwise it returns the number of column positions occupied.
56 .Sh SEE ALSO
57 .Xr iswprint 3 ,
58 .Xr wcwidth 3
59 .Sh STANDARDS
60 The
61 .Fn wcswidth
62 function conforms to
63 .St -p1003.1-2001 .