ncurses 6.2 - patch 20200222
[ncurses.git] / doc / html / man / curs_trace.3x.html
index ebd47f86524125a89c2977a4e933d6b3a37c34d9..a60ae970276dc6d0273afbf1e9cb70f0ed8cb48f 100644 (file)
@@ -1,6 +1,7 @@
 <!-- 
   ****************************************************************************
-  * Copyright (c) 2000-2016,2017 Free Software Foundation, Inc.              *
+  * Copyright 2019,2020 Thomas E. Dickey                                     *
+  * Copyright 2000-2016,2017 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 +27,7 @@
   * sale, use or other dealings in this Software without prior written       *
   * authorization.                                                           *
   ****************************************************************************
-  * @Id: curs_trace.3x,v 1.19 2017/11/18 23:47:37 tom Exp @
+  * @Id: curs_trace.3x,v 1.21 2020/02/02 23:34:34 tom Exp @
 -->
 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
 <HTML>
 
 
 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
-       <STRONG>trace</STRONG>, <STRONG>_tracef</STRONG>, <STRONG>_traceattr</STRONG>, <STRONG>_traceattr2</STRONG>, <STRONG>_tracecchar_t</STRONG>, <STRONG>_tracecchar_t2</STRONG>,
-       <STRONG>_tracechar</STRONG>, <STRONG>_tracechtype</STRONG>, <STRONG>_tracechtype2</STRONG>, <STRONG>_nc_tracebits</STRONG>, <STRONG>_tracedump</STRONG>,
-       <STRONG>_tracemouse</STRONG> - <STRONG>curses</STRONG> debugging routines
+       <STRONG>curses_trace</STRONG>, <STRONG>trace</STRONG>, <STRONG>_tracef</STRONG>, <STRONG>_traceattr</STRONG>, <STRONG>_traceattr2</STRONG>, <STRONG>_tracecchar_t</STRONG>,
+       <STRONG>_tracecchar_t2</STRONG>, <STRONG>_tracechar</STRONG>, <STRONG>_tracechtype</STRONG>, <STRONG>_tracechtype2</STRONG>, <STRONG>_nc_tracebits</STRONG>,
+       <STRONG>_tracedump</STRONG>, <STRONG>_tracemouse</STRONG> - <STRONG>curses</STRONG> debugging routines
 
 
 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
 
-       <STRONG>void</STRONG> <STRONG>trace(const</STRONG> <STRONG>unsigned</STRONG> <STRONG>int</STRONG> <EM>param</EM><STRONG>);</STRONG>
+       <STRONG>unsigned</STRONG> <STRONG>curses_trace(const</STRONG> <STRONG>unsigned</STRONG> <EM>param</EM><STRONG>);</STRONG>
 
        <STRONG>void</STRONG> <STRONG>_tracef(const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG><EM>format</EM><STRONG>,</STRONG> <STRONG>...);</STRONG>
 
        <STRONG>char</STRONG> <STRONG>*_nc_tracebits(void);</STRONG>
        <STRONG>char</STRONG> <STRONG>*_tracemouse(const</STRONG> <STRONG>MEVENT</STRONG> <STRONG>*</STRONG><EM>event</EM><STRONG>);</STRONG>
 
+       /* deprecated */
+       <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 libraries, as
-       well as applications which use the ncurses libraries.  These  functions
-       are  normally available only with the debugging library e.g., <EM>libncurs-</EM>
-       <EM>es</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 <EM>curses</EM> <EM>trace</EM> routines are used for debugging the ncurses libraries,
+       as well as applications which use the ncurses libraries.  Some  limita-
+       tions apply:
+
+       <STRONG>o</STRONG>   Aside from <STRONG>curses_trace</STRONG>, the other functions are normally available
+           only with the debugging library e.g., <EM>libncurses</EM><STRONG>_</STRONG><EM>g.a</EM>.
+
+           All of the trace functions may be compiled into any model  (shared,
+           static, profile) by defining the symbol <STRONG>TRACE</STRONG>.
+
+       <STRONG>o</STRONG>   Additionally,  the  functions  which use <STRONG>cchar_t</STRONG> are only available
+           with the wide-character configuration of the libraries.
 
 
 </PRE><H3><a name="h3-Functions">Functions</a></H3><PRE>
        The principal parts of this interface are
 
