xref: /minix/lib/libc/gen/isspace.3 (revision ebfedea0)
1.\"	$NetBSD: isspace.3,v 1.15 2012/10/03 19:28:44 wiz Exp $
2.\"
3.\" Copyright (c) 1991 The Regents of the University of California.
4.\" All rights reserved.
5.\"
6.\" This code is derived from software contributed to Berkeley by
7.\" the American National Standards Committee X3, on Information
8.\" Processing Systems.
9.\"
10.\" Redistribution and use in source and binary forms, with or without
11.\" modification, are permitted provided that the following conditions
12.\" are met:
13.\" 1. Redistributions of source code must retain the above copyright
14.\"    notice, this list of conditions and the following disclaimer.
15.\" 2. Redistributions in binary form must reproduce the above copyright
16.\"    notice, this list of conditions and the following disclaimer in the
17.\"    documentation and/or other materials provided with the distribution.
18.\" 3. Neither the name of the University nor the names of its contributors
19.\"    may be used to endorse or promote products derived from this software
20.\"    without specific prior written permission.
21.\"
22.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32.\" SUCH DAMAGE.
33.\"
34.\"     @(#)isspace.3	5.3 (Berkeley) 7/31/91
35.\"
36.Dd April 17, 2008
37.Dt ISSPACE 3
38.Os
39.Sh NAME
40.Nm isspace
41.Nd white-space character test
42.Sh LIBRARY
43.Lb libc
44.Sh SYNOPSIS
45.In ctype.h
46.Ft int
47.Fn isspace "int c"
48.Sh DESCRIPTION
49The
50.Fn isspace
51function tests for the standard white-space characters
52.\" or for any
53.\" of an implementation-defined set of characters
54for which
55.Xr isalnum 3
56is false.
57The standard white-space characters are the following:
58.Pp
59.Bl -tag -width xxxxx -offset indent -compact
60.It Sq \0
61Space character.
62.It Li \ef
63Form feed.
64.It Li \en
65New-line.
66.It Li \er
67Carriage return.
68.It Li \et
69Horizontal tab.
70.It Li \ev
71Vertical tab.
72.El
73.Pp
74In the
75.Em ``C''
76locale,
77.Fn isspace
78returns true only for the standard white-space characters.
79.Sh RETURN VALUES
80The
81.Fn isspace
82function returns zero if the character tests false and
83returns non-zero if the character tests true.
84.Sh SEE ALSO
85.Xr ctype 3 ,
86.Xr isalnum 3 ,
87.Xr isalpha 3 ,
88.Xr isascii 3 ,
89.Xr isblank 3 ,
90.Xr iscntrl 3 ,
91.Xr isdigit 3 ,
92.Xr isgraph 3 ,
93.Xr islower 3 ,
94.Xr isprint 3 ,
95.Xr ispunct 3 ,
96.Xr isupper 3 ,
97.Xr isxdigit 3 ,
98.Xr stdio 3 ,
99.Xr toascii 3 ,
100.Xr tolower 3 ,
101.Xr toupper 3 ,
102.Xr ascii 7
103.Sh STANDARDS
104The
105.Fn isspace
106function conforms to
107.St -ansiC .
108.Sh CAVEATS
109The argument to
110.Fn isspace
111must be
112.Dv EOF
113or representable as an
114.Vt unsigned char ;
115otherwise, the behavior is undefined.
116See the
117.Sx CAVEATS
118section of
119.Xr ctype 3
120for more details.
121