* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
- * @Id: curs_trace.3x,v 1.18 2017/01/14 19:46:40 tom Exp @
+ * @Id: curs_trace.3x,v 1.19 2017/11/18 23:47:37 tom Exp @
-->
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
<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">
+<meta name="generator" content="Manpage converted by man2html - see https://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">
<BODY>
<H1 class="no-header">curs_trace 3x</H1>
<PRE>
-<STRONG><A HREF="curs_trace.3x.html">curs_trace(3x)</A></STRONG> <STRONG><A HREF="curs_trace.3x.html">curs_trace(3x)</A></STRONG>
+<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><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>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>
</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 <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.
</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>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.
+ <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.
+ 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 (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.
+ 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.
</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 <STRONG>TRACE_</STRONG><EM>xxx</EM> definitions in <STRONG><curses.h></STRONG>. These in-
- clude:
+ The trace parameter is formed by OR'ing values from the list of
+ <STRONG>TRACE_</STRONG><EM>xxx</EM> definitions in <STRONG><curses.h></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-descriptor 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>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 written to the trace file for each re-
- fresh.
+ 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, as well as return values.
+ trace all curses calls. The parameters for each call are traced,
+ as well as return values.
<STRONG>TRACE_VIRTPUT</STRONG>
trace virtual character puts, i.e., calls to <STRONG>addch</STRONG>.
trace changes to video attributes and colors.
<STRONG>TRACE_MAXIMUM</STRONG>
- maximum trace level, enables all of the separate
- trace features.
+ 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
- names are used as a guideline.
+ Some tracing features are enabled whenever the <STRONG>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 vari-
- able, 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>trace</STRONG> was called:
- filter, initscr, new_prescr, newterm, nofilter,
- restartterm, ripoffline, setupterm, slk_init, tgetent,
- use_env, use_extended_names, use_tioctl
+ filter, initscr, new_prescr, newterm, nofilter, restartterm,
+ ripoffline, setupterm, slk_init, tgetent, use_env,
+ use_extended_names, use_tioctl
</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 ver-
- bose option which extends the set of messages written us-
- ing 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 mes-
- sages which are written.
+ 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_extend-</STRONG>
- <STRONG>ed_names</STRONG>, some of their debugging output may be directed
- to the <EM>trace</EM> file if the <STRONG>NCURSES_TRACE</STRONG> environment vari-
- able is set:
+ 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 in the utility are written to the standard error.
- <STRONG>o</STRONG> messages produced by the underlying library are writ-
- ten to <EM>trace</EM>.
+ <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, and fewer diagnostics are provided by the
- command-line utilities.
+ 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 the <STRONG>_tracef</STRONG> routine.
+ 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, undocumented features, but
+ they are not compatible with ncurses.
- A few functions are not provided when symbol versioning is
- used:
+ A few functions are not provided when symbol versioning is used:
_nc_tracebits, _tracedump, _tracemouse
- <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>
<div class="nav">
<ul>
projects / ncurses.git / blobdiff