X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fcurs_insch.3x;h=4f7fb0af3469f22c92516a3a80444190c4000185;hp=8546cf530e673898521b193d4982d207a7245879;hb=97cb42f22c43eb31a4bf11475bd73ab0e0b10923;hpb=b1f61d9f3aa244512045a6b02e759825d7049d34 diff --git a/man/curs_insch.3x b/man/curs_insch.3x index 8546cf53..4f7fb0af 100644 --- a/man/curs_insch.3x +++ b/man/curs_insch.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998,2000 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2017,2018 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,16 +26,16 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_insch.3x,v 1.7 2000/07/01 19:57:21 tom Exp $ +.\" $Id: curs_insch.3x,v 1.15 2018/07/28 21:34:56 tom Exp $ .TH curs_insch 3X "" .SH NAME \fBinsch\fR, \fBwinsch\fR, \fBmvinsch\fR, -\fBmvwinsch\fR - insert a character before cursor in a \fBcurses\fR window +\fBmvwinsch\fR \- insert a character before cursor in a \fBcurses\fR window .SH SYNOPSIS \fB#include \fR - +.sp \fBint insch(chtype ch);\fR .br \fBint winsch(WINDOW *win, chtype ch);\fR @@ -45,26 +45,30 @@ \fBint mvwinsch(WINDOW *win, int y, int x, chtype ch);\fR .br .SH DESCRIPTION -These routines, insert the character \fIch\fR before the character under the -cursor. All characters to the right of the cursor are moved one space to the +These routines insert the character \fIch\fR before the character under the +cursor. +All characters to the right of the cursor are moved one space to the right, with the possibility of the rightmost character on the line being lost. The insertion operation does not change the cursor position. .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 +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 These routines do not necessarily imply use of a hardware insert character feature. - +.PP Note that \fBinsch\fR, \fBmvinsch\fR, and \fBmvwinsch\fR may be macros. .SH PORTABILITY These functions are described in the XSI Curses standard, Issue 4. .SH SEE ALSO \fBcurses\fR(3X). -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: +.PP +Comparable functions in the wide-character (ncursesw) library are +described in +\fBcurs_ins_wch\fR(3X).