string/FreeBSD/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.10 2002/08/30 15:40:01 robert Exp $
  36 .\"
  37 .Dd June 9, 1993
  38 .Dt STRCASECMP 3
  39 .Os
  40 .Sh NAME
  41 .Nm strcasecmp ,
  42 .Nm strncasecmp
  43 .Nd compare strings, ignoring case
  44 .Sh LIBRARY
  45 .Lb libc
  46 .Sh SYNOPSIS
  47 .In strings.h
  48 .Ft int
  49 .Fn strcasecmp "const char *s1" "const char *s2"
  50 .Ft int
  51 .Fn strncasecmp "const char *s1" "const char *s2" "size_t len"
  52 .Sh DESCRIPTION
  53 The
  54 .Fn strcasecmp
  55 and
  56 .Fn strncasecmp
  57 functions
  58 compare the null-terminated strings
  59 .Fa s1
  60 and
  61 .Fa s2 .
  62 .Pp
  63 The
  64 .Fn strncasecmp
  65 compares at most
  66 .Fa len
  67 characters.
  68 .Sh RETURN VALUES
  69 The
  70 .Fn strcasecmp
  71 and
  72 .Fn strncasecmp
  73 return an integer greater than, equal to, or less than 0,
  74 according as
  75 .Fa s1
  76 is lexicographically greater than, equal to, or less than
  77 .Fa s2
  78 after translation of each corresponding character to lower-case.
  79 The strings themselves are not modified.
  80 The comparison is done using unsigned characters, so that
  81 .Sq Li \e200
  82 is greater than
  83 .Ql \e0 .
  84 .Sh SEE ALSO
  85 .Xr bcmp 3 ,
  86 .Xr memcmp 3 ,
  87 .Xr strcmp 3 ,
  88 .Xr strcoll 3 ,
  89 .Xr strxfrm 3 ,
  90 .Xr tolower 3
  91 .Sh HISTORY
  92 The
  93 .Fn strcasecmp
  94 and
  95 .Fn strncasecmp
  96 functions first appeared in
  97 .Bx 4.4 .
  98 Their prototypes existed previously in
  99 .Aq Pa string.h
 100 before they were moved to
 101 .Aq Pa strings.h
 102 for
 103 .St -p1003.1-2001
 104 compliance.