git.saurik.com Git - apple/libc.git/blame_incremental

... / ...

Commit	Line	Data
	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	.\" 4. 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	.\" @(#)iscntrl.3 8.1 (Berkeley) 6/4/93
	33	.\" $FreeBSD: src/lib/libc/locale/iscntrl.3,v 1.22 2009/09/04 07:44:58 des Exp $
	34	.\"
	35	.Dd July 17, 2005
	36	.Dt ISCNTRL 3
	37	.Os
	38	.Sh NAME
	39	.Nm iscntrl
	40	.Nd control character test
	41	.Sh LIBRARY
	42	.Lb libc
	43	.Sh SYNOPSIS
	44	.In ctype.h
	45	.Ft int
	46	.Fn iscntrl "int c"
	47	.Sh DESCRIPTION
	48	The
	49	.Fn iscntrl
	50	function tests for any control character.
	51	The value of the argument must be representable as an
	52	.Vt "unsigned char"
	53	or the value of
	54	.Dv EOF .
	55	.Pp
	56	In the ASCII character set, this includes the following characters
	57	(preceded by their numeric values, in octal):
	58	.Pp
	59	.Bl -column \&000_``0''__ \&000_``0''__ \&000_``0''__ \&000_``0''__ \&000_``0''__
	60	.It "\&000\ NUL \t001\ SOH \t002\ STX \t003\ ETX \t004\ EOT"
	61	.It "\&005\ ENQ \t006\ ACK \t007\ BEL \t010\ BS \t011\ HT"
	62	.It "\&012\ NL \t013\ VT \t014\ NP \t015\ CR \t016\ SO"
	63	.It "\&017\ SI \t020\ DLE \t021\ DC1 \t022\ DC2 \t023\ DC3"
	64	.It "\&024\ DC4 \t025\ NAK \t026\ SYN \t027\ ETB \t030\ CAN"
	65	.It "\&031\ EM \t032\ SUB \t033\ ESC \t034\ FS \t035\ GS"
	66	.It "\&036\ RS \t037\ US \t177\ DEL"
	67	.El
	68	.Sh RETURN VALUES
	69	The
	70	.Fn iscntrl
	71	function returns zero if the character tests false and
	72	returns non-zero if the character tests true.
	73	.Sh COMPATIBILITY
	74	The
	75	.Bx 4.4
	76	extension of accepting arguments outside of the range of the
	77	.Vt "unsigned char"
	78	type in locales with large character sets is considered obsolete
	79	and may not be supported in future releases.
	80	The
	81	.Fn iswcntrl
	82	function should be used instead.
	83	.Sh SEE ALSO
	84	.Xr ctype 3 ,
	85	.Xr isalnum_l 3 ,
	86	.Xr iswcntrl 3 ,
	87	.Xr ascii 7
	88	.Sh STANDARDS
	89	The
	90	.Fn iscntrl
	91	function conforms to
	92	.St -isoC .