-       <STRONG>o</STRONG>   <STRONG>trace</STRONG>, which selectively enables different tracing features, and
+       <STRONG>o</STRONG>   <STRONG>curses_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 creates the file  <STRONG>trace</STRONG>  in  the
-       current  directory  for output.  If the file already exists, no tracing
-       is done.
+           The other functions either return a pointer to a string-area (allo-
+           cated 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.
+
+       The <STRONG>curses_trace</STRONG> function is always available, whether or not the other
+       trace functions are available:
+
+       <STRONG>o</STRONG>   If tracing is available, calling <STRONG>curses_trace</STRONG> with a nonzero param-
+           eter updates the trace mask, and returns the previous trace mask.
 
-       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  func-
-       tion,  some use a buffer-number parameter, telling the library to allo-
-       cate additional string-areas.
+           When the trace mask is nonzero, ncurses creates the file "trace" in
+           the current directory for output.  If the file already  exists,  no
+           tracing is done.
+
+       <STRONG>o</STRONG>   If tracing is not available, <STRONG>curses_trace</STRONG> returns zero (0).
 
 
 </PRE><H3><a name="h3-Trace-Parameter">Trace Parameter</a></H3><PRE>
-       The trace parameter is  formed  by  OR'ing  values  from  the  list  of
+       The  trace  parameter  is  formed  by  OR'ing  values  from the list of
        <STRONG>TRACE_</STRONG><EM>xxx</EM> definitions in <STRONG>&lt;curses.h&gt;</STRONG>.  These include:
 
        <STRONG>TRACE_DISABLE</STRONG>
             turn off tracing by passing a zero parameter.
 
-            The  library flushes the output file, but retains an open file-de-
-            scriptor to the trace file so that it can resume tracing later  if
-            a nonzero parameter is passed to the <STRONG>trace</STRONG> function.
+            The library flushes the output file, but retains an open  file-de-
+            scriptor  to the trace file so that it can resume tracing later if
+            a nonzero parameter is passed to the <STRONG>curses_trace</STRONG> function.
 
        <STRONG>TRACE_TIMES</STRONG>
             trace user and system times of updates.
             trace all character outputs.
 
        <STRONG>TRACE_ORDINARY</STRONG>
-            trace  all  update  actions.   The old and new screen contents are
+            trace all update actions.  The old and  new  screen  contents  are
             written to the trace file for each refresh.
 
        <STRONG>TRACE_CALLS</STRONG>
-            trace all curses calls.  The parameters for each call are  traced,
+            trace  all curses calls.  The parameters for each call are traced,
             as well as return values.
 
        <STRONG>TRACE_VIRTPUT</STRONG>
        <STRONG>TRACE_MAXIMUM</STRONG>
             maximum trace level, enables all of the separate trace features.
 
-       Some  tracing  features  are  enabled  whenever  the <STRONG>trace</STRONG> parameter is
-       nonzero.  Some features overlap.  The specific  names  are  used  as  a
+       Some tracing features are enabled whenever the  <STRONG>curses_trace</STRONG>  parameter
+       is  nonzero.   Some features overlap.  The specific names are used as a
        guideline.
 
 
 </PRE><H3><a name="h3-Initialization">Initialization</a></H3><PRE>
-       These  functions  check  the <STRONG>NCURSES_TRACE</STRONG> environment variable, to set
-       the tracing feature as if <STRONG>trace</STRONG> was called:
+       These functions check the <STRONG>NCURSES_TRACE</STRONG> environment  variable,  to  set
+       the tracing feature as if <STRONG>curses_trace</STRONG> was called:
 
            filter, initscr, new_prescr, newterm, nofilter, restartterm,
            ripoffline, setupterm, slk_init, tgetent, use_env,
 
 
 </PRE><H3><a name="h3-Command-line-Utilities">Command-line Utilities</a></H3><PRE>
-       The command-line utilities such as  <STRONG><A HREF="tic.1m.html">tic(1)</A></STRONG>  provide  a  verbose  option
-       which  extends  the  set  of messages written using the <STRONG>trace</STRONG> function.
-       Both of these (<STRONG>-v</STRONG> and <STRONG>trace</STRONG>) use the same variable (<STRONG>_nc_tracing</STRONG>), which
-       determines the messages which are written.
-
-       Because  the  command-line  utilities may call initialization functions
-       such as <STRONG>setupterm</STRONG>, <STRONG>tgetent</STRONG> or <STRONG>use_extended_names</STRONG>, some of their  debug-
-       ging  output may be directed to the <EM>trace</EM> file if the <STRONG>NCURSES_TRACE</STRONG> en-
+       The  command-line  utilities  such  as  <STRONG><A HREF="tic.1m.html">tic(1)</A></STRONG> provide a verbose option
+       which extends the set of messages written using the <STRONG>curses_trace</STRONG>  func-
+       tion.   Both  of  these  (<STRONG>-v</STRONG>  and  <STRONG>curses_trace</STRONG>)  use the same variable
+       (<STRONG>_nc_tracing</STRONG>), which determines the messages which are written.
+
+       Because the command-line utilities may  call  initialization  functions
+       such  as <STRONG>setupterm</STRONG>, <STRONG>tgetent</STRONG> or <STRONG>use_extended_names</STRONG>, some of their debug-
+       ging output may be directed to the <EM>trace</EM> file if the <STRONG>NCURSES_TRACE</STRONG>  en-
        vironment variable is set:
 
        <STRONG>o</STRONG>   messages produced in the utility are written to the standard error.
 
        <STRONG>o</STRONG>   messages produced by the underlying library are written to <EM>trace</EM>.
 
-       If ncurses is built without tracing, none of the latter  are  produced,
+       If  ncurses  is built without tracing, none of the latter are produced,
        and fewer diagnostics are provided by the command-line utilities.
 
 
 </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
+       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.
+       These  functions  are not part of the XSI interface.  Some other curses
+       implementations are known to have similar features, but  they  are  not
+       compatible with ncurses:
+
+       <STRONG>o</STRONG>   SVr4  provided  <STRONG>traceon</STRONG>  and <STRONG>traceoff</STRONG>, to control whether debugging
+           information was written to the "trace" file.  While  the  functions
+           were  always  available, this feature was only enabled if <STRONG>DEBUG</STRONG> was
+           defined when building the library.
+
+           The SVr4 tracing feature is undocumented.
+
+       <STRONG>o</STRONG>   PDCurses provides <STRONG>traceon</STRONG> and <STRONG>traceoff</STRONG>, which (like SVr4)  are  al-
+           ways  available, and enable tracing to the "trace" file only when a
+           debug-library is built.
 
-       A few functions are not provided when symbol versioning is used:
+           PDCurses has a short description of these functions,  with  a  note
+           that  they are not present in X/Open Curses, ncurses or NetBSD.  It
+           does not mention SVr4, but the functions'  inclusion  in  a  header
+           file section labeled "Quasi-standard" hints at the origin.
+
+       <STRONG>o</STRONG>   NetBSD  does  not  provide functions for enabling/disabling traces.
+           It  uses  environment   variables   <STRONG>CURSES_TRACE_MASK</STRONG>   and   <STRONG>CURS-</STRONG>
+           <STRONG>ES_TRACE_FILE</STRONG>  to  determine  what is traced, and where the results
+           are written.  This is available only when a debug-library is built.
+
+           The NetBSD tracing feature is undocumented.
+
+       A few ncurses functions are not  provided  when  symbol  versioning  is
+       used:
 
            _nc_tracebits, _tracedump, _tracemouse
 
+       The  original  <STRONG>trace</STRONG> routine was deprecated because it often conflicted
+       with application names.
+
 
 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>.