ncurses 6.5 - patch 20240608

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

diff --git a/man/curs_outopts.3x b/man/curs_outopts.3x
index 0e20a801f8405e75380fa4a2f44037834bd3a619..414d9d08a0ba2fba740b6359ef58a5933f68928a 100644 (file)
--- a/man/curs_outopts.3x
+++ b/man/curs_outopts.3x
@@ -27,29 +27,29 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
-.\" $Id: curs_outopts.3x,v 1.60 2024/04/13 22:23:57 tom Exp $
-.TH curs_outopts 3X 2024-04-13 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls"
+.\" $Id: curs_outopts.3x,v 1.67 2024/05/25 20:10:58 tom Exp $
+.TH curs_outopts 3X 2024-05-25 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls"
 .de bP
 .ie n  .IP \(bu 4
 .el    .IP \(bu 2
 ..
 .SH NAME
 \fB\%clearok\fP,
-\fB\%idlok\fP,
 \fB\%idcok\fP,
+\fB\%idlok\fP,
 \fB\%immedok\fP,
 \fB\%leaveok\fP,
+\fB\%scrollok\fP,
 \fB\%setscrreg\fP,
-\fB\%wsetscrreg\fP,
-\fB\%scrollok\fP \-
+\fB\%wsetscrreg\fP \-
 set \fIcurses\fR output options
 .SH SYNOPSIS
 .nf
 \fB#include <curses.h>
 .PP
 \fBint clearok(WINDOW *\fIwin\fP, bool \fIbf\fP);
-\fBint idlok(WINDOW *\fIwin\fP, bool \fIbf\fP);
 \fBvoid idcok(WINDOW *\fIwin\fP, bool \fIbf\fP);
+\fBint idlok(WINDOW *\fIwin\fP, bool \fIbf\fP);
 \fBvoid immedok(WINDOW *\fIwin\fP, bool \fIbf\fP);
 \fBint leaveok(WINDOW *\fIwin\fP, bool \fIbf\fP);
 \fBint scrollok(WINDOW *\fIwin\fP, bool \fIbf\fP);
@@ -72,6 +72,13 @@ If
 the \fIwin\fP argument to \fBclearok\fP is the global variable \fBcurscr\fP,
 the next call to \fBwrefresh\fP with any window causes the screen to be cleared
 and repainted from scratch.
+.SS idcok
+If \fBidcok\fP is called with \fBFALSE\fP as second argument, \fBcurses\fP
+no longer considers using the hardware insert/delete character feature of
+terminals so equipped.
+Use of character insert/delete is enabled by default.
+Calling \fBidcok\fP with \fBTRUE\fP as second argument re-enables use
+of character insertion and deletion.
 .SS idlok
 If \fBidlok\fP is called with \fBTRUE\fP as second argument, \fBcurses\fP
 considers using the hardware insert/delete line feature of terminals so
@@ -85,13 +92,6 @@ disabled by default because insert/delete line tends to be visually annoying
 when used in applications where it is not really needed.
 If insert/delete line
 cannot be used, \fBcurses\fP redraws the changed portions of all lines.
-.SS idcok
-If \fBidcok\fP is called with \fBFALSE\fP as second argument, \fBcurses\fP
-no longer considers using the hardware insert/delete character feature of
-terminals so equipped.
-Use of character insert/delete is enabled by default.
-Calling \fBidcok\fP with \fBTRUE\fP as second argument re-enables use
-of character insertion and deletion.
 .SS immedok
 If \fBimmedok\fP is called with \fBTRUE\fP as second argument,
 any change in the window image,
@@ -119,7 +119,7 @@ line.
 If enabled, (\fIbf\fP is \fBTRUE\fP), the window is scrolled up one line
 (Note that to get the physical scrolling effect on the terminal, it is
 also necessary to call \fBidlok\fP).
-.SS  "setscrreg, wsetscrreg"
+.SS "setscrreg, wsetscrreg"
 The \fBsetscrreg\fP and \fBwsetscrreg\fP routines allow the application
 programmer to set a software scrolling region in a window.
 The \fItop\fP and
@@ -148,10 +148,15 @@ X/Open Curses does not specify any error conditions.
 In this implementation,
 .bP
 those functions that have a window pointer
-will return an error if the window pointer is null
+will return
+.B ERR
+if the window pointer is null
 .bP
 \fBwsetscrreg\fP
-returns an error if the scrolling region limits extend outside the window.
+returns
+.B ERR
+if the scrolling region limits extend outside the
+window boundaries.
 .SH NOTES
 Note that
 \fBclearok\fP,
@@ -163,7 +168,7 @@ Note that
 The \fBimmedok\fP routine is useful for windows that are used as terminal
 emulators.
 .SH PORTABILITY
-These functions are described in the XSI Curses standard, Issue 4.
+These functions are described in X/Open Curses, Issue 4.
 .PP
 Some historic curses implementations had, as an undocumented feature, the
 ability to do the equivalent of \fBclearok(..., 1)\fP by saying
@@ -173,11 +178,11 @@ This will not work under \fI\%ncurses\fP.
 Earlier System V curses implementations specified that with \fBscrollok\fP
 enabled, any window modification triggering a scroll also forced a physical
 refresh.
-XSI Curses does not require this, and \fI\%ncurses\fP avoids doing
+X/Open Curses does not require this, and \fI\%ncurses\fP avoids doing
 it to perform better vertical-motion optimization at \fBwrefresh\fP
 time.
 .PP
-The XSI Curses standard does not mention that the cursor should be
+X/Open Curses does not mention that the cursor should be
 made invisible as a side-effect of \fBleaveok\fP.
 SVr4 curses documentation does this, but the code does not.
 Use \fBcurs_set\fP to make the cursor invisible.