Gitiles
Code Review Sign In
gerrit.omnirom.org / android_external_libncurses / e6a01f5727d104ee88c228bc866a505de770c1b2 / . / doc / html / man / curs_trace.3x.html
blob: f24a8c81b5b807ff1b1611eaeb65cbef6c241c2e [file] [log] [blame]
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame^]1<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
2<!--
3 ****************************************************************************
4 * Copyright (c) 2000-2005,2007 Free Software Foundation, Inc. *
5 * *
6 * Permission is hereby granted, free of charge, to any person obtaining a *
7 * copy of this software and associated documentation files (the *
8 * "Software"), to deal in the Software without restriction, including *
9 * without limitation the rights to use, copy, modify, merge, publish, *
10 * distribute, distribute with modifications, sublicense, and/or sell *
11 * copies of the Software, and to permit persons to whom the Software is *
12 * furnished to do so, subject to the following conditions: *
13 * *
14 * The above copyright notice and this permission notice shall be included *
15 * in all copies or substantial portions of the Software. *
16 * *
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
18 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
19 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
20 * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
21 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
22 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
23 * THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
24 * *
25 * Except as contained in this notice, the name(s) of the above copyright *
26 * holders shall not be used in advertising or otherwise to promote the *
27 * sale, use or other dealings in this Software without prior written *
28 * authorization. *
29 ****************************************************************************
30 * @Id: curs_trace.3x,v 1.8 2007/02/24 17:33:49 tom Exp @
31-->
32<HTML>
33<HEAD>
34<TITLE>curs_trace 3x</TITLE>
35<link rev=made href="mailto:bug-ncurses@gnu.org">
36<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
37</HEAD>
38<BODY>
39<H1>curs_trace 3x</H1>
40<HR>
41<PRE>
42<!-- Manpage converted by man2html 3.0.1 -->
43<STRONG><A HREF="curs_trace.3x.html">curs_trace(3x)</A></STRONG> <STRONG><A HREF="curs_trace.3x.html">curs_trace(3x)</A></STRONG>
44
45
46
47
48</PRE>
49<H2>NAME</H2><PRE>
50 <STRONG>_tracef</STRONG>, <STRONG>_tracedump</STRONG>, <STRONG>_traceattr</STRONG>, <STRONG>_traceattr2</STRONG>,
51 <STRONG>_nc_tracebits</STRONG>, <STRONG>_tracechar</STRONG>, <STRONG>_tracechtype</STRONG>, <STRONG>_tracechtype2</STRONG>,
52 <STRONG>_tracemouse</STRONG>, <STRONG>trace</STRONG> - <STRONG>curses</STRONG> debugging routines
53
54
55</PRE>
56<H2>SYNOPSIS</H2><PRE>
57 <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
58
59 <STRONG>void</STRONG> <STRONG>_tracef(const</STRONG> <STRONG>char</STRONG> <STRONG>*format,</STRONG> <STRONG>...);</STRONG>
60 <STRONG>void</STRONG> <STRONG>_tracedump(const</STRONG> <STRONG>char</STRONG> <STRONG>*label,</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*win);</STRONG>
61 <STRONG>char</STRONG> <STRONG>*_traceattr(attr_t</STRONG> <STRONG>attr);</STRONG>
62 <STRONG>char</STRONG> <STRONG>*_traceattr2(int</STRONG> <STRONG>buffer,</STRONG> <STRONG>chtype</STRONG> <STRONG>ch);</STRONG>
63 <STRONG>char</STRONG> <STRONG>*_nc_tracebits(void);</STRONG>
64 <STRONG>char</STRONG> <STRONG>*_tracechar(int);</STRONG>
65 <STRONG>char</STRONG> <STRONG>*_tracechtype(chtype</STRONG> <STRONG>ch);</STRONG>
66 <STRONG>char</STRONG> <STRONG>*_tracechtype2(int</STRONG> <STRONG>buffer,</STRONG> <STRONG>chtype</STRONG> <STRONG>ch);</STRONG>
67 <STRONG>char</STRONG> <STRONG>*_tracemouse(const</STRONG> <STRONG>MEVENT</STRONG> <STRONG>*event);</STRONG>
68 <STRONG>void</STRONG> <STRONG>trace(const</STRONG> <STRONG>unsigned</STRONG> <STRONG>int</STRONG> <STRONG>param);</STRONG>
69
70
71</PRE>
72<H2>DESCRIPTION</H2><PRE>
73 The <STRONG>trace</STRONG> routines are used for debugging the ncurses li-
74 braries, as well as applications which use the ncurses li-
75 braries. These functions are normally available only with
76 the debugging library <EM>libncurses</EM><STRONG>_</STRONG><EM>g.a</EM>, but may be compiled
77 into any model (shared, static, profile) by defining the
78 symbol <STRONG>TRACE</STRONG>.
79
80 The principal parts of this interface are the <STRONG>trace</STRONG> rou-
81 tine which selectively enables different tracing features,
82 and the <STRONG>_tracef</STRONG> routine which writes formatted data to the
83 <EM>trace</EM> file.
84
85 Calling <STRONG>trace</STRONG> with a nonzero parameter opens the file
86 <STRONG>trace</STRONG> in the current directory for output. The parameter
87 is formed by OR'ing values from the list of <STRONG>TRACE_</STRONG><EM>xxx</EM> def-
88 initions in <STRONG>&lt;curses.h&gt;</STRONG>. These include:
89
90 TRACE_DISABLE
91 turn off tracing.
92
93 TRACE_TIMES
94 trace user and system times of updates.
95
96 TRACE_TPUTS
97 trace tputs calls.
98
99 TRACE_UPDATE
100 trace update actions, old &amp; new screens.
101
102 TRACE_MOVE
103 trace cursor movement and scrolling.
104
105 TRACE_CHARPUT
106 trace all character outputs.
107
108 TRACE_ORDINARY
109 trace all update actions. The old and new screen
110 contents are written to the trace file for each re-
111 fresh.
112
113 TRACE_CALLS
114 trace all curses calls. The parameters for each call
115 are traced, as well as return values.
116
117 TRACE_VIRTPUT
118 trace virtual character puts, i.e., calls to <STRONG>addch</STRONG>.
119
120 TRACE_IEVENT
121 trace low-level input processing, including timeouts.
122
123 TRACE_BITS
124 trace state of TTY control bits.
125
126 TRACE_ICALLS
127 trace internal/nested calls.
128
129 TRACE_CCALLS
130 trace per-character calls.
131
132 TRACE_DATABASE
133 trace read/write of terminfo/termcap data.
134
135 TRACE_ATTRS
136 trace changes to video attributes and colors.
137
138 TRACE_MAXIMUM
139 maximum trace level, enables all of the separate
140 trace features.
141
142 Some tracing features are enabled whenever the <STRONG>trace</STRONG> pa-
143 rameter is nonzero. Some features overlap. The specific
144 names are used as a guideline.
145
146
147</PRE>
148<H2>RETURN VALUE</H2><PRE>
149 Routines which return a value are designed to be used as
150 parameters to the <STRONG>_tracef</STRONG> routine.
151
152
153</PRE>
154<H2>PORTABILITY</H2><PRE>
155 These functions are not part of the XSI interface. Some
156 other curses implementations are known to have similar,
157 undocumented features, but they are not compatible with
158 ncurses.
159
160
161</PRE>
162<H2>SEE ALSO</H2><PRE>
163 <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>.
164
165
166
167 <STRONG><A HREF="curs_trace.3x.html">curs_trace(3x)</A></STRONG>
168</PRE>
169<HR>
170<ADDRESS>
171Man(1) output converted with
172<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
173</ADDRESS>
174</BODY>
175</HTML>