locale/FreeBSD/toupper.3

   1 .\" Copyright (c) 1989, 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 .\" the American National Standards Committee X3, on Information
   6 .\" 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 .\" 4. 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 .\"     @(#)toupper.3   8.1 (Berkeley) 6/4/93
  33 .\" $FreeBSD: src/lib/libc/locale/toupper.3,v 1.21 2009/09/04 07:44:58 des Exp $
  34 .\"
  35 .Dd July 17, 2005
  36 .Dt TOUPPER 3
  37 .Os
  38 .Sh NAME
  39 .Nm toupper ,
  40 .Nm toupper_l
  41 .Nd lower case to upper case letter conversion
  42 .Sh LIBRARY
  43 .Lb libc
  44 .Sh SYNOPSIS
  45 .In ctype.h
  46 .Ft int
  47 .Fo toupper
  48 .Fa "int c"
  49 .Fc
  50 .In ctype.h
  51 .In xlocale.h
  52 .Ft int
  53 .Fo toupper_l
  54 .Fa "int c"
  55 .Fa "locale_t loc"
  56 .Fc
  57 .Sh DESCRIPTION
  58 The
  59 .Fn toupper
  60 function converts a lower-case letter to the corresponding
  61 upper-case letter.
  62 The argument must be representable as an
  63 .Vt "unsigned char"
  64 or the value of
  65 .Dv EOF .
  66 .Pp
  67 Although the
  68 .Fn toupper
  69 function uses the current locale, the
  70 .Fn toupper_l
  71 function may be passed a locale directly. See
  72 .Xr xlocale 3
  73 for more information.
  74 .Sh RETURN VALUES
  75 If the argument is a lower-case letter, the
  76 .Fn toupper
  77 function returns the corresponding upper-case letter if there is
  78 one; otherwise, the argument is returned unchanged.
  79 .Sh COMPATIBILITY
  80 The
  81 .Bx 4.4
  82 extension of accepting arguments outside of the range of the
  83 .Vt "unsigned char"
  84 type in locales with large character sets is considered obsolete
  85 and may not be supported in future releases.
  86 The
  87 .Fn towupper
  88 function should be used instead.
  89 .Sh SEE ALSO
  90 .Xr ctype 3 ,
  91 .Xr isupper 3 ,
  92 .Xr towupper 3 ,
  93 .Xr xlocale 3
  94 .Sh STANDARDS
  95 The
  96 .Fn toupper
  97 function conforms to
  98 .St -isoC .