lib/libc/gen/psignal.3

   1 .\" Copyright (c) 1983, 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  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 .\"     @(#)psignal.3   8.2 (Berkeley) 2/27/95
  33 .\" $FreeBSD: src/lib/libc/gen/psignal.3,v 1.10.2.5 2003/03/15 15:11:05 trhodes Exp $
  34 .\" $DragonFly: src/lib/libc/gen/psignal.3,v 1.2 2003/06/17 04:26:42 dillon Exp $
  35 .\"
  36 .Dd February 27, 1995
  37 .Dt PSIGNAL 3
  38 .Os
  39 .Sh NAME
  40 .Nm psignal ,
  41 .Nm strsignal ,
  42 .Nm sys_siglist ,
  43 .Nm sys_signame
  44 .Nd system signal messages
  45 .Sh LIBRARY
  46 .Lb libc
  47 .Sh SYNOPSIS
  48 .In signal.h
  49 .Ft void
  50 .Fn psignal "unsigned sig" "const char *s"
  51 .Vt extern const char * const sys_siglist[] ;
  52 .Vt extern const char * const sys_signame[] ;
  53 .In string.h
  54 .Ft "char *"
  55 .Fn strsignal "int sig"
  56 .Sh DESCRIPTION
  57 The
  58 .Fn psignal
  59 and
  60 .Fn strsignal
  61 functions locate the descriptive message
  62 string for a signal number.
  63 .Pp
  64 The
  65 .Fn strsignal
  66 function accepts a signal number argument
  67 .Fa sig
  68 and returns a pointer to the corresponding message string.
  69 .Pp
  70 The
  71 .Fn psignal
  72 function accepts a signal number argument
  73 .Fa sig
  74 and writes it to the standard error.
  75 If the argument
  76 .Fa s
  77 is
  78 .Pf non- Dv NULL
  79 and does not point to the null character,
  80 .Fa s
  81 is written to the standard error file descriptor
  82 prior to the message string,
  83 immediately followed by a colon and a space.
  84 If the signal number is not recognized
  85 .Pq Xr sigaction 2 ,
  86 the string
  87 .Dq "Unknown signal
  88 is produced.
  89 .Pp
  90 The message strings can be accessed directly
  91 through the external array
  92 .Va sys_siglist ,
  93 indexed by recognized signal numbers.
  94 The external array
  95 .Va sys_signame
  96 is used similarly and
  97 contains short, lower-case abbreviations for signals
  98 which are useful for recognizing signal names
  99 in user input.
 100 The defined variable
 101 .Dv NSIG
 102 contains a count of the strings in
 103 .Va sys_siglist
 104 and
 105 .Va sys_signame .
 106 .Sh SEE ALSO
 107 .Xr sigaction 2 ,
 108 .Xr perror 3 ,
 109 .Xr strerror 3
 110 .Sh HISTORY
 111 The
 112 .Fn psignal
 113 function appeared in
 114 .Bx 4.2 .