X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_trace.3x.html;h=7cb64bd4cece0bcfe57e6c7612fd7174a9c35d31;hp=ab4eaef99224f8fe054f6800691e988ad3770baf;hb=06078d3fa68db669ed37178c01873546b4b28745;hpb=6208c89f98f1cf9fe0980bd8e791846ce007a13d
diff --git a/doc/html/man/curs_trace.3x.html b/doc/html/man/curs_trace.3x.html
index ab4eaef9..7cb64bd4 100644
--- a/doc/html/man/curs_trace.3x.html
+++ b/doc/html/man/curs_trace.3x.html
@@ -1,6 +1,6 @@
@@ -40,66 +40,82 @@
-curs_trace(3x) curs_trace(3x)
+curs_trace(3x) curs_trace(3x)
- _tracef, _tracedump, _traceattr, _traceattr2,
- _nc_tracebits, _tracecchar_t, _tracecchar_t2, _tracechar,
- _tracechtype, _tracechtype2, _tracemouse, trace - curses
- debugging routines
+ trace, _tracef, _traceattr, _traceattr2, _tracecchar_t, _tracecchar_t2,
+ _tracechar, _tracechtype, _tracechtype2, _nc_tracebits, _tracedump,
+ _tracemouse - curses debugging routines
#include <curses.h>
+ void trace(const unsigned int param);
+
void _tracef(const char *format, ...);
- void _tracedump(const char *label, WINDOW *win);
+
char *_traceattr(attr_t attr);
char *_traceattr2(int buffer, chtype ch);
- char *_nc_tracebits(void);
- char * _tracecchar_t(const cchar_t *string);
- char * _tracecchar_t2(int buffer, const cchar_t *string);
+ char *_tracecchar_t(const cchar_t *string);
+ char *_tracecchar_t2(int buffer, const cchar_t *string);
char *_tracechar(int ch);
char *_tracechtype(chtype ch);
char *_tracechtype2(int buffer, chtype ch);
+
+ void _tracedump(const char *label, WINDOW *win);
+ char *_nc_tracebits(void);
char *_tracemouse(const MEVENT *event);
- void trace(const unsigned int param);
- 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.
+
+ 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.
- o _tracef, which writes formatted data to the trace
- file.
+ 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.
- Calling trace with a nonzero parameter opens the file
- trace in the current directory for output. The parameter
- is formed by OR'ing values from the list of TRACE_xxx def-
- initions in <curses.h>. These include:
+
+
+ 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.
+ turn off tracing by passing a zero parameter.
+
+ 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.
TRACE_TPUTS
- trace tputs calls.
+ trace tputs(3x) calls.
TRACE_UPDATE
trace update actions, old & new screens.
@@ -111,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.
@@ -141,40 +156,54 @@
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 parameter is
+ nonzero. Some features overlap. The specific names are used as a
+ guideline.
+
+
+
+ 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
- Some tracing features are enabled whenever the trace pa-
- rameter is nonzero. Some features overlap. The specific
- names are used as a guideline.
- 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 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.
- These functions check the NCURSES_TRACE environment vari-
- able, to set the tracing feature as if trace was called:
+ 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:
- filter, initscr, new_prescr, newterm, nofilter,
- restartterm, ripoffline, setupterm, slk_init, tge-
- tent, use_env, use_extended_names, use_tioctl
+ o messages produced in the utility are written to the standard error.
+
+ 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.
- 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:
+
+ _nc_tracebits, _tracedump, _tracemouse
@@ -182,13 +211,20 @@
- curs_trace(3x)
+ curs_trace(3x)