X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fcurs_insstr.3x;h=b3147ed6151e9f3604fab029534f099abfef3206;hp=4166fc308e3b5bf767191f432cd74377a10ce3c5;hb=47d2fb4537d9ad5bb14f4810561a327930ca4280;hpb=55ccd2b959766810cf7db8d1c4462f338ce0afc8 diff --git a/man/curs_insstr.3x b/man/curs_insstr.3x index 4166fc30..b3147ed6 100644 --- a/man/curs_insstr.3x +++ b/man/curs_insstr.3x @@ -1,5 +1,6 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2004,2005 Free Software Foundation, Inc. * +.\" Copyright 2019,2020 Thomas E. Dickey * +.\" Copyright 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 * @@ -26,8 +27,12 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_insstr.3x,v 1.16 2005/05/15 17:48:33 tom Exp $ +.\" $Id: curs_insstr.3x,v 1.24 2020/02/02 23:34:34 tom Exp $ .TH curs_insstr 3X "" +.ie \n(.g .ds `` \(lq +.el .ds `` `` +.ie \n(.g .ds '' \(rq +.el .ds '' '' .SH NAME \fBinsstr\fR, \fBinsnstr\fR, @@ -36,7 +41,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 \fR .br @@ -67,17 +72,22 @@ 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 -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 +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,12 +100,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), -\fBunctrl\fR(3X), +\fBcurs_util\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: