ncurses 6.3 - patch 20221203

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

diff --git a/man/curs_touch.3x b/man/curs_touch.3x
index b5ea35b3fa3fc98fcfcc413e0109ee7c2f58406a..7b979b2b63ab51a89f102604816328ad34cabf0d 100644 (file)
--- a/man/curs_touch.3x
+++ b/man/curs_touch.3x
@@ -1,5 +1,5 @@
 .\"***************************************************************************
 .\"***************************************************************************

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

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


@@ -27,36 +27,36 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"

-.\" $Id: curs_touch.3x,v 1.23 2020/10/24 09:51:21 tom Exp $
+.\" $Id: curs_touch.3x,v 1.26 2022/02/12 20:05:11 tom Exp $

 .TH curs_touch 3X ""
 .na
 .hy 0
 .SH NAME
 .TH curs_touch 3X ""
 .na
 .hy 0
 .SH NAME

-\fBtouchwin\fR,
-\fBtouchline\fR,
-\fBuntouchwin\fR,
-\fBwtouchln\fR,
-\fBis_linetouched\fR,
-\fBis_wintouched\fR \- \fBcurses\fR refresh control routines
+\fBtouchwin\fP,
+\fBtouchline\fP,
+\fBuntouchwin\fP,
+\fBwtouchln\fP,
+\fBis_linetouched\fP,
+\fBis_wintouched\fP \- \fBcurses\fP refresh control routines

 .ad
 .hy
 .SH SYNOPSIS
 .ad
 .hy
 .SH SYNOPSIS

-\fB#include <curses.h>\fR
+\fB#include <curses.h>\fP

 .sp
 .sp

-\fBint touchline(WINDOW *\fP\fIwin\fP\fB, int \fP\fIstart\fP\fB, int \fP\fIcount\fP\fB);\fR
+\fBint touchline(WINDOW *\fIwin\fB, int \fIstart\fB, int \fIcount\fB);\fR

 .sp
 .sp

-\fBint touchwin(WINDOW *\fP\fIwin\fP\fB);\fR
+\fBint touchwin(WINDOW *\fIwin\fB);\fR

 .br
 .br

-\fBint wtouchln(WINDOW *\fP\fIwin\fP\fB, int \fP\fIy\fP\fB, int \fP\fIn\fP\fB, int \fP\fIchanged\fP\fB);\fR
+\fBint wtouchln(WINDOW *\fIwin\fB, int \fIy\fB, int \fIn\fB, int \fIchanged\fB);\fR

 .sp
 .sp

-\fBint untouchwin(WINDOW *\fP\fIwin\fP\fB);\fR
+\fBint untouchwin(WINDOW *\fIwin\fB);\fR

 .sp
 .sp

-\fBbool is_linetouched(WINDOW *\fP\fIwin\fP\fB, int \fP\fIline\fP\fB);\fR
+\fBbool is_linetouched(WINDOW *\fIwin\fB, int \fIline\fB);\fR

 .br
 .br

-\fBbool is_wintouched(WINDOW *\fP\fIwin\fP\fB);\fR
+\fBbool is_wintouched(WINDOW *\fIwin\fB);\fR

 .br
 .SH DESCRIPTION
 .br
 .SH DESCRIPTION

-The \fBtouchwin\fR and \fBtouchline\fR routines throw away all
+The \fBtouchwin\fP and \fBtouchline\fP routines throw away all

 optimization information about which parts of the window have been
 touched, by pretending that the entire window has been drawn on.
 This
 optimization information about which parts of the window have been
 touched, by pretending that the entire window has been drawn on.
 This


@@ -64,25 +64,25 @@ is sometimes necessary when using overlapping windows, since a change
 to one window affects the other window, but the records of which lines
 have been changed in the other window do not reflect the change.
 The
 to one window affects the other window, but the records of which lines
 have been changed in the other window do not reflect the change.
 The

