X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_trace.3x.html;h=af3a377cf76be51b3ad8f460feed3a21663a5c85;hp=85ffaad03b7ac8008e0ed04e062f224aa42154f0;hb=ed646e3f683083e787c6ba773364401dc9fa9d40;hpb=f344f8539c1543f8cd65a5bb142dbaf23b9421d2 diff --git a/doc/html/man/curs_trace.3x.html b/doc/html/man/curs_trace.3x.html index 85ffaad0..af3a377c 100644 --- a/doc/html/man/curs_trace.3x.html +++ b/doc/html/man/curs_trace.3x.html @@ -40,16 +40,15 @@
-curs_trace(3x) curs_trace(3x) +curs_trace(3x) curs_trace(3x)
- trace, _tracef, _traceattr, _traceattr2, _tracecchar_t, - _tracecchar_t2, _tracechar, _tracechtype, _tracechtype2, - _nc_tracebits, _tracedump, _tracemouse - curses debugging - routines + trace, _tracef, _traceattr, _traceattr2, _tracecchar_t, _tracecchar_t2, + _tracechar, _tracechtype, _tracechtype2, _nc_tracebits, _tracedump, + _tracemouse - curses debugging routines
@@ -73,51 +72,44 @@
- The trace routines are used for debugging the ncurses li- - braries, as well as applications which use the ncurses li- - braries. These functions are normally available only with - the debugging library e.g., libncurses_g.a, but may be - compiled into any model (shared, static, profile) by - defining the symbol TRACE. Additionally, some functions - are only available with the wide-character configuration - of the libraries. + The trace routines are used for debugging the ncurses libraries, as + well as applications which use the ncurses libraries. These functions + are normally available only with the debugging library e.g., libncurs- + es_g.a, but may be compiled into any model (shared, static, profile) by + defining the symbol TRACE. Additionally, some functions are only + available with the wide-character configuration of the libraries.
The principal parts of this interface are - o trace, which selectively enables different tracing - features, and + o trace, which selectively enables different tracing features, and - o _tracef, which writes formatted data to the trace - file. + o _tracef, which writes formatted data to the trace file. - Calling trace with a nonzero parameter creates the file - trace in the current directory for output. If the file - already exists, no tracing is done. + Calling trace with a nonzero parameter creates the file trace in the + current directory for output. If the file already exists, no tracing + is done. - The other functions either return a pointer to a string- - area (allocated by the corresponding function), or return - no value (such as _tracedump, which implements the screen - dump for TRACE_UPDATE). The caller should not free these - strings, since the allocation is reused on successive - calls. To work around the problem of a single string-area - per function, some use a buffer-number parameter, telling - the library to allocate additional string-areas. + The other functions either return a pointer to a string-area (allocated + by the corresponding function), or return no value (such as _tracedump, + which implements the screen dump for TRACE_UPDATE). The caller should + not free these strings, since the allocation is reused on successive + calls. To work around the problem of a single string-area per func- + tion, some use a buffer-number parameter, telling the library to allo- + cate additional string-areas.
- The trace parameter is formed by OR'ing values from the - list of TRACE_xxx definitions in <curses.h>. These in- - clude: + The trace parameter is formed by OR'ing values from the list of + TRACE_xxx definitions in <curses.h>. These include: TRACE_DISABLE turn off tracing by passing a zero parameter. - The library flushes the output file, but retains an - open file-descriptor to the trace file so that it can - resume tracing later if a nonzero parameter is passed - to the trace function. + The library flushes the output file, but retains an open file-de- + scriptor to the trace file so that it can resume tracing later if + a nonzero parameter is passed to the trace function. TRACE_TIMES trace user and system times of updates. @@ -135,13 +127,12 @@ trace all character outputs. TRACE_ORDINARY - trace all update actions. The old and new screen - contents are written to the trace file for each re- - fresh. + trace all update actions. The old and new screen contents are + written to the trace file for each refresh. TRACE_CALLS - trace all curses calls. The parameters for each call - are traced, as well as return values. + trace all curses calls. The parameters for each call are traced, + as well as return values. TRACE_VIRTPUT trace virtual character puts, i.e., calls to addch. @@ -165,60 +156,52 @@ trace changes to video attributes and colors. TRACE_MAXIMUM - maximum trace level, enables all of the separate - trace features. + maximum trace level, enables all of the separate trace features. - Some tracing features are enabled whenever the trace pa- - rameter is nonzero. Some features overlap. The specific - names are used as a guideline. + Some tracing features are enabled whenever the trace parameter is + nonzero. Some features overlap. The specific names are used as a + guideline.
- These functions check the NCURSES_TRACE environment vari- - able, to set the tracing feature as if trace was called: + These functions check the NCURSES_TRACE environment variable, to set + the tracing feature as if trace was called: - filter, initscr, new_prescr, newterm, nofilter, - restartterm, ripoffline, setupterm, slk_init, tgetent, - use_env, use_extended_names, use_tioctl + filter, initscr, new_prescr, newterm, nofilter, restartterm, + ripoffline, setupterm, slk_init, tgetent, use_env, + use_extended_names, use_tioctl
- The command-line utilities such as tic(1) provide a ver- - bose option which extends the set of messages written us- - ing the trace function. Both of these (-v and trace) use - the same variable (_nc_tracing), which determines the mes- - sages which are written. + The command-line utilities such as tic(1) provide a verbose option + which extends the set of messages written using the trace function. + Both of these (-v and trace) use the same variable (_nc_tracing), which + determines the messages which are written. - Because the command-line utilities may call initialization - functions such as setupterm, tgetent or use_extend- - ed_names, some of their debugging output may be directed - to the trace file if the NCURSES_TRACE environment vari- - able is set: + Because the command-line utilities may call initialization functions + such as setupterm, tgetent or use_extended_names, some of their debug- + ging output may be directed to the trace file if the NCURSES_TRACE en- + vironment variable is set: - o messages produced in the utility are written to the - standard error. + o messages produced in the utility are written to the standard error. - o messages produced by the underlying library are writ- - ten to trace. + o messages produced by the underlying library are written to trace. - If ncurses is built without tracing, none of the latter - are produced, and fewer diagnostics are provided by the - command-line utilities. + If ncurses is built without tracing, none of the latter are produced, + and fewer diagnostics are provided by the command-line utilities.
- Routines which return a value are designed to be used as - parameters to the _tracef routine. + Routines which return a value are designed to be used as parameters to + the _tracef routine.
- These functions are not part of the XSI interface. Some - other curses implementations are known to have similar, - undocumented features, but they are not compatible with - ncurses. + These functions are not part of the XSI interface. Some other curses + implementations are known to have similar, undocumented features, but + they are not compatible with ncurses. - A few functions are not provided when symbol versioning is - used: + A few functions are not provided when symbol versioning is used: _nc_tracebits, _tracedump, _tracemouse @@ -228,7 +211,7 @@ - curs_trace(3x) + curs_trace(3x)