ncurses 5.7 - patch 20100918

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

diff --git a/man/curs_insstr.3x b/man/curs_insstr.3x
index 4166fc308e3b5bf767191f432cd74377a10ce3c5..072288dc0af047cd75dfc25812a2515d28a4ec2f 100644 (file)
--- a/man/curs_insstr.3x
+++ b/man/curs_insstr.3x
@@ -1,5 +1,5 @@
 .\"***************************************************************************
-.\" Copyright (c) 1998-2004,2005 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,7 +26,7 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
-.\" $Id: curs_insstr.3x,v 1.16 2005/05/15 17:48:33 tom Exp $
+.\" $Id: curs_insstr.3x,v 1.20 2010/08/14 23:29:16 tom Exp $
 .TH curs_insstr 3X ""
 .SH NAME
 \fBinsstr\fR,
@@ -36,7 +36,7 @@
 \fBmvinsstr\fR,
 \fBmvinsnstr\fR,
 \fBmvwinsstr\fR,
-\fBmvwinsnstr\fR - insert string before cursor in a \fBcurses\fR window
+\fBmvwinsnstr\fR \- insert string before cursor in a \fBcurses\fR window
 .SH SYNOPSIS
 \fB#include <curses.h>\fR
 .br
@@ -67,7 +67,7 @@ The cursor position does not change
 The functions with \fIn\fR as the last argument
 insert a leading substring of at most \fIn\fR characters.
 If \fIn\fR<=0, then the entire string is inserted.
-
+.PP
 Special characters are handled as in \fBaddch\fP.
 .SH RETURN VALUE
 All routines that return an integer return \fBERR\fR upon failure and OK (SVr4
@@ -78,6 +78,10 @@ X/Open defines no error conditions.
 In this implementation,
 if the window parameter is null or the str parameter is null,
 an error is returned.
+.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 all but \fBwinsnstr\fR may be macros.
 .SH PORTABILITY
@@ -90,7 +94,7 @@ This is probably an error, since it makes this group of functions inconsistent.
 Also, no implementation of curses documents this inconsistency.
 .SH SEE ALSO
 \fBcurses\fR(3X),
-\fBunctrl\fR(3X),
+\fBcurs_util\fR(3X),
 \fBcurs_clear\fR(3X),
 \fBcurs_inch\fR(3X).
 .\"#