ncurses 6.4 - patch 20230918

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

diff --git a/man/curs_initscr.3x b/man/curs_initscr.3x
index 3451991b239de6edf1b7ed92be7560a8bd086351..404c2bdc6ec71217ce55e7e21638841a9bc393b8 100644 (file)
--- a/man/curs_initscr.3x
+++ b/man/curs_initscr.3x
@@ -27,8 +27,8 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
-.\" $Id: curs_initscr.3x,v 1.40 2023/06/10 16:50:22 tom Exp $
-.TH curs_initscr 3X ""
+.\" $Id: curs_initscr.3x,v 1.50 2023/09/16 23:37:03 tom Exp $
+.TH curs_initscr 3X 2023-09-16 "ncurses 6.4" "Library calls"
 .de bP
 .ie n  .IP \(bu 4
 .el    .IP \(bu 2
@@ -37,17 +37,14 @@
 .el       .ds `` ``
 .ie \n(.g .ds '' \(rq
 .el       .ds '' ''
-.na
-.hy 0
 .SH NAME
-\fBinitscr\fP,
-\fBnewterm\fP,
-\fBendwin\fP,
-\fBisendwin\fP,
-\fBset_term\fP,
-\fBdelscreen\fP \- \fBcurses\fP screen initialization and manipulation routines
-.ad
-.hy
+\fB\%initscr\fP,
+\fB\%newterm\fP,
+\fB\%endwin\fP,
+\fB\%isendwin\fP,
+\fB\%set_term\fP,
+\fB\%delscreen\fP \-
+initialize, manipulate, or tear down \fIcurses\fR terminal interface
 .SH SYNOPSIS
 \fB#include <curses.h>\fP
 .sp
@@ -62,7 +59,6 @@
 \fBSCREEN *set_term(SCREEN *\fInew\fB);\fR
 .br
 \fBvoid delscreen(SCREEN* \fIsp\fB);\fR
-.br
 .SH DESCRIPTION
 .SS initscr
 \fBinitscr\fP is normally the first \fBcurses\fP routine to call when
@@ -81,7 +77,6 @@ If errors occur, \fBinitscr\fP writes an appropriate error
 message to standard error and exits;
 otherwise, a pointer is returned to \fBstdscr\fP.
 .SS newterm
-.PP
 A program that outputs to more than one terminal should use the \fBnewterm\fP
 routine for each terminal instead of \fBinitscr\fP.
 A program that needs to inspect capabilities,
@@ -106,7 +101,6 @@ The file descriptor of the output stream is passed to \fBsetupterm\fP(3X),
 which returns a pointer to a \fBTERMINAL\fP structure.
 \fBnewterm\fP's return value holds a pointer to the \fBTERMINAL\fP structure.
 .SS endwin
-.PP
 The program must also call
 \fBendwin\fP for each terminal being used before exiting from \fBcurses\fP.
 If \fBnewterm\fP is called more than once for the same terminal, the first
@@ -131,19 +125,16 @@ restores tty modes (see \fBreset_shell_mode\fP(3X)).
 Calling \fBrefresh\fP(3X) or \fBdoupdate\fP(3X) after a
 temporary escape causes the program to resume visual mode.
 .SS isendwin
-.PP
 The \fBisendwin\fP routine returns \fBTRUE\fP if \fBendwin\fP has been
 called without any subsequent calls to \fBwrefresh\fP,
 and \fBFALSE\fP otherwise.
 .SS set_term
-.PP
 The \fBset_term\fP routine is used to switch between different terminals.
 The screen reference \fInew\fP becomes the new current terminal.
 The previous terminal is returned by the routine.
 This is the only routine which manipulates \fBSCREEN\fP pointers;
 all other routines affect only the current terminal.
 .SS delscreen
-.PP
 The \fBdelscreen\fP routine frees storage associated with the
 \fBSCREEN\fP data structure.
 The \fBendwin\fP routine does not do
@@ -225,13 +216,14 @@ For example
 NetBSD's \fBbaudrate\fP(3X) function uses the descriptor in \fBTERMINAL\fP.
 \fBncurses\fP and SVr4 use the descriptor in \fBSCREEN\fP.
 .bP
-NetBSD and \fBncurses\fP use the descriptor in \fBTERMINAL\fP for terminal I/O modes,
+NetBSD and \fBncurses\fP use the descriptor
+in \fBTERMINAL\fP
+for terminal I/O modes,
 e.g.,
 \fBdef_shell_mode\fP(3X),
 \fBdef_prog_mode\fP(3X).
 SVr4 curses uses the descriptor in \fBSCREEN\fP.
 .SS Unset TERM Variable
-.PP
 If the TERM variable is missing or empty, \fBinitscr\fP uses the
 value \*(``unknown\*('',
 which normally corresponds to a terminal entry with the \fIgeneric\fP
@@ -240,26 +232,23 @@ Generic entries are detected by \fBsetupterm\fP(3X)
 and cannot be used for full-screen operation.
 Other implementations may handle a missing/empty TERM variable differently.
 .SS Signal Handlers
-.PP
-Quoting from X/Open Curses, section 3.1.1:
+Quoting from X/Open Curses Issue 7, section 3.1.1:
 .RS 5
-.hy 0
 .PP
-.I Curses implementations may provide for special handling of the
-.I \fBSIGINT\fP,
-.I \fBSIGQUIT\fP and
-.I \fBSIGTSTP\fP signals
-.I if their disposition is \fBSIG_DFL\fP at the time
-\fBinitscr\fI is called \fR...
+Curses implementations may provide for special handling of the
+\%SIGINT,
+\%SIGQUIT,
+and \%SIGTSTP signals if their disposition is \%SIG_DFL at the time
+.I \%initscr
+is called.\|.\|.
 .PP
-.I Any special handling for these signals may remain in effect for the
-.I life of the process or until the process changes the disposition of
-.I the signal.
+Any special handling for these signals may remain in effect for the
+life of the process or until the process changes the disposition of
+the signal.
 .PP
-.I None of the Curses functions are required to be safe
-.I with respect to signals \fP...
+None of the Curses functions are required to be safe
+with respect to signals.\|.\|.
 .RE
-.hy
 .PP
 This implementation establishes signal handlers during initialization,
 e.g., \fBinitscr\fP or \fBnewterm\fP.