ncurses 5.2
[ncurses.git] / man / curs_trace.3x
1 .\"***************************************************************************
2 .\" Copyright (c) 2000 Free Software Foundation, Inc.                        *
3 .\"                                                                          *
4 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
5 .\" copy of this software and associated documentation files (the            *
6 .\" "Software"), to deal in the Software without restriction, including      *
7 .\" without limitation the rights to use, copy, modify, merge, publish,      *
8 .\" distribute, distribute with modifications, sublicense, and/or sell       *
9 .\" copies of the Software, and to permit persons to whom the Software is    *
10 .\" furnished to do so, subject to the following conditions:                 *
11 .\"                                                                          *
12 .\" The above copyright notice and this permission notice shall be included  *
13 .\" in all copies or substantial portions of the Software.                   *
14 .\"                                                                          *
15 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
16 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
17 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
18 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
19 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
20 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
21 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
22 .\"                                                                          *
23 .\" Except as contained in this notice, the name(s) of the above copyright   *
24 .\" holders shall not be used in advertising or otherwise to promote the     *
25 .\" sale, use or other dealings in this Software without prior written       *
26 .\" authorization.                                                           *
27 .\"***************************************************************************
28 .\"
29 .\" $Id: curs_trace.3x,v 1.3 2000/07/29 16:34:24 tom Exp $
30 .TH curs_trace 3X ""
31 .SH NAME
32 \fB_tracef\fR,
33 \fB_tracedump\fR,
34 \fB_traceattr\fR,
35 \fB_traceattr2\fR,
36 \fB_nc_tracebits\fR,
37 \fB_tracechar\fR,
38 \fB_tracechtype\fR,
39 \fB_tracechtype2\fR,
40 \fB_tracemouse\fR,
41 \fBtrace\fR - \fBcurses\fR debugging routines
42 .SH SYNOPSIS
43 \fB#include <curses.h>\fR
44 .br
45 \fBvoid _tracef(const char *format, ...);\fR
46 .br
47 \fBvoid _tracedump(const char *label, WINDOW *win);\fR
48 .br
49 \fBchar *_traceattr(attr_t attr);\fR
50 .br
51 \fBchar *_traceattr2(int buffer, chtype ch);\fR
52 .br
53 \fBchar *_nc_tracebits(void);\fR
54 .br
55 \fBchar *_tracechar(const unsigned char ch);\fR
56 .br
57 \fBchar *_tracechtype(chtype ch);\fR
58 .br
59 \fBchar *_tracechtype2(int buffer, chtype ch);\fR
60 .br
61 \fBchar *_tracemouse(const MEVENT *event);\fR
62 .br
63 \fBvoid trace(const unsigned int param);\fR
64 .SH DESCRIPTION
65 The \fBtrace\fR routines are used for debugging the ncurses libraries,
66 as well as applications which use the ncurses libraries.
67 These functions are normally available only with the debugging library
68 \fIlibncurses_g.a\fR, but may be compiled into any model (shared, static,
69 profile) by defining the symbol \fBTRACE\fR.
70
71 The principal parts of this interface are the \fBtrace\fR routine which
72 selectively enables different tracing features, and the \fB_tracef\fR
73 routine which writes formatted data to the \fItrace\fR file.
74
75 Calling \fBtrace\fR with a nonzero parameter opens the file \fBtrace\fR
76 in the current directory for output.  The parameter is formed by OR'ing
77 values from the list of \fBTRACE_\fP\fIxxx\fR definitions in \fB<curses.h>\fR.
78 These include:
79 .TP 5
80 TRACE_DISABLE
81 turn off tracing.
82 .TP 5
83 TRACE_TIMES
84 trace user and system times of updates.
85 .TP 5
86 TRACE_TPUTS
87 trace tputs calls.
88 .TP 5
89 TRACE_UPDATE
90 trace update actions, old & new screens.
91 .TP 5
92 TRACE_MOVE
93 trace cursor movement and scrolling.
94 .TP 5
95 TRACE_CHARPUT
96 trace all character outputs.
97 .TP 5
98 TRACE_ORDINARY
99 trace all update actions.
100 The old and new screen contents are written to the trace file
101 for each refresh.
102 .TP 5
103 TRACE_CALLS
104 trace all curses calls.
105 The parameters for each call are traced, as well as return values.
106 .TP 5
107 TRACE_VIRTPUT
108 trace virtual character puts, i.e., calls to \fBaddch\fR.
109 .TP 5
110 TRACE_IEVENT
111 trace low-level input processing, including timeouts.
112 .TP 5
113 TRACE_BITS
114 trace state of TTY control bits.
115 .TP 5
116 TRACE_ICALLS
117 trace internal/nested calls.
118 .TP 5
119 TRACE_CCALLS
120 trace per-character calls.
121 .TP 5
122 TRACE_DATABASE
123 trace read/write of terminfo/termcap data.
124 .TP 5
125 TRACE_ATTRS
126 trace changes to video attributes and colors.
127 .TP 5
128 TRACE_MAXIMUM
129 maximum trace level, enables all of the separate trace features.
130
131 Some tracing features are enabled whenever the \fBtrace\fR parameter
132 is nonzero.  Some features overlap.
133 The specific names are used as a guideline.
134 ..
135 .SH RETURN VALUE
136 Routines which return a value are designed to be used as parameters
137 to the \fB_tracef\fR routine.
138 .SH PORTABILITY
139 These functions are not part of the XSI interface.
140 Some other curses implementations are known to
141 have similar, undocumented features,
142 but they are not compatible with ncurses.
143 .SH SEE ALSO
144 \fBcurses\fR(3X).
145 .\"#
146 .\"# The following sets edit modes for GNU EMACS
147 .\"# Local Variables:
148 .\"# mode:nroff
149 .\"# fill-column:79
150 .\"# End: