ncurses 6.0 - patch 20161015
[ncurses.git] / doc / html / man / curs_trace.3x.html
index 828042688576388d67f0760353eb50b03d5a3b68..c066797f2b3c753d976ccb7112bc27c733432dfb 100644 (file)
+<!-- 
+  ****************************************************************************
+  * Copyright (c) 2000-2015,2016 Free Software Foundation, Inc.              *
+  *                                                                          *
+  * Permission is hereby granted, free of charge, to any person obtaining a  *
+  * copy of this software and associated documentation files (the            *
+  * "Software"), to deal in the Software without restriction, including      *
+  * without limitation the rights to use, copy, modify, merge, publish,      *
+  * distribute, distribute with modifications, sublicense, and/or sell       *
+  * copies of the Software, and to permit persons to whom the Software is    *
+  * furnished to do so, subject to the following conditions:                 *
+  *                                                                          *
+  * The above copyright notice and this permission notice shall be included  *
+  * in all copies or substantial portions of the Software.                   *
+  *                                                                          *
+  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
+  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
+  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
+  * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
+  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
+  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
+  * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
+  *                                                                          *
+  * Except as contained in this notice, the name(s) of the above copyright   *
+  * holders shall not be used in advertising or otherwise to promote the     *
+  * sale, use or other dealings in this Software without prior written       *
+  * authorization.                                                           *
+  ****************************************************************************
+  * @Id: curs_trace.3x,v 1.14 2016/10/15 17:26:09 tom Exp @
+-->
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
 <HTML>
 <HTML>
+<HEAD>
+<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
+<meta name="generator" content="Manpage converted by man2html - see http://invisible-island.net/scripts/readme.html#others_scripts">
+<TITLE>curs_trace 3x</TITLE>
+<link rev=made href="mailto:bug-ncurses@gnu.org">
+<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+</HEAD>
 <BODY>
 <BODY>
+<H1 class="no-header">curs_trace 3x</H1>
 <PRE>
 <PRE>
