original/man3/strsignal.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 17:59:03 1993 by Rik Faith (faith@cs.unc.edu)
  30 .TH STRSIGNAL 3  2010-09-15 "GNU" "Linux Programmer's Manual"
  31 .SH NAME
  32 strsignal \- return string describing signal
  33 .SH SYNOPSIS
  34 .nf
  35 .B #include <string.h>
  36 .sp
  37 .BI "char *strsignal(int " sig );
  38 .sp
  39 .BI "extern const char * const " sys_siglist [];
  40 .fi
  41 .sp
  42 .in -4n
  43 Feature Test Macro Requirements for glibc (see
  44 .BR feature_test_macros (7)):
  45 .in
  46 .sp
  47 .BR strsignal ():
  48 .PD 0
  49 .ad l
  50 .RS 4
  51 .TP 4
  52 Since glibc 2.10:
  53 _XOPEN_SOURCE\ >=\ 700 || _POSIX_C_SOURCE\ >=\ 200809L
  54 .TP
  55 Before glibc 2.10:
  56 _GNU_SOURCE
  57 .RE
  58 .ad
  59 .PD
  60 .SH DESCRIPTION
  61 The
  62 .BR strsignal ()
  63 function returns a string describing the signal
  64 number passed in the argument \fIsig\fP.
  65 The string can be used only until the next call to
  66 .BR strsignal ().
  67 .PP
  68 The array \fIsys_siglist\fP holds the signal description strings
  69 indexed by signal number.
  70 The
  71 .BR strsignal ()
  72 function should be
  73 used if possible instead of this array.
  74 .SH RETURN VALUE
  75 The
  76 .BR strsignal ()
  77 function returns the appropriate description
  78 string, or an unknown signal message if the signal number is invalid.
  79 On some systems (but not on Linux), a NULL pointer may be
  80 returned instead for an invalid signal number.
  81 .SH CONFORMING TO
  82 POSIX.1-2008.
  83 Present on Solaris and the BSDs.
  84 .SH SEE ALSO
  85 .BR psignal (3),
  86 .BR strerror (3)