NetBSD/lib/libc/string/strcmp.3

.\" Copyright (c) 1990, 1991, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" This code is derived from software contributed to Berkeley by
.\" Chris Torek and the American National Standards Committee X3,
.\" on Information Processing Systems.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"     from: @(#)strcmp.3	8.1 (Berkeley) 6/4/93
.\"	$NetBSD: strcmp.3,v 1.12 2003/08/07 16:43:49 agc Exp $
.\"
.Dd June 4, 1993
.Dt STRCMP 3
.Os
.Sh NAME
.Nm strcmp ,
.Nm strncmp
.Nd compare strings
.Sh LIBRARY
.Lb libc
.Sh SYNOPSIS
.In string.h
.Ft int
.Fn strcmp "const char *s1" "const char *s2"
.Ft int
.Fn strncmp "const char *s1" "const char *s2" "size_t len"
.Sh DESCRIPTION
The
.Fn strcmp
and
.Fn strncmp
functions
lexicographically compare the null-terminated strings
.Fa s1
and
.Fa s2 .
.Sh RETURN VALUES
The
.Fn strcmp
and
.Fn strncmp
return an integer greater than, equal to, or less than 0, according
to whether the string
.Fa s1
is greater than, equal to, or less than the string
.Fa s2 .
The comparison is done using unsigned characters, so that
.Ql \e200
is greater than
.Ql \e0 .
.Pp
The
.Fn strncmp
compares not more than
.Fa len
characters.
.Sh SEE ALSO
.Xr bcmp 3 ,
.Xr memcmp 3 ,
.Xr strcasecmp 3 ,
.Xr strcoll 3 ,
.Xr strxfrm 3
.Sh STANDARDS
The
.Fn strcmp
and
.Fn strncmp
functions
conform to
.St -ansiC .
.Sh NOTES
If
.Fa len
is zero
.Fn strncmp
returns always 0.
update to lite-2 1998-01-31 02:37:40 +03:00			`.\" Copyright (c) 1990, 1991, 1993`
			`.\" The Regents of the University of California. All rights reserved.`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.\"`
			`.\" This code is derived from software contributed to Berkeley by`
			`.\" Chris Torek and the American National Standards Committee X3,`
			`.\" on Information Processing Systems.`
			`.\"`
			`.\" Redistribution and use in source and binary forms, with or without`
			`.\" modification, are permitted provided that the following conditions`
			`.\" are met:`
			`.\" 1. Redistributions of source code must retain the above copyright`
			`.\" notice, this list of conditions and the following disclaimer.`
			`.\" 2. Redistributions in binary form must reproduce the above copyright`
			`.\" notice, this list of conditions and the following disclaimer in the`
			`.\" documentation and/or other materials provided with the distribution.`
Move UCB-licensed code from 4-clause to 3-clause licence. Patches provided by Joel Baker in PR 22280, verified by myself. 2003-08-07 20:42:00 +04:00			`.\" 3. Neither the name of the University nor the names of its contributors`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.\" may be used to endorse or promote products derived from this software`
			`.\" without specific prior written permission.`
			`.\"`
			.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
			`.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE`
			`.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE`
			`.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE`
			`.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL`
			`.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS`
			`.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)`
			`.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT`
			`.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY`
			`.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF`
			`.\" SUCH DAMAGE.`
			`.\"`
update to lite-2 1998-01-31 02:37:40 +03:00			`.\" from: @(#)strcmp.3 8.1 (Berkeley) 6/4/93`
Move UCB-licensed code from 4-clause to 3-clause licence. Patches provided by Joel Baker in PR 22280, verified by myself. 2003-08-07 20:42:00 +04:00			`.\" $NetBSD: strcmp.3,v 1.12 2003/08/07 16:43:49 agc Exp $`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.\"`
update to lite-2 1998-01-31 02:37:40 +03:00			`.Dd June 4, 1993`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Dt STRCMP 3`
			`.Os`
			`.Sh NAME`
add missing .Nm entries. from spz@serpens.swb.de. 1997-11-14 05:04:36 +03:00			`.Nm strcmp ,`
			`.Nm strncmp`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Nd compare strings`
add LIBRARY section to man page 1998-02-05 21:45:17 +03:00			`.Sh LIBRARY`
			`.Lb libc`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Sh SYNOPSIS`
Use .In header.h instead of .Fd #include \[Lt]header.h\[Gt] Much easier to read and write, and supported by groff for ages. Okayed by ross. 2003-04-16 17:34:34 +04:00			`.In string.h`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Ft int`
			`.Fn strcmp "const char s1" "const char s2"`
			`.Ft int`
			`.Fn strncmp "const char s1" "const char s2" "size_t len"`
			`.Sh DESCRIPTION`
			`The`
			`.Fn strcmp`
			`and`
			`.Fn strncmp`
			`functions`
			`lexicographically compare the null-terminated strings`
			`.Fa s1`
			`and`
			`.Fa s2 .`
			`.Sh RETURN VALUES`
			`The`
			`.Fn strcmp`
			`and`
			`.Fn strncmp`
			`return an integer greater than, equal to, or less than 0, according`
Grammar improvement from jmc@openbsd. 2003-05-10 16:30:23 +04:00			`to whether the string`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Fa s1`
			`is greater than, equal to, or less than the string`
			`.Fa s2 .`
			`The comparison is done using unsigned characters, so that`
			`.Ql \e200`
			`is greater than`
			`.Ql \e0 .`
			`.Pp`
			`The`
			`.Fn strncmp`
			`compares not more than`
			`.Fa len`
			`characters.`
			`.Sh SEE ALSO`
			`.Xr bcmp 3 ,`
			`.Xr memcmp 3 ,`
			`.Xr strcasecmp 3 ,`
			`.Xr strcoll 3 ,`
			`.Xr strxfrm 3`
			`.Sh STANDARDS`
			`The`
			`.Fn strcmp`
			`and`
			`.Fn strncmp`
			`functions`
			`conform to`
			`.St -ansiC .`
Add note about special case when calling strcmp() or strcasecmp() with len = 0 as suggested by Jaromir Dolecek in PR lib/6344. 1998-10-23 21:49:29 +04:00			`.Sh NOTES`
			`If`
Whitespace fixes and sort SEE ALSO. 2001-09-16 05:41:09 +04:00			`.Fa len`
Add note about special case when calling strcmp() or strcasecmp() with len = 0 as suggested by Jaromir Dolecek in PR lib/6344. 1998-10-23 21:49:29 +04:00			`is zero`
			`.Fn strncmp`
			`returns always 0.`