[apple/libc.git] / gen / FreeBSD / psignal.3

.\" Copyright (c) 1983, 1991, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 4. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"     @(#)psignal.3	8.2 (Berkeley) 2/27/95
.\" $FreeBSD: src/lib/libc/gen/psignal.3,v 1.17 2007/01/09 00:27:54 imp Exp $
.\"
.Dd February 27, 1995
.Dt PSIGNAL 3
.Os
.Sh NAME
.Nm psignal ,
.Nm strsignal ,
.Nm sys_siglist ,
.Nm sys_signame
.Nd system signal messages
.Sh LIBRARY
.Lb libc
.Sh SYNOPSIS
.In signal.h
.Ft void
.Fn psignal "unsigned sig" "const char *s"
.Vt extern const char * const sys_siglist[] ;
.Vt extern const char * const sys_signame[] ;
.In string.h
.Ft "char *"
.Fn strsignal "int sig"
.Sh DESCRIPTION
The
.Fn psignal
and
.Fn strsignal
functions locate the descriptive message
string for a signal number.
.Pp
The
.Fn strsignal
function accepts a signal number argument
.Fa sig
and returns a pointer to the corresponding message string.
.Pp
The
.Fn psignal
function accepts a signal number argument
.Fa sig
and writes it to the standard error.
If the argument
.Fa s
is
.Pf non- Dv NULL
and does not point to the null character,
.Fa s
is written to the standard error file descriptor
prior to the message string,
immediately followed by a colon and a space.
If the signal number is not recognized
.Pq Xr sigaction 2 ,
the string
.Dq "Unknown signal
is produced.
.Pp
The message strings can be accessed directly
through the external array
.Va sys_siglist ,
indexed by recognized signal numbers.
The external array
.Va sys_signame
is used similarly and
contains short, lower-case abbreviations for signals
which are useful for recognizing signal names
in user input.
The defined variable
.Dv NSIG
contains a count of the strings in
.Va sys_siglist
and
.Va sys_signame .
.Sh SEE ALSO
.Xr sigaction 2 ,
.Xr perror 3 ,
.Xr strerror 3
.Sh HISTORY
The
.Fn psignal
function appeared in
.Bx 4.2 .
Commit	Line	Data
5b2abdfb	1	.\" Copyright (c) 1983, 1991, 1993
e9ce8d39 A	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.
e9ce8d39 A	12	.\" 4. 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	.\"
5b2abdfb	28	.\" @(#)psignal.3 8.2 (Berkeley) 2/27/95
1f2f436a	29	.\" $FreeBSD: src/lib/libc/gen/psignal.3,v 1.17 2007/01/09 00:27:54 imp Exp $
e9ce8d39	30	.\"
5b2abdfb A	31	.Dd February 27, 1995
5b2abdfb A	32	.Dt PSIGNAL 3
e9ce8d39 A	33	.Os
e9ce8d39 A	34	.Sh NAME
5b2abdfb A	35	.Nm psignal ,
	36	.Nm strsignal ,
	37	.Nm sys_siglist ,
	38	.Nm sys_signame
	39	.Nd system signal messages
e9ce8d39 A	40	.Sh LIBRARY
	41	.Lb libc
	42	.Sh SYNOPSIS
5b2abdfb A	43	.In 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	.In string.h
	49	.Ft "char *"
	50	.Fn strsignal "int sig"
e9ce8d39 A	51	.Sh DESCRIPTION
e9ce8d39 A	52	The
5b2abdfb	53	.Fn psignal
e9ce8d39	54	and
5b2abdfb A	55	.Fn strsignal
	56	functions locate the descriptive message
	57	string for a signal number.
	58	.Pp
e9ce8d39	59	The
5b2abdfb A	60	.Fn strsignal
	61	function accepts a signal number argument
	62	.Fa sig
	63	and returns a pointer to the corresponding message string.
	64	.Pp
	65	The
	66	.Fn psignal
9385eb3d	67	function accepts a signal number argument
5b2abdfb A	68	.Fa sig
	69	and writes it to the standard error.
	70	If the argument
	71	.Fa s
	72	is
	73	.Pf non- Dv NULL
	74	and does not point to the null character,
	75	.Fa s
	76	is written to the standard error file descriptor
	77	prior to the message string,
	78	immediately followed by a colon and a space.
	79	If the signal number is not recognized
	80	.Pq Xr sigaction 2 ,
	81	the string
	82	.Dq "Unknown signal
	83	is produced.
	84	.Pp
	85	The message strings can be accessed directly
	86	through the external array
	87	.Va sys_siglist ,
	88	indexed by recognized signal numbers.
	89	The external array
	90	.Va sys_signame
	91	is used similarly and
	92	contains short, lower-case abbreviations for signals
	93	which are useful for recognizing signal names
	94	in user input.
	95	The defined variable
	96	.Dv NSIG
	97	contains a count of the strings in
	98	.Va sys_siglist
	99	and
	100	.Va sys_signame .
e9ce8d39	101	.Sh SEE ALSO
5b2abdfb A	102	.Xr sigaction 2 ,
	103	.Xr perror 3 ,
	104	.Xr strerror 3
e9ce8d39 A	105	.Sh HISTORY
e9ce8d39 A	106	The
5b2abdfb A	107	.Fn psignal
	108	function appeared in
	109	.Bx 4.2 .