NetBSD/lib/libc/gen/isspace.3

.\"	$NetBSD: isspace.3,v 1.15 2012/10/03 19:28:44 wiz Exp $
.\"
.\" Copyright (c) 1991 The Regents of the University of California.
.\" All rights reserved.
.\"
.\" This code is derived from software contributed to Berkeley by
.\" the American National Standards Committee X3, on Information
.\" Processing Systems.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"     @(#)isspace.3	5.3 (Berkeley) 7/31/91
.\"
.Dd April 17, 2008
.Dt ISSPACE 3
.Os
.Sh NAME
.Nm isspace
.Nd white-space character test
.Sh LIBRARY
.Lb libc
.Sh SYNOPSIS
.In ctype.h
.Ft int
.Fn isspace "int c"
.Sh DESCRIPTION
The
.Fn isspace
function tests for the standard white-space characters
.\" or for any
.\" of an implementation-defined set of characters
for which
.Xr isalnum 3
is false.
The standard white-space characters are the following:
.Pp
.Bl -tag -width xxxxx -offset indent -compact
.It Sq \0
Space character.
.It Li \ef
Form feed.
.It Li \en
New-line.
.It Li \er
Carriage return.
.It Li \et
Horizontal tab.
.It Li \ev
Vertical tab.
.El
.Pp
In the
.Em ``C''
locale,
.Fn isspace
returns true only for the standard white-space characters.
.Sh RETURN VALUES
The
.Fn isspace
function returns zero if the character tests false and
returns non-zero if the character tests true.
.Sh SEE ALSO
.Xr ctype 3 ,
.Xr isalnum 3 ,
.Xr isalpha 3 ,
.Xr isascii 3 ,
.Xr isblank 3 ,
.Xr iscntrl 3 ,
.Xr isdigit 3 ,
.Xr isgraph 3 ,
.Xr islower 3 ,
.Xr isprint 3 ,
.Xr ispunct 3 ,
.Xr isupper 3 ,
.Xr isxdigit 3 ,
.Xr stdio 3 ,
.Xr toascii 3 ,
.Xr tolower 3 ,
.Xr toupper 3 ,
.Xr ascii 7
.Sh STANDARDS
The
.Fn isspace
function conforms to
.St -ansiC .
.Sh CAVEATS
The argument to
.Fn isspace
must be
.Dv EOF
or representable as an
.Vt unsigned char ;
otherwise, the behavior is undefined.
See the
.Sx CAVEATS
section of
.Xr ctype 3
for more details.
Improve wording. From Bug Hunting. 2012-10-03 23:28:44 +04:00			`.\" $NetBSD: isspace.3,v 1.15 2012/10/03 19:28:44 wiz Exp $`
merge with Lite, keeping local changes. Fix up Id format, etc. 1995-02-27 07:34:47 +03:00			`.\"`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.\" Copyright (c) 1991 The Regents of the University of California.`
			`.\" All rights reserved.`
			`.\"`
			`.\" This code is derived from software contributed to Berkeley by`
			`.\" the American National Standards Committee X3, on Information`
			`.\" Processing Systems.`
			`.\"`
			`.\" Redistribution and use in source and binary forms, with or without`
			`.\" modification, are permitted provided that the following conditions`
			`.\" are met:`
			`.\" 1. Redistributions of source code must retain the above copyright`
			`.\" notice, this list of conditions and the following disclaimer.`
			`.\" 2. Redistributions in binary form must reproduce the above copyright`
			`.\" notice, this list of conditions and the following disclaimer in the`
			`.\" documentation and/or other materials provided with the distribution.`
Move UCB-licensed code from 4-clause to 3-clause licence. Patches provided by Joel Baker in PR 22280, verified by myself. 2003-08-07 20:42:00 +04:00			`.\" 3. Neither the name of the University nor the names of its contributors`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.\" may be used to endorse or promote products derived from this software`
			`.\" without specific prior written permission.`
			`.\"`
			.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
			`.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE`
			`.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE`
			`.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE`
			`.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL`
			`.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS`
			`.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)`
			`.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT`
			`.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY`
			`.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF`
			`.\" SUCH DAMAGE.`
			`.\"`
merge with Lite, keeping local changes. Fix up Id format, etc. 1995-02-27 07:34:47 +03:00			`.\" @(#)isspace.3 5.3 (Berkeley) 7/31/91`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.\"`
Refer to the CAVEATS section of ctype(3) for more information. 2008-04-17 20:25:36 +04:00			`.Dd April 17, 2008`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Dt ISSPACE 3`
			`.Os`
			`.Sh NAME`
			`.Nm isspace`
			`.Nd white-space character test`
add LIBRARY section to man page 1998-02-05 21:45:17 +03:00			`.Sh LIBRARY`
			`.Lb libc`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Sh SYNOPSIS`
Use .In header.h instead of .Fd #include \[Lt]header.h\[Gt] Much easier to read and write, and supported by groff for ages. Okayed by ross. 2003-04-16 17:34:34 +04:00			`.In ctype.h`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Ft int`
			`.Fn isspace "int c"`
			`.Sh DESCRIPTION`
			`The`
			`.Fn isspace`
			`function tests for the standard white-space characters`
			`.\" or for any`
			`.\" of an implementation-defined set of characters`
			`for which`
			`.Xr isalnum 3`
			`is false.`
			`The standard white-space characters are the following:`
			`.Pp`
			`.Bl -tag -width xxxxx -offset indent -compact`
			`.It Sq \0`
			`Space character.`
			`.It Li \ef`
			`Form feed.`
			`.It Li \en`
			`New-line.`
			`.It Li \er`
			`Carriage return.`
			`.It Li \et`
			`Horizontal tab.`
			`.It Li \ev`
Improve wording. From Bug Hunting. 2012-10-03 23:28:44 +04:00			`Vertical tab.`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.El`
			`.Pp`
Boring whitespace fixes. 2001-09-16 06:30:23 +04:00			`In the`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			.Em ``C''
			`locale,`
			`.Fn isspace`
			`returns true only for the standard white-space characters.`
			`.Sh RETURN VALUES`
			`The`
			`.Fn isspace`
Fixed the wording of the <ctype.h> character classification functions by always using "function" instead of "macro". Changed "undefined result" into "undefined behavior" for argument values outside the valid range. Since the character table is allocated via malloc(), it _may_ happen that it starts at a page boundary, so that negative values for the argument result in a segmentation fault. In that case, there is no result at all. 2006-10-06 02:34:52 +04:00			`function returns zero if the character tests false and`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`returns non-zero if the character tests true.`
			`.Sh SEE ALSO`
Added a reference to ctype.3. What's the value of having that page at all if it isn't referenced by others? Suggested by Slava Semushin via private mail. 2007-01-18 11:35:07 +03:00			`.Xr ctype 3 ,`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Xr isalnum 3 ,`
			`.Xr isalpha 3 ,`
Make sure all items in SEE ALSO list are comma separated. Add cross references to isblank(). 1993-10-15 03:58:52 +03:00			`.Xr isascii 3 ,`
			`.Xr isblank 3 ,`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Xr iscntrl 3 ,`
			`.Xr isdigit 3 ,`
			`.Xr isgraph 3 ,`
			`.Xr islower 3 ,`
			`.Xr isprint 3 ,`
			`.Xr ispunct 3 ,`
			`.Xr isupper 3 ,`
			`.Xr isxdigit 3 ,`
Standardize section headers, sort sections, sort SEE ALSO, punctuation and misc. fixes. 2001-09-16 06:57:03 +04:00			`.Xr stdio 3 ,`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Xr toascii 3 ,`
			`.Xr tolower 3 ,`
			`.Xr toupper 3 ,`
			`.Xr ascii 7`
			`.Sh STANDARDS`
			`The`
			`.Fn isspace`
			`function conforms to`
			`.St -ansiC .`
import CAVEATS sections from OpenBSD. with little tweak by me. 2002-07-10 18:37:12 +04:00			`.Sh CAVEATS`
			`The argument to`
			`.Fn isspace`
			`must be`
			`.Dv EOF`
			`or representable as an`
Refer to the CAVEATS section of ctype(3) for more information. 2008-04-17 20:25:36 +04:00			`.Vt unsigned char ;`
Fixed the wording of the <ctype.h> character classification functions by always using "function" instead of "macro". Changed "undefined result" into "undefined behavior" for argument values outside the valid range. Since the character table is allocated via malloc(), it _may_ happen that it starts at a page boundary, so that negative values for the argument result in a segmentation fault. In that case, there is no result at all. 2006-10-06 02:34:52 +04:00			`otherwise, the behavior is undefined.`
Refer to the CAVEATS section of ctype(3) for more information. 2008-04-17 20:25:36 +04:00			`See the`
			`.Sx CAVEATS`
			`section of`
			`.Xr ctype 3`
			`for more details.`