summaryrefslogtreecommitdiffstats
path: root/man3/strcoll.3
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-15 19:40:15 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-15 19:40:15 +0000
commit399644e47874bff147afb19c89228901ac39340e (patch)
tree1c4c0b733f4c16b5783b41bebb19194a9ef62ad1 /man3/strcoll.3
parentInitial commit. (diff)
downloadmanpages-upstream/6.05.01.tar.xz
manpages-upstream/6.05.01.zip
Adding upstream version 6.05.01.upstream/6.05.01
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'man3/strcoll.3')
-rw-r--r--man3/strcoll.387
1 files changed, 87 insertions, 0 deletions
diff --git a/man3/strcoll.3 b/man3/strcoll.3
new file mode 100644
index 0000000..e8146b7
--- /dev/null
+++ b/man3/strcoll.3
@@ -0,0 +1,87 @@
+'\" t
+.\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
+.\"
+.\" SPDX-License-Identifier: Linux-man-pages-copyleft
+.\"
+.\" References consulted:
+.\" Linux libc source code
+.\" Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991)
+.\" 386BSD man pages
+.\" Modified Sun Jul 25 10:40:44 1993 by Rik Faith (faith@cs.unc.edu)
+.TH strcoll 3 2023-07-20 "Linux man-pages 6.05.01"
+.SH NAME
+strcoll \- compare two strings using the current locale
+.SH LIBRARY
+Standard C library
+.RI ( libc ", " \-lc )
+.SH SYNOPSIS
+.nf
+.B #include <string.h>
+.PP
+.BI "int strcoll(const char *" s1 ", const char *" s2 );
+.fi
+.SH DESCRIPTION
+The
+.BR strcoll ()
+function compares the two strings
+.I s1
+and
+.IR s2 .
+It returns an integer less than, equal to, or greater
+than zero if
+.I s1
+is found, respectively, to be less than,
+to match, or be greater than
+.IR s2 .
+The comparison is based on
+strings interpreted as appropriate for the program's current locale
+for category
+.BR LC_COLLATE .
+(See
+.BR setlocale (3).)
+.SH RETURN VALUE
+The
+.BR strcoll ()
+function returns an integer less than, equal to,
+or greater than zero if
+.I s1
+is found, respectively, to be less
+than, to match, or be greater than
+.IR s2 ,
+when both are interpreted
+as appropriate for the current locale.
+.SH ATTRIBUTES
+For an explanation of the terms used in this section, see
+.BR attributes (7).
+.TS
+allbox;
+lbx lb lb
+l l l.
+Interface Attribute Value
+T{
+.na
+.nh
+.BR strcoll ()
+T} Thread safety MT-Safe locale
+.TE
+.sp 1
+.SH STANDARDS
+C11, POSIX.1-2008.
+.SH HISTORY
+POSIX.1-2001, C89, SVr4, 4.3BSD.
+.SH NOTES
+In the
+.I "POSIX"
+or
+.I "C"
+locales
+.BR strcoll ()
+is equivalent to
+.BR strcmp (3).
+.SH SEE ALSO
+.BR memcmp (3),
+.BR setlocale (3),
+.BR strcasecmp (3),
+.BR strcmp (3),
+.BR string (3),
+.BR strxfrm (3)