1.\"	$OpenBSD: ispunct.3,v 1.12 2017/09/05 03:16:13 schwarze Exp $
2.\"
3.\" Copyright (c) 1991 The Regents of the University of California.
4.\" Copyright (c) 2017 Ingo Schwarze <schwarze@openbsd.org>
5.\" All rights reserved.
6.\"
7.\" This code is derived from software contributed to Berkeley by
8.\" the American National Standards Committee X3, on Information
9.\" Processing Systems.
10.\"
11.\" Redistribution and use in source and binary forms, with or without
12.\" modification, are permitted provided that the following conditions
13.\" are met:
14.\" 1. Redistributions of source code must retain the above copyright
15.\"    notice, this list of conditions and the following disclaimer.
16.\" 2. Redistributions in binary form must reproduce the above copyright
17.\"    notice, this list of conditions and the following disclaimer in the
18.\"    documentation and/or other materials provided with the distribution.
19.\" 3. Neither the name of the University nor the names of its contributors
20.\"    may be used to endorse or promote products derived from this software
21.\"    without specific prior written permission.
22.\"
23.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33.\" SUCH DAMAGE.
34.\"
35.Dd $Mdocdate: September 5 2017 $
36.Dt ISPUNCT 3
37.Os
38.Sh NAME
39.Nm ispunct ,
40.Nm ispunct_l
41.Nd punctuation single-byte character test
42.Sh SYNOPSIS
43.In ctype.h
44.Ft int
45.Fn ispunct "int c"
46.Ft int
47.Fn ispunct_l "int c" "locale_t locale"
48.Sh DESCRIPTION
49The
50.Fn ispunct
51and
52.Fn ispunct_l
53test for any punctuation characters.
54.Pp
55In the C locale, the complete list of punctuation characters is:
56.Pp
57.Dl !\(dq#$%&\(aq()*+,\-./:;<=>?@[\e]\(ha_\(ga{|}\(ti
58.Pp
59These are all characters for which
60.Xr isgraph 3
61is true but
62.Xr isalnum 3
63is not.
64.Ox
65always uses the C locale for these functions,
66ignoring the global locale, the thread-specific locale, and the
67.Fa locale
68argument.
69.Sh RETURN VALUES
70These functions return zero if the character tests false or
71non-zero if the character tests true.
72.Sh ENVIRONMENT
73On systems supporting non-ASCII single-byte character encodings,
74results of these functions may differ, and the results of
75.Fn ispunct
76may depend on the
77.Ev LC_CTYPE
78.Xr locale 1 .
79.Sh SEE ALSO
80.Xr isalnum 3 ,
81.Xr isalpha 3 ,
82.Xr isascii 3 ,
83.Xr isblank 3 ,
84.Xr iscntrl 3 ,
85.Xr isdigit 3 ,
86.Xr isgraph 3 ,
87.Xr islower 3 ,
88.Xr isprint 3 ,
89.Xr isspace 3 ,
90.Xr isupper 3 ,
91.Xr iswpunct 3 ,
92.Xr isxdigit 3 ,
93.Xr stdio 3 ,
94.Xr toascii 3 ,
95.Xr tolower 3 ,
96.Xr toupper 3 ,
97.Xr ascii 7
98.Sh STANDARDS
99The
100.Fn ispunct
101function conforms to
102.St -ansiC ,
103and
104.Fn ispunct_l
105to
106.St -p1003.1-2008 .
107.Sh HISTORY
108The
109.Fn ispunct
110function first appeared in
111.At v7 ,
112and
113.Fn ispunct_l
114has been available since
115.Ox 6.2 .
116.Sh CAVEATS
117The argument
118.Fa c
119must be
120.Dv EOF
121or representable as an
122.Li unsigned char ;
123otherwise, the result is undefined.
124