ncurses 6.2 - patch 20201017

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

diff --git a/man/curs_ins_wch.3x b/man/curs_ins_wch.3x
index 23cf0999572a38d1c81951d7b2f3c5b6981a79b5..9b19a2825c41fc4e72706f09af8edb82b8503443 100644 (file)
--- a/man/curs_ins_wch.3x
+++ b/man/curs_ins_wch.3x
@@ -1,5 +1,6 @@
 .\"***************************************************************************
-.\" Copyright (c) 2002 Free Software Foundation, Inc.                        *
+.\" Copyright 2019,2020 Thomas E. Dickey                                     *
+.\" Copyright 2002-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_ins_wch.3x,v 1.2 2002/03/10 23:43:27 tom Exp $
+.\" $Id: curs_ins_wch.3x,v 1.10 2020/10/18 00:22:21 tom Exp $
 .TH curs_ins_wch 3X ""
+.ie \n(.g .ds `` \(lq
+.el       .ds `` ``
+.ie \n(.g .ds '' \(rq
+.el       .ds '' ''
 .SH NAME
 \fBins_wch\fR,
 \fBmvins_wch\fR,
@@ -35,14 +40,14 @@
 \fBwins_wch\fR \- insert a complex character and rendition into a window
 .SH SYNOPSIS
 #include <curses.h>
-
+.sp
 \fBint ins_wch(const cchar_t *\fR\fIwch\fR\fB);\fR
 .br
-\fBint wins_wch(WINDOW *\fR\fIwin, const cchar_t *\fR\fIwch\fR\fB);\fR
+\fBint wins_wch(WINDOW *\fR\fIwin\fP\fB, const cchar_t *\fR\fIwch\fR\fB);\fR
+.sp
+\fBint mvins_wch(int \fR\fIy\fP\fB, int \fR\fIx\fP\fB, const cchar_t *\fR\fIwch\fR\fB);\fR
 .br
-\fBint mvins_wch(int \fR\fIy, int \fR\fIx, const cchar_t *\fR\fIwch\fR\fB);\fR
-.br
-\fBint mvwins_wch(WINDOW *\fR\fIwin, int \fR\fIy, int \fR\fIx, const cchar_t *\fR\fIwch\fR\fB);\fR
+\fBint mvwins_wch(WINDOW *\fR\fIwin\fP\fB, int \fR\fIy\fP\fB, int \fR\fIx\fP\fB, const cchar_t *\fR\fIwch\fR\fB);\fR
 .SH DESCRIPTION
 These routines, insert the complex character \fIwch\fR with rendition
 before the character under the cursor.
@@ -50,16 +55,14 @@ 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
-If successful, these functions return OK.
-If not, they return ERR.
+If successful, these functions return \fBOK\fP.
+If not, they return \fBERR\fP.
+.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 ERRORS
 No errors are defined.
 .SH SEE ALSO
 \fBcurses\fR(3X),
 \fBcurs_insch\fR(3X).
-.\"#
-.\"# The following sets edit modes for GNU EMACS
-.\"# Local Variables:
-.\"# mode:nroff
-.\"# fill-column:79
-.\"# End: