ncurses 5.4
[ncurses.git] / doc / html / man / curs_trace.3x.html
1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
2 <!-- 
3   ****************************************************************************
4   * Copyright (c) 2000,2002 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.5 2002/02/16 22:39:52 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        <STRONG>void</STRONG> <STRONG>_tracef(const</STRONG> <STRONG>char</STRONG> <STRONG>*format,</STRONG> <STRONG>...);</STRONG>
59        <STRONG>void</STRONG> <STRONG>_tracedump(const</STRONG> <STRONG>char</STRONG> <STRONG>*label,</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*win);</STRONG>
60        <STRONG>char</STRONG> <STRONG>*_traceattr(attr_t</STRONG> <STRONG>attr);</STRONG>
61        <STRONG>char</STRONG> <STRONG>*_traceattr2(int</STRONG> <STRONG>buffer,</STRONG> <STRONG>chtype</STRONG> <STRONG>ch);</STRONG>
62        <STRONG>char</STRONG> <STRONG>*_nc_tracebits(void);</STRONG>
63        <STRONG>char</STRONG> <STRONG>*_tracechar(const</STRONG> <STRONG>unsigned</STRONG> <STRONG>char</STRONG> <STRONG>ch);</STRONG>
64        <STRONG>char</STRONG> <STRONG>*_tracechtype(chtype</STRONG> <STRONG>ch);</STRONG>
65        <STRONG>char</STRONG> <STRONG>*_tracechtype2(int</STRONG> <STRONG>buffer,</STRONG> <STRONG>chtype</STRONG> <STRONG>ch);</STRONG>
66        <STRONG>char</STRONG> <STRONG>*_tracemouse(const</STRONG> <STRONG>MEVENT</STRONG> <STRONG>*event);</STRONG>
67        <STRONG>void</STRONG> <STRONG>trace(const</STRONG> <STRONG>unsigned</STRONG> <STRONG>int</STRONG> <STRONG>param);</STRONG>
68
69
70 </PRE>
71 <H2>DESCRIPTION</H2><PRE>
72        The  <STRONG>trace</STRONG>  routines  are  used  for debugging the ncurses
73        libraries, as well as applications which use  the  ncurses
74        libraries.   These  functions  are normally available only
75        with the debugging library <EM>libncurses</EM><STRONG>_</STRONG><EM>g.a</EM>, but may be com-
76        piled into any model (shared, static, profile) by defining
77        the symbol <STRONG>TRACE</STRONG>.
78
79        The principal parts of this interface are the  <STRONG>trace</STRONG>  rou-
80        tine which selectively enables different tracing features,
81        and the <STRONG>_tracef</STRONG> routine which writes formatted data to the
82        <EM>trace</EM> file.
83
84        Calling  <STRONG>trace</STRONG>  with  a  nonzero  parameter opens the file
85        <STRONG>trace</STRONG> in the current directory for output.  The  parameter
86        is formed by OR'ing values from the list of <STRONG>TRACE_</STRONG><EM>xxx</EM> def-
87        initions in <STRONG>&lt;curses.h&gt;</STRONG>.  These include:
88
89        TRACE_DISABLE
90             turn off tracing.
91
92        TRACE_TIMES
93             trace user and system times of updates.
94
95        TRACE_TPUTS
96             trace tputs calls.
97
98        TRACE_UPDATE
99             trace update actions, old &amp; new screens.
100
101        TRACE_MOVE
102             trace cursor movement and scrolling.
103
104        TRACE_CHARPUT
105             trace all character outputs.
106
107        TRACE_ORDINARY
108             trace all update actions.  The  old  and  new  screen
109             contents  are  written  to  the  trace  file for each
110             refresh.
111
112        TRACE_CALLS
113             trace all curses calls.  The parameters for each call
114             are traced, as well as return values.
115
116        TRACE_VIRTPUT
117             trace virtual character puts, i.e., calls to <STRONG>addch</STRONG>.
118
119        TRACE_IEVENT
120             trace low-level input processing, including timeouts.
121
122        TRACE_BITS
123             trace state of TTY control bits.
124
125        TRACE_ICALLS
126             trace internal/nested calls.
127
128        TRACE_CCALLS
129             trace per-character calls.
130
131        TRACE_DATABASE
132             trace read/write of terminfo/termcap data.
133
134        TRACE_ATTRS
135             trace changes to video attributes and colors.
136
137        TRACE_MAXIMUM
138             maximum trace level,  enables  all  of  the  separate
139             trace features.
140
141             Some  tracing features are enabled whenever the <STRONG>trace</STRONG>
142             parameter is nonzero.  Some  features  overlap.   The
143             specific names are used as a guideline.
144
145
146 </PRE>
147 <H2>RETURN VALUE</H2><PRE>
148        Routines  which  return a value are designed to be used as
149        parameters to the <STRONG>_tracef</STRONG> routine.
150
151
152 </PRE>
153 <H2>PORTABILITY</H2><PRE>
154        These functions are not part of the XSI  interface.   Some
155        other  curses  implementations  are known to have similar,
156        undocumented features, but they are  not  compatible  with
157        ncurses.
158
159
160 </PRE>
161 <H2>SEE ALSO</H2><PRE>
162        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>.
163
164
165
166                                                    <STRONG><A HREF="curs_trace.3x.html">curs_trace(3x)</A></STRONG>
167 </PRE>
168 <HR>
169 <ADDRESS>
170 Man(1) output converted with
171 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
172 </ADDRESS>
173 </BODY>
174 </HTML>