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  1999-02-08 "GNU" "Linux Programmer's Manual"
  29 .SH NAME
  30 strsignal \- return string describing signal
  31 .SH SYNOPSIS
  32 .nf
  33 .B #define _GNU_SOURCE
  34 .br
  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 .SH DESCRIPTION
  42 The \fBstrsignal()\fP function returns a string describing the signal
  43 number passed in the argument \fIsig\fP.  The string can only be used
  44 until the next call to \fBstrsignal()\fP.
  45 .PP
  46 The array \fIsys_siglist\fP holds the signal description strings
  47 indexed by signal number.  The \fBstrsignal()\fP function should be
  48 used if possible instead of this array.
  49 .SH "RETURN VALUE"
  50 The \fBstrsignal()\fP function returns the appropriate description
  51 string, or an unknown signal message if the signal number is invalid.
  52 On some systems (but not on Linux), a \fBNULL\fP pointer may be
  53 returned instead for an invalid signal number.
  54 .SH "CONFORMING TO"
  55 This function is not part of any standard, but may be found on Linux
  56 systems and some UNIX systems (such as Solaris).
  57 .SH "SEE ALSO"
  58 .BR psignal (3),
  59 .BR strerror (3)