stringprep_utf8_nfkc_normalize.3   [plain text]

.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
.TH "stringprep_utf8_nfkc_normalize" 3 "0.6.14" "libidn" "libidn"
.SH NAME
stringprep_utf8_nfkc_normalize \- normalize Unicode string
.SH SYNOPSIS
.B #include <stringprep.h>
.sp
.BI "char * stringprep_utf8_nfkc_normalize(const char * " str ", ssize_t " len ");"
.SH ARGUMENTS
.IP "const char * str" 12
a UTF-8 encoded string.
.IP "ssize_t len" 12
length of \fIstr\fP, in bytes, or -1 if \fIstr\fP is nul-terminated.
.SH "DESCRIPTION"
Converts a string into canonical form, standardizing
such issues as whether a character with an accent
is represented as a base character and combining
accent or as a single precomposed character.

The normalization mode is NFKC (ALL COMPOSE).  It standardizes
differences that do not affect the text content, such as the
above\-mentioned accent representation. It standardizes the
"compatibility" characters in Unicode, such as SUPERSCRIPT THREE to
the standard forms (in this case DIGIT THREE). Formatting
information may be lost but for most text operations such
characters should be considered the same. It returns a result with
composed forms rather than a maximally decomposed form.
.SH "RETURN VALUE"
a newly allocated string, that is the
NFKC normalized form of \fIstr\fP.
.SH "REPORTING BUGS"
Report bugs to <bug-libidn@gnu.org>.
.SH COPYRIGHT
Copyright \(co 2002, 2003, 2004, 2005, 2006, 2007 Simon Josefsson.
.br
Permission is granted to make and distribute verbatim copies of this
manual provided the copyright notice and this permission notice are
preserved on all copies.
.SH "SEE ALSO"
The full documentation for
.B libidn
is maintained as a Texinfo manual.  If the
.B info
and
.B libidn
programs are properly installed at your site, the command
.IP
.B info libidn
.PP
should give you access to the complete manual.