ncurses 6.3 - patch 20211225

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

diff --git a/man/curs_touch.3x b/man/curs_touch.3x
index 8d4a88cb0cfb7c1b4c7ae3867dedd98ea24dd0af..2a7f520001f04425b72b50a43bd7755332a57bc2 100644 (file)
--- a/man/curs_touch.3x
+++ b/man/curs_touch.3x
@@ -1,5 +1,6 @@
 .\"***************************************************************************
 .\"***************************************************************************

-.\" Copyright (c) 1998-2015,2017 Free Software Foundation, Inc.              *
+.\" Copyright 2018-2020,2021 Thomas E. Dickey                                *
+.\" Copyright 1998-2015,2017 Free Software Foundation, Inc.                  *

 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
 .\" copy of this software and associated documentation files (the            *
 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
 .\" copy of this software and associated documentation files (the            *


@@ -26,60 +27,62 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"

-.\" $Id: curs_touch.3x,v 1.20 2017/11/25 16:19:42 tom Exp $
+.\" $Id: curs_touch.3x,v 1.25 2021/12/25 17:39:16 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
+\fBint touchline(WINDOW *\fP\fIwin\fP\fB, int \fP\fIstart\fP\fB, int \fP\fIcount\fP\fB);\fP
+.sp
+\fBint touchwin(WINDOW *\fP\fIwin\fP\fB);\fP

 .br
 .br

-\fBint touchwin(WINDOW *win);\fR
+\fBint wtouchln(WINDOW *\fP\fIwin\fP\fB, int \fP\fIy\fP\fB, int \fP\fIn\fP\fB, int \fP\fIchanged\fP\fB);\fP
+.sp
+\fBint untouchwin(WINDOW *\fP\fIwin\fP\fB);\fP
+.sp
+\fBbool is_linetouched(WINDOW *\fP\fIwin\fP\fB, int \fP\fIline\fP\fB);\fP

 .br
 .br

-\fBint touchline(WINDOW *win, int start, int count);\fR
-.br
-\fBint untouchwin(WINDOW *win);\fR
-.br
-\fBint wtouchln(WINDOW *win, int y, int n, int changed);\fR
-.br
-\fBbool is_linetouched(WINDOW *win, int line);\fR
-.br
-\fBbool is_wintouched(WINDOW *win);\fR
+\fBbool is_wintouched(WINDOW *\fP\fIwin\fP\fB);\fP

 .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
 optimization information about which parts of the window have been

-touched, by pretending that the entire window has been drawn on.  This
+touched, by pretending that the entire window has been drawn on.
+This

 is sometimes necessary when using overlapping windows, since a change
 to one window affects the other window, but the records of which lines
 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
-routine \fBtouchline\fR only pretends that \fIcount\fR lines have been
-changed, beginning with line \fIstart\fR.
+have been changed in the other window do not reflect the change.
+The
+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\fP, look as if they have (\fIchanged\fP\fB=1\fP) or have
+not (\fIchanged\fP\fB=0\fP) 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.


@@ -87,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


@@ -102,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


@@ -119,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).