xref: /freebsd/lib/libc/gen/psignal.3 (revision 380a989b3223d455375b4fae70fd0b9bdd43bafb)
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.\"
34.Dd February 27, 1995
35.Dt PSIGNAL 3
36.Os BSD 4.2
37.Sh NAME
38.Nm psignal ,
39.Nm sys_siglist ,
40.Nm sys_signame
41.Nd system signal messages
42.Sh SYNOPSIS
43.Fd #include <signal.h>
44.Ft void
45.Fn psignal "unsigned sig" "const char *s"
46.Vt extern const char * const sys_siglist[];
47.Vt extern const char * const sys_signame[];
48.Sh DESCRIPTION
49The
50.Fn psignal
51function locates the descriptive message
52string for the given signal number
53.Fa sig
54and writes it to the standard error.
55.Pp
56If the argument
57.Fa s
58is
59.Pf non- Dv NULL
60and does not point to the null character,
61.Fa s
62is 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
72through the external array
73.Va sys_siglist ,
74indexed by recognized signal numbers.
75The external array
76.Va sys_signame
77is used similarly and
78contains short, lower-case abbreviations for signals
79which are useful for recognizing signal names
80in user input.
81The defined variable
82.Dv NSIG
83contains a count of the strings in
84.Va sys_siglist
85and
86.Va sys_signame .
87.Sh SEE ALSO
88.Xr sigaction 2 ,
89.Xr perror 3
90.Sh HISTORY
91The
92.Fn psignal
93function appeared in
94.Bx 4.2 .
95