-<!-- Manpage converted by man2html 3.0.1 -->
+<STRONG><A HREF="curs_trace.3x.html">curs_trace(3x)</A></STRONG>                                           <STRONG><A HREF="curs_trace.3x.html">curs_trace(3x)</A></STRONG>
 
 
-</PRE>
-<H2>NAME</H2><PRE>
-       <B>_tracef</B>,      <B>_tracedump</B>,     <B>_traceattr</B>,     <B>_traceattr2</B>,
-       <B>_nc_tracebits</B>,  <B>_tracechar</B>,  <B>_tracechtype</B>,  <B>_tracechtype2</B>,
-       <B>_tracemouse</B>, <B>trace</B> - <B>curses</B> debugging routines
 
 
 
 
-</PRE>
-<H2>SYNOPSIS</H2><PRE>
-       <B>#include</B> <B>&lt;curses.h&gt;</B>
-       <B>void</B> <B>_tracef(const</B> <B>char</B> <B>*format,</B> <B>...);</B>
-       <B>void</B> <B>_tracedump(const</B> <B>char</B> <B>*label,</B> <B>WINDOW</B> <B>*win);</B>
-       <B>char</B> <B>*_traceattr(attr_t</B> <B>attr);</B>
-       <B>char</B> <B>*_traceattr2(int</B> <B>buffer,</B> <B>chtype</B> <B>ch);</B>
-       <B>char</B> <B>*_nc_tracebits(void);</B>
-       <B>char</B> <B>*_tracechar(const</B> <B>unsigned</B> <B>char</B> <B>ch);</B>
-       <B>char</B> <B>*_tracechtype(chtype</B> <B>ch);</B>
-       <B>char</B> <B>*_tracechtype2(int</B> <B>buffer,</B> <B>chtype</B> <B>ch);</B>
-       <B>char</B> <B>*_tracemouse(const</B> <B>MEVENT</B> <B>*event);</B>
-       <B>void</B> <B>trace(const</B> <B>unsigned</B> <B>int</B> <B>param);</B>
 
 
+</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
+       <STRONG>_tracef</STRONG>, <STRONG>_tracedump</STRONG>, <STRONG>_traceattr</STRONG>, <STRONG>_traceattr2</STRONG>,
+       <STRONG>_nc_tracebits</STRONG>, <STRONG>_tracecchar_t</STRONG>, <STRONG>_tracecchar_t2</STRONG>, <STRONG>_tracechar</STRONG>,
+       <STRONG>_tracechtype</STRONG>, <STRONG>_tracechtype2</STRONG>, <STRONG>_tracemouse</STRONG>, <STRONG>trace</STRONG> - <STRONG>curses</STRONG>
+       debugging routines
 
 
-</PRE>
-<H2>DESCRIPTION</H2><PRE>
-       The  <B>trace</B>  routines  are  used  for debugging the ncurses
-       libraries, as well as applications which use  the  ncurses
-       libraries.   These  functions  are normally available only
-       with the debugging library <I>libncurses</I><B>_</B><I>g.a</I>, but may be com-
-       piled into any model (shared, static, profile) by defining
-       the symbol <B>TRACE</B>.
-
-       The principal parts of this interface are the  <B>trace</B>  rou-
-       tine which selectively enables different tracing features,
-       and the <B>_tracef</B> routine which writes formatted data to the
-       <I>trace</I> file.
-
-       Calling  <B>trace</B>  with  a  nonzero  parameter opens the file
-       <B>trace</B> in the current directory for output.  The  parameter
-       is formed by OR'ing values from the list of <B>TRACE_</B><I>xxx</I> def-
-       initions in <B>&lt;curses.h&gt;</B>.  These include:
-
-       TRACE_DISABLE
+
+</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
+       <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
+
+       <STRONG>void</STRONG> <STRONG>_tracef(const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG><EM>format</EM><STRONG>,</STRONG> <STRONG>...);</STRONG>
+       <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>
+       <STRONG>char</STRONG> <STRONG>*_traceattr(attr_t</STRONG> <EM>attr</EM><STRONG>);</STRONG>
+       <STRONG>char</STRONG> <STRONG>*_traceattr2(int</STRONG> <EM>buffer</EM><STRONG>,</STRONG> <STRONG>chtype</STRONG> <EM>ch</EM><STRONG>);</STRONG>
+       <STRONG>char</STRONG> <STRONG>*_nc_tracebits(void);</STRONG>
+       <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>_tracecchar_t(const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>string</EM><STRONG>);</STRONG>
+       <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>
+       <STRONG>char</STRONG> <STRONG>*_tracechar(int</STRONG> <EM>ch</EM><STRONG>);</STRONG>
+       <STRONG>char</STRONG> <STRONG>*_tracechtype(chtype</STRONG> <EM>ch</EM><STRONG>);</STRONG>
+       <STRONG>char</STRONG> <STRONG>*_tracechtype2(int</STRONG> <EM>buffer</EM><STRONG>,</STRONG> <STRONG>chtype</STRONG> <EM>ch</EM><STRONG>);</STRONG>
+       <STRONG>char</STRONG> <STRONG>*_tracemouse(const</STRONG> <STRONG>MEVENT</STRONG> <STRONG>*</STRONG><EM>event</EM><STRONG>);</STRONG>
+       <STRONG>void</STRONG> <STRONG>trace(const</STRONG> <STRONG>unsigned</STRONG> <STRONG>int</STRONG> <EM>param</EM><STRONG>);</STRONG>
+
+
+</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
+       The <STRONG>trace</STRONG> routines are used for debugging the ncurses  li-
+       braries, as well as applications which use the ncurses li-
+       braries.  These functions are normally available only with
+       the  debugging  library  e.g.,  <EM>libncurses</EM><STRONG>_</STRONG><EM>g.a</EM>, but may be
+       compiled into  any  model  (shared,  static,  profile)  by
+       defining  the  symbol <STRONG>TRACE</STRONG>.  Additionally, some functions
+       are only available with the  wide-character  configuration
+       of the libraries.
+
+       The principal parts of this interface are
+
+       <STRONG>o</STRONG>   <STRONG>trace</STRONG>,  which  selectively  enables  different tracing
+           features, and
+
+       <STRONG>o</STRONG>   <STRONG>_tracef</STRONG>, which writes  formatted  data  to  the  <EM>trace</EM>
+           file.
+
+       Calling  <STRONG>trace</STRONG>  with  a  nonzero  parameter opens the file
+       <STRONG>trace</STRONG> in the current directory for output.  The  parameter
+       is formed by OR'ing values from the list of <STRONG>TRACE_</STRONG><EM>xxx</EM> def-
+       initions in <STRONG>&lt;curses.h&gt;</STRONG>.  These include:
+
+       <STRONG>TRACE_DISABLE</STRONG>
             turn off tracing.
 
             turn off tracing.
 
-       TRACE_TIMES
+       <STRONG>TRACE_TIMES</STRONG>
             trace user and system times of updates.
 
             trace user and system times of updates.
 
-       TRACE_TPUTS
-            trace tputs calls.
+       <STRONG>TRACE_TPUTS</STRONG>
+            trace <STRONG>tputs</STRONG> calls.
 
 
-       TRACE_UPDATE
+       <STRONG>TRACE_UPDATE</STRONG>
             trace update actions, old &amp; new screens.
 
             trace update actions, old &amp; new screens.
 
-       TRACE_MOVE
+       <STRONG>TRACE_MOVE</STRONG>
             trace cursor movement and scrolling.
 
             trace cursor movement and scrolling.
 
-       TRACE_CHARPUT
+       <STRONG>TRACE_CHARPUT</STRONG>
             trace all character outputs.
 
             trace all character outputs.
 
