ncurses 5.5
[ncurses.git] / man / curs_initscr.3x
index 66aae13cab1d72aff6432d19dc5efef9d041fc99..1a865f94ec08895b59d5ff3101f5aef7eabb5daa 100644 (file)
@@ -1,5 +1,5 @@
 .\"***************************************************************************
-.\" Copyright (c) 1998 Free Software Foundation, Inc.                        *
+.\" Copyright (c) 1998-2003,2005 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            *
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
-.\" $Id: curs_initscr.3x,v 1.8 1999/09/18 23:52:30 tom Exp $
+.\" $Id: curs_initscr.3x,v 1.14 2005/05/15 16:18:01 tom Exp $
 .TH curs_initscr 3X ""
+.na
+.hy 0
 .SH NAME
-\fBinitscr\fR, \fBnewterm\fR, \fBendwin\fR,
-\fBisendwin\fR, \fBset_term\fR, \fBdelscreen\fR - \fBcurses\fR screen
-initialization and manipulation routines
+\fBinitscr\fR,
+\fBnewterm\fR,
+\fBendwin\fR,
+\fBisendwin\fR,
+\fBset_term\fR,
+\fBdelscreen\fR - \fBcurses\fR screen initialization and manipulation routines
+.ad
+.hy
 .SH SYNOPSIS
 \fB#include <curses.h>\fR
-
+.sp
 \fBWINDOW *initscr(void);\fR
 .br
 \fBint endwin(void);\fR
 .br
-\fBint isendwin(void);\fR
+\fBbool isendwin(void);\fR
 .br
-\fBSCREEN *newterm(const char *type, FILE *outfd, FILE *infd);\fR
+\fBSCREEN *newterm(char *type, FILE *outfd, FILE *infd);\fR
 .br
 \fBSCREEN *set_term(SCREEN *new);\fR
 .br
@@ -53,13 +60,13 @@ initializing a program.  A few special routines sometimes need to be
 called before it; these are \fBslk_init\fR, \fBfilter\fR, \fBripoffline\fR,
 \fBuse_env\fR.  For multiple-terminal applications, \fBnewterm\fR may be
 called before \fBinitscr\fR.
-
+.PP
 The initscr code determines the terminal type and initializes all \fBcurses\fR
 data structures.  \fBinitscr\fR also causes the first call to \fBrefresh\fR to
 clear the screen.  If errors occur, \fBinitscr\fR writes an appropriate error
 message to standard error and exits; otherwise, a pointer is returned to
 \fBstdscr\fR.
-
+.PP
 A program that outputs to more than one terminal should use the \fBnewterm\fR
 routine for each terminal instead of \fBinitscr\fR.  A program that needs to
 inspect capabilities, so it can continue to run in a line-oriented mode if the
@@ -73,23 +80,23 @@ is \fBNULL\fR, \fB$TERM\fR will be used).  The program must also call
 \fBendwin\fR for each terminal being used before exiting from \fBcurses\fR.
 If \fBnewterm\fR is called more than once for the same terminal, the first
 terminal referred to must be the last one for which \fBendwin\fR is called.
-
+.PP
 A program should always call \fBendwin\fR before exiting or escaping from
 \fBcurses\fR mode temporarily.  This routine restores tty modes, moves the
 cursor to the lower left-hand corner of the screen and resets the terminal into
 the proper non-visual mode.  Calling \fBrefresh\fR or \fBdoupdate\fR after a
 temporary escape causes the program to resume visual mode.
-
+.PP
 The \fBisendwin\fR routine returns \fBTRUE\fR if \fBendwin\fR has been
 called without any subsequent calls to \fBwrefresh\fR, and \fBFALSE\fR
 otherwise.
-
+.PP
 The \fBset_term\fR routine is used to switch between different
 terminals.  The screen reference \fBnew\fR becomes the new current
 terminal.  The previous terminal is returned by the routine.  This is
 the only routine which manipulates \fBSCREEN\fR pointers; all other
 routines affect only the current terminal.
-
+.PP
 The \fBdelscreen\fR routine frees storage associated with the
 \fBSCREEN\fR data structure.  The \fBendwin\fR routine does not do
 this, so \fBdelscreen\fR should be called after \fBendwin\fR if a
@@ -97,18 +104,22 @@ particular \fBSCREEN\fR is no longer needed.
 .SH RETURN VALUE
 \fBendwin\fR returns the integer \fBERR\fR upon failure and \fBOK\fR
 upon successful completion.
-
+.PP
 Routines that return pointers always return \fBNULL\fR on error.
+.PP
+X/Open defines no error conditions.
+In this implementation
+\fBendwin\fP returns an error if the terminal was not initialized.
 .SH NOTES
 Note that \fBinitscr\fR and \fBnewterm\fR may be macros.
 .SH PORTABILITY
 These functions are described in the XSI Curses standard, Issue 4.  It
 specifies that portable applications must not call \fBinitscr\fR more than
 once.
-
+.PP
 Old versions of curses, e.g., BSD 4.4, may have returned a null pointer
 from \fBinitscr\fR when an error is detected, rather than exiting.
-It is safe but redundant to check the return value of \fBinitscr\fR 
+It is safe but redundant to check the return value of \fBinitscr\fR
 in XSI Curses.
 .SH SEE ALSO
 \fBcurses\fR(3X), \fBcurs_kernel\fR(3X), \fBcurs_refresh\fR(3X),