-routine \fBtouchline\fR only pretends that \fIcount\fR lines have been
-changed, beginning with line \fIstart\fR.
+routine \fBtouchline\fP only pretends that \fIcount\fP lines have been
+changed, beginning with line \fIstart\fP.

 .PP
 .PP

-The \fBuntouchwin\fR routine marks all lines in the window as unchanged since
-the last call to \fBwrefresh\fR.
+The \fBuntouchwin\fP routine marks all lines in the window as unchanged since
+the last call to \fBwrefresh\fP.

 .PP
 .PP

-The \fBwtouchln\fR routine makes \fIn\fR lines in the window, starting
-at line \fIy\fR, look as if they have (\fIchanged\fR\fB=1\fR) or have
-not (\fIchanged\fR\fB=0\fR) been changed since the last call to
-\fBwrefresh\fR.
+The \fBwtouchln\fP routine makes \fIn\fP lines in the window, starting
+at line \fIy\fR, look as if they have (\fIchanged\fB=1\fR) or have
+not (\fIchanged\fB=0\fR) been changed since the last call to
+\fBwrefresh\fP.

 .PP
 .PP

-The \fBis_linetouched\fR and \fBis_wintouched\fR routines return
-\fBTRUE\fR if the specified line/window was modified since the last
-call to \fBwrefresh\fR; otherwise they return \fBFALSE\fR.  In
-addition, \fBis_linetouched\fR returns \fBERR\fR if \fIline\fR is not
+The \fBis_linetouched\fP and \fBis_wintouched\fP routines return
+\fBTRUE\fP if the specified line/window was modified since the last
+call to \fBwrefresh\fP; otherwise they return \fBFALSE\fP.  In
+addition, \fBis_linetouched\fP returns \fBERR\fP if \fIline\fP is not

 valid for the given window.
 .SH RETURN VALUE
 valid for the given window.
 .SH RETURN VALUE

-All routines return the integer \fBERR\fR upon failure and an integer value
-other than \fBERR\fR upon successful completion, unless otherwise noted in the
+All routines return the integer \fBERR\fP upon failure and an integer value
+other than \fBERR\fP upon successful completion, unless otherwise noted in the

 preceding routine descriptions.
 .PP
 X/Open does not define any error conditions.
 preceding routine descriptions.
 .PP
 X/Open does not define any error conditions.


@@ -90,7 +90,7 @@ In this implementation
 .RS 3
 .TP 5
 \fBis_linetouched\fP
 .RS 3
 .TP 5
 \fBis_linetouched\fP

-returns an error 
+returns an error

 if the window pointer is null, or
 if the line number is outside the window.
 .IP
 if the window pointer is null, or
 if the line number is outside the window.
 .IP


@@ -105,7 +105,7 @@ the \fBERR\fP is provided by a macro named \fBis_linetouched\fP.
 The actual function returns \fBFALSE\fP when it detects an error.
 .TP 5
 \fBwtouchln\fP
 The actual function returns \fBFALSE\fP when it detects an error.
 .TP 5
 \fBwtouchln\fP

-returns an error 
+returns an error

 if the window pointer is null, or
 if the line number is outside the window.
 .RE
 if the window pointer is null, or
 if the line number is outside the window.
 .RE


@@ -122,8 +122,8 @@ otherwise this implementation behaves the same as SVr4.
 The XSI Curses standard, Issue 4 describes these functions,
 but defines no error conditions.
 .SH NOTES
 The XSI Curses standard, Issue 4 describes these functions,
 but defines no error conditions.
 .SH NOTES

-All of these routines except \fBwtouchln\fR may be macros.
+All of these routines except \fBwtouchln\fP may be macros.

 .SH SEE ALSO
 .SH SEE ALSO

-\fBcurses\fR(3X),
-\fBcurs_refresh\fR(3X),
-\fBcurs_variables\fR(3X).
+\fBcurses\fP(3X),
+\fBcurs_refresh\fP(3X),
+\fBcurs_variables\fP(3X).