summaryrefslogtreecommitdiffstats
path: root/upstream/archlinux/man3p/psiginfo.3p
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-15 19:43:11 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-15 19:43:11 +0000
commitfc22b3d6507c6745911b9dfcc68f1e665ae13dbc (patch)
treece1e3bce06471410239a6f41282e328770aa404a /upstream/archlinux/man3p/psiginfo.3p
parentInitial commit. (diff)
downloadmanpages-l10n-fc22b3d6507c6745911b9dfcc68f1e665ae13dbc.tar.xz
manpages-l10n-fc22b3d6507c6745911b9dfcc68f1e665ae13dbc.zip
Adding upstream version 4.22.0.upstream/4.22.0
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'upstream/archlinux/man3p/psiginfo.3p')
-rw-r--r--upstream/archlinux/man3p/psiginfo.3p179
1 files changed, 179 insertions, 0 deletions
diff --git a/upstream/archlinux/man3p/psiginfo.3p b/upstream/archlinux/man3p/psiginfo.3p
new file mode 100644
index 00000000..8e503832
--- /dev/null
+++ b/upstream/archlinux/man3p/psiginfo.3p
@@ -0,0 +1,179 @@
+'\" et
+.TH PSIGINFO "3P" 2017 "IEEE/The Open Group" "POSIX Programmer's Manual"
+.\"
+.SH PROLOG
+This manual page is part of the POSIX Programmer's Manual.
+The Linux implementation of this interface may differ (consult
+the corresponding Linux manual page for details of Linux behavior),
+or the interface may not be implemented on Linux.
+.\"
+.SH NAME
+psiginfo, psignal
+\(em write signal information to standard error
+.SH SYNOPSIS
+.LP
+.nf
+#include <signal.h>
+.P
+void psiginfo(const siginfo_t *\fIpinfo\fP, const char *\fImessage\fP);
+void psignal(int \fIsignum\fP, const char *\fImessage\fP);
+.fi
+.SH DESCRIPTION
+The
+\fIpsiginfo\fR()
+and
+\fIpsignal\fR()
+functions shall write a language-dependent message associated with a
+signal number to the standard error stream as follows:
+.IP " *" 4
+First, if
+.IR message
+is not a null pointer and is not the empty string, the string pointed
+to by the
+.IR message
+argument shall be written, followed by a
+<colon>
+and a
+<space>.
+.IP " *" 4
+Then the signal description string associated with
+.IR signum
+or with the signal indicated by
+.IR pinfo
+shall be written, followed by a
+<newline>.
+.P
+For
+\fIpsiginfo\fR(),
+the application shall ensure that the argument
+.IR pinfo
+references a valid
+.BR siginfo_t
+structure. For
+\fIpsignal\fR(),
+if
+.IR signum
+is not a valid signal number, the behavior is implementation-defined.
+.P
+The
+\fIpsiginfo\fR()
+and
+\fIpsignal\fR()
+functions shall not change the orientation of the standard error stream.
+.P
+The
+\fIpsiginfo\fR()
+and
+\fIpsignal\fR()
+functions shall mark for update the last data modification and last file
+status change timestamps of the file associated with the standard error
+stream at some time between their successful completion and
+\fIexit\fR(),
+\fIabort\fR(),
+or the completion of
+\fIfflush\fR()
+or
+\fIfclose\fR()
+on
+.IR stderr .
+.P
+The
+\fIpsiginfo\fR()
+and
+\fIpsignal\fR()
+functions shall not change the setting of
+.IR errno
+if successful.
+.P
+On error, the
+\fIpsiginfo\fR()
+and
+\fIpsignal\fR()
+functions shall set the error indicator for the stream to which
+.IR stderr
+points, and shall set
+.IR errno
+to indicate the error.
+.P
+Since no value is returned, an application wishing to check for error
+situations should set
+.IR errno
+to 0, then call
+\fIpsiginfo\fR()
+or
+\fIpsignal\fR(),
+then check
+.IR errno .
+.SH "RETURN VALUE"
+These functions shall not return a value.
+.SH ERRORS
+Refer to
+.IR "\fIfputc\fR\^(\|)".
+.LP
+.IR "The following sections are informative."
+.SH EXAMPLES
+None.
+.SH "APPLICATION USAGE"
+As an alternative to setting
+.IR errno
+to zero before the call and checking if it is non-zero afterwards,
+applications can use
+\fIferror\fR()
+to detect whether
+\fIpsiginfo\fR()
+or
+\fIpsignal\fR()
+encountered an error.
+.P
+An application wishing to use this method to check for error situations
+should call
+.IR clearerr ( stderr )
+before calling
+\fIpsiginfo\fR()
+or
+\fIpsignal\fR(),
+then if
+.IR ferror ( stderr )
+returns non-zero, the value of
+.IR errno
+indicates which error occurred.
+.SH RATIONALE
+System V historically has
+\fIpsignal\fR()
+and
+\fIpsiginfo\fR()
+in
+.IR <siginfo.h> .
+However, the
+.IR <siginfo.h>
+header is not specified in the Base Definitions volume of POSIX.1\(hy2017, and the type
+.BR siginfo_t
+is defined in
+.IR <signal.h> .
+.SH "FUTURE DIRECTIONS"
+None.
+.SH "SEE ALSO"
+.IR "\fIfputc\fR\^(\|)",
+.IR "\fIperror\fR\^(\|)",
+.IR "\fIstrsignal\fR\^(\|)"
+.P
+The Base Definitions volume of POSIX.1\(hy2017,
+.IR "\fB<signal.h>\fP"
+.\"
+.SH COPYRIGHT
+Portions of this text are reprinted and reproduced in electronic form
+from IEEE Std 1003.1-2017, Standard for Information Technology
+-- Portable Operating System Interface (POSIX), The Open Group Base
+Specifications Issue 7, 2018 Edition,
+Copyright (C) 2018 by the Institute of
+Electrical and Electronics Engineers, Inc and The Open Group.
+In the event of any discrepancy between this version and the original IEEE and
+The Open Group Standard, the original IEEE and The Open Group Standard
+is the referee document. The original Standard can be obtained online at
+http://www.opengroup.org/unix/online.html .
+.PP
+Any typographical or formatting errors that appear
+in this page are most likely
+to have been introduced during the conversion of the source files to
+man page format. To report such errors, see
+https://www.kernel.org/doc/man-pages/reporting_bugs.html .