original/man3/strsignal.3

   1 .\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
   2 .\"
   3 .\" Permission is granted to make and distribute verbatim copies of this
   4 .\" manual provided the copyright notice and this permission notice are
   5 .\" preserved on all copies.
   6 .\"
   7 .\" Permission is granted to copy and distribute modified versions of this
   8 .\" manual under the conditions for verbatim copying, provided that the
   9 .\" entire resulting derived work is distributed under the terms of a
  10 .\" permission notice identical to this one.
  11 .\"
  12 .\" Since the Linux kernel and libraries are constantly changing, this
  13 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  14 .\" responsibility for errors or omissions, or for damages resulting from
  15 .\" the use of the information contained herein.  The author(s) may not
  16 .\" have taken the same level of care in the production of this manual,
  17 .\" which is licensed free of charge, as they might when working
  18 .\" professionally.
  19 .\"
  20 .\" Formatted or processed versions of this manual, if unaccompanied by
  21 .\" the source, must acknowledge the copyright and authors of this work.
  22 .\"
  23 .\" References consulted:
  24 .\"     Linux libc source code
  25 .\"     Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991)
  26 .\"     386BSD man pages
  27 .\" Modified Sat Jul 24 17:59:03 1993 by Rik Faith (faith@cs.unc.edu)
  28 .TH STRSIGNAL 3  2010-09-15 "GNU" "Linux Programmer's Manual"
  29 .SH NAME
  30 strsignal \- return string describing signal
  31 .SH SYNOPSIS
  32 .nf
  33 .B #include <string.h>
  34 .sp
  35 .BI "char *strsignal(int " sig );
  36 .sp
  37 .BI "extern const char * const " sys_siglist [];
  38 .fi
  39 .sp
  40 .in -4n
  41 Feature Test Macro Requirements for glibc (see
  42 .BR feature_test_macros (7)):
  43 .in
  44 .sp
  45 .BR strsignal ():
  46 .PD 0
  47 .ad l
  48 .RS 4
  49 .TP 4
  50 Since glibc 2.10:
  51 _XOPEN_SOURCE\ >=\ 700 || _POSIX_C_SOURCE\ >=\ 200809L
  52 .TP
  53 Before glibc 2.10:
  54 _GNU_SOURCE
  55 .RE
  56 .ad
  57 .PD
  58 .SH DESCRIPTION
  59 The
  60 .BR strsignal ()
  61 function returns a string describing the signal
  62 number passed in the argument \fIsig\fP.
  63 The string can only be used
  64 until the next call to
  65 .BR strsignal ().
  66 .PP
  67 The array \fIsys_siglist\fP holds the signal description strings
  68 indexed by signal number.
  69 The
  70 .BR strsignal ()
  71 function should be
  72 used if possible instead of this array.
  73 .SH "RETURN VALUE"
  74 The
  75 .BR strsignal ()
  76 function returns the appropriate description
  77 string, or an unknown signal message if the signal number is invalid.
  78 On some systems (but not on Linux), a NULL pointer may be
  79 returned instead for an invalid signal number.
  80 .SH "CONFORMING TO"
  81 POSIX.1-2008.
  82 Present on Solaris and the BSDs.
  83 .SH "SEE ALSO"
  84 .BR psignal (3),
  85 .BR strerror (3),
  86 .BR feature_test_macros (7)