ncurses 6.5 - patch 20240504

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

diff --git a/man/curs_touch.3x b/man/curs_touch.3x
index 72bcb6aae23e2bb4f5e05d672cb8208563e5d027..613b6958268dbc82d871abb9cd6e5abb990ce8ae 100644 (file)
--- a/man/curs_touch.3x
+++ b/man/curs_touch.3x
@@ -1,5 +1,5 @@
 .\"***************************************************************************
 .\"***************************************************************************

-.\" Copyright 2018-2022,2023 Thomas E. Dickey                                *
+.\" Copyright 2018-2023,2024 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,8 +27,8 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"

-.\" $Id: curs_touch.3x,v 1.39 2023/09/23 22:49:51 tom Exp $
-.TH curs_touch 3X 2023-09-23 "ncurses 6.4" "Library calls"
+.\" $Id: curs_touch.3x,v 1.47 2024/04/20 21:20:07 tom Exp $
+.TH curs_touch 3X 2024-04-20 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls"

 .SH NAME
 \fB\%touchwin\fP,
 \fB\%touchline\fP,
 .SH NAME
 \fB\%touchwin\fP,
 \fB\%touchline\fP,


@@ -39,17 +39,17 @@
 control terminal output refresh in a \fIcurses\fR window
 .SH SYNOPSIS
 .nf
 control terminal output refresh in a \fIcurses\fR window
 .SH SYNOPSIS
 .nf

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

 .PP
 .PP

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

 .PP
 .PP

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

 .PP
 .PP

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

 .PP
 .PP

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

 .fi
 .SH DESCRIPTION
 The \fB\%touchwin\fP and \fB\%touchline\fP routines throw away all
 .fi
 .SH DESCRIPTION
 The \fB\%touchwin\fP and \fB\%touchline\fP routines throw away all


@@ -81,14 +81,14 @@ 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
 other than \fBERR\fP upon successful completion, unless otherwise noted in the
 preceding routine descriptions.
 .PP

-X/Open does not define any error conditions.
+X/Open Curses does not specify any error conditions.

 In this implementation
 .RS 3
 .TP 5
 \fBis_linetouched\fP
 returns an error
 if the window pointer is null, or
 In this implementation
 .RS 3
 .TP 5
 \fBis_linetouched\fP
 returns an error
 if the window pointer is null, or

-if the line number is outside the window.
+if the line number is outside the window boundaries.

 .IP
 The constant \fBERR\fP is distinct from \fBTRUE\fP and \fBFALSE\fP,
 which are the normal return values of this function.
 .IP
 The constant \fBERR\fP is distinct from \fBTRUE\fP and \fBFALSE\fP,
 which are the normal return values of this function.


@@ -103,8 +103,10 @@ The actual function returns \fBFALSE\fP when it detects an error.
 \fBwtouchln\fP
 returns an error
 if the window pointer is null, or
 \fBwtouchln\fP
 returns an error
 if the window pointer is null, or

-if the line number is outside the window.
+if the line number is outside the window boundaries.

 .RE
 .RE

+.SH NOTES
+All of these routines except \fB\%wtouchln\fP may be macros.

 .SH PORTABILITY
 These functions were introduced by SVr4.
 The Solaris \fIcurses\fP header file,
 .SH PORTABILITY
 These functions were introduced by SVr4.
 The Solaris \fIcurses\fP header file,


@@ -114,10 +116,8 @@ SVr4 \fIcurses\fP does not check the window parameter \fIwin\fP to ensure
 that it is not \fBNULL\fP;
 otherwise this implementation behaves the same as SVr4.
 .PP
 that it is not \fBNULL\fP;
 otherwise this implementation behaves the same as SVr4.
 .PP

-The XSI Curses standard, Issue 4 describes these functions,
+X/Open Curses, Issue 4 describes these functions,

 but defines no error conditions.
 but defines no error conditions.

-.SH NOTES
-All of these routines except \fB\%wtouchln\fP may be macros.

 .SH SEE ALSO
 \fB\%curses\fP(3X),
 \fB\%curs_refresh\fP(3X),
 .SH SEE ALSO
 \fB\%curses\fP(3X),
 \fB\%curs_refresh\fP(3X),