ncurses 5.7 - patch 20100828

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

diff --git a/man/curs_delch.3x b/man/curs_delch.3x
index d63d6020e3a9318b681eb347aa4468043fcf55d2..6f05e3eb7c2130ae5703a007215c5f1250e0b2db 100644 (file)
--- a/man/curs_delch.3x
+++ b/man/curs_delch.3x
@@ -1,5 +1,5 @@
 .\"***************************************************************************
-.\" Copyright (c) 1998 Free Software Foundation, Inc.                        *
+.\" Copyright (c) 1998-2006,2010 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,14 +26,16 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
-.\" $Id: curs_delch.3x,v 1.6 1998/03/11 21:12:53 juergen Exp $
+.\" $Id: curs_delch.3x,v 1.10 2010/08/14 23:29:16 tom Exp $
 .TH curs_delch 3X ""
 .SH NAME
-\fBdelch\fR, \fBwdelch\fR, \fBmvdelch\fR, \fBmvwdelch\fR -
-delete character under the cursor in a \fBcurses\fR window
+\fBdelch\fR,
+\fBwdelch\fR,
+\fBmvdelch\fR,
+\fBmvwdelch\fR \- delete character under the cursor in a \fBcurses\fR window
 .SH SYNOPSIS
 \fB#include <curses.h>\fR
-
+.sp
 \fBint delch(void);\fR
 .br
 \fBint wdelch(WINDOW *win);\fR
@@ -52,6 +54,10 @@ imply use of the hardware delete character feature.)
 All routines return the integer \fBERR\fR upon failure and an \fBOK\fR (SVr4
 specifies only "an integer value other than \fBERR\fR") upon successful
 completion.
+.PP
+Functions with a "mv" prefix first perform a cursor movement using
+\fBwmove\fP, and return an error if the position is outside the window,
+or if the window pointer is null.
 .SH NOTES
 Note that \fBdelch\fR, \fBmvdelch\fR, and \fBmvwdelch\fR may be macros.
 .SH PORTABILITY