xref: /freebsd/lib/libc/string/strcmp.3 (revision a8445737e740901f5f2c8d24c12ef7fc8b00134e)
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 and the American National Standards Committee X3,
6.\" on Information Processing Systems.
7.\"
8.\" Redistribution and use in source and binary forms, with or without
9.\" modification, are permitted provided that the following conditions
10.\" are met:
11.\" 1. Redistributions of source code must retain the above copyright
12.\"    notice, this list of conditions and the following disclaimer.
13.\" 2. Redistributions in binary form must reproduce the above copyright
14.\"    notice, this list of conditions and the following disclaimer in the
15.\"    documentation and/or other materials provided with the distribution.
16.\" 3. All advertising materials mentioning features or use of this software
17.\"    must display the following acknowledgement:
18.\"	This product includes software developed by the University of
19.\"	California, Berkeley and its contributors.
20.\" 4. Neither the name of the University nor the names of its contributors
21.\"    may be used to endorse or promote products derived from this software
22.\"    without specific prior written permission.
23.\"
24.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34.\" SUCH DAMAGE.
35.\"
36.\"     @(#)strcmp.3	8.1 (Berkeley) 6/4/93
37.\"
38.Dd June 4, 1993
39.Dt STRCMP 3
40.Os
41.Sh NAME
42.Nm strcmp ,
43.Nm strncmp ,
44.Nd compare strings
45.Sh SYNOPSIS
46.Fd #include <string.h>
47.Ft int
48.Fn strcmp "const char *s1" "const char *s2"
49.Ft int
50.Fn strncmp "const char *s1" "const char *s2" "size_t len"
51.Sh DESCRIPTION
52The
53.Fn strcmp
54and
55.Fn strncmp
56functions
57lexicographically compare the null-terminated strings
58.Fa s1
59and
60.Fa s2 .
61.Sh RETURN VALUES
62The
63.Fn strcmp
64and
65.Fn strncmp
66return an integer greater than, equal to, or less than 0, according
67as the string
68.Fa s1
69is greater than, equal to, or less than the string
70.Fa s2 .
71The comparison is done using unsigned characters, so that
72.Ql \e200
73is greater than
74.Ql \e0 .
75.Pp
76The
77.Fn strncmp
78compares not more than
79.Fa len
80characters.
81.Sh SEE ALSO
82.Xr bcmp 3 ,
83.Xr memcmp 3 ,
84.Xr strcasecmp 3 ,
85.Xr strcoll 3 ,
86.Xr strxfrm 3
87.Sh STANDARDS
88The
89.Fn strcmp
90and
91.Fn strncmp
92functions
93conform to
94.St -ansiC .
95