xref: /netbsd/lib/libc/gen/psignal.3 (revision c4a72b64)
1.\"	$NetBSD: psignal.3,v 1.13 2002/10/01 16:48:35 wiz 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.2 (Berkeley) 2/27/95
35.\"
36.Dd February 27, 1995
37.Dt PSIGNAL 3
38.Os
39.Sh NAME
40.Nm psignal ,
41.Nm sys_siglist ,
42.Nm sys_signame
43.Nd system signal messages
44.Sh LIBRARY
45.Lb libc
46.Sh SYNOPSIS
47.Fd #include \*[Lt]signal.h\*[Gt]
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.Sh DESCRIPTION
53The
54.Fn psignal
55function locates the descriptive message
56string for the given signal number
57.Fa sig
58and writes it to the standard error.
59.Pp
60If the argument
61.Fa s
62is
63.Pf non- Dv NULL
64it is written to the standard error file descriptor
65prior to the message string,
66immediately followed by a colon and a space.
67If the signal number is not recognized
68.Pq Xr sigaction 2 ,
69the string
70.Dq "Unknown signal
71is produced.
72.Pp
73The message strings can be accessed directly using the external array
74.Va sys_siglist ,
75indexed by recognized signal numbers.
76The external array
77.Va sys_signame
78is used similarly and contains short, upper-case abbreviations for signals
79which are useful for recognizing signal names in user input.
80The defined variable
81.Dv NSIG
82contains a count of the strings in
83.Va sys_siglist
84and
85.Va sys_signame .
86.Sh SEE ALSO
87.Xr sigaction 2 ,
88.Xr perror 3 ,
89.Xr setlocale 3 ,
90.Xr strsignal 3
91.Sh HISTORY
92The
93.Fn psignal
94function appeared in
95.Bx 4.2 .
96