xref: /netbsd-src/lib/libc/gen/psignal.3 (revision edfa83365254b6d7c6cdaa0d30b214319daeee7f)
1.\"	$NetBSD: psignal.3,v 1.5 1995/02/27 04:35:39 cgd Exp $
2.\"
3.\" Copyright (c) 1983, 1991, 1993
4.\"	The Regents of the University of California.  All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\" 3. All advertising materials mentioning features or use of this software
15.\"    must display the following acknowledgement:
16.\"	This product includes software developed by the University of
17.\"	California, Berkeley and its contributors.
18.\" 4. Neither the name of the University nor the names of its contributors
19.\"    may be used to endorse or promote products derived from this software
20.\"    without specific prior written permission.
21.\"
22.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32.\" SUCH DAMAGE.
33.\"
34.\"     @(#)psignal.3	8.1 (Berkeley) 6/4/93
35.\"
36.Dd June 4, 1993
37.Dt PSIGNAL 3
38.Os BSD 4.2
39.Sh NAME
40.Nm psignal ,
41.Nm sys_siglist ,
42.Nm sys_signame
43.Nd system signal messages
44.Sh SYNOPSIS
45.Fd #include <sys/signal.h>
46.Ft void
47.Fn psignal "unsigned sig" "const char *s"
48.Vt extern char *sys_siglist[];
49.Vt extern char *sys_signame[];
50.Sh DESCRIPTION
51The
52.Fn psignal
53function locates the descriptive message
54string for the given signal number
55.Fa sig
56and writes it to the standard error.
57.Pp
58If the argument
59.Fa s
60is
61.Pf non- Dv NULL
62it is written to the standard error file descriptor
63prior to the message string,
64immediately followed by a colon and a space.
65If the signal number is not recognized
66.Pq Xr sigaction 2 ,
67the string
68.Dq "Unknown signal
69is produced.
70.Pp
71The message strings can be accessed directly using the external array
72.Va sys_siglist ,
73indexed by recognized signal numbers.  The external array
74.Va sys_signame
75is used similarly and contains short, upper-case abbreviations for signals
76which are useful for recognizing signal names in user input.  The defined
77variable
78.Dv NSIG
79contains a count of the strings in
80.Va sys_siglist
81and
82.Va sys_signame .
83.Sh SEE ALSO
84.Xr sigaction 2 ,
85.Xr perror 3
86.Sh HISTORY
87The
88.Fn psignal
89function appeared in
90.Bx 4.2 .
91