diff options
Diffstat (limited to 'doc/Signal.3')
-rw-r--r-- | doc/Signal.3 | 15 |
1 files changed, 9 insertions, 6 deletions
diff --git a/doc/Signal.3 b/doc/Signal.3 index e11c944..70b9d91 100644 --- a/doc/Signal.3 +++ b/doc/Signal.3 @@ -4,9 +4,8 @@ '\" 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.2 2002/01/15 21:19:06 dgp Exp $ -.so man.macros .TH Tcl_SignalId 3 8.3 Tcl "Tcl Library Procedures" +.so man.macros .BS .SH NAME Tcl_SignalId, Tcl_SignalMsg \- Convert signal codes @@ -14,13 +13,14 @@ Tcl_SignalId, Tcl_SignalMsg \- Convert signal codes .nf \fB#include <tcl.h>\fR .sp -CONST char * +const char * \fBTcl_SignalId\fR(\fIsig\fR) .sp -CONST char * +const char * \fBTcl_SignalMsg\fR(\fIsig\fR) .sp .SH ARGUMENTS +.AS int sig .AP int sig in A POSIX signal number such as \fBSIGPIPE\fR. .BE @@ -30,8 +30,11 @@ A POSIX signal number such as \fBSIGPIPE\fR. \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 +as +.QW SIGPIPE . +\fBTcl_SignalMsg\fR returns a human-readable string such as +.QW "bus error" . +The strings returned by these functions are statically allocated and the caller must not free or modify them. .SH KEYWORDS |