ncurses 5.5

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

diff --git a/man/curs_overlay.3x b/man/curs_overlay.3x
index b6a026059d44a2ae995a8cb60f33d0403ac299f1..2a5e3cab38b45f5ed64335a17292170e8808e305 100644 (file)
--- a/man/curs_overlay.3x
+++ b/man/curs_overlay.3x
@@ -1,5 +1,5 @@
 .\"***************************************************************************
 .\"***************************************************************************

-.\" Copyright (c) 1998 Free Software Foundation, Inc.                        *
+.\" Copyright (c) 1998-2002,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            *
 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
 .\" copy of this software and associated documentation files (the            *


@@ -26,11 +26,16 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"

-.\" $Id: curs_overlay.3x,v 1.8 1998/12/26 20:08:30 tom Exp $
+.\" $Id: curs_overlay.3x,v 1.13 2005/05/15 16:18:38 tom Exp $

 .TH curs_overlay 3X ""
 .TH curs_overlay 3X ""

+.na
+.hy 0

 .SH NAME
 .SH NAME

-\fBoverlay\fR, \fBoverwrite\fR, \fBcopywin\fR - overlay and
-manipulate overlapped \fBcurses\fR windows
+\fBoverlay\fR,
+\fBoverwrite\fR,
+\fBcopywin\fR - overlay and manipulate overlapped \fBcurses\fR windows
+.ad
+.hy

 .SH SYNOPSIS
 \fB#include <curses.h>\fR
 
 .SH SYNOPSIS
 \fB#include <curses.h>\fR
 


@@ -38,7 +43,7 @@ manipulate overlapped \fBcurses\fR windows
 .br
 \fBint overwrite(const WINDOW *srcwin, WINDOW *dstwin);\fR
 .br
 .br
 \fBint overwrite(const WINDOW *srcwin, WINDOW *dstwin);\fR
 .br

-\fBint copywin(WINDOW *srcwin, WINDOW *dstwin, int sminrow,\fR
+\fBint copywin(const WINDOW *srcwin, WINDOW *dstwin, int sminrow,\fR

       \fBint smincol, int dminrow, int dmincol, int dmaxrow,\fR
       \fBint dmaxcol, int overlay);\fR
 .SH DESCRIPTION
       \fBint smincol, int dminrow, int dmincol, int dmaxrow,\fR
       \fBint dmaxcol, int overlay);\fR
 .SH DESCRIPTION


@@ -59,12 +64,19 @@ argument \fIoverlay\fR is \fBtrue\fR, then copying is non-destructive, as in
 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
 completion.
 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
 completion.

+.PP
+X/Open defines no error conditions.
+In this implementation,
+\fBcopywin\fP,
+\fBoverlay\fP and \fBoverwrite\fP return an error
+if either of the window pointers are null, or
+if some part of the window would be placed off-screen.

 .SH NOTES
 Note that \fBoverlay\fR and \fBoverwrite\fR may be macros.
 .SH PORTABILITY
 The XSI Curses standard, Issue 4 describes these functions (adding the const
 qualifiers).  It further specifies their behavior in the presence of characters
 .SH NOTES
 Note that \fBoverlay\fR and \fBoverwrite\fR may be macros.
 .SH PORTABILITY
 The XSI Curses standard, Issue 4 describes these functions (adding the const
 qualifiers).  It further specifies their behavior in the presence of characters

-with multi-byte renditions (not yet supported in this implementation).
+with multibyte renditions (not yet supported in this implementation).

 .SH SEE ALSO
 \fBcurses\fR(3X), \fBcurs_pad\fR(3X), \fBcurs_refresh\fR(3X)
 .\"#
 .SH SEE ALSO
 \fBcurses\fR(3X), \fBcurs_pad\fR(3X), \fBcurs_refresh\fR(3X)
 .\"#