summaryrefslogtreecommitdiffstats
path: root/doc/Signal.3
diff options
context:
space:
mode:
Diffstat (limited to 'doc/Signal.3')
-rw-r--r--doc/Signal.338
1 files changed, 38 insertions, 0 deletions
diff --git a/doc/Signal.3 b/doc/Signal.3
new file mode 100644
index 0000000..b49dbe7
--- /dev/null
+++ b/doc/Signal.3
@@ -0,0 +1,38 @@
+'\"
+'\" Copyright (c) 2001 ActiveState Tool Corp.
+'\"
+'\" See the file "license.terms" for information on usage and redistribution
+'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
+'\"
+'\" RCS: @(#) $Id: Signal.3,v 1.1 2001/04/03 14:53:45 andreas_kupries Exp $
+.so man.macros
+.TH Tcl_SignalId 3 8.3 Tcl "Tcl Library Procedures"
+.BS
+.SH NAME
+Tcl_SignalId, Tcl_SignalMsg \- Convert signal codes
+.SH SYNOPSIS
+.nf
+\fB#include <tcl.h>\fR
+.sp
+char *
+\fBTcl_SignalId\fR(\fIsig\fR)
+.sp
+char *
+\fBTcl_SignalMsg\fR(\fIsig\fR)
+.sp
+.SH ARGUMENTS
+.AP int sig in
+A POSIX signal number such as \fBSIGPIPE\fR.
+.BE
+
+.SH DESCRIPTION
+.PP
+\fBTcl_SignalId\fR and \fBTcl_SignalMsg\fR return a string
+representation of the provided signal number (\fIsig\fR).
+\fBTcl_SignalId\fR returns a machine-readable textual identifier such
+as "SIGPIPE". \fBTcl_SignalMsg\fR returns a human-readable string such
+as "bus error". The strings returned by these functions are
+statically allocated and the caller must not free or modify them.
+
+.SH KEYWORDS
+signals, signal numbers