xref: /freebsd/lib/libc/string/strcmp.3 (revision 23f282aa31e9b6fceacd449020e936e98d6f2298)
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.\" $FreeBSD$
38.\"
39.Dd June 4, 1993
40.Dt STRCMP 3
41.Os
42.Sh NAME
43.Nm strcmp ,
44.Nm strncmp
45.Nd compare strings
46.Sh LIBRARY
47.Lb libc
48.Sh SYNOPSIS
49.Fd #include <string.h>
50.Ft int
51.Fn strcmp "const char *s1" "const char *s2"
52.Ft int
53.Fn strncmp "const char *s1" "const char *s2" "size_t len"
54.Sh DESCRIPTION
55The
56.Fn strcmp
57and
58.Fn strncmp
59functions
60lexicographically compare the null-terminated strings
61.Fa s1
62and
63.Fa s2 .
64.Pp
65The
66.Fn strncmp
67compares not more than
68.Fa len
69characters.
70.Sh RETURN VALUES
71The
72.Fn strcmp
73and
74.Fn strncmp
75return an integer greater than, equal to, or less than 0, according
76as the string
77.Fa s1
78is greater than, equal to, or less than the string
79.Fa s2 .
80The comparison is done using unsigned characters, so that
81.Ql \e200
82is greater than
83.Ql \e0 .
84.Sh SEE ALSO
85.Xr bcmp 3 ,
86.Xr memcmp 3 ,
87.Xr strcasecmp 3 ,
88.Xr strcoll 3 ,
89.Xr strxfrm 3
90.Sh STANDARDS
91The
92.Fn strcmp
93and
94.Fn strncmp
95functions
96conform to
97.St -ansiC .
98