X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fcurs_trace.3x;h=d5f6fde0681ab8746a0cf809665ce9f7ceca26ee;hp=4af258da3b09128deb63303a917c8038ba245375;hb=71c0306f0824ef2b10c4c5813fb003db48f3012e;hpb=46722468f47c2b77b3987729b4bcf2321cccfd01 diff --git a/man/curs_trace.3x b/man/curs_trace.3x index 4af258da..d5f6fde0 100644 --- a/man/curs_trace.3x +++ b/man/curs_trace.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 2000,2002 Free Software Foundation, Inc. * +.\" Copyright (c) 2000-2009,2010 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * .\" copy of this software and associated documentation files (the * @@ -26,22 +26,28 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_trace.3x,v 1.5 2002/02/16 22:39:52 tom Exp $ +.\" $Id: curs_trace.3x,v 1.11 2010/07/31 16:10:55 tom Exp $ .TH curs_trace 3X "" +.na +.hy 0 .SH NAME \fB_tracef\fR, \fB_tracedump\fR, \fB_traceattr\fR, \fB_traceattr2\fR, \fB_nc_tracebits\fR, +\fB_tracecchar_t\fR, +\fB_tracecchar_t2\fR, \fB_tracechar\fR, \fB_tracechtype\fR, \fB_tracechtype2\fR, \fB_tracemouse\fR, -\fBtrace\fR - \fBcurses\fR debugging routines +\fBtrace\fR \- \fBcurses\fR debugging routines +.ad +.hy .SH SYNOPSIS \fB#include \fR -.br +.sp \fBvoid _tracef(const char *format, ...);\fR .br \fBvoid _tracedump(const char *label, WINDOW *win);\fR @@ -52,7 +58,11 @@ .br \fBchar *_nc_tracebits(void);\fR .br -\fBchar *_tracechar(const unsigned char ch);\fR +\fBchar * _tracecchar_t(const cchar_t *string);\fR +.br +\fBchar * _tracecchar_t2(int buffer, const cchar_t *string);\fR +.br +\fBchar *_tracechar(int ch);\fR .br \fBchar *_tracechtype(chtype ch);\fR .br @@ -67,11 +77,13 @@ as well as applications which use the ncurses libraries. These functions are normally available only with the debugging library \fIlibncurses_g.a\fR, but may be compiled into any model (shared, static, profile) by defining the symbol \fBTRACE\fR. - +Additionally, some functions are only available with the wide-character +configuration of the libraries. +.PP The principal parts of this interface are the \fBtrace\fR routine which selectively enables different tracing features, and the \fB_tracef\fR routine which writes formatted data to the \fItrace\fR file. - +.PP Calling \fBtrace\fR with a nonzero parameter opens the file \fBtrace\fR in the current directory for output. The parameter is formed by OR'ing values from the list of \fBTRACE_\fP\fIxxx\fR definitions in \fB\fR. @@ -127,10 +139,25 @@ trace changes to video attributes and colors. .TP 5 TRACE_MAXIMUM maximum trace level, enables all of the separate trace features. - +.PP Some tracing features are enabled whenever the \fBtrace\fR parameter is nonzero. Some features overlap. The specific names are used as a guideline. +.PP +These functions check the \fBNCURSES_TRACE\fP environment variable, +to set the tracing feature as if \fBtrace\fP was called: +.RS +filter, +initscr, +new_prescr, +newterm, +nofilter, +ripoffline, +setupterm, +slk_init, +tgetent +.RE + .SH RETURN VALUE Routines which return a value are designed to be used as parameters to the \fB_tracef\fR routine.