.\"	$OpenBSD: toupper.3,v 1.16 2017/09/05 03:16:13 schwarze Exp $
.\"
.\" Copyright (c) 1989, 1991 The Regents of the University of California.
.\" Copyright (c) 2017 Ingo Schwarze <schwarze@openbsd.org>
.\" All rights reserved.
.\"
.\" This code is derived from software contributed to Berkeley by
.\" the American National Standards Committee X3, on Information
.\" Processing Systems.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.Dd $Mdocdate: September 5 2017 $
.Dt TOUPPER 3
.Os
.Sh NAME
.Nm toupper ,
.Nm toupper_l ,
.Nm _toupper
.Nd lower case to upper case letter conversion
.Sh SYNOPSIS
.In ctype.h
.Ft int
.Fn toupper "int c"
.Ft int
.Fn toupper_l "int c" "locale_t locale"
.Ft int
.Fn _toupper "int c"
.Sh DESCRIPTION
The
.Fn toupper
and
.Fn toupper_l
functions convert a lower-case letter to the corresponding
upper-case letter.
The
.Fn _toupper
function is identical to
.Fn toupper
except that
.Fa c
must be a lower-case letter.
.Pp
.Ox
always uses the C locale for these functions,
ignoring the global locale, the thread-specific locale, and the
.Fa locale
argument.
.Sh RETURN VALUES
If the argument to the
.Fn toupper
or
.Fn toupper_l
function is a lower-case letter, the corresponding upper-case letter
is returned if there is one; otherwise the argument is returned unchanged.
If the argument to the
.Fn _toupper
function is a lower-case letter, the corresponding upper-case letter
is returned; otherwise the output is undefined.
.Sh ENVIRONMENT
On systems supporting non-ASCII single-byte character encodings,
the results of
.Fn toupper
and
.Fn _toupper
may depend on the
.Ev LC_CTYPE
.Xr locale 1 .
.Sh SEE ALSO
.Xr isalnum 3 ,
.Xr isalpha 3 ,
.Xr isascii 3 ,
.Xr isblank 3 ,
.Xr iscntrl 3 ,
.Xr isdigit 3 ,
.Xr isgraph 3 ,
.Xr islower 3 ,
.Xr isprint 3 ,
.Xr ispunct 3 ,
.Xr isspace 3 ,
.Xr isupper 3 ,
.Xr isxdigit 3 ,
.Xr stdio 3 ,
.Xr toascii 3 ,
.Xr tolower 3 ,
.Xr towupper 3 ,
.Xr ascii 7
.Sh STANDARDS
The
.Fn toupper
function conforms to
.St -ansiC ,
and
.Fn toupper_l
to
.St -p1003.1-2008 .
.Sh HISTORY
The
.Fn toupper
function first appeared in
.At v7
and acquired the current semantics in
.At III ,
where
.Fn _toupper
first appeared.
.Pp
The
.Fn toupper_l
function has been available since
.Ox 6.2 .
.Sh CAVEATS
The argument
.Fa c
must be
.Dv EOF
or representable as an
.Li unsigned char ;
otherwise, the result is undefined.