ncurses 6.4 - patch 20231001

[ncurses.git] / man / curs_trace.3x

diff --git a/man/curs_trace.3x b/man/curs_trace.3x
index ee9f19477b667793e5226261d00c67c84d644bac..f793267a89a032dfcd02e5bfb563f130e22e8399 100644 (file)
--- a/man/curs_trace.3x
+++ b/man/curs_trace.3x
@@ -1,5 +1,5 @@
 .\"***************************************************************************
 .\"***************************************************************************

-.\" Copyright 2019-2020,2021 Thomas E. Dickey                                *
+.\" Copyright 2019-2022,2023 Thomas E. Dickey                                *

 .\" Copyright 2000-2016,2017 Free Software Foundation, Inc.                  *
 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
 .\" Copyright 2000-2016,2017 Free Software Foundation, Inc.                  *
 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *


@@ -27,7 +27,8 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"

-.\" $Id: curs_trace.3x,v 1.24 2021/12/25 21:41:58 tom Exp $
+.\" $Id: curs_trace.3x,v 1.39 2023/09/30 21:38:11 tom Exp $
+.TH curs_trace 3X 2023-09-30 "ncurses 6.4" "Library calls"

 .ie \n(.g .ds `` \(lq
 .el       .ds `` ``
 .ie \n(.g .ds '' \(rq
 .ie \n(.g .ds `` \(lq
 .el       .ds `` ``
 .ie \n(.g .ds '' \(rq


@@ -36,55 +37,44 @@
 .ie n  .IP \(bu 4
 .el    .IP \(bu 2
 ..
 .ie n  .IP \(bu 4
 .el    .IP \(bu 2
 ..

-.TH curs_trace 3X ""
-.na
-.hy 0

 .SH NAME
 .SH NAME

-\fBcurses_trace\fP,
-\fBtrace\fP,
-\fB_tracef\fP,
-\fB_traceattr\fP,
-\fB_traceattr2\fP,
-\fB_tracecchar_t\fP,
-\fB_tracecchar_t2\fP,
-\fB_tracechar\fP,
-\fB_tracechtype\fP,
-\fB_tracechtype2\fP,
-\fB_nc_tracebits\fP,
-\fB_tracedump\fP,
-\fB_tracemouse\fP \- \fBcurses\fP debugging routines
-.ad
-.hy
+\fB\%curses_trace\fP,
+\fB\%trace\fP,
+\fB\%_tracef\fP,
+\fB\%_traceattr\fP,
+\fB\%_traceattr2\fP,
+\fB\%_tracecchar_t\fP,
+\fB\%_tracecchar_t2\fP,
+\fB\%_tracechar\fP,
+\fB\%_tracechtype\fP,
+\fB\%_tracechtype2\fP,
+\fB\%_nc_tracebits\fP,
+\fB\%_tracedump\fP,
+\fB\%_tracemouse\fP \-
+\fIcurses\fR debugging routines

 .SH SYNOPSIS
 .SH SYNOPSIS

+.nf

 \fB#include <curses.h>\fP
 \fB#include <curses.h>\fP

-.sp
-\fBunsigned curses_trace(const unsigned \fP\fIparam\fP\fB);\fP
-.sp
-\fBvoid _tracef(const char *\fP\fIformat\fP\fB, ...);\fP
-.sp
-\fBchar *_traceattr(attr_t \fP\fIattr\fP\fB);\fP
-.br
-\fBchar *_traceattr2(int \fP\fIbuffer\fP\fB, chtype \fP\fIch\fP\fB);\fP
-.br
-\fBchar *_tracecchar_t(const cchar_t *\fP\fIstring\fP\fB);\fP
-.br
-\fBchar *_tracecchar_t2(int \fP\fIbuffer\fP\fB, const cchar_t *\fP\fIstring\fP\fB);\fP
-.br
-\fBchar *_tracechar(int \fP\fIch\fP\fB);\fP
-.br
-\fBchar *_tracechtype(chtype \fP\fIch\fP\fB);\fP
-.br
-\fBchar *_tracechtype2(int \fP\fIbuffer\fP\fB, chtype \fP\fIch\fP\fB);\fP
-.sp
-\fBvoid _tracedump(const char *\fP\fIlabel\fP\fB, WINDOW *\fP\fIwin\fP\fB);\fP
-.br
+.PP
+\fBunsigned curses_trace(const unsigned \fIparam\fB);\fR
+.PP
+\fBvoid _tracef(const char *\fIformat\fB, ...);\fR
+.PP
+\fBchar *_traceattr(attr_t \fIattr\fB);\fR
+\fBchar *_traceattr2(int \fIbuffer\fB, chtype \fIch\fB);\fR
+\fBchar *_tracecchar_t(const cchar_t *\fIstring\fB);\fR
+\fBchar *_tracecchar_t2(int \fIbuffer\fB, const cchar_t *\fIstring\fB);\fR
+\fBchar *_tracechar(int \fIch\fB);\fR
+\fBchar *_tracechtype(chtype \fIch\fB);\fR
+\fBchar *_tracechtype2(int \fIbuffer\fB, chtype \fIch\fB);\fR
+.PP
+\fBvoid _tracedump(const char *\fIlabel\fB, WINDOW *\fIwin\fB);\fR

 \fBchar *_nc_tracebits(void);\fP
 \fBchar *_nc_tracebits(void);\fP

-.br
-\fBchar *_tracemouse(const MEVENT *\fP\fIevent\fP\fB);\fP
-.sp
+\fBchar *_tracemouse(const MEVENT *\fIevent\fB);\fR
+.PP

 /* deprecated */
 /* deprecated */

-.br
-\fBvoid trace(const unsigned int \fP\fIparam\fP\fB);\fP
+\fBvoid trace(const unsigned int \fIparam\fB);\fR
+.fi

 .SH DESCRIPTION
 The \fIcurses trace\fP routines are used for debugging the ncurses libraries,
 as well as applications which use the ncurses libraries.
 .SH DESCRIPTION
 The \fIcurses trace\fP routines are used for debugging the ncurses libraries,
 as well as applications which use the ncurses libraries.


@@ -131,7 +121,7 @@ If the file already exists, no tracing is done.
 If tracing is not available, \fBcurses_trace\fP returns zero (0).
 .SS Trace Parameter
 The trace parameter is formed by OR'ing
 If tracing is not available, \fBcurses_trace\fP returns zero (0).
 .SS Trace Parameter
 The trace parameter is formed by OR'ing

-values from the list of \fBTRACE_\fP\fIxxx\fP definitions in \fB<curses.h>\fP.
+values from the list of \fBTRACE_\fIxxx\fR definitions in \fB<curses.h>\fR.

 These include:
 .TP 5
 .B TRACE_DISABLE
 These include:
 .TP 5
 .B TRACE_DISABLE


@@ -199,8 +189,6 @@ These functions check the \fBNCURSES_TRACE\fP environment variable,
 to set the tracing feature as if \fBcurses_trace\fP was called:
 .RS 4
 .PP
 to set the tracing feature as if \fBcurses_trace\fP was called:
 .RS 4
 .PP

-.na
-.hy 0

 filter,
 initscr,
 new_prescr,
 filter,
 initscr,
 new_prescr,


@@ -214,11 +202,8 @@ tgetent,
 use_env,
 use_extended_names,
 use_tioctl
 use_env,
 use_extended_names,
 use_tioctl

-.hy
-.ad

 .RE
 .SS Command-line Utilities
 .RE
 .SS Command-line Utilities

-.PP

 The command-line utilities such as \fBtic\fP(1) provide a verbose option
 which extends the set of messages written using the \fBcurses_trace\fP function.
 Both of these (\fB\-v\fP and \fBcurses_trace\fP)
 The command-line utilities such as \fBtic\fP(1) provide a verbose option
 which extends the set of messages written using the \fBcurses_trace\fP function.
 Both of these (\fB\-v\fP and \fBcurses_trace\fP)


@@ -287,4 +272,4 @@ _tracemouse
 The original \fBtrace\fP routine was deprecated because
 it often conflicted with application names.
 .SH SEE ALSO
 The original \fBtrace\fP routine was deprecated because
 it often conflicted with application names.
 .SH SEE ALSO

-\fBcurses\fP(3X).
+\fB\%curses\fP(3X)