xref: /freebsd/lib/libc/locale/iscntrl.3 (revision 7f3dea244c40159a41ab22da77a434d7c5b5e85a)
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.\" 3. All advertising materials mentioning features or use of this software
17.\"    must display the following acknowledgement:
18.\"	This product includes software developed by the University of
19.\"	California, Berkeley and its contributors.
20.\" 4. Neither the name of the University nor the names of its contributors
21.\"    may be used to endorse or promote products derived from this software
22.\"    without specific prior written permission.
23.\"
24.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34.\" SUCH DAMAGE.
35.\"
36.\"     @(#)iscntrl.3	8.1 (Berkeley) 6/4/93
37.\" $FreeBSD$
38.\"
39.Dd June 4, 1993
40.Dt ISCNTRL 3
41.Os
42.Sh NAME
43.Nm iscntrl
44.Nd control character test
45.Sh SYNOPSIS
46.Fd #include <ctype.h>
47.Ft int
48.Fn iscntrl "int c"
49.Sh DESCRIPTION
50The
51.Fn iscntrl
52function tests for any control character.
53In the ASCII character set, this includes the following characters:
54.Pp
55.Bl -column \&000_``0''__ \&000_``0''__ \&000_``0''__ \&000_``0''__ \&000_``0''__
56.It \&000\ nul \t001\ soh \t002\ stx \t003\ etx \t004\ eot
57.It \&005\ enq \t006\ ack \t007\ bel \t010\ bs \t011\ ht
58.It \&012\ nl \t013\ vt \t014\ np \t015\ cr \t016\ so
59.It \&017\ si \t020\ dle \t021\ dc1 \t022\ dc2 \t023\ dc3
60.It \&024\ dc4 \t025\ nak \t026\ syn \t027\ etb \t030\ can
61.It \&031\ em \t032\ sub \t033\ esc \t034\ fs \t035\ gs
62.It \&036\ rs \t037\ us \t177\ del
63.El
64.Sh RETURN VALUES
65The
66.Fn iscntrl
67function returns zero if the character tests false and
68returns non-zero if the character tests true.
69.Sh SEE ALSO
70.Xr ctype 3 ,
71.Xr ascii 7
72.Sh STANDARDS
73The
74.Fn iscntrl
75function conforms to
76.St -ansiC .
77