locales, libconv: Sync with FreeBSD (extensive reach)
[dragonfly.git] / lib / libc / locale / islower.3
1 .\" Copyright (c) 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 .\"     @(#)islower.3   8.1 (Berkeley) 6/4/93
33 .\" $FreeBSD: head/lib/libc/locale/islower.3 238920 2012-07-30 21:02:44Z joel $
34 .\"
35 .Dd July 30, 2012
36 .Dt ISLOWER 3
37 .Os
38 .Sh NAME
39 .Nm islower
40 .Nd lower-case character test
41 .Sh LIBRARY
42 .Lb libc
43 .Sh SYNOPSIS
44 .In ctype.h
45 .Ft int
46 .Fn islower "int c"
47 .Ft int
48 .Fn islower_l "int c" "locale_t loc"
49 .Sh DESCRIPTION
50 The
51 .Fn islower
52 function tests for any lower-case letters.
53 The value of the argument must be representable as an
54 .Vt "unsigned char"
55 or the value of
56 .Dv EOF .
57 .Pp
58 In the ASCII character set, this includes the following characters
59 (with their numeric values shown in octal):
60 .Bl -column \&000_``0''__ \&000_``0''__ \&000_``0''__ \&000_``0''__ \&000_``0''__
61 .It "\&141\ ``a''" Ta "142\ ``b''" Ta "143\ ``c''" Ta "144\ ``d''" Ta "145\ ``e''"
62 .It "\&146\ ``f''" Ta "147\ ``g''" Ta "150\ ``h''" Ta "151\ ``i''" Ta "152\ ``j''"
63 .It "\&153\ ``k''" Ta "154\ ``l''" Ta "155\ ``m''" Ta "156\ ``n''" Ta "157\ ``o''"
64 .It "\&160\ ``p''" Ta "161\ ``q''" Ta "162\ ``r''" Ta "163\ ``s''" Ta "164\ ``t''"
65 .It "\&165\ ``u''" Ta "166\ ``v''" Ta "167\ ``w''" Ta "170\ ``x''" Ta "171\ ``y''"
66 .It "\&172\ ``z''" Ta \& Ta \& Ta \& Ta \&
67 .El
68 The
69 .Fn islower_l
70 function takes an explicit locale argument, whereas the
71 .Fn islower
72 function uses the current global or per-thread locale.
73 .Sh RETURN VALUES
74 The
75 .Fn islower
76 and
77 .Fn islower_l
78 functions return zero if the character tests false and
79 return non-zero if the character tests true.
80 .Sh COMPATIBILITY
81 The
82 .Bx 4.4
83 extension of accepting arguments outside of the range of the
84 .Vt "unsigned char"
85 type in locales with large character sets is considered obsolete
86 and may not be supported in future releases.
87 The
88 .Fn iswlower
89 function should be used instead.
90 .Sh SEE ALSO
91 .Xr ctype 3 ,
92 .Xr iswlower 3 ,
93 .Xr tolower 3 ,
94 .Xr ascii 7
95 .Sh STANDARDS
96 The
97 .Fn islower
98 function conforms to
99 .St -isoC .
100 The
101 .Fn islower_l
102 function conforms to
103 .St -p1003.1-2008 .