Correct BSD License clause numbering from 1-2-4 to 1-2-3.
[dragonfly.git] / lib / libc / locale / isgraph.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 .\" 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 .\"     @(#)isgraph.3   8.2 (Berkeley) 12/11/93
33 .\" $FreeBSD: head/lib/libc/locale/isgraph.3 238919 2012-07-30 20:56:19Z issyl0 $
34 .\"
35 .Dd December 25, 2013
36 .Dt ISGRAPH 3
37 .Os
38 .Sh NAME
39 .Nm isgraph ,
40 .Nm isgraph_l
41 .Nd printing character test (space character exclusive)
42 .Sh LIBRARY
43 .Lb libc
44 .Sh SYNOPSIS
45 .In ctype.h
46 .Ft int
47 .Fn isgraph "int c"
48 .Ft int
49 .Fn isgraph_l "int c" "locale_t locale"
50 .Sh DESCRIPTION
51 The
52 .Fn isgraph
53 and
54 .Fn isgraph_l
55 functions test for any printing character except space
56 .Pq Ql "\~"
57 and other
58 locale-specific space-like characters.
59 The value of the argument must be representable as an
60 .Vt "unsigned char"
61 or the value of
62 .Dv EOF .
63 .Pp
64 In the ASCII character set, this includes the following characters
65 (with their numeric values shown in octal):
66 .Bl -column \&000_``0''__ \&000_``0''__ \&000_``0''__ \&000_``0''__ \&000_``0''__
67 .It "\&041\ ``!''" Ta "042\ ``""''" Ta "043\ ``#''" Ta "044\ ``$''" Ta "045\ ``%''"
68 .It "\&046\ ``&''" Ta "047\ ``'''" Ta "050\ ``(''" Ta "051\ ``)''" Ta "052\ ``*''"
69 .It "\&053\ ``+''" Ta "054\ ``,''" Ta "055\ ``-''" Ta "056\ ``.''" Ta "057\ ``/''"
70 .It "\&060\ ``0''" Ta "061\ ``1''" Ta "062\ ``2''" Ta "063\ ``3''" Ta "064\ ``4''"
71 .It "\&065\ ``5''" Ta "066\ ``6''" Ta "067\ ``7''" Ta "070\ ``8''" Ta "071\ ``9''"
72 .It "\&072\ ``:''" Ta "073\ ``;''" Ta "074\ ``<''" Ta "075\ ``=''" Ta "076\ ``>''"
73 .It "\&077\ ``?''" Ta "100\ ``@''" Ta "101\ ``A''" Ta "102\ ``B''" Ta "103\ ``C''"
74 .It "\&104\ ``D''" Ta "105\ ``E''" Ta "106\ ``F''" Ta "107\ ``G''" Ta "110\ ``H''"
75 .It "\&111\ ``I''" Ta "112\ ``J''" Ta "113\ ``K''" Ta "114\ ``L''" Ta "115\ ``M''"
76 .It "\&116\ ``N''" Ta "117\ ``O''" Ta "120\ ``P''" Ta "121\ ``Q''" Ta "122\ ``R''"
77 .It "\&123\ ``S''" Ta "124\ ``T''" Ta "125\ ``U''" Ta "126\ ``V''" Ta "127\ ``W''"
78 .It "\&130\ ``X''" Ta "131\ ``Y''" Ta "132\ ``Z''" Ta "133\ ``[''" Ta "134\ ``\e\|''"
79 .It "\&135\ ``]''" Ta "136\ ``^''" Ta "137\ ``_''" Ta "140\ ```''" Ta "141\ ``a''"
80 .It "\&142\ ``b''" Ta "143\ ``c''" Ta "144\ ``d''" Ta "145\ ``e''" Ta "146\ ``f''"
81 .It "\&147\ ``g''" Ta "150\ ``h''" Ta "151\ ``i''" Ta "152\ ``j''" Ta "153\ ``k''"
82 .It "\&154\ ``l''" Ta "155\ ``m''" Ta "156\ ``n''" Ta "157\ ``o''" Ta "160\ ``p''"
83 .It "\&161\ ``q''" Ta "162\ ``r''" Ta "163\ ``s''" Ta "164\ ``t''" Ta "165\ ``u''"
84 .It "\&166\ ``v''" Ta "167\ ``w''" Ta "170\ ``x''" Ta "171\ ``y''" Ta "172\ ``z''"
85 .It "\&173\ ``{''" Ta "174\ ``|''" Ta "175\ ``}''" Ta "176\ ``~''" Ta \&
86 .El
87 .Pp
88 The
89 .Fn isgraph_l
90 function takes an explicit
91 .Fa locale
92 argument, whereas the
93 .Fn isgraph
94 function uses the current global or per-thread locale.
95 .Sh RETURN VALUES
96 The
97 .Fn isgraph
98 and
99 .Fn isgraph_l
100 functions return zero if the character tests false and
101 return non-zero if the character tests true.
102 .Sh COMPATIBILITY
103 The
104 .Bx 4.4
105 extension of accepting arguments outside of the range of the
106 .Vt "unsigned char"
107 type in locales with large character sets is considered obsolete
108 and may not be supported in future releases.
109 The
110 .Fn iswgraph
111 and
112 .Fn iswgraph_l
113 functions should be used instead.
114 .Sh SEE ALSO
115 .Xr ctype 3 ,
116 .Xr ctype_l 3 ,
117 .Xr iswgraph 3 ,
118 .Xr iswgraph_l 3 ,
119 .Xr xlocale 3 ,
120 .Xr ascii 7
121 .Sh STANDARDS
122 The
123 .Fn isgraph
124 function conforms to
125 .St -isoC .
126 The
127 .Fn isgraph_l
128 function conforms to
129 .St -p1003.1-2008 .