lib/libc/gen/toupper.3

   1 .\"     $NetBSD: toupper.3,v 1.17 2008/04/17 16:25:36 apb Exp $
   2 .\"
   3 .\" Copyright (c) 1989, 1991 The Regents of the University of California.
   4 .\" All rights reserved.
   5 .\"
   6 .\" This code is derived from software contributed to Berkeley by
   7 .\" the American National Standards Committee X3, on Information
   8 .\" Processing Systems.
   9 .\"
  10 .\" Redistribution and use in source and binary forms, with or without
  11 .\" modification, are permitted provided that the following conditions
  12 .\" are met:
  13 .\" 1. Redistributions of source code must retain the above copyright
  14 .\"    notice, this list of conditions and the following disclaimer.
  15 .\" 2. Redistributions in binary form must reproduce the above copyright
  16 .\"    notice, this list of conditions and the following disclaimer in the
  17 .\"    documentation and/or other materials provided with the distribution.
  18 .\" 3. 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 .\"     @(#)toupper.3   5.2 (Berkeley) 6/29/91
  35 .\"
  36 .Dd April 17, 2008
  37 .Dt TOUPPER 3
  38 .Os
  39 .Sh NAME
  40 .Nm toupper
  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 .Fn toupper "int c"
  48 .Sh DESCRIPTION
  49 The
  50 .Fn toupper
  51 function converts a lower-case letter to the corresponding
  52 upper-case letter.
  53 .Sh RETURN VALUES
  54 If the argument is a lower-case letter, the
  55 .Fn toupper
  56 function returns the corresponding upper-case letter if there is
  57 one; otherwise the argument is returned unchanged.
  58 .\" In the
  59 .\" .Em ``C''
  60 .\" locale,
  61 .\" .Fn toupper
  62 .\" maps only the characters for which
  63 .\" .Xr islower
  64 .\" is true to the corresponding characters for which
  65 .\" .Xr isupper
  66 .\" is true.
  67 .Sh SEE ALSO
  68 .Xr ctype 3 ,
  69 .Xr isalnum 3 ,
  70 .Xr isalpha 3 ,
  71 .Xr isascii 3 ,
  72 .Xr iscntrl 3 ,
  73 .Xr isdigit 3 ,
  74 .Xr isgraph 3 ,
  75 .Xr islower 3 ,
  76 .Xr isprint 3 ,
  77 .Xr ispunct 3 ,
  78 .Xr isspace 3 ,
  79 .Xr isupper 3 ,
  80 .Xr isxdigit 3 ,
  81 .Xr stdio 3 ,
  82 .Xr toascii 3 ,
  83 .Xr ascii 7
  84 .Sh STANDARDS
  85 The
  86 .Fn toupper
  87 function conforms to
  88 .St -ansiC .
  89 .Sh CAVEATS
  90 The argument to
  91 .Fn toupper
  92 must be
  93 .Dv EOF
  94 or representable as an
  95 .Vt unsigned char ;
  96 otherwise, the behavior is undefined.
  97 See the
  98 .Sx CAVEATS
  99 section of
 100 .Xr ctype 3
 101 for more details.