X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fcurs_refresh.3x;h=ed84a0b028138f1e6b68f34aed8795ef795ac857;hp=5ce06903d83d58a8155ab1e50f4237dfe2fc0570;hb=16fea43a5003e094f1f7eee30bdd0ef2f2c51dba;hpb=55ccd2b959766810cf7db8d1c4462f338ce0afc8 diff --git a/man/curs_refresh.3x b/man/curs_refresh.3x index 5ce06903..ed84a0b0 100644 --- a/man/curs_refresh.3x +++ b/man/curs_refresh.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2001,2005 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2010,2016 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_refresh.3x,v 1.12 2005/05/15 16:18:49 tom Exp $ +.\" $Id: curs_refresh.3x,v 1.17 2016/10/15 16:45:45 tom Exp $ .TH curs_refresh 3X "" .na .hy 0 @@ -36,7 +36,7 @@ \fBrefresh\fR, \fBwnoutrefresh\fR, \fBwredrawln\fR, -\fBwrefresh\fR - refresh \fBcurses\fR windows and lines +\fBwrefresh\fR \- refresh \fBcurses\fR windows and lines .ad .hy .SH SYNOPSIS @@ -55,6 +55,7 @@ \fBint wredrawln(WINDOW *win, int beg_line, int num_lines);\fR .br .SH DESCRIPTION +.SS refresh/wrefresh The \fBrefresh\fR and \fBwrefresh\fR routines (or \fBwnoutrefresh\fR and \fBdoupdate\fR) must be called to get actual output to the terminal, as other routines merely manipulate data structures. @@ -66,6 +67,7 @@ same, using \fBstdscr\fR as the default window. Unless \fBleaveok\fR has been enabled, the physical cursor of the terminal is left at the location of the cursor for that window. +.SS wnoutrefresh/doupdate .PP The \fBwnoutrefresh\fR and \fBdoupdate\fR routines allow multiple updates with more efficiency than \fBwrefresh\fR alone. @@ -98,11 +100,12 @@ order and the overlap region will be modified only when it is explicitly changed. (But see the section on \fBPORTABILITY\fR below for a warning about exploiting this behavior.) +.SS wredrawln/redrawwin .PP The \fBwredrawln\fR routine indicates to \fBcurses\fR that some screen lines are corrupted and should be thrown away before anything is written over them. It touches the indicated lines (marking them changed). -The routine \fBredrawwin\fR() touches the entire window. +The routine \fBredrawwin\fR touches the entire window. .SH RETURN VALUE Routines that return an integer return \fBERR\fR upon failure, and \fBOK\fR (SVr4 only specifies "an integer value other than \fBERR\fR") upon successful @@ -110,7 +113,7 @@ completion. .PP X/Open does not define any error conditions. In this implementation -.RS +.RS 3 .TP 5 \fBwnoutrefresh\fP returns an error @@ -126,19 +129,15 @@ Note that \fBrefresh\fR and \fBredrawwin\fR may be macros. .SH PORTABILITY The XSI Curses standard, Issue 4 describes these functions. .PP -Whether \fBwnoutrefresh()\fR copies to the virtual screen the entire contents +Whether \fBwnoutrefresh\fR copies to the virtual screen the entire contents of a window or just its changed portions has never been well-documented in historic curses versions (including SVr4). It might be unwise to rely on either behavior in programs that might have to be linked with other curses implementations. -Instead, you can do an explicit \fBtouchwin()\fR before the -\fBwnoutrefresh()\fR call to guarantee an entire-contents copy anywhere. +Instead, you can do an explicit \fBtouchwin\fR before the +\fBwnoutrefresh\fR call to guarantee an entire-contents copy anywhere. .SH SEE ALSO -\fBcurses\fR(3X), \fBcurs_outopts\fR(3X) -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: +\fBcurses\fR(3X), +\fBcurs_outopts\fR(3X) +\fBcurs_variables\fR(3X).