add manual pages for iswctype(), towctrans(), wctype() and wctrans().

This commit is contained in:
tshiozak 2003-03-04 12:11:49 +00:00
parent 2c9762a5ec
commit 188f0525a0
5 changed files with 364 additions and 4 deletions

View File

@ -1,5 +1,5 @@
# from: @(#)Makefile.inc 5.1 (Berkeley) 2/18/91
# $NetBSD: Makefile.inc,v 1.42 2003/03/03 08:24:58 tshiozak Exp $
# $NetBSD: Makefile.inc,v 1.43 2003/03/04 12:11:49 tshiozak Exp $
# locale sources
.PATH: ${ARCHDIR}/locale ${.CURDIR}/locale
@ -29,9 +29,9 @@ CPPFLAGS+=-DWITH_RUNE -I${.CURDIR}
SRCS+= ___runetype_mb.c _wctrans.c iswctype.c multibyte_c90.c \
multibyte_amd1.c rune.c runeglue.c runetable.c setrunelocale.c
.endif
MAN+= btowc.3 iswalnum.3 towlower.3 mblen.3 mbrlen.3 mbrtowc.3 mbsinit.3 \
mbsrtowcs.3 mbstowcs.3 mbtowc.3 wcrtomb.3 wcsrtombs.3 wcstombs.3 \
wctob.3 wctomb.3
MAN+= btowc.3 iswalnum.3 iswctype.3 towlower.3 towctrans.3 mblen.3 mbrlen.3 \
mbrtowc.3 mbsinit.3 mbsrtowcs.3 mbstowcs.3 mbtowc.3 wcrtomb.3 \
wcsrtombs.3 wcstombs.3 wctob.3 wctomb.3 wctrans.3 wctype.3
MLINKS+=iswalnum.3 iswalpha.3 iswalnum.3 iswblank.3 \

View File

@ -0,0 +1,96 @@
.\" $NetBSD: iswctype.3,v 1.1 2003/03/04 12:11:50 tshiozak 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 4, 2003
.Dt ISWCTYPE 3
.Os
.\" ----------------------------------------------------------------------
.Sh NAME
.Nm iswctype
.Nd test a character for character class identifier
.\" ----------------------------------------------------------------------
.Sh LIBRARY
.Lb libc
.\" ----------------------------------------------------------------------
.Sh SYNOPSIS
.Fd #include \*[Lt]wctype.h\*[Gt]
.Ft int
.Fn iswctype "wint_t wc" "wctype_t charclass"
.\" ----------------------------------------------------------------------
.Sh DESCRIPTION
The
.Fn iswctype
function returns a boolean value that indicates whether a wide character
.Fa wc
consists in
.Fa charclass .
.Pp
The behaviour of the
.Fn iswctype
is undefined
if the
.Fn iswctype
function is called with an invalid
.Fa charclass
(changes of LC_CTYPE category invalidate
.Fa charclass )
or invalid wide character as
.Fa wc .
.Pp
The behaviour of the
.Fn iswctype
is affected by LC_CTYPE category of the current locale.
.\" ----------------------------------------------------------------------
.Sh RETURN VALUES
The
.Fn iswcttype
returns:
.Bl -tag -width 012345678901
.It 0
.Fa wc
does not consist in
.Fa charclass .
.It non-zero
.Fa wc
consists in
.Fa charclass .
.El
.Pp
.\" ----------------------------------------------------------------------
.Sh ERRORS
No errors are defined.
.\" ----------------------------------------------------------------------
.Sh SEE ALSO
.Xr wctype 3 ,
.Xr wctrans 3 ,
.Xr towctrans 3 ,
.Xr setlocale 3
.\" ----------------------------------------------------------------------
.Sh STANDARDS
The
.Fn iswctype
function conforms to
.St -isoC-amd1 .

View File

@ -0,0 +1,85 @@
.\" $NetBSD: towctrans.3,v 1.1 2003/03/04 12:11:51 tshiozak 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 4, 2003
.Dt TOWCTRANS 3
.Os
.\" ----------------------------------------------------------------------
.Sh NAME
.Nm towctrans
.Nd conver a wide character with a specified map
.\" ----------------------------------------------------------------------
.Sh LIBRARY
.Lb libc
.\" ----------------------------------------------------------------------
.Sh SYNOPSIS
.Fd #include \*[Lt]wctype.h\*[Gt]
.Ft wint_t
.Fn towctrans "wint_t wc" "wctrans_t charmap"
.\" ----------------------------------------------------------------------
.Sh DESCRIPTION
The
.Fn towctrans
function converts a wide character
.Fa wc
with a character mapping
.Fa charmap .
.Pp
The behaviour of the
.Fn towctrans
is undefined
if the
.Fn towctrans
function is called with an invalid
.Fa charmap
(changes of LC_CTYPE category invalidate
.Fa charclass )
or invalid wide character as
.Fa wc .
.Pp
The behaviour of the
.Fn towctrans
is affected by LC_CTYPE category of the current locale.
.\" ----------------------------------------------------------------------
.Sh RETURN VALUES
The
.Fn towctrans
returns a result character of the conversion.
.\" ----------------------------------------------------------------------
.Sh ERRORS
No errors are defined.
.\" ----------------------------------------------------------------------
.Sh SEE ALSO
.Xr wctrans 3 ,
.Xr wctype 3 ,
.Xr iswctype 3 ,
.Xr setlocale 3
.\" ----------------------------------------------------------------------
.Sh STANDARDS
The
.Fn towctrans
function conforms to
.St -isoC-amd1 .

