ncurses 6.4 - patch 20240224

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

diff --git a/man/curs_addstr.3x b/man/curs_addstr.3x
index b0b35482dee6daa9a97478a949d4eaeb25dc7996..8db64ada9802d2674ac592e820540aa6dfc38b2f 100644 (file)
--- a/man/curs_addstr.3x
+++ b/man/curs_addstr.3x
@@ -27,12 +27,19 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
-.\" $Id: curs_addstr.3x,v 1.34 2023/09/30 21:38:11 tom Exp $
-.TH curs_addstr 3X 2023-09-30 "ncurses 6.4" "Library calls"
-.ie \n(.g .ds `` \(lq
-.el       .ds `` ``
-.ie \n(.g .ds '' \(rq
-.el       .ds '' ''
+.\" $Id: curs_addstr.3x,v 1.37 2023/11/18 21:18:55 tom Exp $
+.TH curs_addstr 3X 2023-11-18 "ncurses 6.4" "Library calls"
+.ie \n(.g \{\
+.ds `` \(lq
+.ds '' \(rq
+.\}
+.el \{\
+.ie t .ds `` ``
+.el   .ds `` ""
+.ie t .ds '' ''
+.el   .ds '' ""
+.\}
+.
 .de bP
 .ie n  .IP \(bu 4
 .el    .IP \(bu 2
@@ -49,23 +56,17 @@
 add a string to a \fIcurses\fR window and advance the cursor
 .SH SYNOPSIS
 .nf
-\fB#include <curses.h>\fP
+\fB#include <curses.h>
 .PP
-\fBint addstr(const char *\fIstr\fB);\fR
-.br
-\fBint addnstr(const char *\fIstr\fB, int \fIn\fB);\fR
-.br
-\fBint waddstr(WINDOW *\fIwin\fB, const char *\fIstr\fB);\fR
-.br
-\fBint waddnstr(WINDOW *\fIwin\fB, const char *\fIstr\fB, int \fIn\fB);\fR
-.sp
-\fBint mvaddstr(int \fIy\fB, int \fIx\fB, const char *\fIstr\fB);\fR
-.br
-\fBint mvaddnstr(int \fIy\fB, int \fIx\fB, const char *\fIstr\fB, int \fIn\fB);\fR
-.br
-\fBint mvwaddstr(WINDOW *\fIwin\fB, int \fIy\fB, int \fIx\fB, const char *\fIstr\fB);\fR
-.br
-\fBint mvwaddnstr(WINDOW *\fIwin\fB, int \fIy\fB, int \fIx\fB, const char *\fIstr, int \fIn\fB);\fR
+\fBint addstr(const char *\fIstr\fP);
+\fBint addnstr(const char *\fIstr\fP, int \fIn\fP);
+\fBint waddstr(WINDOW *\fIwin\fP, const char *\fIstr\fP);
+\fBint waddnstr(WINDOW *\fIwin\fP, const char *\fIstr\fP, int \fIn\fP);
+.PP
+\fBint mvaddstr(int \fIy\fP, int \fIx\fP, const char *\fIstr\fP);
+\fBint mvaddnstr(int \fIy\fP, int \fIx\fP, const char *\fIstr\fP, int \fIn\fP);
+\fBint mvwaddstr(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP, const char *\fIstr\fP);
+\fBint mvwaddnstr(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP, const char *\fIstr\fP, int \fIn\fP);
 .fi
 .SH DESCRIPTION
 These functions write the (null-terminated) character string
@@ -95,22 +96,13 @@ if the corresponding calls to \fBwaddch\fP return an error.
 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.
-If an error is returned by the \fBwmove\fP,
-no characters are added to the window.
-.PP
-If an error is returned by \fBwaddch\fP
-(e.g.,
-because the window is not large enough,
-or an illegal byte sequence was detected)
-only part of the string may be added.
-Aside from that,
-there is a special case in \fBwaddch\fP where an error may be
-returned after successfully writing a character to the lower-right corner
-of a window when \fBscrollok\fP(3X) is disabled.
 .SH NOTES
 All of these functions except \fBwaddnstr\fP may be macros.
 .SH PORTABILITY
 These functions are described in the XSI Curses standard, Issue 4.
 .SH SEE ALSO
 \fB\%curses\fP(3X),
-\fB\%curs_addch\fP(3X)
+\fB\%curs_addch\fP(3X),
+\fB\%curs_addchstr\fP(3X),
+\fB\%curs_addwstr\fP(3X),
+\fB\%curs_add_wchstr\fP(3X)