gen/FreeBSD/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.16 2002/12/30 21:18:02 schweikh Exp $
  34 .\"
  35 .Dd February 27, 1995
  36 .Dt PSIGNAL 3
  37 .Os
  38 .Sh NAME
  39 .Nm psignal ,
  40 .Nm strsignal ,
  41 .Nm sys_siglist ,
  42 .Nm sys_signame
  43 .Nd system signal messages
  44 .Sh LIBRARY
  45 .Lb libc
  46 .Sh SYNOPSIS
  47 .In signal.h
  48 .Ft void
  49 .Fn psignal "unsigned sig" "const char *s"
  50 .Vt extern const char * const sys_siglist[] ;
  51 .Vt extern const char * const sys_signame[] ;
  52 .In string.h
  53 .Ft "char *"
  54 .Fn strsignal "int sig"
  55 .Sh DESCRIPTION
  56 The
  57 .Fn psignal
  58 and
  59 .Fn strsignal
  60 functions locate the descriptive message
  61 string for a signal number.
  62 .Pp
  63 The
  64 .Fn strsignal
  65 function accepts a signal number argument
  66 .Fa sig
  67 and returns a pointer to the corresponding message string.
  68 .Pp
  69 The
  70 .Fn psignal
  71 function accepts a signal number argument
  72 .Fa sig
  73 and writes it to the standard error.
  74 If the argument
  75 .Fa s
  76 is
  77 .Pf non- Dv NULL
  78 and does not point to the null character,
  79 .Fa s
  80 is written to the standard error file descriptor
  81 prior to the message string,
  82 immediately followed by a colon and a space.
  83 If the signal number is not recognized
  84 .Pq Xr sigaction 2 ,
  85 the string
  86 .Dq "Unknown signal
  87 is produced.
  88 .Pp
  89 The message strings can be accessed directly
  90 through the external array
  91 .Va sys_siglist ,
  92 indexed by recognized signal numbers.
  93 The external array
  94 .Va sys_signame
  95 is used similarly and
  96 contains short, lower-case abbreviations for signals
  97 which are useful for recognizing signal names
  98 in user input.
  99 The defined variable
 100 .Dv NSIG
 101 contains a count of the strings in
 102 .Va sys_siglist
 103 and
 104 .Va sys_signame .
 105 .Sh SEE ALSO
 106 .Xr sigaction 2 ,
 107 .Xr perror 3 ,
 108 .Xr strerror 3
 109 .Sh HISTORY
 110 The
 111 .Fn psignal
 112 function appeared in
 113 .Bx 4.2 .