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. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     @(#)psignal.3   8.2 (Berkeley) 2/27/95
  29 .\" $FreeBSD: src/lib/libc/gen/psignal.3,v 1.10.2.5 2003/03/15 15:11:05 trhodes Exp $
  30 .\"
  31 .Dd September 12, 2019
  32 .Dt PSIGNAL 3
  33 .Os
  34 .Sh NAME
  35 .Nm psignal ,
  36 .Nm psiginfo ,
  37 .Nm strsignal ,
  38 .Nm sys_siglist ,
  39 .Nm sys_signame ,
  40 .Nm sys_nsig
  41 .Nd system signal messages
  42 .Sh LIBRARY
  43 .Lb libc
  44 .Sh SYNOPSIS
  45 .In signal.h
  46 .Ft void
  47 .Fn psignal "int sig" "const char *s"
  48 .Ft void
  49 .Fn psiginfo "const siginfo_t *si" "const char *s"
  50 .Vt extern const char * const sys_siglist[] ;
  51 .Vt extern const char * const sys_signame[] ;
  52 .Vt extern const int sys_nsig ;
  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
  91 .Fn psiginfo
  92 function is similar to
  93 .Fn psignal ,
  94 except that the signal number information is taken from the
  95 .Fa si
  96 argument which is a
  97 .Vt siginfo_t
  98 structure.
  99 .Pp
 100 The message strings can be accessed directly
 101 through the external array
 102 .Va sys_siglist ,
 103 indexed by recognized signal numbers.
 104 The external array
 105 .Va sys_signame
 106 is used similarly and
 107 contains short, lower-case abbreviations for signals
 108 which are useful for recognizing signal names
 109 in user input.
 110 The external variable
 111 .Va sys_nsig
 112 contains a count of the strings in
 113 .Va sys_siglist
 114 and
 115 .Va sys_signame .
 116 Note that the defined variable
 117 .Dv NSIG
 118 will typically be the same as
 119 .Va sys_nsig ,
 120 but might be different due to newer or older kernels and newer or
 121 older libc libraries.  For maximum portability you must use
 122 .Va sys_nsig
 123 to limit-check the above arrays.  Additionally, you should check
 124 for
 125 .Dv NULL
 126 array entries and generate a generic signal name in those cases.
 127 .Sh SEE ALSO
 128 .Xr sigaction 2 ,
 129 .Xr perror 3 ,
 130 .Xr strerror 3
 131 .Sh HISTORY
 132 The
 133 .Fn psignal
 134 function appeared in
 135 .Bx 4.2 .
 136 The
 137 .Fn psiginfo
 138 function appeared in
 139 .Dx 4.1 .