xref: /dragonfly/lib/libc/locale/toupper.3 (revision 19b217af)
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: head/lib/libc/locale/toupper.3 210468 2010-07-25 13:32:19Z bcr $
34.\"
35.Dd July 25, 2010
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.Fn toupper "int c"
48.In ctype.h
49.In xlocale.h
50.Ft int
51.Fn toupper_l "int c" "locale_t loc"
52.Sh DESCRIPTION
53The
54.Fn toupper
55function converts a lower-case letter to the corresponding
56upper-case letter.
57The argument must be representable as an
58.Vt "unsigned char"
59or the value of
60.Dv EOF .
61.Pp
62The _l-suffixed version takes an explicit locale argument, whereas the
63non-suffixed version uses the current global or per-thread locale.
64.Sh RETURN VALUES
65If the argument is a lower-case letter, the
66.Fn toupper
67function returns the corresponding upper-case letter if there is
68one; otherwise, the argument is returned unchanged.
69.Sh COMPATIBILITY
70The
71.Bx 4.4
72extension of accepting arguments outside of the range of the
73.Vt "unsigned char"
74type in locales with large character sets is considered obsolete
75and may not be supported in future releases.
76The
77.Fn towupper
78function should be used instead.
79.Sh SEE ALSO
80.Xr ctype 3 ,
81.Xr ctype_l 3 ,
82.Xr isupper 3 ,
83.Xr towupper 3 ,
84.Xr xlocale 3
85.Sh STANDARDS
86The
87.Fn toupper
88function conforms to
89.St -isoC .
90