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