man3/psignal.3

   1 .\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
   2 .\"
   3 .\" %%%LICENSE_START(VERBATIM)
   4 .\" Permission is granted to make and distribute verbatim copies of this
   5 .\" manual provided the copyright notice and this permission notice are
   6 .\" preserved on all copies.
   7 .\"
   8 .\" Permission is granted to copy and distribute modified versions of this
   9 .\" manual under the conditions for verbatim copying, provided that the
  10 .\" entire resulting derived work is distributed under the terms of a
  11 .\" permission notice identical to this one.
  12 .\"
  13 .\" Since the Linux kernel and libraries are constantly changing, this
  14 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  15 .\" responsibility for errors or omissions, or for damages resulting from
  16 .\" the use of the information contained herein.  The author(s) may not
  17 .\" have taken the same level of care in the production of this manual,
  18 .\" which is licensed free of charge, as they might when working
  19 .\" professionally.
  20 .\"
  21 .\" Formatted or processed versions of this manual, if unaccompanied by
  22 .\" the source, must acknowledge the copyright and authors of this work.
  23 .\" %%%LICENSE_END
  24 .\"
  25 .\" References consulted:
  26 .\"     Linux libc source code
  27 .\"     Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991)
  28 .\"     386BSD man pages
  29 .\" Modified Sat Jul 24 18:45:17 1993 by Rik Faith (faith@cs.unc.edu)
  30 .TH PSIGNAL 3  2021-03-22 "GNU" "Linux Programmer's Manual"
  31 .SH NAME
  32 psignal, psiginfo \- print signal description
  33 .SH SYNOPSIS
  34 .nf
  35 .B #include <signal.h>
  36 .PP
  37 .BI "void psignal(int " sig ", const char *" s );
  38 .BI "void psiginfo(const siginfo_t *" pinfo ", const char *" s );
  39 .fi
  40 .PP
  41 .RS -4
  42 Feature Test Macro Requirements for glibc (see
  43 .BR feature_test_macros (7)):
  44 .RE
  45 .PP
  46 .BR psignal ():
  47     Since glibc 2.19:
  48             _DEFAULT_SOURCE
  49     Glibc 2.19 and earlier:
  50         _BSD_SOURCE || _SVID_SOURCE
  51 .PP
  52 .BR psiginfo ():
  53 .nf
  54     _POSIX_C_SOURCE >= 200809L
  55 .fi
  56 .SH DESCRIPTION
  57 The
  58 .BR psignal ()
  59 function displays a message on \fIstderr\fP
  60 consisting of the string \fIs\fP, a colon, a space, a string
  61 describing the signal number \fIsig\fP, and a trailing newline.
  62 If the string \fIs\fP is NULL or empty, the colon and space are omitted.
  63 If \fIsig\fP is invalid,
  64 the message displayed will indicate an unknown signal.
  65 .PP
  66 The
  67 .BR psiginfo ()
  68 function is like
  69 .BR psignal (),
  70 except that it displays information about the signal described by
  71 .IR pinfo ,
  72 which should point to a valid
  73 .I siginfo_t
  74 structure.
  75 As well as the signal description,
  76 .BR psiginfo ()
  77 displays information about the origin of the signal,
  78 and other information relevant to the signal
  79 (e.g., the relevant memory address for hardware-generated signals,
  80 the child process ID for
  81 .BR SIGCHLD ,
  82 and the user ID and process ID of the sender, for signals set using
  83 .BR kill (2)
  84 or
  85 .BR sigqueue (3)).
  86 .SH RETURN VALUE
  87 The
  88 .BR psignal ()
  89 and
  90 .BR psiginfo ()
  91 functions return no value.
  92 .SH VERSIONS
  93 The
  94 .BR psiginfo ()
  95 function was added to glibc in version 2.10.
  96 .SH ATTRIBUTES
  97 For an explanation of the terms used in this section, see
  98 .BR attributes (7).
  99 .ad l
 100 .nh
 101 .TS
 102 allbox;
 103 lbx lb lb
 104 l l l.
 105 Interface       Attribute       Value
 106 T{
 107 .BR psignal (),
 108 .BR psiginfo ()
 109 T}      Thread safety   MT-Safe locale
 110 .TE
 111 .hy
 112 .ad
 113 .sp 1
 114 .SH CONFORMING TO
 115 POSIX.1-2008, 4.3BSD.
 116 .SH BUGS
 117 In glibc versions up to 2.12,
 118 .BR psiginfo ()
 119 had the following bugs:
 120 .IP * 3
 121 In some circumstances, a trailing newline is not printed.
 122 .\" FIXME . http://sourceware.org/bugzilla/show_bug.cgi?id=12107
 123 .\" Reportedly now fixed; check glibc 2.13
 124 .IP *
 125 Additional details are not displayed for real-time signals.
 126 .\" FIXME . http://sourceware.org/bugzilla/show_bug.cgi?id=12108
 127 .\" Reportedly now fixed; check glibc 2.13
 128 .SH SEE ALSO
 129 .BR sigaction (2),
 130 .BR perror (3),
 131 .BR strsignal (3),
 132 .BR signal (7)