1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
3 ****************************************************************************
4 * Copyright (c) 2000-2009,2010 Free Software Foundation, Inc. *
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: *
14 * The above copyright notice and this permission notice shall be included *
15 * in all copies or substantial portions of the Software. *
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. *
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 *
29 ****************************************************************************
30 * @Id: curs_trace.3x,v 1.12 2010/12/04 18:40:45 tom Exp @
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">
39 <H1>curs_trace 3x</H1>
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>
50 <STRONG>_tracef</STRONG>, <STRONG>_tracedump</STRONG>, <STRONG>_traceattr</STRONG>, <STRONG>_traceattr2</STRONG>,
51 <STRONG>_nc_tracebits</STRONG>, <STRONG>_tracecchar_t</STRONG>, <STRONG>_tracecchar_t2</STRONG>, <STRONG>_tracechar</STRONG>,
52 <STRONG>_tracechtype</STRONG>, <STRONG>_tracechtype2</STRONG>, <STRONG>_tracemouse</STRONG>, <STRONG>trace</STRONG> - <STRONG>curses</STRONG>
57 <H2>SYNOPSIS</H2><PRE>
58 <STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
60 <STRONG>void</STRONG> <STRONG>_tracef(const</STRONG> <STRONG>char</STRONG> <STRONG>*format,</STRONG> <STRONG>...);</STRONG>
61 <STRONG>void</STRONG> <STRONG>_tracedump(const</STRONG> <STRONG>char</STRONG> <STRONG>*label,</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*win);</STRONG>
62 <STRONG>char</STRONG> <STRONG>*_traceattr(attr_t</STRONG> <STRONG>attr);</STRONG>
63 <STRONG>char</STRONG> <STRONG>*_traceattr2(int</STRONG> <STRONG>buffer,</STRONG> <STRONG>chtype</STRONG> <STRONG>ch);</STRONG>
64 <STRONG>char</STRONG> <STRONG>*_nc_tracebits(void);</STRONG>
65 <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>_tracecchar_t(const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*string);</STRONG>
66 <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>_tracecchar_t2(int</STRONG> <STRONG>buffer,</STRONG> <STRONG>const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*string);</STRONG>
67 <STRONG>char</STRONG> <STRONG>*_tracechar(int</STRONG> <STRONG>ch);</STRONG>
68 <STRONG>char</STRONG> <STRONG>*_tracechtype(chtype</STRONG> <STRONG>ch);</STRONG>
69 <STRONG>char</STRONG> <STRONG>*_tracechtype2(int</STRONG> <STRONG>buffer,</STRONG> <STRONG>chtype</STRONG> <STRONG>ch);</STRONG>
70 <STRONG>char</STRONG> <STRONG>*_tracemouse(const</STRONG> <STRONG>MEVENT</STRONG> <STRONG>*event);</STRONG>
71 <STRONG>void</STRONG> <STRONG>trace(const</STRONG> <STRONG>unsigned</STRONG> <STRONG>int</STRONG> <STRONG>param);</STRONG>
75 <H2>DESCRIPTION</H2><PRE>
76 The <STRONG>trace</STRONG> routines are used for debugging the ncurses li-
77 braries, as well as applications which use the ncurses li-
78 braries. These functions are normally available only with
79 the debugging library <EM>libncurses</EM><STRONG>_</STRONG><EM>g.a</EM>, but may be compiled
80 into any model (shared, static, profile) by defining the
81 symbol <STRONG>TRACE</STRONG>. Additionally, some functions are only
82 available with the wide-character configuration of the li-
85 The principal parts of this interface are the <STRONG>trace</STRONG> rou-
86 tine which selectively enables different tracing features,
87 and the <STRONG>_tracef</STRONG> routine which writes formatted data to the
90 Calling <STRONG>trace</STRONG> with a nonzero parameter opens the file
91 <STRONG>trace</STRONG> in the current directory for output. The parameter
92 is formed by OR'ing values from the list of <STRONG>TRACE_</STRONG><EM>xxx</EM> def-
93 initions in <STRONG><curses.h></STRONG>. These include:
99 trace user and system times of updates.
105 trace update actions, old & new screens.
108 trace cursor movement and scrolling.
111 trace all character outputs.
114 trace all update actions. The old and new screen
115 contents are written to the trace file for each re-
119 trace all curses calls. The parameters for each call
120 are traced, as well as return values.
123 trace virtual character puts, i.e., calls to <STRONG>addch</STRONG>.
126 trace low-level input processing, including timeouts.
129 trace state of TTY control bits.
132 trace internal/nested calls.
135 trace per-character calls.
138 trace read/write of terminfo/termcap data.
141 trace changes to video attributes and colors.
144 maximum trace level, enables all of the separate
147 Some tracing features are enabled whenever the <STRONG>trace</STRONG> pa-
148 rameter is nonzero. Some features overlap. The specific
149 names are used as a guideline.
151 These functions check the <STRONG>NCURSES_TRACE</STRONG> environment vari-
152 able, to set the tracing feature as if <STRONG>trace</STRONG> was called:
153 filter, initscr, new_prescr, newterm, nofilter,
154 ripoffline, setupterm, slk_init, tgetent
159 <H2>RETURN VALUE</H2><PRE>
160 Routines which return a value are designed to be used as
161 parameters to the <STRONG>_tracef</STRONG> routine.
165 <H2>PORTABILITY</H2><PRE>
166 These functions are not part of the XSI interface. Some
167 other curses implementations are known to have similar,
168 undocumented features, but they are not compatible with
173 <H2>SEE ALSO</H2><PRE>
174 <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>.
178 <STRONG><A HREF="curs_trace.3x.html">curs_trace(3x)</A></STRONG>
182 Man(1) output converted with
183 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>