freebsd-dev/lib/libkiconv/kiconv.3
Bruce M Simpson ed1e0e1be7 Correct .Xr's in kiconv.3.
Submitted by:	osa
2003-10-05 13:39:28 +00:00

107 lines
2.9 KiB
Groff

.\"
.\" Copyright (c) 2003 Ryuichiro Imura
.\" 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.
.\"
.\" $FreeBSD$
.\"
.Dd July 17, 2003
.Dt KICONV 3
.Os
.Sh NAME
.Nm kiconv_add_xlat16_cspair ,
.Nm kiconv_add_xlat16_table
.Nd Kernel side iconv library
.Sh LIBRARY
.Lb libkiconv
.Sh SYNOPSIS
.In sys/iconv.h
.Ft int
.Fo kiconv_add_xlat16_cspair
.Fa "const char *tocode"
.Fa "const char *fromcode"
.Fa "int flag"
.Fc
.Ft int
.Fo kiconv_add_xlat16_table
.Fa "const char *tocode"
.Fa "const char *fromcode"
.Fa "const void *data"
.Fa "int datalen"
.Fc
.Sh DESCRIPTION
The
.Xr kiconv 3
library provides multi-byte character conversion tables for kernel side
iconv service.
.Pp
.Fn kiconv_add_xlat16_cspair
defines a conversion table using
.Xr iconv 3
between
.Ar fromcode
charset and
.Ar tocode
charset. You can specify
.Ar flag
to determine if
.Xr tolower 3
/
.Xr toupper 3
conversion is included in the table.
The
.Ar flag
has following values.
.Pp
.Bl -tag -width "KICONV_FROM_LOWER" -compact
.It Fa KICONV_LOWER
.It Fa KICONV_FROM_LOWER
It generates a tolower table in addition to a character conversion table.
The difference between two is tolower
.Ar tocode
or tolower
.Ar fromcode .
.It Fa KICONV_UPPER
.It Fa KICONV_FROM_UPPER
It generates a toupper table in addition to a character conversion table.
The difference between two is toupper
.Ar tocode
or toupper
.Ar fromcode .
.El
.Pp
A tolower/toupper conversion is limited to single-byte characters.
.Pp
.Fn kiconv_add_xlat16_table
defines a conversion table directly pointed by
.Ar data
whose length is
.Ar datalen ,
not using
.Xr iconv 3 .
.Sh SEE ALSO
.Xr iconv 3 ,
.Xr tolower 3 ,
.Xr toupper 3 ,
.Xr iconv 9