diff options
Diffstat (limited to 'doc/html/man/curs_trace.3x.html')
| -rw-r--r-- | doc/html/man/curs_trace.3x.html | 142 |
1 files changed, 75 insertions, 67 deletions
diff --git a/doc/html/man/curs_trace.3x.html b/doc/html/man/curs_trace.3x.html index a60ae970276d..c1ea937fd64b 100644 --- a/doc/html/man/curs_trace.3x.html +++ b/doc/html/man/curs_trace.3x.html @@ -1,6 +1,6 @@ -<!-- +<!-- **************************************************************************** - * Copyright 2019,2020 Thomas E. Dickey * + * Copyright 2019-2023,2024 Thomas E. Dickey * * Copyright 2000-2016,2017 Free Software Foundation, Inc. * * * * Permission is hereby granted, free of charge, to any person obtaining a * @@ -27,35 +27,35 @@ * sale, use or other dealings in this Software without prior written * * authorization. * **************************************************************************** - * @Id: curs_trace.3x,v 1.21 2020/02/02 23:34:34 tom Exp @ + * @Id: curs_trace.3x,v 1.50 2024/04/20 21:24:19 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 https://invisible-island.net/scripts/readme.html#others_scripts"> -<TITLE>curs_trace 3x</TITLE> +<TITLE>curs_trace 3x 2024-04-20 ncurses 6.5 Library calls</TITLE> <link rel="author" href="mailto:bug-ncurses@gnu.org"> -<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> + </HEAD> <BODY> -<H1 class="no-header">curs_trace 3x</H1> +<H1 class="no-header">curs_trace 3x 2024-04-20 ncurses 6.5 Library calls</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> Library calls <STRONG><A HREF="curs_trace.3x.html">curs_trace(3x)</A></STRONG> </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE> - <STRONG>curses_trace</STRONG>, <STRONG>trace</STRONG>, <STRONG>_tracef</STRONG>, <STRONG>_traceattr</STRONG>, <STRONG>_traceattr2</STRONG>, <STRONG>_tracecchar_t</STRONG>, + <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 + <STRONG>_tracedump</STRONG>, <STRONG>_tracemouse</STRONG> - <EM>curses</EM> debugging routines </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE> <STRONG>#include</STRONG> <STRONG><curses.h></STRONG> - <STRONG>unsigned</STRONG> <STRONG>curses_trace(const</STRONG> <STRONG>unsigned</STRONG> <EM>param</EM><STRONG>);</STRONG> + <STRONG>unsigned</STRONG> <STRONG>curses_trace(const</STRONG> <STRONG>unsigned</STRONG> <EM>trace-mask</EM><STRONG>);</STRONG> <STRONG>void</STRONG> <STRONG>_tracef(const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG><EM>format</EM><STRONG>,</STRONG> <STRONG>...);</STRONG> @@ -63,7 +63,7 @@ <STRONG>char</STRONG> <STRONG>*_traceattr2(int</STRONG> <EM>buffer</EM><STRONG>,</STRONG> <STRONG>chtype</STRONG> <EM>ch</EM><STRONG>);</STRONG> <STRONG>char</STRONG> <STRONG>*_tracecchar_t(const</STRONG> <STRONG>cchar_t</STRONG> <STRONG>*</STRONG><EM>string</EM><STRONG>);</STRONG> <STRONG>char</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>*_tracechar(int</STRONG> <EM>c</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> @@ -71,17 +71,17 @@ <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> + <EM>/*</EM> <EM>deprecated</EM> <EM>*/</EM> + <STRONG>void</STRONG> <STRONG>trace(const</STRONG> <STRONG>unsigned</STRONG> <STRONG>int</STRONG> <EM>trace-mask</EM><STRONG>);</STRONG> </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE> - 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: + The <EM>curses</EM> <EM>trace</EM> routines are used for debugging the <EM>ncurses</EM> libraries, + as well as applications which use the <EM>ncurses</EM> libraries. Some + limitations 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>. + only with the debugging library e.g., <STRONG>libncurses_g.a</STRONG>. All of the trace functions may be compiled into any model (shared, static, profile) by defining the symbol <STRONG>TRACE</STRONG>. @@ -98,9 +98,9 @@ <STRONG>o</STRONG> <STRONG>_tracef</STRONG>, which writes formatted data to the <EM>trace</EM> file. - 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 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, @@ -109,26 +109,27 @@ 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. + <STRONG>o</STRONG> If tracing is available, calling <STRONG>curses_trace</STRONG> with a nonzero + parameter updates the trace mask, and returns the previous trace + mask. - When the trace mask is nonzero, ncurses creates the file "trace" in - the current directory for output. If the file already exists, no + When the trace mask is nonzero, <EM>ncurses</EM> 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><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-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. + 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>curses_trace</STRONG> function. <STRONG>TRACE_TIMES</STRONG> trace user and system times of updates. @@ -146,11 +147,11 @@ 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> @@ -177,36 +178,27 @@ <STRONG>TRACE_MAXIMUM</STRONG> maximum trace level, enables all of the separate trace features. - Some tracing features are enabled whenever the <STRONG>curses_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>curses_trace</STRONG> was called: - - 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 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 + which extends the set of messages written using the <STRONG>curses_trace</STRONG> + function. 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: + such as <STRONG>setupterm</STRONG>, <STRONG>tgetent</STRONG> or <STRONG>use_extended_names</STRONG>, some of their + debugging output may be directed to the <EM>trace</EM> file if the <EM>NCURSES</EM><STRONG>_</STRONG><EM>TRACE</EM> + environment 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 <EM>ncurses</EM> is built without tracing, none of the latter are produced, and fewer diagnostics are provided by the command-line utilities. @@ -215,35 +207,47 @@ the <STRONG>_tracef</STRONG> routine. +</PRE><H2><a name="h2-ENVIRONMENT">ENVIRONMENT</a></H2><PRE> + +</PRE><H3><a name="h3-NCURSES_TRACE">NCURSES_TRACE</a></H3><PRE> + A positive integral value stored in this variable causes the following + functions to enable the tracing feature as if <STRONG>curses_trace</STRONG> were called. + + <STRONG>filter</STRONG>, <STRONG>initscr</STRONG>, <STRONG>new_prescr</STRONG>, <STRONG>newterm</STRONG>, <STRONG>nofilter</STRONG>, <STRONG>restartterm</STRONG>, + <STRONG>ripoffline</STRONG>, <STRONG>setupterm</STRONG>, <STRONG>slk_init</STRONG>, <STRONG>tgetent</STRONG>, <STRONG>use_env</STRONG>, + <STRONG>use_extended_names</STRONG>, <STRONG>use_tioctl</STRONG> + + </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 features, but they are not - compatible with ncurses: + These functions are not part of the X/Open Curses interface. Some + other curses implementations are known to have similar features, but + they are not compatible with <EM>ncurses</EM>: - <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 + <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. + <STRONG>o</STRONG> PDCurses provides <STRONG>traceon</STRONG> and <STRONG>traceoff</STRONG>, which (like SVr4) are + always available, and enable tracing to the "trace" file only when + a debug-library is built. - 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 + PDCurses has a short description of these functions, with a note + that they are not present in X/Open Curses, <EM>ncurses</EM> 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. + <STRONG>o</STRONG> NetBSD does not provide functions for enabling/disabling traces. + It uses environment variables <EM>CURSES</EM><STRONG>_</STRONG><EM>TRACE</EM><STRONG>_</STRONG><EM>MASK</EM> and + <EM>CURSES</EM><STRONG>_</STRONG><EM>TRACE</EM><STRONG>_</STRONG><EM>FILE</EM> 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 + A few <EM>ncurses</EM> functions are not provided when symbol versioning is used: _nc_tracebits, _tracedump, _tracemouse @@ -253,11 +257,11 @@ </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="ncurses.3x.html">curses(3x)</A></STRONG> - <STRONG><A HREF="curs_trace.3x.html">curs_trace(3x)</A></STRONG> +ncurses 6.5 2024-04-20 <STRONG><A HREF="curs_trace.3x.html">curs_trace(3x)</A></STRONG> </PRE> <div class="nav"> <ul> @@ -267,11 +271,15 @@ <ul> <li><a href="#h3-Functions">Functions</a></li> <li><a href="#h3-Trace-Parameter">Trace Parameter</a></li> -<li><a href="#h3-Initialization">Initialization</a></li> <li><a href="#h3-Command-line-Utilities">Command-line Utilities</a></li> </ul> </li> <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li> +<li><a href="#h2-ENVIRONMENT">ENVIRONMENT</a> +<ul> +<li><a href="#h3-NCURSES_TRACE">NCURSES_TRACE</a></li> +</ul> +</li> <li><a href="#h2-PORTABILITY">PORTABILITY</a></li> <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li> </ul> |