ncurses 5.9 - patch 20130608
[ncurses.git] / doc / html / man / curs_trace.3x.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
2 <!-- 
3   ****************************************************************************
4   * Copyright (c) 2000-2009,2010 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.12 2010/12/04 18:40:45 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>_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>
53        debugging routines
54
55
56 </PRE>
57 <H2>SYNOPSIS</H2><PRE>
58        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
59
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>
72
73
74 </PRE>
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-
83        braries.
84
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
88        <EM>trace</EM> file.
89
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>&lt;curses.h&gt;</STRONG>.  These include:
94
95        TRACE_DISABLE
96             turn off tracing.
97
98        TRACE_TIMES
99             trace user and system times of updates.
100
101        TRACE_TPUTS
102             trace tputs calls.
103
104        TRACE_UPDATE
105             trace update actions, old &amp; new screens.
106
107        TRACE_MOVE
108             trace cursor movement and scrolling.
109
110        TRACE_CHARPUT
111             trace all character outputs.
112
113        TRACE_ORDINARY
114             trace  all  update  actions.   The old and new screen
115             contents are written to the trace file for  each  re-
116             fresh.
117
118        TRACE_CALLS
119             trace all curses calls.  The parameters for each call
120             are traced, as well as return values.
121
122        TRACE_VIRTPUT
123             trace virtual character puts, i.e., calls to <STRONG>addch</STRONG>.
124
125        TRACE_IEVENT
126             trace low-level input processing, including timeouts.
127
128        TRACE_BITS
129             trace state of TTY control bits.
130
131        TRACE_ICALLS
132             trace internal/nested calls.
133
134        TRACE_CCALLS
135             trace per-character calls.
136
137        TRACE_DATABASE
138             trace read/write of terminfo/termcap data.
139
140        TRACE_ATTRS
141             trace changes to video attributes and colors.
142
143        TRACE_MAXIMUM
144             maximum trace level,  enables  all  of  the  separate
145             trace features.
146
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.
150
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
155
156
157
158 </PRE>
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.
162
163
164 </PRE>
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
169        ncurses.
170
171
172 </PRE>
173 <H2>SEE ALSO</H2><PRE>
174        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>.
175
176
177
178                                                          <STRONG><A HREF="curs_trace.3x.html">curs_trace(3x)</A></STRONG>
179 </PRE>
180 <HR>
181 <ADDRESS>
182 Man(1) output converted with
183 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
184 </ADDRESS>
185 </BODY>
186 </HTML>