Blame man-pages-posix-2013-a/man3p/strsignal.3p

Packit 7cfc04
'\" et
Packit 7cfc04
.TH STRSIGNAL "3P" 2013 "IEEE/The Open Group" "POSIX Programmer's Manual"
Packit 7cfc04
.SH PROLOG
Packit 7cfc04
This manual page is part of the POSIX Programmer's Manual.
Packit 7cfc04
The Linux implementation of this interface may differ (consult
Packit 7cfc04
the corresponding Linux manual page for details of Linux behavior),
Packit 7cfc04
or the interface may not be implemented on Linux.
Packit 7cfc04
Packit 7cfc04
.SH NAME
Packit 7cfc04
strsignal
Packit 7cfc04
\(em get name of signal
Packit 7cfc04
.SH SYNOPSIS
Packit 7cfc04
.LP
Packit 7cfc04
.nf
Packit 7cfc04
#include <string.h>
Packit 7cfc04
.P
Packit 7cfc04
char *strsignal(int \fIsignum\fP);
Packit 7cfc04
.fi
Packit 7cfc04
.SH DESCRIPTION
Packit 7cfc04
The
Packit 7cfc04
\fIstrsignal\fR()
Packit 7cfc04
function shall map the signal number in
Packit 7cfc04
.IR signum
Packit 7cfc04
to an implementation-defined string and shall return a pointer to it.
Packit 7cfc04
It shall use the same set of messages as the
Packit 7cfc04
\fIpsignal\fR()
Packit 7cfc04
function.
Packit 7cfc04
.P
Packit 7cfc04
The application shall not modify the string returned. The returned
Packit 7cfc04
pointer might be invalidated or the string content might be overwritten
Packit 7cfc04
by a subsequent call to
Packit 7cfc04
\fIstrsignal\fR()
Packit 7cfc04
or
Packit 7cfc04
\fIsetlocale\fR().
Packit 7cfc04
.P
Packit 7cfc04
The contents of the message strings returned by
Packit 7cfc04
\fIstrsignal\fR()
Packit 7cfc04
should be determined by the setting of the
Packit 7cfc04
.IR LC_MESSAGES
Packit 7cfc04
category in the current locale.
Packit 7cfc04
.P
Packit 7cfc04
The implementation shall behave as if no function defined in this
Packit 7cfc04
standard calls
Packit 7cfc04
\fIstrsignal\fR().
Packit 7cfc04
.P
Packit 7cfc04
Since no return value is reserved to indicate an error, an application
Packit 7cfc04
wishing to check for error situations should set
Packit 7cfc04
.IR errno
Packit 7cfc04
to 0, then call
Packit 7cfc04
\fIstrsignal\fR(),
Packit 7cfc04
then check
Packit 7cfc04
.IR errno .
Packit 7cfc04
.P
Packit 7cfc04
The
Packit 7cfc04
\fIstrsignal\fR()
Packit 7cfc04
function need not be thread-safe.
Packit 7cfc04
.SH "RETURN VALUE"
Packit 7cfc04
Upon successful completion,
Packit 7cfc04
\fIstrsignal\fR()
Packit 7cfc04
shall return a pointer to a string. Otherwise, if
Packit 7cfc04
.IR signum
Packit 7cfc04
is not a valid signal number, the return value is unspecified.
Packit 7cfc04
.SH ERRORS
Packit 7cfc04
No errors are defined.
Packit 7cfc04
.LP
Packit 7cfc04
.IR "The following sections are informative."
Packit 7cfc04
.SH EXAMPLES
Packit 7cfc04
None.
Packit 7cfc04
.SH "APPLICATION USAGE"
Packit 7cfc04
None.
Packit 7cfc04
.SH RATIONALE
Packit 7cfc04
If
Packit 7cfc04
.IR signum
Packit 7cfc04
is not a valid signal number, some implementations return NULL, while
Packit 7cfc04
for others the
Packit 7cfc04
\fIstrsignal\fR()
Packit 7cfc04
function returns a pointer to a string containing an unspecified
Packit 7cfc04
message denoting an unknown signal. POSIX.1\(hy2008 leaves this return
Packit 7cfc04
value unspecified.
Packit 7cfc04
.SH "FUTURE DIRECTIONS"
Packit 7cfc04
None.
Packit 7cfc04
.SH "SEE ALSO"
Packit 7cfc04
.IR "\fIpsiginfo\fR\^(\|)",
Packit 7cfc04
.IR "\fIsetlocale\fR\^(\|)"
Packit 7cfc04
.P
Packit 7cfc04
The Base Definitions volume of POSIX.1\(hy2008,
Packit 7cfc04
.IR "\fB<string.h>\fP"
Packit 7cfc04
.SH COPYRIGHT
Packit 7cfc04
Portions of this text are reprinted and reproduced in electronic form
Packit 7cfc04
from IEEE Std 1003.1, 2013 Edition, Standard for Information Technology
Packit 7cfc04
-- Portable Operating System Interface (POSIX), The Open Group Base
Packit 7cfc04
Specifications Issue 7, Copyright (C) 2013 by the Institute of
Packit 7cfc04
Electrical and Electronics Engineers, Inc and The Open Group.
Packit 7cfc04
(This is POSIX.1-2008 with the 2013 Technical Corrigendum 1 applied.) In the
Packit 7cfc04
event of any discrepancy between this version and the original IEEE and
Packit 7cfc04
The Open Group Standard, the original IEEE and The Open Group Standard
Packit 7cfc04
is the referee document. The original Standard can be obtained online at
Packit 7cfc04
http://www.unix.org/online.html .
Packit 7cfc04
Packit 7cfc04
Any typographical or formatting errors that appear
Packit 7cfc04
in this page are most likely
Packit 7cfc04
to have been introduced during the conversion of the source files to
Packit 7cfc04
man page format. To report such errors, see
Packit 7cfc04
https://www.kernel.org/doc/man-pages/reporting_bugs.html .