ncurses 6.1 - patch 20190216

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

diff --git a/man/curs_insstr.3x b/man/curs_insstr.3x
index 6a5d312970f6a6ce0e78c21c904af72562fa95fb..b396ec52613bf8898067e3e77ed953db4691b8a9 100644 (file)
--- a/man/curs_insstr.3x
+++ b/man/curs_insstr.3x
@@ -1,5 +1,5 @@
 .\"***************************************************************************
 .\"***************************************************************************

-.\" Copyright (c) 1998-2005,2006 Free Software Foundation, Inc.              *
+.\" Copyright (c) 1998-2010,2017 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,7 +26,7 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"

-.\" $Id: curs_insstr.3x,v 1.17 2006/02/25 21:49:19 tom Exp $
+.\" $Id: curs_insstr.3x,v 1.22 2017/11/21 00:53:44 tom Exp $

 .TH curs_insstr 3X ""
 .SH NAME
 \fBinsstr\fR,
 .TH curs_insstr 3X ""
 .SH NAME
 \fBinsstr\fR,


@@ -36,7 +36,7 @@
 \fBmvinsstr\fR,
 \fBmvinsnstr\fR,
 \fBmvwinsstr\fR,
 \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
 .SH SYNOPSIS
 \fB#include <curses.h>\fR
 .br


@@ -70,14 +70,19 @@ If \fIn\fR<=0, then the entire string is inserted.
 .PP
 Special characters are handled as in \fBaddch\fP.
 .SH RETURN VALUE
 .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
-specifies only "an integer value other than \fBERR\fR") upon successful
-completion, unless otherwise noted in the preceding routine descriptions.
+All routines that return an integer return \fBERR\fR upon failure and \fBOK\fP
+(SVr4 specifies only "an integer value other than \fBERR\fR")
+upon successful completion,
+unless otherwise noted in the preceding routine descriptions.

 .PP
 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
 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
 .SH NOTES
 Note that all but \fBwinsnstr\fR may be macros.
 .SH PORTABILITY


@@ -90,12 +95,6 @@ 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),
 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).
 \fBcurs_clear\fR(3X),
 \fBcurs_inch\fR(3X).

-.\"#
-.\"# The following sets edit modes for GNU EMACS
-.\"# Local Variables:
-.\"# mode:nroff
-.\"# fill-column:79
-.\"# End: