1curs_trace(3X)                                                  curs_trace(3X)
2
3
4

NAME

6       _tracef, _tracedump, _traceattr, _traceattr2, _nc_tracebits,
7       _tracechar, _tracechtype, _tracechtype2, _tracemouse, trace - curses
8       debugging routines
9

SYNOPSIS

11       #include <curses.h>
12
13       void _tracef(const char *format, ...);
14       void _tracedump(const char *label, WINDOW *win);
15       char *_traceattr(attr_t attr);
16       char *_traceattr2(int buffer, chtype ch);
17       char *_nc_tracebits(void);
18       char *_tracechar(int);
19       char *_tracechtype(chtype ch);
20       char *_tracechtype2(int buffer, chtype ch);
21       char *_tracemouse(const MEVENT *event);
22       void trace(const unsigned int param);
23

DESCRIPTION

25       The  trace  routines  are  used for debugging the ncurses libraries, as
26       well as applications which use the ncurses libraries.  These  functions
27       are  normally available only with the debugging library libncurses_g.a,
28       but may be compiled into any model (shared, static, profile) by  defin‐
29       ing the symbol TRACE.
30
31       The  principal  parts of this interface are the trace routine which se‐
32       lectively enables different tracing features, and the  _tracef  routine
33       which writes formatted data to the trace file.
34
35       Calling trace with a nonzero parameter opens the file trace in the cur‐
36       rent directory for output.  The parameter is formed  by  OR'ing  values
37       from the list of TRACE_xxx definitions in <curses.h>.  These include:
38
39       TRACE_DISABLE
40            turn off tracing.
41
42       TRACE_TIMES
43            trace user and system times of updates.
44
45       TRACE_TPUTS
46            trace tputs calls.
47
48       TRACE_UPDATE
49            trace update actions, old & new screens.
50
51       TRACE_MOVE
52            trace cursor movement and scrolling.
53
54       TRACE_CHARPUT
55            trace all character outputs.
56
57       TRACE_ORDINARY
58            trace  all  update  actions.   The old and new screen contents are
59            written to the trace file for each refresh.
60
61       TRACE_CALLS
62            trace all curses calls.  The parameters for each call are  traced,
63            as well as return values.
64
65       TRACE_VIRTPUT
66            trace virtual character puts, i.e., calls to addch.
67
68       TRACE_IEVENT
69            trace low-level input processing, including timeouts.
70
71       TRACE_BITS
72            trace state of TTY control bits.
73
74       TRACE_ICALLS
75            trace internal/nested calls.
76
77       TRACE_CCALLS
78            trace per-character calls.
79
80       TRACE_DATABASE
81            trace read/write of terminfo/termcap data.
82
83       TRACE_ATTRS
84            trace changes to video attributes and colors.
85
86       TRACE_MAXIMUM
87            maximum trace level, enables all of the separate trace features.
88
89       Some  tracing  features  are  enabled  whenever  the trace parameter is
90       nonzero.  Some features overlap.  The specific  names  are  used  as  a
91       guideline.
92

RETURN VALUE

94       Routines  which return a value are designed to be used as parameters to
95       the _tracef routine.
96

PORTABILITY

98       These functions are not part of the XSI interface.  Some  other  curses
99       implementations  are  known to have similar, undocumented features, but
100       they are not compatible with ncurses.
101

SEE ALSO

103       curses(3X).
104
105
106
107                                                                curs_trace(3X)
Impressum