]> ncurses.scripts.mit.edu Git - ncurses.git/blobdiff - man/curs_insch.3x
ncurses 6.5 - patch 20240504
[ncurses.git] / man / curs_insch.3x
index 4be93c6bbdc23fc49311a5f54231919e6fb41c94..baf2f6cc1bbbd5978aa1bdea0a53c46213a45247 100644 (file)
@@ -1,5 +1,5 @@
 .\"***************************************************************************
-.\" Copyright 2018-2022,2023 Thomas E. Dickey                                *
+.\" Copyright 2018-2023,2024 Thomas E. Dickey                                *
 .\" Copyright 1998-2010,2017 Free Software Foundation, Inc.                  *
 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
@@ -27,8 +27,8 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
-.\" $Id: curs_insch.3x,v 1.36 2023/12/23 16:03:24 tom Exp $
-.TH curs_insch 3X 2023-12-23 "ncurses 6.4" "Library calls"
+.\" $Id: curs_insch.3x,v 1.40 2024/04/20 19:03:47 tom Exp $
+.TH curs_insch 3X 2024-04-20 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls"
 .ie \n(.g \{\
 .ds `` \(lq
 .ds '' \(rq
@@ -44,7 +44,7 @@
 \fB\%winsch\fP,
 \fB\%mvinsch\fP,
 \fB\%mvwinsch\fP \-
-insert a \fIcurses\fR character in a window
+insert a \fIcurses\fP character in a window
 .SH SYNOPSIS
 .nf
 \fB#include <curses.h>\fP
@@ -68,35 +68,43 @@ cell to the right;
 the rightmost character on the line is discarded.
 The cursor does not advance.
 .SH "RETURN VALUE"
-These functions return \fBOK\fP on success and \fBERR\fP on failure.
+These functions return
+.B OK
+on success and
+.B ERR
+on failure.
 .PP
 Functions taking a
 .I \%WINDOW
 pointer argument fail if the pointer is
 .BR NULL .
 .PP
-Functions prefixed with \*(``mv\*('' first perform cursor movement using
-\fB\%wmove\fP and fail if the position
+Functions prefixed with \*(``mv\*('' first perform cursor movement and
+fail if the position
 .RI ( y ,
 .IR x )
-is outside the window.
+is outside the window boundaries.
 .SH NOTES
+.BR \%insch ,
+.BR \%mvinsch ,
+and
+.B \%mvwinsch
+may be implemented as macros.
+.PP
 A terminal's
 .B \%insert_character
 .RB ( ich1 )
 capability
 is not necessarily employed.
-.PP
-\fB\%insch\fP,
-\fB\%mvinsch\fP,
-and
-\fB\%mvwinsch\fP
-may be implemented as macros.
 .SH PORTABILITY
-X/Open Curses, Issue 4, describes these functions.
+X/Open Curses,
+Issue 4 describes these functions.
 .PP
-SVr4 describes successful return values only as
-\*(``an integer value other than \fBERR\fP\*(''.
+SVr4
+.I curses
+describes a successful return value only as
+\*(``an integer value other than
+.BR ERR \*(''.
 .SH "SEE ALSO"
 \fB\%curs_ins_wch\fP(3X) describes comparable functions in the
 wide-character