xref: /freebsd/lib/libc/locale/toupper.3 (revision 734e82fe33aa764367791a7d603b383996c6b40b)
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.\" 3. 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.\"
34.Dd December 19, 2022
35.Dt TOUPPER 3
36.Os
37.Sh NAME
38.Nm toupper ,
39.Nm toupper_l
40.Nd lower case to upper case letter conversion
41.Sh LIBRARY
42.Lb libc
43.Sh SYNOPSIS
44.In ctype.h
45.Ft int
46.Fn toupper "int c"
47.Ft int
48.Fn toupper_l "int c" "locale_t loc"
49.Sh DESCRIPTION
50The
51.Fn toupper
52and
53.Fn toupper_l
54functions convert a lower-case letter to the corresponding
55upper-case letter.
56The argument must be representable as an
57.Vt "unsigned char"
58or the value of
59.Dv EOF .
60.Pp
61The
62.Fn toupper_l
63function takes an explicit locale argument, whereas the
64.Fn toupper
65function uses the current global or per-thread locale.
66.Sh RETURN VALUES
67If the argument is a lower-case letter, the
68.Fn toupper
69and
70.Fn toupper_l
71functions return the corresponding upper-case letter if there is
72one; otherwise, the argument is returned unchanged.
73.Sh COMPATIBILITY
74The
75.Bx 4.4
76extension of accepting arguments outside of the range of the
77.Vt "unsigned char"
78type in locales with large character sets is considered obsolete
79and may not be supported in future releases.
80The
81.Fn towupper
82or
83.Fn towupper_l
84function should be used instead.
85.Sh SEE ALSO
86.Xr ctype 3 ,
87.Xr ctype_l 3 ,
88.Xr isupper 3 ,
89.Xr isupper_l 3 ,
90.Xr towupper 3 ,
91.Xr towupper_l 3 ,
92.Xr xlocale 3
93.Sh STANDARDS
94The
95.Fn toupper
96function conforms to
97.St -isoC .
98