util/src/TclTk/tcl8.6.12/doc/Signal.3

   1 '\"
   2 '\" Copyright (c) 2001 ActiveState Tool Corp.
   3 '\"
   4 '\" See the file "license.terms" for information on usage and redistribution
   5 '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
   6 '\"
   7 .TH Tcl_SignalId 3 8.3 Tcl "Tcl Library Procedures"
   8 .so man.macros
   9 .BS
  10 .SH NAME
  11 Tcl_SignalId, Tcl_SignalMsg \- Convert signal codes
  12 .SH SYNOPSIS
  13 .nf
  14 \fB#include <tcl.h>\fR
  15 .sp
  16 const char *
  17 \fBTcl_SignalId\fR(\fIsig\fR)
  18 .sp
  19 const char *
  20 \fBTcl_SignalMsg\fR(\fIsig\fR)
  21 .sp
  22 .SH ARGUMENTS
  23 .AS int sig
  24 .AP int sig in
  25 A POSIX signal number such as \fBSIGPIPE\fR.
  26 .BE
  27
  28 .SH DESCRIPTION
  29 .PP
  30 \fBTcl_SignalId\fR and \fBTcl_SignalMsg\fR return a string
  31 representation of the provided signal number (\fIsig\fR).
  32 \fBTcl_SignalId\fR returns a machine-readable textual identifier such
  33 as
  34 .QW SIGPIPE .
  35 \fBTcl_SignalMsg\fR returns a human-readable string such as
  36 .QW "bus error" .
  37 The strings returned by these functions are
  38 statically allocated and the caller must not free or modify them.
  39
  40 .SH KEYWORDS
  41 signals, signal numbers