X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fcurs_initscr.3x;h=0082b03e855f76c9101f67363d291a3c20adad15;hp=0582ea2df680e375c261c24c0bfffdfbff2eae0a;hb=2560bc3dae7f4919060c02c91a593566c908091c;hpb=32f9f5f12cd9159261f9db228461049e8c770404;ds=inline diff --git a/man/curs_initscr.3x b/man/curs_initscr.3x index 0582ea2d..0082b03e 100644 --- a/man/curs_initscr.3x +++ b/man/curs_initscr.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2014,2015 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2016,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 * @@ -26,7 +26,7 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_initscr.3x,v 1.23 2015/07/16 09:23:42 tom Exp $ +.\" $Id: curs_initscr.3x,v 1.28 2017/05/30 21:12:51 tom Exp $ .TH curs_initscr 3X "" .de bP .IP \(bu 4 @@ -55,25 +55,25 @@ .br \fBbool isendwin(void);\fR .br -\fBSCREEN *newterm(char *type, FILE *outfd, FILE *infd);\fR +\fBSCREEN *newterm(char *\fP\fItype\fP\fB, FILE *\fP\fIoutfd\fP\fB, FILE *\fP\fIinfd\fP\fB);\fR .br -\fBSCREEN *set_term(SCREEN *new);\fR +\fBSCREEN *set_term(SCREEN *\fP\fInew\fP\fB);\fR .br -\fBvoid delscreen(SCREEN* sp);\fR +\fBvoid delscreen(SCREEN* \fP\fIsp\fP\fB);\fR .br .SH DESCRIPTION .SS initscr \fBinitscr\fR is normally the first \fBcurses\fR routine to call when initializing a program. A few special routines sometimes need to be called before it; -these are \fBslk_init\fR, \fBfilter\fR, \fBripoffline\fR, +these are \fBslk_init\fR(3X), \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. +\fBinitscr\fR also causes the first call to \fBrefresh\fR(3X) 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. @@ -108,14 +108,19 @@ A program should always call \fBendwin\fR before exiting or escaping from \fBcurses\fR mode temporarily. This routine .bP -restores tty modes, +resets colors to correspond with the default color pair 0, .bP -moves the cursor to the lower left-hand corner of the screen and +moves the cursor to the lower left-hand corner of the screen, .bP -resets the terminal into -the proper non-visual mode. +clears the remainder of the line so that it uses the default colors, +.bP +sets the cursor to normal visibility (see \fBcurs_set\fP(3X)), +.bP +stops cursor-addressing mode using the \fIexit_ca_mode\fP terminal capability, +.bP +restores tty modes (see \fBreset_shell_mode\fP(3X)). .PP -Calling \fBrefresh\fR or \fBdoupdate\fR after a +Calling \fBrefresh\fR(3X) or \fBdoupdate\fR(3X) after a temporary escape causes the program to resume visual mode. .SS isendwin .PP @@ -155,8 +160,6 @@ i.e., .bP \fBset_term\fP returns no error. -.SH NOTES -Note that \fBinitscr\fR and \fBnewterm\fR may be macros. .SH PORTABILITY These functions were described in the XSI Curses standard, Issue 4. As of 2015, the current document is X/Open Curses, Issue 7. @@ -187,9 +190,10 @@ Other implementations may handle a missing/empty TERM variable differently. Quoting from X/Open Curses, section 3.1.1: .RS 5 .PP -\fICurses implementations may provide for special handling of the SIGINT, -SIGQUIT and SIGTSTP signals if their disposition is SIG_DFL at the time -\fBinitscr()\fP is called \fP... +\fICurses implementations may provide for special handling of the \fBSIGINT\fP, +\fBSIGQUIT\fP and \fBSIGTSTP\fP signals +if their disposition is \fBSIG_DFL\fP at the time +\fBinitscr\fP is called \fP... .PP \fIAny special handling for these signals may remain in effect for the life of the process or until the process changes the disposition of @@ -231,7 +235,7 @@ assuming that it has been completely altered. It also updates the saved terminal modes with \fBdef_shell_mode\fP (see curs_kernel(3X)). .TP 5 .B SIGWINCH -This handles the window-size changes which were initially ignored in +This handles the window-size changes which were ignored in the standardization efforts. The handler sets a (signal-safe) variable which is later tested in \fBwgetch\fP (see curs_getch(3X)).