freebsd-nq/lib/libc/gen/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$
.\"
.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 .
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.\" 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.`
			`.\"`
Merge from Lite2: man page updates 1997-03-11 11:47:52 +00:00			`.\" @(#)psignal.3 8.2 (Berkeley) 2/27/95`
$Id$ -> $FreeBSD$ 1999-08-28 00:22:10 +00:00			`.\" $FreeBSD$`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.\"`
Merge from Lite2: man page updates 1997-03-11 11:47:52 +00:00			`.Dd February 27, 1995`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Dt PSIGNAL 3`
mdoc(7) police: removed HISTORY info from the .Os call. 2001-07-10 13:41:46 +00:00			`.Os`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Sh NAME`
			`.Nm psignal ,`
Add a strsignal(3) (like strerror(3)) for libc compatability with other systems. NetBSD, Linux, SVR4 etc all have it. 1999-05-18 04:48:58 +00:00			`.Nm strsignal ,`
Fixed various problems: typos, grammer, missing include files wrong function type declarations, and wrong argument type declarations. 1996-05-23 01:05:25 +00:00			`.Nm sys_siglist ,`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Nm sys_signame`
			`.Nd system signal messages`
Introduce ".Lb" macro to libc manpages. More libraries manpages updates following. 2000-04-21 09:42:15 +00:00			`.Sh LIBRARY`
			`.Lb libc`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Sh SYNOPSIS`
mdoc(7) police: Use the new .In macro for #include statements. 2001-10-01 16:09:29 +00:00			`.In signal.h`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Ft void`
			`.Fn psignal "unsigned sig" "const char *s"`
mdoc(7) police: Ft/Vt now accept punctuation-type arguments. 2001-01-12 15:46:56 +00:00			`.Vt extern const char * const sys_siglist[] ;`
			`.Vt extern const char * const sys_signame[] ;`
mdoc(7) police: Use the new .In macro for #include statements. 2001-10-01 16:09:29 +00:00			`.In string.h`
Fixed wrong prototype and missing include for strsignal(3). strsignal() takes an int arg and is prototyped in <string.h>. It has the opposite interface botches to psignal(3) which takes a bogus unsigned arg but is prototyped in the right place. This is not the last of the interface problems for strsignal(). We obtained it from NetBSD, but NetBSD has moved its prototype to <unistd.h>. strsignal() should return const char , but it returns char for historical reasons. NetBSD declares it as returning __aconst char, where __aconst is normally empty but can be set to `const' to give better error checking. glibc-2.1.1 prototypes strsignal() in <string.h>. 1999-12-23 16:29:58 +00:00			`.Ft "char *"`
			`.Fn strsignal "int sig"`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Sh DESCRIPTION`
			`The`
			`.Fn psignal`
Add a strsignal(3) (like strerror(3)) for libc compatability with other systems. NetBSD, Linux, SVR4 etc all have it. 1999-05-18 04:48:58 +00:00			`and`
			`.Fn strsignal`
			`functions locate the descriptive message`
			`string for a signal number.`
			`.Pp`
			`The`
			`.Fn strsignal`
			`function accepts a signal number argument`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Fa sig`
Add a strsignal(3) (like strerror(3)) for libc compatability with other systems. NetBSD, Linux, SVR4 etc all have it. 1999-05-18 04:48:58 +00:00			`and returns a pointer to the corresponding message string.`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Pp`
Add a strsignal(3) (like strerror(3)) for libc compatability with other systems. NetBSD, Linux, SVR4 etc all have it. 1999-05-18 04:48:58 +00:00			`The`
			`.Fn psignal`
Fix typos, mostly s/ an / a / where appropriate and a few s/an/and/ Add FreeBSD Id tag where missing. 2002-12-30 21:18:15 +00:00			`function accepts a signal number argument`
Add a strsignal(3) (like strerror(3)) for libc compatability with other systems. NetBSD, Linux, SVR4 etc all have it. 1999-05-18 04:48:58 +00:00			`.Fa sig`
			`and writes it to the standard error.`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`If the argument`
			`.Fa s`
			`is`
			`.Pf non- Dv NULL`
Clarify processing of the string argument by psignal(). 1998-10-29 22:17:46 +00:00			`and does not point to the null character,`
			`.Fa s`
			`is written to the standard error file descriptor`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`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 ,`
Add a strsignal(3) (like strerror(3)) for libc compatability with other systems. NetBSD, Linux, SVR4 etc all have it. 1999-05-18 04:48:58 +00:00			`.Xr perror 3 ,`
			`.Xr strerror 3`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Sh HISTORY`
			`The`
			`.Fn psignal`
Whitespace only change: trim trailing whitespace. 2000-10-30 13:23:19 +00:00			`function appeared in`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Bx 4.2 .`