ncurses 6.5 - patch 20240525

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

diff --git a/man/curs_trace.3x b/man/curs_trace.3x
index 2a55275c2e46045a7140cd4802d65284553f23b1..ddae7911254160565f7c286adde7bdc6b1657454 100644 (file)
--- a/man/curs_trace.3x
+++ b/man/curs_trace.3x
@@ -1,5 +1,5 @@
 .\"***************************************************************************
-.\" Copyright 2019-2022,2023 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,8 +27,8 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
-.\" $Id: curs_trace.3x,v 1.42 2023/12/23 16:08:25 tom Exp $
-.TH curs_trace 3X 2023-12-23 "ncurses 6.4" "Library calls"
+.\" $Id: curs_trace.3x,v 1.50 2024/04/20 21:24:19 tom Exp $
+.TH curs_trace 3X 2024-04-20 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls"
 .ie \n(.g \{\
 .ds `` \(lq
 .ds '' \(rq
@@ -44,6 +44,17 @@
 .ie n  .IP \(bu 4
 .el    .IP \(bu 2
 ..
+.
+.de dS \" Start unfilled display.
+.nr aD \n(.j
+.na
+..
+.
+.de dE \" End unfilled display.
+.ad \n(.j
+.rr aD
+..
+.
 .SH NAME
 \fB\%curses_trace\fP,
 \fB\%trace\fP,
@@ -63,7 +74,7 @@
 .nf
 \fB#include <curses.h>
 .PP
-\fBunsigned curses_trace(const unsigned \fIparam\fP);
+\fBunsigned curses_trace(const unsigned \fItrace-mask\fP);
 .PP
 \fBvoid _tracef(const char *\fIformat\fP, ...);
 .PP
@@ -71,7 +82,7 @@
 \fBchar *_traceattr2(int \fIbuffer\fP, chtype \fIch\fP);
 \fBchar *_tracecchar_t(const cchar_t *\fIstring\fP);
 \fBchar *_tracecchar_t2(int \fIbuffer\fP, const cchar_t *\fIstring\fP);
-\fBchar *_tracechar(int \fIch\fP);
+\fBchar *_tracechar(int \fIc\fP);
 \fBchar *_tracechtype(chtype \fIch\fP);
 \fBchar *_tracechtype2(int \fIbuffer\fP, chtype \fIch\fP);
 .PP
@@ -80,7 +91,7 @@
 \fBchar *_tracemouse(const MEVENT *\fIevent\fP);
 .PP
 \fI/* deprecated */\fP
-\fBvoid trace(const unsigned int \fIparam\fP);
+\fBvoid trace(const unsigned int \fItrace-mask\fP);
 .fi
 .SH DESCRIPTION
 The \fIcurses trace\fP routines are used for debugging the
@@ -192,25 +203,6 @@ Some tracing features are enabled whenever the \fBcurses_trace\fP parameter
 is nonzero.
 Some features overlap.
 The specific names are used as a guideline.
-.SS Initialization
-These functions check the \fI\%NCURSES_TRACE\fP environment variable,
-to set the tracing feature as if \fBcurses_trace\fP was called:
-.RS 4
-.PP
-filter,
-initscr,
-new_prescr,
-newterm,
-nofilter,
-restartterm,
-ripoffline,
-setupterm,
-slk_init,
-tgetent,
-use_env,
-use_extended_names,
-use_tioctl
-.RE
 .SS "Command-line Utilities"
 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.
@@ -233,8 +225,32 @@ and fewer diagnostics are provided by the command-line utilities.
 .SH RETURN VALUE
 Routines which return a value are designed to be used as parameters
 to the \fB_tracef\fP routine.
+.SH ENVIRONMENT
+.SS NCURSES_TRACE
+A positive integral value stored in this variable causes the following
+functions to enable the tracing feature as if
+.B \%curses_trace
+were called.
+.PP
+.dS
+.RS 4
+\fB\%filter\fP,
+\fB\%initscr\fP,
+\fB\%new_prescr\fP,
+\fB\%newterm\fP,
+\fB\%nofilter\fP,
+\fB\%restartterm\fP,
+\fB\%ripoffline\fP,
+\fB\%setupterm\fP,
+\fB\%slk_init\fP,
+\fB\%tgetent\fP,
+\fB\%use_env\fP,
+\fB\%use_extended_names\fP,
+\fB\%use_tioctl\fP
+.RE
+.dE
 .SH PORTABILITY
-These functions are not part of the XSI interface.
+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 \fI\%ncurses\fP: