freebsd-skq/lib/libc/locale/isblank.3

.\" Copyright (c) 1991, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" 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.
.\" 4. 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.
.\"
.\"     @(#)isblank.3	8.1 (Berkeley) 6/4/93
.\" $FreeBSD$
.\"
.Dd July 17, 2005
.Dt ISBLANK 3
.Os
.Sh NAME
.Nm isblank
.Nd space or tab character test
.Sh LIBRARY
.Lb libc
.Sh SYNOPSIS
.In ctype.h
.Ft int
.Fn isblank "int c"
.Sh DESCRIPTION
The
.Fn isblank
function tests for a space or tab character.
For any locale, this includes the following standard characters:
.Pp
.Bl -column \&`\et''___ \&``\et''___
.It "\&``\et''\t`` ''"
.El
.Pp
In the "C" locale
.Fn isblank
successful test is limited to this characters only.
The value of the argument must be representable as an
.Vt "unsigned char"
or the value of
.Dv EOF .
.Sh RETURN VALUES
The
.Fn isblank
function returns zero if the character tests false and
returns non-zero if the character tests true.
.Sh COMPATIBILITY
The
.Bx 4.4
extension of accepting arguments outside of the range of the
.Vt "unsigned char"
type in locales with large character sets is considered obsolete
and may not be supported in future releases.
The
.Fn iswblank
function should be used instead.
.Sh SEE ALSO
.Xr ctype 3 ,
.Xr iswblank 3 ,
.Xr ascii 7
.Sh STANDARDS
The
.Fn isblank
function
conforms to
.St -isoC-99 .
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.\" Copyright (c) 1991, 1993`
			`.\" The Regents of the University of California. All rights reserved.`
			`.\"`
			`.\" 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.`
			`.\" 4. 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.`
			`.\"`
			`.\" @(#)isblank.3 8.1 (Berkeley) 6/4/93`
$Id$ -> $FreeBSD$ 1999-08-28 00:22:10 +00:00			`.\" $FreeBSD$`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.\"`
Remove confusing "single C char locales" phrase; arguments to these functions and must now be either an unsigned char or EOF, regardless of locale. 2005-07-17 04:11:06 +00:00			`.Dd July 17, 2005`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Dt ISBLANK 3`
			`.Os`
			`.Sh NAME`
			`.Nm isblank`
			`.Nd space or tab character test`
Introduce ".Lb" macro to libc manpages. More libraries manpages updates following. 2000-04-21 09:42:15 +00:00			`.Sh LIBRARY`
			`.Lb libc`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Sh SYNOPSIS`
mdoc(7) police: Use the new .In macro for #include statements. 2001-10-01 16:09:29 +00:00			`.In ctype.h`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Ft int`
Don't use literal semicolons in .Fn macro invocations. 1997-04-13 12:55:36 +00:00			`.Fn isblank "int c"`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Sh DESCRIPTION`
			`The`
			`.Fn isblank`
			`function tests for a space or tab character.`
Clarify isblank range 2001-11-30 05:39:08 +00:00			`For any locale, this includes the following standard characters:`
			`.Pp`
			.Bl -column \&`\et''___ \&``\et''___
			.It "\&``\et''\t`` ''"
			`.El`
			`.Pp`
			`In the "C" locale`
			`.Fn isblank`
			`successful test is limited to this characters only.`
Remove confusing "single C char locales" phrase; arguments to these functions and must now be either an unsigned char or EOF, regardless of locale. 2005-07-17 04:11:06 +00:00			`The value of the argument must be representable as an`
-mdoc sweep. 2005-11-17 13:00:00 +00:00			`.Vt "unsigned char"`
Better wording according to multibyte(3) Better man formatting Add reference to multibyte(3) 2000-04-11 14:41:37 +00:00			`or the value of`
			`.Dv EOF .`
Sort sections. 2005-01-20 09:17:07 +00:00			`.Sh RETURN VALUES`
			`The`
			`.Fn isblank`
			`function returns zero if the character tests false and`
			`returns non-zero if the character tests true.`
Add a note to the Compatiblity section suggesting that these functions only be used for byte values. Add cross-references to the wide-char counterparts. 2002-10-06 10:15:38 +00:00			`.Sh COMPATIBILITY`
Re-word the COMPATIBILITY section, taking care to use the word "deprecated" to describe the 4.4BSD extension of accepting arguments outside the range of unsigned char. This gives us freedom to remove this extension when we remove the <rune.h> interface in FreeBSD 6. 2004-07-29 23:32:41 +00:00			`The`
Add a note to the Compatiblity section suggesting that these functions only be used for byte values. Add cross-references to the wide-char counterparts. 2002-10-06 10:15:38 +00:00			`.Bx 4.4`
Re-word the COMPATIBILITY section, taking care to use the word "deprecated" to describe the 4.4BSD extension of accepting arguments outside the range of unsigned char. This gives us freedom to remove this extension when we remove the <rune.h> interface in FreeBSD 6. 2004-07-29 23:32:41 +00:00			`extension of accepting arguments outside of the range of the`
			`.Vt "unsigned char"`
Re-word compatibility section, taking care to use the word "obsolete" to describe the 4.4BSD extension of accepting characters (runes) outside of the range of unsigned char. 2004-08-21 07:37:08 +00:00			`type in locales with large character sets is considered obsolete`
			`and may not be supported in future releases.`
Re-word the COMPATIBILITY section, taking care to use the word "deprecated" to describe the 4.4BSD extension of accepting arguments outside the range of unsigned char. This gives us freedom to remove this extension when we remove the <rune.h> interface in FreeBSD 6. 2004-07-29 23:32:41 +00:00			`The`
Add a note to the Compatiblity section suggesting that these functions only be used for byte values. Add cross-references to the wide-char counterparts. 2002-10-06 10:15:38 +00:00			`.Fn iswblank`
Re-word compatibility section, taking care to use the word "obsolete" to describe the 4.4BSD extension of accepting characters (runes) outside of the range of unsigned char. 2004-08-21 07:37:08 +00:00			`function should be used instead.`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Sh SEE ALSO`
			`.Xr ctype 3 ,`
Add a note to the Compatiblity section suggesting that these functions only be used for byte values. Add cross-references to the wide-char counterparts. 2002-10-06 10:15:38 +00:00			`.Xr iswblank 3 ,`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Xr ascii 7`
Restore C99 standard conformance information, isblank() _is_ in final standard document Pointed by: "Jacques A. Vidrine" <n@nectar.cc> 2002-01-22 20:14:35 +00:00			`.Sh STANDARDS`
mdoc(7) police: "The .Fn function". 2002-12-18 12:45:11 +00:00			`The`
Restore C99 standard conformance information, isblank() _is_ in final standard document Pointed by: "Jacques A. Vidrine" <n@nectar.cc> 2002-01-22 20:14:35 +00:00			`.Fn isblank`
mdoc(7) police: "The .Fn function". 2002-12-18 12:45:11 +00:00			`function`
Restore C99 standard conformance information, isblank() _is_ in final standard document Pointed by: "Jacques A. Vidrine" <n@nectar.cc> 2002-01-22 20:14:35 +00:00			`conforms to`
			`.St -isoC-99 .`