lib/libc/locale/iscntrl.3

   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. 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 .Dd December 19, 2022
  33 .Dt ISCNTRL 3
  34 .Os
  35 .Sh NAME
  36 .Nm iscntrl ,
  37 .Nm iscntrl_l
  38 .Nd control character test
  39 .Sh LIBRARY
  40 .Lb libc
  41 .Sh SYNOPSIS
  42 .In ctype.h
  43 .Ft int
  44 .Fn iscntrl "int c"
  45 .Ft int
  46 .Fn iscntrl_l "int c" "locale_t loc"
  47 .Sh DESCRIPTION
  48 The
  49 .Fn iscntrl
  50 and
  51 .Fn iscntrl_l
  52 functions test for any control character.
  53 The value of the argument must be representable as an
  54 .Vt "unsigned char"
  55 or the value of
  56 .Dv EOF .
  57 .Pp
  58 In the ASCII character set, this includes the following characters
  59 (with their numeric values shown in octal):
  60 .Bl -column \&000_``0''__ \&000_``0''__ \&000_``0''__ \&000_``0''__ \&000_``0''__
  61 .It "\&000\ NUL" Ta "001\ SOH" Ta "002\ STX" Ta "003\ ETX" Ta "004\ EOT"
  62 .It "\&005\ ENQ" Ta "006\ ACK" Ta "007\ BEL" Ta "010\ BS" Ta "011\ HT"
  63 .It "\&012\ NL" Ta "013\ VT" Ta "014\ NP" Ta "015\ CR" Ta "016\ SO"
  64 .It "\&017\ SI" Ta "020\ DLE" Ta "021\ DC1" Ta "022\ DC2" Ta "023\ DC3"
  65 .It "\&024\ DC4" Ta "025\ NAK" Ta "026\ SYN" Ta "027\ ETB" Ta "030\ CAN"
  66 .It "\&031\ EM" Ta "032\ SUB" Ta "033\ ESC" Ta "034\ FS" Ta "035\ GS"
  67 .It "\&036\ RS" Ta "037\ US" Ta "177\ DEL" Ta \& Ta \&
  68 .El
  69 .Pp
  70 The
  71 .Fn iscntrl_l
  72 function takes an explicit locale argument, whereas the
  73 .Fn iscntrl
  74 function uses the current global or per-thread locale.
  75 .Sh RETURN VALUES
  76 The
  77 .Fn iscntrl
  78 and
  79 .Fn iscntrl_l
  80 functions return zero if the character tests false and
  81 return non-zero if the character tests true.
  82 .Sh COMPATIBILITY
  83 The
  84 .Bx 4.4
  85 extension of accepting arguments outside of the range of the
  86 .Vt "unsigned char"
  87 type in locales with large character sets is considered obsolete
  88 and may not be supported in future releases.
  89 The
  90 .Fn iswcntrl
  91 or
  92 .Fn iswcntrl_l
  93 function should be used instead.
  94 .Sh SEE ALSO
  95 .Xr ctype 3 ,
  96 .Xr ctype_l 3 ,
  97 .Xr iswcntrl 3 ,
  98 .Xr iswcntrl_l 3 ,
  99 .Xr xlocale 3 ,
 100 .Xr ascii 7
 101 .Sh STANDARDS
 102 The
 103 .Fn iscntrl
 104 function conforms to
 105 .St -isoC .
 106 The
 107 .Fn iscntrl_l
 108 function conforms to
 109 .St -p1003.1-2008 .
 110 .Sh HISTORY
 111 The
 112 .Fn iscntrl
 113 function first appeared in
 114 .At v7 .