add opendir alias
[minix.git] / lib / libc / string / strcmp.3
blobbcafe26ca310c8e2db67ceba6859070d429b7910
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. Neither the name of the University nor the names of its contributors
17 .\"    may be used to endorse or promote products derived from this software
18 .\"    without specific prior written permission.
19 .\"
20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 .\" SUCH DAMAGE.
31 .\"
32 .\"     from: @(#)strcmp.3      8.1 (Berkeley) 6/4/93
33 .\"     $NetBSD: strcmp.3,v 1.13 2006/10/16 08:48:45 wiz Exp $
34 .\"
35 .Dd June 4, 1993
36 .Dt STRCMP 3
37 .Os
38 .Sh NAME
39 .Nm strcmp ,
40 .Nm strncmp
41 .Nd compare strings
42 .Sh LIBRARY
43 .Lb libc
44 .Sh SYNOPSIS
45 .In string.h
46 .Ft int
47 .Fn strcmp "const char *s1" "const char *s2"
48 .Ft int
49 .Fn strncmp "const char *s1" "const char *s2" "size_t len"
50 .Sh DESCRIPTION
51 The
52 .Fn strcmp
53 and
54 .Fn strncmp
55 functions
56 lexicographically compare the nul-terminated strings
57 .Fa s1
58 and
59 .Fa s2 .
60 .Sh RETURN VALUES
61 The
62 .Fn strcmp
63 and
64 .Fn strncmp
65 return an integer greater than, equal to, or less than 0, according
66 to whether the string
67 .Fa s1
68 is greater than, equal to, or less than the string
69 .Fa s2 .
70 The comparison is done using unsigned characters, so that
71 .Ql \e200
72 is greater than
73 .Ql \e0 .
74 .Pp
75 The
76 .Fn strncmp
77 compares not more than
78 .Fa len
79 characters.
80 .Sh SEE ALSO
81 .Xr bcmp 3 ,
82 .Xr memcmp 3 ,
83 .Xr strcasecmp 3 ,
84 .Xr strcoll 3 ,
85 .Xr strxfrm 3
86 .Sh STANDARDS
87 The
88 .Fn strcmp
89 and
90 .Fn strncmp
91 functions
92 conform to
93 .St -ansiC .
94 .Sh NOTES
96 .Fa len
97 is zero
98 .Fn strncmp
99 returns always 0.