X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_trace.3x.html;h=c066797f2b3c753d976ccb7112bc27c733432dfb;hp=1880c8e93d2d24ff6c64fe89fb0d4418cf053f4e;hb=c3b21f65a2687f3894a0d3217006c23f162c893a;hpb=77afe78361875f531dc2bf8d73f2e781c8e76176 diff --git a/doc/html/man/curs_trace.3x.html b/doc/html/man/curs_trace.3x.html index 1880c8e9..c066797f 100644 --- a/doc/html/man/curs_trace.3x.html +++ b/doc/html/man/curs_trace.3x.html @@ -1,7 +1,6 @@ - + + + curs_trace 3x -

curs_trace 3x

-
+

curs_trace 3x

-
 curs_trace(3x)                                           curs_trace(3x)
 
 
 
 
-
-

NAME

+

NAME

        _tracef, _tracedump, _traceattr, _traceattr2,
        _nc_tracebits, _tracecchar_t, _tracecchar_t2, _tracechar,
        _tracechtype, _tracechtype2, _tracemouse, trace - curses
        debugging routines
 
 
-
-

SYNOPSIS

+

SYNOPSIS

        #include <curses.h>
 
-       void _tracef(const char *format, ...);
-       void _tracedump(const char *label, WINDOW *win);
-       char *_traceattr(attr_t attr);
-       char *_traceattr2(int buffer, chtype ch);
+       void _tracef(const char *format, ...);
+       void _tracedump(const char *label, WINDOW *win);
+       char *_traceattr(attr_t attr);
+       char *_traceattr2(int buffer, chtype ch);
        char *_nc_tracebits(void);
-       char * _tracecchar_t(const cchar_t *string);
-       char * _tracecchar_t2(int buffer, const cchar_t *string);
-       char *_tracechar(int ch);
-       char *_tracechtype(chtype ch);
-       char *_tracechtype2(int buffer, chtype ch);
-       char *_tracemouse(const MEVENT *event);
-       void trace(const unsigned int param);
+       char * _tracecchar_t(const cchar_t *string);
+       char * _tracecchar_t2(int buffer, const cchar_t *string);
+       char *_tracechar(int ch);
+       char *_tracechtype(chtype ch);
+       char *_tracechtype2(int buffer, chtype ch);
+       char *_tracemouse(const MEVENT *event);
+       void trace(const unsigned int param);
 
 
-
-

DESCRIPTION

+

DESCRIPTION

        The trace 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 libncurses_g.a, but may be compiled
-       into any model (shared, static, profile) by  defining  the
-       symbol  TRACE.   Additionally,  some  functions  are  only
-       available with the wide-character configuration of the li-
-       braries.
-
-       The  principal  parts of this interface are the trace rou-
-       tine which selectively enables different tracing features,
-       and the _tracef routine which writes formatted data to the
-       trace file.
-
-       Calling trace with a  nonzero  parameter  opens  the  file
-       trace  in the current directory for output.  The parameter
+       the  debugging  library  e.g.,  libncurses_g.a, but may be
+       compiled into  any  model  (shared,  static,  profile)  by
+       defining  the  symbol TRACE.  Additionally, some functions
+       are only available with the  wide-character  configuration
+       of the libraries.
+
+       The principal parts of this interface are
+
+       o   trace,  which  selectively  enables  different tracing
+           features, and
+
+       o   _tracef, which writes  formatted  data  to  the  trace
+           file.
+
+       Calling  trace  with  a  nonzero  parameter opens the file
+       trace in the current directory for output.  The  parameter
        is formed by OR'ing values from the list of TRACE_xxx def-
        initions in <curses.h>.  These include:
 
-       TRACE_DISABLE
+       TRACE_DISABLE
             turn off tracing.
 
-       TRACE_TIMES
+       TRACE_TIMES
             trace user and system times of updates.
 
-       TRACE_TPUTS
-            trace tputs calls.
+       TRACE_TPUTS
+            trace tputs calls.
 
-       TRACE_UPDATE
+       TRACE_UPDATE
             trace update actions, old & new screens.
 
-       TRACE_MOVE
+       TRACE_MOVE
             trace cursor movement and scrolling.
 
-       TRACE_CHARPUT
+       TRACE_CHARPUT
             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-
+       TRACE_ORDINARY
+            trace all update actions.  The  old  and  new  screen
+            contents  are  written to the trace file for each re-
             fresh.
 
-       TRACE_CALLS
+       TRACE_CALLS
             trace all curses calls.  The parameters for each call
             are traced, as well as return values.
 
-       TRACE_VIRTPUT
+       TRACE_VIRTPUT
             trace virtual character puts, i.e., calls to addch.
 
-       TRACE_IEVENT
+       TRACE_IEVENT
             trace low-level input processing, including timeouts.
 
-       TRACE_BITS
+       TRACE_BITS
             trace state of TTY control bits.
 
-       TRACE_ICALLS
+       TRACE_ICALLS
             trace internal/nested calls.
 
-       TRACE_CCALLS
+       TRACE_CCALLS
             trace per-character calls.
 
-       TRACE_DATABASE
+       TRACE_DATABASE
             trace read/write of terminfo/termcap data.
 
-       TRACE_ATTRS
+       TRACE_ATTRS
             trace changes to video attributes and colors.
 
-       TRACE_MAXIMUM
-            maximum trace level,  enables  all  of  the  separate
+       TRACE_MAXIMUM
+            maximum  trace  level,  enables  all  of the separate
             trace features.
 
-       Some  tracing  features are enabled whenever the trace pa-
-       rameter is nonzero.  Some features overlap.  The  specific
+       Some tracing features are enabled whenever the  trace  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 _tracedump, which implements the  screen
+       dump  for TRACE_UPDATE).  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 NCURSES_TRACE environment vari-
        able, to set the tracing feature as if trace 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
 
 
-
-

RETURN VALUE

-       Routines  which  return a value are designed to be used as
+

RETURN VALUE

+       Routines which return a value are designed to be  used  as
        parameters to the _tracef routine.
 
 
-
-

PORTABILITY

-       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
+

PORTABILITY

+       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.
 
 
-
-

SEE ALSO

+

SEE ALSO

        curses(3x).
 
 
 
                                                          curs_trace(3x)
 
-
-
-Man(1) output converted with -man2html -
+