ncurses 6.0 - patch 20150725
[ncurses.git] / doc / html / man / curs_trace.3x.html
index 2a4d906343b4c307a0836ef899c43fa6ea80f6a8..e4d1129cb6f9d14703063700a9f331312d914a2f 100644 (file)
@@ -1,6 +1,6 @@
 <!-- 
   ****************************************************************************
-  * Copyright (c) 2000-2009,2010 Free Software Foundation, Inc.              *
+  * Copyright (c) 2000-2010,2015 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            *
@@ -26,7 +26,7 @@
   * sale, use or other dealings in this Software without prior written       *
   * authorization.                                                           *
   ****************************************************************************
-  * @Id: curs_trace.3x,v 1.12 2010/12/04 18:40:45 tom Exp @
+  * @Id: curs_trace.3x,v 1.13 2015/07/20 22:54:44 tom Exp @
 -->
 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
 <HTML>
 <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>*format,</STRONG> <STRONG>...);</STRONG>
-       <STRONG>void</STRONG> <STRONG>_tracedump(const</STRONG> <STRONG>char</STRONG> <STRONG>*label,</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*win);</STRONG>
-       <STRONG>char</STRONG> <STRONG>*_traceattr(attr_t</STRONG> <STRONG>attr);</STRONG>
-       <STRONG>char</STRONG> <STRONG>*_traceattr2(int</STRONG> <STRONG>buffer,</STRONG> <STRONG>chtype</STRONG> <STRONG>ch);</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>*string);</STRONG>
-       <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>_tracecchar_t2(int</STRONG> <STRONG>buffer,</STRONG> <STRONG>const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*string);</STRONG>
-       <STRONG>char</STRONG> <STRONG>*_tracechar(int</STRONG> <STRONG>ch);</STRONG>
-       <STRONG>char</STRONG> <STRONG>*_tracechtype(chtype</STRONG> <STRONG>ch);</STRONG>
-       <STRONG>char</STRONG> <STRONG>*_tracechtype2(int</STRONG> <STRONG>buffer,</STRONG> <STRONG>chtype</STRONG> <STRONG>ch);</STRONG>
-       <STRONG>char</STRONG> <STRONG>*_tracemouse(const</STRONG> <STRONG>MEVENT</STRONG> <STRONG>*event);</STRONG>
-       <STRONG>void</STRONG> <STRONG>trace(const</STRONG> <STRONG>unsigned</STRONG> <STRONG>int</STRONG> <STRONG>param);</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>
        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 <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 li-
-       braries.
-
-       The  principal  parts of this interface are the <STRONG>trace</STRONG> rou-
-       tine which selectively enables different tracing features,
-       and the <STRONG>_tracef</STRONG> routine 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
+       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:
 
-       TRACE_DISABLE
+       <STRONG>TRACE_DISABLE</STRONG>
             turn off tracing.
 
-       TRACE_TIMES
+       <STRONG>TRACE_TIMES</STRONG>
             trace user and system times of updates.
 
-       TRACE_TPUTS
+       <STRONG>TRACE_TPUTS</STRONG>
             trace tputs calls.
 
-       TRACE_UPDATE
+       <STRONG>TRACE_UPDATE</STRONG>
             trace update actions, old &amp; new screens.
 
-       TRACE_MOVE
+       <STRONG>TRACE_MOVE</STRONG>
             trace cursor movement and scrolling.
 
-       TRACE_CHARPUT
+       <STRONG>TRACE_CHARPUT</STRONG>
             trace all character outputs.
 
-       TRACE_ORDINARY
-            trace  all  update  actions.   The old and new screen
-            contents are written to the trace file for  each  re-
+       <STRONG>TRACE_ORDINARY</STRONG>
+            trace all update actions.  The  old  and  new  screen
+            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_VIRTPUT
+       <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_BITS
+       <STRONG>TRACE_BITS</STRONG>
             trace state of TTY control bits.
 
-       TRACE_ICALLS
+       <STRONG>TRACE_ICALLS</STRONG>
             trace internal/nested calls.
 
-       TRACE_CCALLS
+       <STRONG>TRACE_CCALLS</STRONG>
             trace per-character calls.
 
-       TRACE_DATABASE
+       <STRONG>TRACE_DATABASE</STRONG>
             trace read/write of terminfo/termcap data.
 
-       TRACE_ATTRS
+       <STRONG>TRACE_ATTRS</STRONG>
             trace changes to video attributes and colors.
 
-       TRACE_MAXIMUM
-            maximum trace level,  enables  all  of  the  separate
+       <STRONG>TRACE_MAXIMUM</STRONG>
+            maximum  trace  level,  enables  all  of the separate
             trace features.
 
-       Some  tracing  features are enabled whenever the <STRONG>trace</STRONG> pa-
-       rameter is nonzero.  Some features overlap.  The  specific
+       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.
+
        These  functions check the <STRONG>NCURSES_TRACE</STRONG> environment vari-
        able, to set the tracing feature as if <STRONG>trace</STRONG> was called:
-              filter,  initscr,  new_prescr,  newterm,  nofilter,
-              ripoffline, setupterm, slk_init, tgetent
 
+              filter, initscr, new_prescr, newterm, nofilter,
+              restartterm, ripoffline, setupterm, slk_init, tge-
+              tent, use_env, use_extended_names, use_tioctl
 
 
 </PRE>
 <H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
-       Routines  which  return a value are designed to be used as
+       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
+       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.