freebsd-dev/lib/libc/locale/toupper.3

.\" Copyright (c) 1989, 1991, 1993
.\"	The Regents of the University of California.  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.
.\" 4. 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.
.\"
.\"	@(#)toupper.3	8.1 (Berkeley) 6/4/93
.\" $FreeBSD$
.\"
.Dd July 25, 2010
.Dt TOUPPER 3
.Os
.Sh NAME
.Nm toupper
.Nd lower case to upper case letter conversion
.Sh LIBRARY
.Lb libc
.Sh SYNOPSIS
.In ctype.h
.Ft int
.Fn toupper "int c"
.Sh DESCRIPTION
The
.Fn toupper
function converts a lower-case letter to the corresponding
upper-case letter.
The argument must be representable as an
.Vt "unsigned char"
or the value of
.Dv EOF .
.Sh RETURN VALUES
If the argument is a lower-case letter, the
.Fn toupper
function returns the corresponding upper-case letter if there is
one; otherwise, the argument is returned unchanged.
.Sh COMPATIBILITY
The
.Bx 4.4
extension of accepting arguments outside of the range of the
.Vt "unsigned char"
type in locales with large character sets is considered obsolete
and may not be supported in future releases.
The
.Fn towupper
function should be used instead.
.Sh SEE ALSO
.Xr ctype 3 ,
.Xr isupper 3 ,
.Xr towupper 3
.Sh STANDARDS
The
.Fn toupper
function conforms to
.St -isoC .
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.\" Copyright (c) 1989, 1991, 1993`
			`.\" The Regents of the University of California. 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.`
			`.\" 4. 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.`
			`.\"`
			`.\" @(#)toupper.3 8.1 (Berkeley) 6/4/93`
$Id$ -> $FreeBSD$ 1999-08-28 00:22:10 +00:00			`.\" $FreeBSD$`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.\"`
Apply a small grammar fix to {toupper,tolower}(3). PR: docs/140458 Submitted by: Jeremy Huddleston (Jeremyhu at apple dot com) MFC after: 5 days 2010-07-25 13:32:19 +00:00			`.Dd July 25, 2010`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Dt TOUPPER 3`
			`.Os`
			`.Sh NAME`
			`.Nm toupper`
			`.Nd lower case to upper case letter conversion`
Introduce ".Lb" macro to libc manpages. More libraries manpages updates following. 2000-04-21 09:42:15 +00:00			`.Sh LIBRARY`
			`.Lb libc`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Sh SYNOPSIS`
mdoc(7) police: Use the new .In macro for #include statements. 2001-10-01 16:09:29 +00:00			`.In ctype.h`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Ft int`
			`.Fn toupper "int c"`
			`.Sh DESCRIPTION`
			`The`
			`.Fn toupper`
Remove whitespace at EOL. 2001-07-15 07:53:42 +00:00			`function converts a lower-case letter to the corresponding`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`upper-case letter.`
Remove confusing "single C char locales" phrase; arguments to tolower() and toupper() must now be either an unsigned char or EOF, regardless of locale. 2005-07-17 03:37:00 +00:00			`The argument must be representable as an`
-mdoc sweep. 2005-11-17 13:00:00 +00:00			`.Vt "unsigned char"`
Describe agrument range correctly, according to multibyte(3) Remove unneded comment 2000-07-03 13:03:15 +00:00			`or the value of`
			`.Dv EOF .`
			`.Sh RETURN VALUES`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`If the argument is a lower-case letter, the`
			`.Fn toupper`
			`function returns the corresponding upper-case letter if there is`
Apply a small grammar fix to {toupper,tolower}(3). PR: docs/140458 Submitted by: Jeremy Huddleston (Jeremyhu at apple dot com) MFC after: 5 days 2010-07-25 13:32:19 +00:00			`one; otherwise, the argument is returned unchanged.`
Point out that although toupper() and tolower() really accept rune_t's and not just unsigned char's, callers should use towupper() and towlower() instead when working with wide characters if portability is a concern. 2002-10-03 11:14:00 +00:00			`.Sh COMPATIBILITY`
Re-word compatibility section, taking care to use the word "obsolete" to describe the 4.4BSD extension of accepting characters (runes) outside of the range of unsigned char. 2004-08-21 07:37:08 +00:00			`The`
Point out that although toupper() and tolower() really accept rune_t's and not just unsigned char's, callers should use towupper() and towlower() instead when working with wide characters if portability is a concern. 2002-10-03 11:14:00 +00:00			`.Bx 4.4`
Re-word compatibility section, taking care to use the word "obsolete" to describe the 4.4BSD extension of accepting characters (runes) outside of the range of unsigned char. 2004-08-21 07:37:08 +00:00			`extension of accepting arguments outside of the range of the`
			`.Vt "unsigned char"`
			`type in locales with large character sets is considered obsolete`
			`and may not be supported in future releases.`
			`The`
Point out that although toupper() and tolower() really accept rune_t's and not just unsigned char's, callers should use towupper() and towlower() instead when working with wide characters if portability is a concern. 2002-10-03 11:14:00 +00:00			`.Fn towupper`
Re-word compatibility section, taking care to use the word "obsolete" to describe the 4.4BSD extension of accepting characters (runes) outside of the range of unsigned char. 2004-08-21 07:37:08 +00:00			`function should be used instead.`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Sh SEE ALSO`
Replaced bogus cross references by the usual one for the ctype family (ctype(3)). 2002-01-11 15:39:50 +00:00			`.Xr ctype 3 ,`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Xr isupper 3 ,`
Point out that although toupper() and tolower() really accept rune_t's and not just unsigned char's, callers should use towupper() and towlower() instead when working with wide characters if portability is a concern. 2002-10-03 11:14:00 +00:00			`.Xr towupper 3`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Sh STANDARDS`
			`The`
Correct what seem to me to be some mistakes in the references and standards sections. Also add a missing `,' to each file. 1995-12-28 21:06:07 +00:00			`.Fn toupper`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`function conforms to`
.St -ansiC -> .St -isoC 2001-02-26 13:23:47 +00:00			`.St -isoC .`