summaryrefslogtreecommitdiff
path: root/lib/libc/locale/wctob.3
diff options
context:
space:
mode:
authorMarc Espie <espie@cvs.openbsd.org>2005-05-11 18:44:14 +0000
committerMarc Espie <espie@cvs.openbsd.org>2005-05-11 18:44:14 +0000
commit7847cf8cac3ace56d062c6d1962f2df02d25d329 (patch)
treec860a1a863e5b2697b9daf1ea627279ec05d3ced /lib/libc/locale/wctob.3
parent8d8d7a1eeeb3509c69bb27b3d97c04a887175599 (diff)
major abi changes:
* introduce the mbstate_t typedef. impacts gnu libiconv, which has already been taken care of. * Prepare for mb stuff to really exist, replace macro MB_CUR_MAX with an external variable __mb_cur_max (impacts libX11 and various ports). * use mbstate in all the mb <-> wchar functions with state. * add a stub iswctype function allowing some ports to compile. bash and gdiff are missing wcscoll, and need to be told there's no i18n until this is fixed. Discussed and matthieu, otto, millert, kettenis, deraadt. Major libc bump
Diffstat (limited to 'lib/libc/locale/wctob.3')
-rw-r--r--lib/libc/locale/wctob.388
1 files changed, 88 insertions, 0 deletions
diff --git a/lib/libc/locale/wctob.3 b/lib/libc/locale/wctob.3
new file mode 100644
index 00000000000..191568b5d71
--- /dev/null
+++ b/lib/libc/locale/wctob.3
@@ -0,0 +1,88 @@
+.\" $OpenBSD: wctob.3,v 1.1 2005/05/11 18:44:12 espie Exp $
+.\" $NetBSD: wctob.3,v 1.3 2003/04/16 13:34:41 wiz Exp $
+.\"
+.\" Copyright (c)2003 Citrus Project,
+.\" All rights reserved.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\" notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\" notice, this list of conditions and the following disclaimer in the
+.\" documentation and/or other materials provided with the distribution.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.
+.\"
+.Dd March 3, 2003
+.Dt WCTOB 3
+.Os
+.\" ----------------------------------------------------------------------
+.Sh NAME
+.Nm wctob
+.Nd convert a wide character to a single byte character
+.\" ----------------------------------------------------------------------
+.Sh LIBRARY
+.Lb libc
+.\" ----------------------------------------------------------------------
+.Sh SYNOPSIS
+.In wchar.h
+.Ft int
+.Fn wctob "wint_t wc"
+.\" ----------------------------------------------------------------------
+.Sh DESCRIPTION
+The
+.Fn wctob
+function converts a wide character
+.Fa wc
+to a corresponding single byte character in the initial shift state of
+the current locale.
+.Pp
+The behaviour of the
+.Fn wctob
+is affected by the
+.Dv LC_CTYPE
+category of the current locale.
+.\" ----------------------------------------------------------------------
+.Sh RETURN VALUES
+The
+.Fn wctob
+function returns:
+.Bl -tag -width 012345678901
+.It Dv EOF
+if
+.Fa wc
+is
+.Dv WEOF
+or if
+.Fa wc
+does not correspond to a valid single byte character representation.
+.It (otherwise)
+a single byte character corresponding to
+.Fa wc .
+.El
+.\" ----------------------------------------------------------------------
+.Sh ERRORS
+No errors are defined.
+.\" ----------------------------------------------------------------------
+.Sh SEE ALSO
+.Xr btowc 3 ,
+.Xr setlocale 3 ,
+.Xr wcrtomb 3
+.\" ----------------------------------------------------------------------
+.Sh STANDARDS
+The
+.Fn wctob
+function conforms to
+.St -isoC-amd1 .