-       TRACE_ORDINARY
+       <STRONG>TRACE_ORDINARY</STRONG>
             trace all update actions.  The  old  and  new  screen
             trace all update actions.  The  old  and  new  screen
-            contents  are  written  to  the  trace  file for each
-            refresh.
+            contents  are  written to the trace file for each re-
+            fresh.
 
 
-       TRACE_CALLS
+       <STRONG>TRACE_CALLS</STRONG>
             trace all curses calls.  The parameters for each call
             are traced, as well as return values.
 
             trace all curses calls.  The parameters for each call
             are traced, as well as return values.
 
-       TRACE_VIRTPUT
-            trace virtual character puts, i.e., calls to <B>addch</B>.
+       <STRONG>TRACE_VIRTPUT</STRONG>
+            trace virtual character puts, i.e., calls to <STRONG>addch</STRONG>.
 
 
-       TRACE_IEVENT
+       <STRONG>TRACE_IEVENT</STRONG>
             trace low-level input processing, including timeouts.
 
             trace low-level input processing, including timeouts.
 
-       TRACE_BITS
+       <STRONG>TRACE_BITS</STRONG>
             trace state of TTY control bits.
 
             trace state of TTY control bits.
 
-       TRACE_ICALLS
+       <STRONG>TRACE_ICALLS</STRONG>
             trace internal/nested calls.
 
             trace internal/nested calls.
 
-       TRACE_CCALLS
+       <STRONG>TRACE_CCALLS</STRONG>
             trace per-character calls.
 
             trace per-character calls.
 
-       TRACE_DATABASE
+       <STRONG>TRACE_DATABASE</STRONG>
             trace read/write of terminfo/termcap data.
 
             trace read/write of terminfo/termcap data.
 
-       TRACE_MAXIMUM
-            maximum trace level,  enables  all  of  the  separate
+       <STRONG>TRACE_ATTRS</STRONG>
+            trace changes to video attributes and colors.
+
+       <STRONG>TRACE_MAXIMUM</STRONG>
+            maximum  trace  level,  enables  all  of the separate
             trace features.
 
             trace features.
 
-            Some  tracing features are enabled whenever the <B>trace</B>
-            parameter is nonzero.  Some  features  overlap.   The
-            specific names are used as a guideline.
+       Some tracing features are enabled whenever the  <STRONG>trace</STRONG>  pa-
+       rameter  is nonzero.  Some features overlap.  The specific
+       names are used as a guideline.
 
 
+       The other functions either return a pointer to  a  string-
+       area  (allocated by the corresponding function), or return
+       no value (such as <STRONG>_tracedump</STRONG>, which implements the  screen
+       dump  for <STRONG>TRACE_UPDATE</STRONG>).  The caller should not free these
+       strings, since the  allocation  is  reused  on  successive
+       calls.  To work around the problem of a single string-area
+       per function, some use a buffer-number parameter,  telling
+       the library to allocate additional string-areas.
 
 
-</PRE>
-<H2>RETURN VALUE</H2><PRE>
-       Routines  which  return a value are designed to be used as
-       parameters to the <B>_tracef</B> routine.
+       These  functions check the <STRONG>NCURSES_TRACE</STRONG> environment vari-
+       able, to set the tracing feature as if <STRONG>trace</STRONG> was called:
 
 
-
-</PRE>
-<H2>PORTABILITY</H2><PRE>
-       These functions are not part of the XSI  interface.   Some
-       other  curses  implementations  are known to have similar,
-       undocumented features, but they are  not  compatible  with
-       ncurses.
+              filter, initscr, new_prescr, newterm, nofilter,
+              restartterm, ripoffline, setupterm, slk_init, tge-
+              tent, use_env, use_extended_names, use_tioctl
 
 
 
 
-</PRE>
-<H2>SEE ALSO</H2><PRE>
-       <B><A HREF="ncurses.3x.html">curses(3x)</A></B>.
+</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
+       Routines which return a value are designed to be  used  as
+       parameters to the <STRONG>_tracef</STRONG> routine.
 
 
 
 
+</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
+       These  functions  are not part of the XSI interface.  Some
+       other curses implementations are known  to  have  similar,
+       undocumented  features,  but  they are not compatible with
+       ncurses.
 
 
 
 
+</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
+       <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>.
 
 
 
 
 
 
+                                                         <STRONG><A HREF="curs_trace.3x.html">curs_trace(3x)</A></STRONG>
 </PRE>
 </PRE>
-<HR>
-<ADDRESS>
-Man(1) output converted with
-<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
-</ADDRESS>
+<div class="nav">
+<ul>
+<li><a href="#h2-NAME">NAME</a></li>
+<li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
+<li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
+<li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
+<li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
+<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
+</ul>
+</div>
 </BODY>
 </HTML>
 </BODY>
 </HTML>