8067c82dec7ca3d2efb0b46f050bc7b6a0b4f15e
[dragonfly.git] / lib / libc / string / strcasecmp.3
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 .\" 3. All advertising materials mentioning features or use of this software
15 .\"    must display the following acknowledgement:
16 .\"     This product includes software developed by the University of
17 .\"     California, Berkeley and its contributors.
18 .\" 4. Neither the name of the University nor the names of its contributors
19 .\"    may be used to endorse or promote products derived from this software
20 .\"    without specific prior written permission.
21 .\"
22 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 .\" SUCH DAMAGE.
33 .\"
34 .\"     @(#)strcasecmp.3        8.1 (Berkeley) 6/9/93
35 .\" $FreeBSD: src/lib/libc/string/strcasecmp.3,v 1.6.2.3 2001/12/14 18:33:59 ru Exp $
36 .\" $DragonFly: src/lib/libc/string/strcasecmp.3,v 1.2 2003/06/17 04:26:46 dillon Exp $
37 .\"
38 .Dd June 9, 1993
39 .Dt STRCASECMP 3
40 .Os
41 .Sh NAME
42 .Nm strcasecmp ,
43 .Nm strncasecmp
44 .Nd compare strings, ignoring case
45 .Sh LIBRARY
46 .Lb libc
47 .Sh SYNOPSIS
48 .In string.h
49 .Ft int
50 .Fn strcasecmp "const char *s1" "const char *s2"
51 .Ft int
52 .Fn strncasecmp "const char *s1" "const char *s2" "size_t len"
53 .Sh DESCRIPTION
54 The
55 .Fn strcasecmp
56 and
57 .Fn strncasecmp
58 functions
59 compare the null-terminated strings
60 .Fa s1
61 and
62 .Fa s2 .
63 .Pp
64 The
65 .Fn strncasecmp
66 compares at most
67 .Fa len
68 characters.
69 .Sh RETURN VALUES
70 The
71 .Fn strcasecmp
72 and
73 .Fn strncasecmp
74 return an integer greater than, equal to, or less than 0,
75 according as
76 .Fa s1
77 is lexicographically greater than, equal to, or less than
78 .Fa s2
79 after translation of each corresponding character to lower-case.
80 The strings themselves are not modified.
81 The comparison is done using unsigned characters, so that
82 .Sq Li \e200
83 is greater than
84 .Ql \e0 .
85 .Sh SEE ALSO
86 .Xr bcmp 3 ,
87 .Xr memcmp 3 ,
88 .Xr strcmp 3 ,
89 .Xr strcoll 3 ,
90 .Xr strxfrm 3 ,
91 .Xr tolower 3
92 .Sh HISTORY
93 The
94 .Fn strcasecmp
95 and
96 .Fn strncasecmp
97 functions first appeared in
98 .Bx 4.4 .