89
lib/libc/locale/wctrans.3 Normal file
View File

@ -0,0 +1,89 @@
.\" $NetBSD: wctrans.3,v 1.1 2003/03/04 12:11:52 tshiozak 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 4, 2003
.Dt WCTRANS 3
.Os
.\" ----------------------------------------------------------------------
.Sh NAME
.Nm wctrans
.Nd get character mapping identifier by name
.\" ----------------------------------------------------------------------
.Sh LIBRARY
.Lb libc
.\" ----------------------------------------------------------------------
.Sh SYNOPSIS
.Fd #include \*[Lt]wctype.h\*[Gt]
.Ft wctrans_t
.Fn wctrans "const char *charmap"
.\" ----------------------------------------------------------------------
.Sh DESCRIPTION
The
.Fn wctrans
function returns a character mapping identifier corresponding to the
locale-specific character mapping name, pointed by
.Fa charmap .
This identifier can be used on the subsequent calls of
.Fn towctrans .
The following names are defined in all locales:
.Bd -literal -offset indent
tolower toupper
.Ed
.Pp
The behaviour of the
.Fn wctrans
is affected by LC_CTYPE category of the current locale.
.\" ----------------------------------------------------------------------
.Sh RETURN VALUES
The
.Fn wctrans
returns:
.Bl -tag -width 012345678901
.It 0
if the string pointed by
.Fa charmap
does not corresponding to a valid character mapping name.
.It non-zero
an character mapping identifier corresponding to the name pointed by
.Fa charmap .
.El
.Pp
note: wctype_t is a scalar type, e.g. pointer.
.\" ----------------------------------------------------------------------
.Sh ERRORS
No errors are defined.
.\" ----------------------------------------------------------------------
.Sh SEE ALSO
.Xr wctrans 3 ,
.Xr wctype 3 ,
.Xr iswctype 3 ,
.Xr setlocale 3
.\" ----------------------------------------------------------------------
.Sh STANDARDS
The
.Fn towctrans
function conforms to
.St -isoC-amd1 .

90
lib/libc/locale/wctype.3 Normal file
View File

@ -0,0 +1,90 @@
.\" $NetBSD: wctype.3,v 1.1 2003/03/04 12:11:53 tshiozak 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 4, 2003
.Dt WCTYPE 3
.Os
.\" ----------------------------------------------------------------------
.Sh NAME
.Nm wctype
.Nd get character class identifier by name
.\" ----------------------------------------------------------------------
.Sh LIBRARY
.Lb libc
.\" ----------------------------------------------------------------------
.Sh SYNOPSIS
.Fd #include \*[Lt]wctype.h\*[Gt]
.Ft wctype_t
.Fn wctype "const char *charclass"
.\" ----------------------------------------------------------------------
.Sh DESCRIPTION
The
.Fn wctype
function returns a character class identifier corresponding to the
locale-specific character class name, pointed by
.Fa charclass .
This identifier can be used on the subsequent calls of
.Fn iswctype .
The following names are defined in all locales:
.Bd -literal -offset indent
alnum alpha blank cntrl digit graph
lower print punct space upper xdigit
.Ed
.Pp
The behaviour of the
.Fn wctype
is affected by LC_CTYPE category of the current locale.
.\" ----------------------------------------------------------------------
.Sh RETURN VALUES
The
.Fn wcttype
returns:
.Bl -tag -width 012345678901
.It 0
if the string pointed by
.Fa charclass
does not corresponding to a valid character class name.
.It non-zero
an character class identifier corresponding to the name pointed by
.Fa charclass .
.El
.Pp
note: wctype_t is a scalar type, e.g. pointer.
.\" ----------------------------------------------------------------------
.Sh ERRORS
No errors are defined.
.\" ----------------------------------------------------------------------
.Sh SEE ALSO
.Xr iswctype 3 ,
.Xr wctrans 3 ,
.Xr towctrans 3 ,
.Xr setlocale 3
.\" ----------------------------------------------------------------------
.Sh STANDARDS
The
.Fn wctype
function conforms to
.St -isoC-amd1 .