ncurses 5.5

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

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

-.\" Copyright (c) 1998,2000,2001 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,12 +26,16 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"

-.\" $Id: curs_overlay.3x,v 1.11 2002/07/20 14:53:00 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
 \fBoverlay\fR,
 \fBoverwrite\fR,
 \fBcopywin\fR - overlay and manipulate overlapped \fBcurses\fR windows
 .SH NAME
 \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
 


@@ -60,6 +64,13 @@ 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
 .SH NOTES
 Note that \fBoverlay\fR and \fBoverwrite\fR may be macros.
 .SH PORTABILITY