diff options
Diffstat (limited to 'doc/Panic.3')
| -rw-r--r-- | doc/Panic.3 | 26 |
1 files changed, 8 insertions, 18 deletions
diff --git a/doc/Panic.3 b/doc/Panic.3 index 3f10f88..0b2ec03 100644 --- a/doc/Panic.3 +++ b/doc/Panic.3 @@ -2,14 +2,14 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: Panic.3,v 1.3 2001/08/25 20:14:06 dgp Exp $ +'\" RCS: @(#) $Id: Panic.3,v 1.8 2005/09/13 21:23:51 dgp Exp $ '\" .so man.macros .TH Tcl_Panic 3 8.4 Tcl "Tcl Library Procedures" .BS '\" Note: do not modify the .SH NAME line immediately below! .SH NAME -Tcl_Panic, Tcl_PanicVA, Tcl_SetPanicProc, panic, panicVA \- report fatal error and abort +Tcl_Panic, Tcl_PanicVA, Tcl_SetPanicProc \- report fatal error and abort .SH SYNOPSIS .nf \fB#include <tcl.h>\fR @@ -23,21 +23,15 @@ void void \fBTcl_SetPanicProc\fR(\fIpanicProc\fR) .sp -void -\fBpanic\fR(\fIformat\fR, \fIarg\fR, \fIarg\fR, \fI...\fR) -.sp -void -\fBpanicVA\fR(\fIformat\fR, \fIargList\fR) -.sp .SH ARGUMENTS .AS Tcl_PanicProc *panicProc -.AP "CONST char*" format in +.AP "const char*" format in A printf-style format string. .AP "" arg in Arguments matching the format string. .AP va_list argList in An argument list of arguments matching the format string. -Must have been initialized using \fBTCL_VARARGS_START\fR, +Must have been initialized using \fBva_start\fR, and cleared using \fBva_end\fR. .AP Tcl_PanicProc *panicProc in Procedure to report fatal error message and abort. @@ -53,7 +47,7 @@ to display a message describing the error and abort the process. The \fIformat\fR argument is a format string describing how to format the remaining arguments \fIarg\fR into an error message, according to the same formatting rules used by the \fBprintf\fR family of functions. The -same formatting rules are also used by the builtin Tcl command +same formatting rules are also used by the built-in Tcl command \fBformat\fR. .PP In a freshly loaded Tcl library, \fBTcl_Panic\fR prints the formatted @@ -67,8 +61,8 @@ type \fBTcl_PanicProc\fR: .PP .CS typedef void Tcl_PanicProc( - CONST char *\fBformat\fR, - \fBarg\fR, \fBarg\fR,...); + const char *\fBformat\fR, + \fBarg\fR, \fBarg\fR,...); .CE .PP After \fBTcl_SetPanicProc\fR returns, any future calls to @@ -94,11 +88,7 @@ have a panic message displayed the same way that panic messages from Tcl will be displayed. .PP \fBTcl_PanicVA\fR is the same as \fBTcl_Panic\fR except that instead of -taking a variable number of arguments it takes an argument list. The -procedures \fBpanic\fR and \fBpanicVA\fR are synonyms (implemented as -macros) for \fBTcl_Panic\fR and \fBTcl_PanicVA\fR, respectively. They -exist to support old code; new code should use direct calls to -\fBTcl_Panic\fR or \fBTcl_PanicVA\fR. +taking a variable number of arguments it takes an argument list. .SH "SEE ALSO" abort(3), printf(3), exec(n), format(n) |