ncurses 6.0 - patch 20160130
[ncurses.git] / doc / html / man / curs_trace.3x.html
1 <!-- 
2   ****************************************************************************
3   * Copyright (c) 2000-2010,2015 Free Software Foundation, Inc.              *
4   *                                                                          *
5   * Permission is hereby granted, free of charge, to any person obtaining a  *
6   * copy of this software and associated documentation files (the            *
7   * "Software"), to deal in the Software without restriction, including      *
8   * without limitation the rights to use, copy, modify, merge, publish,      *
9   * distribute, distribute with modifications, sublicense, and/or sell       *
10   * copies of the Software, and to permit persons to whom the Software is    *
11   * furnished to do so, subject to the following conditions:                 *
12   *                                                                          *
13   * The above copyright notice and this permission notice shall be included  *
14   * in all copies or substantial portions of the Software.                   *
15   *                                                                          *
16   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
17   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
18   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
19   * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
20   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
21   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
22   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
23   *                                                                          *
24   * Except as contained in this notice, the name(s) of the above copyright   *
25   * holders shall not be used in advertising or otherwise to promote the     *
26   * sale, use or other dealings in this Software without prior written       *
27   * authorization.                                                           *
28   ****************************************************************************
29   * @Id: curs_trace.3x,v 1.13 2015/07/20 22:54:44 tom Exp @
30 -->
31 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
32 <HTML>
33 <HEAD>
34 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
35 <meta name="generator" content="Manpage converted by man2html - see http://invisible-island.net/scripts/readme.html#others_scripts">
36 <TITLE>curs_trace 3x</TITLE>
37 <link rev=made href="mailto:bug-ncurses@gnu.org">
38 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
39 </HEAD>
40 <BODY>
41 <H1 class="no-header">curs_trace 3x</H1>
42 <PRE>
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><H2><a name="h2-NAME">NAME</a></H2><PRE>
49        <STRONG>_tracef</STRONG>, <STRONG>_tracedump</STRONG>, <STRONG>_traceattr</STRONG>, <STRONG>_traceattr2</STRONG>,
50        <STRONG>_nc_tracebits</STRONG>, <STRONG>_tracecchar_t</STRONG>, <STRONG>_tracecchar_t2</STRONG>, <STRONG>_tracechar</STRONG>,
51        <STRONG>_tracechtype</STRONG>, <STRONG>_tracechtype2</STRONG>, <STRONG>_tracemouse</STRONG>, <STRONG>trace</STRONG> - <STRONG>curses</STRONG>
52        debugging routines
53
54
55 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
56        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
57
58        <STRONG>void</STRONG> <STRONG>_tracef(const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG><EM>format</EM><STRONG>,</STRONG> <STRONG>...);</STRONG>
59        <STRONG>void</STRONG> <STRONG>_tracedump(const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG><EM>label</EM><STRONG>,</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>);</STRONG>
60        <STRONG>char</STRONG> <STRONG>*_traceattr(attr_t</STRONG> <EM>attr</EM><STRONG>);</STRONG>
61        <STRONG>char</STRONG> <STRONG>*_traceattr2(int</STRONG> <EM>buffer</EM><STRONG>,</STRONG> <STRONG>chtype</STRONG> <EM>ch</EM><STRONG>);</STRONG>
62        <STRONG>char</STRONG> <STRONG>*_nc_tracebits(void);</STRONG>
63        <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>_tracecchar_t(const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>string</EM><STRONG>);</STRONG>
64        <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>_tracecchar_t2(int</STRONG> <EM>buffer</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>string</EM><STRONG>);</STRONG>
65        <STRONG>char</STRONG> <STRONG>*_tracechar(int</STRONG> <EM>ch</EM><STRONG>);</STRONG>
66        <STRONG>char</STRONG> <STRONG>*_tracechtype(chtype</STRONG> <EM>ch</EM><STRONG>);</STRONG>
67        <STRONG>char</STRONG> <STRONG>*_tracechtype2(int</STRONG> <EM>buffer</EM><STRONG>,</STRONG> <STRONG>chtype</STRONG> <EM>ch</EM><STRONG>);</STRONG>
68        <STRONG>char</STRONG> <STRONG>*_tracemouse(const</STRONG> <STRONG>MEVENT</STRONG> <STRONG>*</STRONG><EM>event</EM><STRONG>);</STRONG>
69        <STRONG>void</STRONG> <STRONG>trace(const</STRONG> <STRONG>unsigned</STRONG> <STRONG>int</STRONG> <EM>param</EM><STRONG>);</STRONG>
70
71
72 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></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  e.g.,  <EM>libncurses</EM><STRONG>_</STRONG><EM>g.a</EM>, but may be
77        compiled into  any  model  (shared,  static,  profile)  by
78        defining  the  symbol <STRONG>TRACE</STRONG>.  Additionally, some functions
79        are only available with the  wide-character  configuration
80        of the libraries.
81
82        The principal parts of this interface are
83
84        <STRONG>o</STRONG>   <STRONG>trace</STRONG>,  which  selectively  enables  different tracing
85            features, and
86
87        <STRONG>o</STRONG>   <STRONG>_tracef</STRONG>, which writes  formatted  data  to  the  <EM>trace</EM>
88            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        <STRONG>TRACE_DISABLE</STRONG>
96             turn off tracing.
97
98        <STRONG>TRACE_TIMES</STRONG>
99             trace user and system times of updates.
100
101        <STRONG>TRACE_TPUTS</STRONG>
102             trace tputs calls.
103
104        <STRONG>TRACE_UPDATE</STRONG>
105             trace update actions, old &amp; new screens.
106
107        <STRONG>TRACE_MOVE</STRONG>
108             trace cursor movement and scrolling.
109
110        <STRONG>TRACE_CHARPUT</STRONG>
111             trace all character outputs.
112
113        <STRONG>TRACE_ORDINARY</STRONG>
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        <STRONG>TRACE_CALLS</STRONG>
119             trace all curses calls.  The parameters for each call
120             are traced, as well as return values.
121
122        <STRONG>TRACE_VIRTPUT</STRONG>
123             trace virtual character puts, i.e., calls to <STRONG>addch</STRONG>.
124
125        <STRONG>TRACE_IEVENT</STRONG>
126             trace low-level input processing, including timeouts.
127
128        <STRONG>TRACE_BITS</STRONG>
129             trace state of TTY control bits.
130
131        <STRONG>TRACE_ICALLS</STRONG>
132             trace internal/nested calls.
133
134        <STRONG>TRACE_CCALLS</STRONG>
135             trace per-character calls.
136
137        <STRONG>TRACE_DATABASE</STRONG>
138             trace read/write of terminfo/termcap data.
139
140        <STRONG>TRACE_ATTRS</STRONG>
141             trace changes to video attributes and colors.
142
143        <STRONG>TRACE_MAXIMUM</STRONG>
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        The other functions either return a pointer to  a  string-
152        area  (allocated by the corresponding function), or return
153        no value (such as <STRONG>_tracedump</STRONG>, which implements the  screen
154        dump  for <STRONG>TRACE_UPDATE</STRONG>).  The caller should not free these
155        strings, since the  allocation  is  reused  on  successive
156        calls.  To work around the problem of a single string-area
157        per function, some use a buffer-number parameter,  telling
158        the library to allocate additional string-areas.
159
160        These  functions check the <STRONG>NCURSES_TRACE</STRONG> environment vari-
161        able, to set the tracing feature as if <STRONG>trace</STRONG> was called:
162
163               filter, initscr, new_prescr, newterm, nofilter,
164               restartterm, ripoffline, setupterm, slk_init, tge-
165               tent, use_env, use_extended_names, use_tioctl
166
167
168 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
169        Routines which return a value are designed to be  used  as
170        parameters to the <STRONG>_tracef</STRONG> routine.
171
172
173 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
174        These  functions  are not part of the XSI interface.  Some
175        other curses implementations are known  to  have  similar,
176        undocumented  features,  but  they are not compatible with
177        ncurses.
178
179
180 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
181        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>.
182
183
184
185                                                          <STRONG><A HREF="curs_trace.3x.html">curs_trace(3x)</A></STRONG>
186 </PRE>
187 <div class="nav">
188 <ul>
189 <li><a href="#h2-NAME">NAME</a></li>
190 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
191 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
192 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
193 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
194 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
195 </ul>
196 </div>
197 </BODY>
198 </HTML>