doc/html/man/curs_trace.3x.html

   1 <HTML>
   2 <BODY>
   3 <PRE>
   4 <!-- Manpage converted by man2html 3.0.1 -->
   5
   6 </PRE>
   7 <H2>NAME</H2><PRE>
   8        <B>_tracef</B>,      <B>_tracedump</B>,     <B>_traceattr</B>,     <B>_traceattr2</B>,
   9        <B>_nc_tracebits</B>,  <B>_tracechar</B>,  <B>_tracechtype</B>,  <B>_tracechtype2</B>,
  10        <B>_tracemouse</B>, <B>trace</B> - <B>curses</B> debugging routines
  11
  12
  13 </PRE>
  14 <H2>SYNOPSIS</H2><PRE>
  15        <B>#include</B> <B>&lt;curses.h&gt;</B>
  16        <B>void</B> <B>_tracef(const</B> <B>char</B> <B>*format,</B> <B>...);</B>
  17        <B>void</B> <B>_tracedump(const</B> <B>char</B> <B>*label,</B> <B>WINDOW</B> <B>*win);</B>
  18        <B>char</B> <B>*_traceattr(attr_t</B> <B>attr);</B>
  19        <B>char</B> <B>*_traceattr2(int</B> <B>buffer,</B> <B>chtype</B> <B>ch);</B>
  20        <B>char</B> <B>*_nc_tracebits(void);</B>
  21        <B>char</B> <B>*_tracechar(const</B> <B>unsigned</B> <B>char</B> <B>ch);</B>
  22        <B>char</B> <B>*_tracechtype(chtype</B> <B>ch);</B>
  23        <B>char</B> <B>*_tracechtype2(int</B> <B>buffer,</B> <B>chtype</B> <B>ch);</B>
  24        <B>char</B> <B>*_tracemouse(const</B> <B>MEVENT</B> <B>*event);</B>
  25        <B>void</B> <B>trace(const</B> <B>unsigned</B> <B>int</B> <B>param);</B>
  26
  27
  28 </PRE>
  29 <H2>DESCRIPTION</H2><PRE>
  30        The  <B>trace</B>  routines  are  used  for debugging the ncurses
  31        libraries, as well as applications which use  the  ncurses
  32        libraries.   These  functions  are normally available only
  33        with the debugging library <I>libncurses</I><B>_</B><I>g.a</I>, but may be com-
  34        piled into any model (shared, static, profile) by defining
  35        the symbol <B>TRACE</B>.
  36
  37        The principal parts of this interface are the  <B>trace</B>  rou-
  38        tine which selectively enables different tracing features,
  39        and the <B>_tracef</B> routine which writes formatted data to the
  40        <I>trace</I> file.
  41
  42        Calling  <B>trace</B>  with  a  nonzero  parameter opens the file
  43        <B>trace</B> in the current directory for output.  The  parameter
  44        is formed by OR'ing values from the list of <B>TRACE_</B><I>xxx</I> def-
  45        initions in <B>&lt;curses.h&gt;</B>.  These include:
  46
  47        TRACE_DISABLE
  48             turn off tracing.
  49
  50        TRACE_TIMES
  51             trace user and system times of updates.
  52
  53        TRACE_TPUTS
  54             trace tputs calls.
  55
  56        TRACE_UPDATE
  57             trace update actions, old &amp; new screens.
  58
  59        TRACE_MOVE
  60             trace cursor movement and scrolling.
  61
  62        TRACE_CHARPUT
  63             trace all character outputs.
  64
  65        TRACE_ORDINARY
  66             trace all update actions.  The  old  and  new  screen
  67             contents  are  written  to  the  trace  file for each
  68             refresh.
  69
  70        TRACE_CALLS
  71             trace all curses calls.  The parameters for each call
  72             are traced, as well as return values.
  73
  74        TRACE_VIRTPUT
  75             trace virtual character puts, i.e., calls to <B>addch</B>.
  76
  77        TRACE_IEVENT
  78             trace low-level input processing, including timeouts.
  79
  80        TRACE_BITS
  81             trace state of TTY control bits.
  82
  83        TRACE_ICALLS
  84             trace internal/nested calls.
  85
  86        TRACE_CCALLS
  87             trace per-character calls.
  88
  89        TRACE_DATABASE
  90             trace read/write of terminfo/termcap data.
  91
  92        TRACE_MAXIMUM
  93             maximum trace level,  enables  all  of  the  separate
  94             trace features.
  95
  96             Some  tracing features are enabled whenever the <B>trace</B>
  97             parameter is nonzero.  Some  features  overlap.   The
  98             specific names are used as a guideline.
  99
 100
 101 </PRE>
 102 <H2>RETURN VALUE</H2><PRE>
 103        Routines  which  return a value are designed to be used as
 104        parameters to the <B>_tracef</B> routine.
 105
 106
 107 </PRE>
 108 <H2>PORTABILITY</H2><PRE>
 109        These functions are not part of the XSI  interface.   Some
 110        other  curses  implementations  are known to have similar,
 111        undocumented features, but they are  not  compatible  with
 112        ncurses.
 113
 114
 115 </PRE>
 116 <H2>SEE ALSO</H2><PRE>
 117        <B><A HREF="ncurses.3x.html">curses(3x)</A></B>.
 118
 119
 120
 121
 122
 123
 124
 125 </PRE>
 126 <HR>
 127 <ADDRESS>
 128 Man(1) output converted with
 129 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
 130 </ADDRESS>
 131 </BODY>
 132 </HTML>