xref: /freebsd/lib/libc/string/strcasecmp.3 (revision aa0a1e58)
1.\" Copyright (c) 1990, 1991, 1993
2.\"	The Regents of the University of California.  All rights reserved.
3.\"
4.\" This code is derived from software contributed to Berkeley by
5.\" Chris Torek.
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\" 4. Neither the name of the University nor the names of its contributors
15.\"    may be used to endorse or promote products derived from this software
16.\"    without specific prior written permission.
17.\"
18.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
19.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
22.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28.\" SUCH DAMAGE.
29.\"
30.\"     @(#)strcasecmp.3	8.1 (Berkeley) 6/9/93
31.\" $FreeBSD$
32.\"
33.Dd June 9, 1993
34.Dt STRCASECMP 3
35.Os
36.Sh NAME
37.Nm strcasecmp ,
38.Nm strncasecmp
39.Nd compare strings, ignoring case
40.Sh LIBRARY
41.Lb libc
42.Sh SYNOPSIS
43.In strings.h
44.Ft int
45.Fn strcasecmp "const char *s1" "const char *s2"
46.Ft int
47.Fn strncasecmp "const char *s1" "const char *s2" "size_t len"
48.Sh DESCRIPTION
49The
50.Fn strcasecmp
51and
52.Fn strncasecmp
53functions
54compare the null-terminated strings
55.Fa s1
56and
57.Fa s2 .
58.Pp
59The
60.Fn strncasecmp
61compares at most
62.Fa len
63characters.
64.Sh RETURN VALUES
65The
66.Fn strcasecmp
67and
68.Fn strncasecmp
69return an integer greater than, equal to, or less than 0,
70according as
71.Fa s1
72is lexicographically greater than, equal to, or less than
73.Fa s2
74after translation of each corresponding character to lower-case.
75The strings themselves are not modified.
76The comparison is done using unsigned characters, so that
77.Sq Li \e200
78is greater than
79.Ql \e0 .
80.Sh SEE ALSO
81.Xr bcmp 3 ,
82.Xr memcmp 3 ,
83.Xr strcmp 3 ,
84.Xr strcoll 3 ,
85.Xr strxfrm 3 ,
86.Xr tolower 3 ,
87.Xr wcscasecmp 3
88.Sh HISTORY
89The
90.Fn strcasecmp
91and
92.Fn strncasecmp
93functions first appeared in
94.Bx 4.4 .
95Their prototypes existed previously in
96.In string.h
97before they were moved to
98.In strings.h
99for
100.St -p1003.1-2001
101compliance.
102