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