diff options
| -rw-r--r-- | doc/Panic.3 | 12 |
1 files changed, 9 insertions, 3 deletions
diff --git a/doc/Panic.3 b/doc/Panic.3 index cc3b17f..3f10f88 100644 --- a/doc/Panic.3 +++ b/doc/Panic.3 @@ -2,11 +2,12 @@ '\" 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.2 2001/08/07 02:59:14 hobbs Exp $ +'\" RCS: @(#) $Id: Panic.3,v 1.3 2001/08/25 20:14:06 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 .SH SYNOPSIS @@ -27,6 +28,7 @@ void .sp void \fBpanicVA\fR(\fIformat\fR, \fIargList\fR) +.sp .SH ARGUMENTS .AS Tcl_PanicProc *panicProc .AP "CONST char*" format in @@ -39,6 +41,7 @@ Must have been initialized using \fBTCL_VARARGS_START\fR, and cleared using \fBva_end\fR. .AP Tcl_PanicProc *panicProc in Procedure to report fatal error message and abort. + .BE .SH DESCRIPTION @@ -47,7 +50,7 @@ When the Tcl library detects that its internal data structures are in an inconsistent state, or that its C procedures have been called in a manner inconsistent with their documentation, it calls \fBTcl_Panic\fR to display a message describing the error and abort the process. The -\fIformat\fB argument is a format string describing how to format 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 @@ -61,10 +64,13 @@ return. \fBTcl_SetPanicProc\fR may be used to modify the behavior of \fBTcl_Panic\fR. The \fIpanicProc\fR argument should match the type \fBTcl_PanicProc\fR: +.PP .CS -typedef void Tcl_PanicProc( CONST char *\fBformat\fR, +typedef void Tcl_PanicProc( + CONST char *\fBformat\fR, \fBarg\fR, \fBarg\fR,...); .CE +.PP After \fBTcl_SetPanicProc\fR returns, any future calls to \fBTcl_Panic\fR will call \fIpanicProc\fR, passing along the \fIformat\fR and \fIarg\fR arguments. To maintain consistency with the |