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  2017-09-15 "GNU" "Linux Programmer's Manual"
  31 .SH NAME
  32 psignal, psiginfo \- print signal message
  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 .PP
  40 .BI "extern const char *const " sys_siglist [];
  41 .fi
  42 .PP
  43 .in -4n
  44 Feature Test Macro Requirements for glibc (see
  45 .BR feature_test_macros (7)):
  46 .in
  47 .PP
  48 .BR psignal ():
  49     Since glibc 2.19:
  50         _DEFAULT_SOURCE
  51     Glibc 2.19 and earlier:
  52         _BSD_SOURCE || _SVID_SOURCE
  53 .br
  54 .BR psiginfo ():
  55 _POSIX_C_SOURCE\ >=\ 200809L
  56 .br
  57 .IR sys_siglist :
  58     Since glibc 2.19:
  59         _DEFAULT_SOURCE
  60     Glibc 2.19 and earlier:
  61         _BSD_SOURCE
  62 .SH DESCRIPTION
  63 The
  64 .BR psignal ()
  65 function displays a message on \fIstderr\fP
  66 consisting of the string \fIs\fP, a colon, a space, a string
  67 describing the signal number \fIsig\fP, and a trailing newline.
  68 If the string \fIs\fP is NULL or empty, the colon and space are omitted.
  69 If \fIsig\fP is invalid,
  70 the message displayed will indicate an unknown signal.
  71 .PP
  72 The
  73 .BR psiginfo ()
  74 function is like
  75 .BR psignal (),
  76 except that it displays information about the signal described by
  77 .IR pinfo ,
  78 which should point to a valid
  79 .I siginfo_t
  80 structure.
  81 As well as the signal description,
  82 .BR psiginfo ()
  83 displays information about the origin of the signal,
  84 and other information relevant to the signal
  85 (e.g., the relevant memory address for hardware-generated signals,
  86 the child process ID for
  87 .BR SIGCHLD ,
  88 and the user ID and process ID of the sender, for signals set using
  89 .BR kill (2)
  90 or
  91 .BR sigqueue (3)).
  92 .PP
  93 The array \fIsys_siglist\fP holds the signal description strings
  94 indexed by signal number.
  95 .SH RETURN VALUE
  96 The
  97 .BR psignal ()
  98 and
  99 .BR psiginfo ()
 100 functions return no value.
 101 .SH VERSIONS
 102 The
 103 .BR psiginfo ()
 104 function was added to glibc in version 2.10.
 105 .SH ATTRIBUTES
 106 For an explanation of the terms used in this section, see
 107 .BR attributes (7).
 108 .TS
 109 allbox;
 110 lbw21 lb lb
 111 l l l.
 112 Interface       Attribute       Value
 113 T{
 114 .BR psignal (),
 115 .BR psiginfo ()
 116 T}      Thread safety   MT-Safe locale
 117 .TE
 118 .sp 1
 119 .SH CONFORMING TO
 120 POSIX.1-2008, 4.3BSD.
 121 .SH BUGS
 122 In glibc versions up to 2.12,
 123 .BR psiginfo ()
 124 had the following bugs:
 125 .IP * 3
 126 In some circumstances, a trailing newline is not printed.
 127 .\" FIXME . http://sourceware.org/bugzilla/show_bug.cgi?id=12107
 128 .\" Reportedly now fixed; check glibc 2.13
 129 .IP *
 130 Additional details are not displayed for real-time signals.
 131 .\" FIXME . http://sourceware.org/bugzilla/show_bug.cgi?id=12108
 132 .\" Reportedly now fixed; check glibc 2.13
 133 .SH SEE ALSO
 134 .BR sigaction (2),
 135 .BR perror (3),
 136 .BR strsignal (3),
 137 .BR signal (7)