]> git.ipfire.org Git - thirdparty/man-pages.git/blobdiff - man3/strxfrm.3
fanotify_init.2, fanotify.7: Document FAN_REPORT_TID
[thirdparty/man-pages.git] / man3 / strxfrm.3
index 898538d858772e4d0174967d40c57fdc263c27bf..6e19731573ac2e67d665142d2dbcf001be2e2bef 100644 (file)
@@ -1,5 +1,6 @@
 .\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
 .\"
+.\" %%%LICENSE_START(VERBATIM)
 .\" 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.
 .\"
 .\" Formatted or processed versions of this manual, if unaccompanied by
 .\" the source, must acknowledge the copyright and authors of this work.
+.\" %%%LICENSE_END
 .\"
 .\" References consulted:
 .\"     Linux libc source code
 .\"     Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991)
 .\"     386BSD man pages
 .\" Modified Sun Jul 25 10:41:28 1993 by Rik Faith (faith@cs.unc.edu)
-.TH STRXFRM 3  2011-09-28 "GNU" "Linux Programmer's Manual"
+.TH STRXFRM 3  2016-07-17 "GNU" "Linux Programmer's Manual"
 .SH NAME
 strxfrm \- string transformation
 .SH SYNOPSIS
 .nf
 .B #include <string.h>
-.sp
+.PP
 .BI "size_t strxfrm(char *" dest ", const char *" src ", size_t " n );
 .fi
 .SH DESCRIPTION
 The
 .BR strxfrm ()
-function transforms the \fIsrc\fP string into a
+function transforms the
+.I src
+string into a
 form such that the result of
 .BR strcmp (3)
 on two strings that have
@@ -46,28 +50,44 @@ been transformed with
 is the same as the result of
 .BR strcoll (3)
 on the two strings before their transformation.
-The first \fIn\fP bytes of the transformed string are placed in
-\fIdest\fP.
+The first
+.I n
+bytes of the transformed string are placed in
+.IR dest .
 The transformation is based on the program's current
-locale for category \fBLC_COLLATE\fP.  (See
+locale for category
+.BR LC_COLLATE .
+(See
 .BR setlocale (3)).
-.SH "RETURN VALUE"
+.SH RETURN VALUE
 The
 .BR strxfrm ()
 function returns the number of bytes required to
-store the transformed string in \fIdest\fP excluding the
+store the transformed string in
+.I dest
+excluding the
 terminating null byte (\(aq\\0\(aq).
-If the value returned is \fIn\fP or more, the
-contents of \fIdest\fP are indeterminate.
-.SH "CONFORMING TO"
-SVr4, 4.3BSD, C89, C99.
-.SH NOTES
-In the \fI"POSIX"\fP or \fI"C"\fP locales
+If the value returned is
+.I n
+or more, the
+contents of
+.I dest
+are indeterminate.
+.SH ATTRIBUTES
+For an explanation of the terms used in this section, see
+.BR attributes (7).
+.TS
+allbox;
+lb lb lb
+l l l.
+Interface      Attribute       Value
+T{
 .BR strxfrm ()
-is equivalent to
-copying the string with
-.BR strncpy (3).
-.SH "SEE ALSO"
+T}     Thread safety   MT-Safe locale
+.TE
+.SH CONFORMING TO
+POSIX.1-2001, POSIX.1-2008, C89, C99, SVr4, 4.3BSD.
+.SH SEE ALSO
 .BR bcmp (3),
 .BR memcmp (3),
 .BR setlocale (3),