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