Try to tell what this really does.

Including a BUGS section on why it doesn't.

*roff code by wiz@, with some input from
Slava Semushin <slava.semushin@gmail.com>
This commit is contained in:
hubertf 2007-02-18 00:38:22 +00:00
parent 6f8e93a61f
commit 002621f0bc
1 changed files with 18 additions and 7 deletions

View File

@ -30,7 +30,7 @@
.\" SUCH DAMAGE.
.\"
.\" from: @(#)strxfrm.3 8.1 (Berkeley) 6/4/93
.\" $NetBSD: strxfrm.3,v 1.9 2003/08/07 16:43:53 agc Exp $
.\" $NetBSD: strxfrm.3,v 1.10 2007/02/18 00:38:22 hubertf Exp $
.\"
.Dd June 4, 1993
.Dt STRXFRM 3
@ -45,13 +45,19 @@
.Ft size_t
.Fn strxfrm "char * restrict dst" "const char * restrict src" "size_t n"
.Sh DESCRIPTION
The
The idea of
.Fn strxfrm
function
does something horrible (see
.Tn ANSI
standard).
In this implementation it just copies.
is to
.Dq un-localize
a string: the function transforms
.Ar src ,
storing the result in
.Ar dst ,
such that
.Xr strcmp 3
transformed strings returns what
.Xr strcoll 3
on the original untransformed strings would return.
.Sh SEE ALSO
.Xr bcmp 3 ,
.Xr memcmp 3 ,
@ -65,3 +71,8 @@ The
function
conforms to
.St -ansiC .
.Sh BUGS
Since locales are not fully implemented on
.Nx ,
.Fn strxfrm
just returns a copy of the original string.