102 lines
3.5 KiB
Groff
102 lines
3.5 KiB
Groff
.\" Copyright (c) 1991, 1993
|
|
.\" 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. All advertising materials mentioning features or use of this software
|
|
.\" must display the following acknowledgement:
|
|
.\" This product includes software developed by the University of
|
|
.\" California, Berkeley and its contributors.
|
|
.\" 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.
|
|
.\"
|
|
.\" @(#)iscntrl.3 8.1 (Berkeley) 6/4/93
|
|
.\" $FreeBSD$
|
|
.\"
|
|
.Dd October 6, 2002
|
|
.Dt ISCNTRL 3
|
|
.Os
|
|
.Sh NAME
|
|
.Nm iscntrl
|
|
.Nd control character test
|
|
.Sh LIBRARY
|
|
.Lb libc
|
|
.Sh SYNOPSIS
|
|
.In ctype.h
|
|
.Ft int
|
|
.Fn iscntrl "int c"
|
|
.Sh DESCRIPTION
|
|
The
|
|
.Fn iscntrl
|
|
function tests for any control character.
|
|
For single C
|
|
.Va char Ns s
|
|
locales (see
|
|
.Xr multibyte 3 )
|
|
the value of the argument is
|
|
representable as an
|
|
.Li unsigned char
|
|
or the value of
|
|
.Dv EOF .
|
|
In the ASCII character set, this includes the following characters
|
|
(with their numeric values shown in octal):
|
|
.Pp
|
|
.Bl -column \&000_``0''__ \&000_``0''__ \&000_``0''__ \&000_``0''__ \&000_``0''__
|
|
.It "\&000\ nul \t001\ soh \t002\ stx \t003\ etx \t004\ eot"
|
|
.It "\&005\ enq \t006\ ack \t007\ bel \t010\ bs \t011\ ht"
|
|
.It "\&012\ nl \t013\ vt \t014\ np \t015\ cr \t016\ so"
|
|
.It "\&017\ si \t020\ dle \t021\ dc1 \t022\ dc2 \t023\ dc3"
|
|
.It "\&024\ dc4 \t025\ nak \t026\ syn \t027\ etb \t030\ can"
|
|
.It "\&031\ em \t032\ sub \t033\ esc \t034\ fs \t035\ gs"
|
|
.It "\&036\ rs \t037\ us \t177\ del"
|
|
.El
|
|
.Sh RETURN VALUES
|
|
The
|
|
.Fn iscntrl
|
|
function returns zero if the character tests false and
|
|
returns non-zero if the character tests true.
|
|
.Sh COMPATIBILITY
|
|
Although
|
|
.Fn iscntrl
|
|
accepts arguments outside of the range of the
|
|
.Vt "unsigned char"
|
|
type in locales with large character sets,
|
|
this is a
|
|
.Bx 4.4
|
|
extension and the
|
|
.Fn iwcntrl
|
|
function should be used instead for maximum portability.
|
|
.Sh SEE ALSO
|
|
.Xr ctype 3 ,
|
|
.Xr iswcntrl 3 ,
|
|
.Xr multibyte 3 ,
|
|
.Xr ascii 7
|
|
.Sh STANDARDS
|
|
The
|
|
.Fn iscntrl
|
|
function conforms to
|
|
.St -isoC .
|